node.js - 使用 botium 和 testmybot 包测试聊天机器人

Question

如何使用 botium 或 testmybot Node 包测试聊天机器人？

我找不到任何端到端示例来理解这一点。

Answer 1

Testmybot 的 Github 存储库中包含多个示例和 Botium .

Botium Wiki包含一些有用的信息和一个 Walkthrough .

运行Botium脚本的基本步骤如下(来自one of the samples)

安装要求

• 安装 Node.js
• 安装 docker
• 安装 docker-compose

还有其他不需要 docker 的示例可用。

初始化Botium目录

打开命令行窗口，创建目录，初始化NPM并下载Botium包。

mkdir botium
cd botium
npm init
npm install --save botium-core

加载 botium 库

首先，加载 botium 库和所需的类。

const BotDriver = require('botium-core').BotDriver
const Capabilities = require('botium-core').Capabilities
const Source = require('botium-core').Source

配置能力

告诉 Botium 正在测试哪种聊天机器人以及如何连接到它。在此示例中，聊天机器人应加载到 docker 容器中，Botium 必须连接到 Microsoft Bot Framework。

const driver = new BotDriver()
    .setCapability(Capabilities.PROJECTNAME, 'core-CreateNewConversation')
    .setCapability(Capabilities.CONTAINERMODE , 'docker')
    .setCapability(Capabilities.BOTFRAMEWORK_API, true)
    .setCapability(Capabilities.BOTFRAMEWORK_APP_ID, 'my microsoft app id')
    .setCapability(Capabilities.BOTFRAMEWORK_CHANNEL_ID, 'facebook')

配置聊天机器人存储库

Botium 直接从源 Github 存储库中检索聊天机器人代码。作为替代方案，可以先克隆存储库并从本地目录加载。在 CI 环境中，从 Git 加载通常更有意义。此外，初始化 Git 存储库的命令(“npm install”)、启动聊天机器人服务的命令(“npm start”)和一些环境变量是运行示例聊天机器人所必需的。

driver.setSource(Source.GITURL, 'https://github.com/Microsoft/BotBuilder-Samples.git')
    .setSource(Source.GITDIR, 'Node/core-CreateNewConversation')
    .setSource(Source.GITPREPARECMD, 'npm install')
    .setCapability(Capabilities.STARTCMD, 'npm start')
    .setEnv('MICROSOFT_APP_ID', 'my microsoft app id')
    .setEnv('MICROSOFT_APP_PASSWORD', 'my microsoft app password')
    .setEnv('NODE_DEBUG', 'botbuilder')
    .setEnv('DEBUG', '*')

进行对话并评估响应

Botium 提供了一个“fluent interface”。

首先，初始化 Botium 驱动程序(创建工作目录、下载存储库、构建 docker 网络...)并启动。

driver.BuildFluent()
    .Start()
    ...

然后，通过向聊天机器人发送输入(“UserSaysText”)或等待聊天机器人的 react (“WaitBotSaysText”)开始对话。对话是为正在使用的聊天机器人量身定制的。如果聊天机器人没有反应或表现出意外 react ，对话将立即结束。

...
.UserSaysText('hi bot')
.WaitBotSaysText((text) => assert('You\'ve been invited to a survey! It will start in a few seconds...', text))
.WaitBotSaysText(null, 10000, (text) => assert('Hello... What\'s your name?', text))
.UserSaysText('John')
.WaitBotSaysText((text) => assert('Hi John, How many years have you been coding?', text))
.UserSaysText('5')
.WaitBotSaysText((text) => assert('What language do you code Node using?', text))
.UserSaysText('CoffeeScript')
.WaitBotSaysText((text) => assert('Got it... John you\'ve been programming for 5 years and use CoffeeScript.', text))
...

最后，Botium 停止并执行一些清理任务。不要忘记调用“Exec”，否则什么都不会执行!

...
.Stop()
.Clean()
.Exec()
...

运行程序并观察输出

现在在命令行窗口中像往常一样运行程序。

[ec2-user@ip-172-30-0-104 botframework]$ node botiumFluent.js
SUCCESS: Got Expected <You've been invited to a survey! It will start in a few seconds...>
SUCCESS: Got Expected <Hello... What's your name?>
SUCCESS: Got Expected <Hi John, How many years have you been coding?>
SUCCESS: Got Expected <What language do you code Node using?>
SUCCESS: Got Expected <Got it... John you've been programming for 5 years and use CoffeeScript.>
READY
[ec2-user@ip-172-30-0-104 botframework]$

测试我的机器人

Botium 与 Selenium/Appium 正在做的事情(统一的 API 和“页面对象模型”)相当。 TestMyBot 是 Botium 之上的一层，用于将 Botium 与 CI/CD 管道和测试运行器(如 Mocha 和 Jasmine)集成。对话不必像上面那样编码，而是在文本文件、excel 文件或 yml 文件中“编写脚本”，例如:

调查

#me
hi

#bot
You've been invited to a survey! It will start in a few seconds...

#bot
Hello... What's your name?

#me
John

#bot
Hi John, How many years have you been coding?

#me
10

#bot
What language do you code Node using? 

#me
C#

#bot
I didn't understand. Please choose an option from the list.

#me
JavaScript

#bot
Got it... John you've been programming for 10 years and use JavaScript.

所有这些文件都必须放在目录 spec/convo 中，并且 Jasmine 或 Mocha(或任何其他测试运行程序)的测试用例仅使用一个简短的脚本(放在 spec/testmybot.spec.js):

const bot = require('testmybot');

bot.helper.jasmine().setupJasmineTestSuite(60000);

了解 Jasmine 或 Mocha 的知识真的很有帮助。正确设置后，唯一要运行的命令是:

npm run test