Botium Connector for Rasa


![license]()

This is a Botium connector for testing your Rasa 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 connects to your Rasa chatbot either to Rasa Core or to Rasa NLU directly.

When connecting to Rasa Core, Botium can test the conversational flow. When connecting to Rasa NLU, Botium can test the NLU functions only with the Botium NLP Asserters

It can be used as any other Botium connector with all Botium Stack components:
* Botium CLI
* Botium Bindings
* Botium Box

Requirements

* Node.js and NPM
* a Rasa bot
* a project directory on your workstation to hold test cases and Botium configuration

Install Botium and Rasa Connector

When using __Botium CLI__:

``
> npm install -g botium-cli
> npm install -g botium-connector-rasa
> botium-cli init
> botium-cli run
`

When using __Botium Bindings__:

`
> npm install -g botium-bindings
> npm install -g botium-connector-rasa
> botium-bindings init mocha
> npm install && npm run mocha
`

When using __Botium Box__:

_Already integrated into Botium Box, no setup required_

Connecting Rasa chatbot to Botium

$3

When using _REST\_INPUT_ (Rasa Core), you have to add the RestInput channel to your Rasa configuration.

When using _NLU\_INPUT_ (Rasa Core), you have to add the _--enable-api_ command line switch when starting your Rasa server.

$3

Create a botium.json with the the URL of your Rasa installation in your project directory:

`
{
"botium": {
"Capabilities": {
"PROJECTNAME": "",
"CONTAINERMODE": "rasa",
"RASA_MODE": "REST_INPUT",
"RASA_ENDPOINT_URL": "https://box.botium.at/rasa-demo/"
}
}
}
`

To check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:

`
> botium-cli emulator
`

Botium setup is ready, you can begin to write your test cases with BotiumScript.

Using the botium-connector-rasa-cli

This connector provides a CLI interface for importing convos and utterances from your Rasa model and convert it to BotiumScript.

You can either run the CLI with botium-cli (it is integrated there), or directly from this connector (see samples/nlu/package.json for an example):

> botium-connector-rasa-cli import --nlufile path-to-my-nlu.md

_Please note that a botium-core installation is required_

For getting help on the available CLI options and switches, run:

> botium-connector-rasa-cli --help

How to start sample

There are two samples available in the samples folder. Both of them are based on Sara - the Rasa Demo Bot. Adapt the botium.json in these directories with your own Rasa Demo installation.

You can start the samples with these commands:

`
> cd ./samples/core
> npm install && npm test
`

Supported Capabilities

Set the capability __CONTAINERMODE__ to __rasa__ to activate this connector.

$3

Rasa endpoint URL.

$3

_Default: DIALOG\_AND\_NLUT_

REST_INPUT for using Rasa Core
The Rasa endpoint URL is extended with /webhooks/rest/webhook for posting the Botium requests.

NLU_INPUT for using Rasa NLU
The Rasa endpoint URL is extended with /model/parse for posting the Botium requests.

DIALOG_AND_NLU
Combining Rasa dialogue and NLU engine endpoints

$3

Rest endpoint path. By default, it is webhooks/rest/webhook

$3

NLU endpoint path. By default, it is model/parse`

$3

_Default: endpoint URL/version_

URL to ping for checking availability of Rasa. By default, the _version_-endpoint is contacted.

$3

If your Rasa endpoint is protected with token authentication, you have to specify the token to use here.

$3

If your Rasa endpoint is protected with JWT Auth, you have to specify the JWT Token here.