https://github.com/codeforequity-at/botium-connector-ubitec
Botium Connector for Ubitec
https://github.com/codeforequity-at/botium-connector-ubitec
Last synced: 12 months ago
JSON representation
Botium Connector for Ubitec
- Host: GitHub
- URL: https://github.com/codeforequity-at/botium-connector-ubitec
- Owner: codeforequity-at
- License: mit
- Created: 2020-04-15T11:06:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-05T10:03:13.000Z (almost 5 years ago)
- Last Synced: 2025-03-28T20:48:51.410Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.botium.ai
- Size: 29.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botium Connector for Ubitec Bot Framework
[](https://nodei.co/npm/botium-connector-ubitec/)
[](https://app.codeship.com/projects/394685)
[](https://badge.fury.io/js/botium-connector-ubitec)
[]()
This is a [Botium](https://www.botium.ai) connector for testing your Ubitec Bot Framework chatbot.
__Did you read the [Botium in a Nutshell](https://medium.com/@floriantreml/botium-in-a-nutshell-part-1-overview-f8d0ceaf8fb4) 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 Ubitec Bot Framework chatbot.
It can be used as any other Botium connector with all Botium Stack components:
* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)
* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)
* [Botium Box](https://www.botium.ai)
## Requirements
* **Node.js and NPM**
* a **Ubitec bot**
* a **project directory** on your workstation to hold test cases and Botium configuration
## Install Botium and Ubitec Bot Framework Connector
When using __Botium CLI__:
```
> npm install -g botium-cli
> npm install -g botium-connector-ubitec
> botium-cli init
> botium-cli run
```
When using __Botium Bindings__:
```
> npm install -g botium-bindings
> npm install -g botium-connector-ubitec
> botium-bindings init mocha
> npm install && npm run mocha
```
When using __Botium Box__:
_Already integrated into Botium Box, no setup required_
## Connecting Ubitec Bot Framework chatbot to Botium
Process is very simple, you have to know just the endpoint URL and Basic Authentication credentials for your chatbot.
Create a botium.json with this URL in your project directory:
```
{
"botium": {
"Capabilities": {
"PROJECTNAME": "",
"CONTAINERMODE": "ubitec",
"UBITEC_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](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.
## How to start samples
There is a sample available in [samples](./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
```
## Supported Capabilities
Set the capability __CONTAINERMODE__ to __ubitec__ to activate this connector.
### UBITEC_URL
Path of the Botium Consumer endpoint
### UBITEC_USER
Username for Basic Authentication
### UBITEC_PASSWORD
Password for Basic Authentication