botium-connector-teneo v0.1.4

Botium Connector for Teneo

This is a Botium connector for testing your Teneo 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 the API of your Teneo chatbot.

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 Teneo bot
• a project directory on your workstation to hold test cases and Botium configuration

Install Botium and Teneo Connector

When using Botium CLI:

> npm install -g botium-cli
> npm install -g botium-connector-teneo
> botium-cli init
> botium-cli run

When using Botium Bindings:

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

When using Botium Box:

Already integrated into Botium Box, no setup required

Connecting Teneo chatbot to Botium

Process is very simple, you have to know just the endpoint URL for your chatbot.

Create a botium.json with this URL in your project directory:

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "<whatever>",
      "CONTAINERMODE": "teneo",
      "TENEO_URL": "..."
    }
  }
}

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 BotiumScript files.

How to start samples

There is a sample available in samples with Botium Bindings.

• Adapt botium.json in the sample directory if required (change URL)
• Install packages, run the test

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

Additional Input Parameters

#begin
UPDATE_CUSTOM TENEO_PARAM|usertimezone|CEST

Assert Output Parameters

#bot
JSON_PATH $.input.parameters.usertimezone|CEST
JSON_PATH $.output.parameters.displayWidget.time

Supported Capabilities

Set the capability CONTAINERMODE to teneo to activate this connector.

TENEO_URL

Teneo chatbot endpoint url

TENEO_STATIC_PARAMS

Static parameters to add as endpoint url query parameters

"TENEO_STATIC_PARAMS": {
  "staticparam1": "staticvalue1",
  "staticparam2": "staticvalue2"
}