Botium Connector for Botpress
This is a Botium connector for testing your Botpress chatbot.
Did you read the Botium in a Nutshell articles ? Be warned, without prior knowledge of Botium you won't be able to properly use this library!
How it works ?
Botium uses the Botpress built-in JSON channel to connect to your chatbot.
It can be used as any other Botium connector with all Botium Stack components:
Requirements
- Node.js and NPM
- a Botpress Server
- a project directory on your workstation to hold test cases and Botium configuration
Install Botium and Botpress Connector
When using Botium CLI:
> npm install -g botium-cli
> npm install -g botium-connector-botpress
> botium-cli init
> botium-cli run
When using Botium Bindings:
> npm install -g botium-bindings
> npm install -g botium-connector-botpress
> botium-bindings init mocha
> npm install && npm run mocha
When using Botium Box:
Already integrated into Botium Box, no setup required
Connecting your Botpress server to Botium
Open the file botium.json in your working directory and add the Botpress chatbot connection settings.
{
"botium": {
"Capabilities": {
"PROJECTNAME": "<whatever>",
"CONTAINERMODE": "botpress",
"BOTPRESS_SERVER_URL": "...",
"BOTPRESS_BOTID": "..."
}
}
}
Botium setup is ready, you can begin to write your BotiumScript files.
Supported Capabilities
Set the capability CONTAINERMODE to botpress to activate this connector.
BOTPRESS_SERVER_URL
The Botpress server url (without any path, just http/https, servername, port)
BOTPRESS_BOTID
The Botpress bot id
BOTPRESS_USERID
If set, this userId will be used. Otherwise, for each convo a new userId is generated
BOTPRESS_USE_INTENT
Set this to true for testing the resolved intents only instead of the output text