@leopradel/telegram-test-api
v0.0.2
Published
Emulating telegram API
Downloads
15
Readme
Telegram test Api
Telegram API emulation web server for testing telegram bots which lets you test bot's logic without using telegram API.
Installation
npm install telegram-test-api
Usage
Implement bot with any logic and any library
class TestBot {
constructor(bot) {
bot.onText(/\/ping/, (msg, match)=> {
let chatId = msg.from.id;
let opts = {
reply_to_message_id: msg.message_id,
reply_markup: JSON.stringify({
keyboard: [[{text: 'ok 1'}]],
}),
};
bot.sendMessage(chatId, 'pong', opts);
});
bot.onText(/\/start/, (msg, match)=> {
let chatId = msg.from.id;
let opts = {
reply_to_message_id: msg.message_id,
reply_markup: JSON.stringify({
keyboard: [[{text: 'Masha'}, {text: 'Sasha'}]],
}),
};
bot.sendMessage(chatId, 'What is your name?', opts);
});
bot.onText(/Masha/, (msg, match)=> {
let chatId = msg.from.id;
let opts = {
reply_to_message_id: msg.message_id,
reply_markup: JSON.stringify({
keyboard: [[{text: 'Hello!'}]],
}),
};
bot.sendMessage(chatId, 'Hello, Masha!', opts);
});
bot.onText(/Sasha/, (msg, match)=> {
let chatId = msg.from.id;
let opts = {
reply_to_message_id: msg.message_id,
reply_markup: JSON.stringify({
keyboard: [[{text: 'Hello!'}]],
}),
};
bot.sendMessage(chatId, 'Hello, Sasha!', opts);
});
}
}
Start server
You can use npm start
to start server using settings from config/config.json
or include it in your node.js module and use like this:
const TelegramServer = require('telegram-test-api');
let serverConfig = {port: 9000};
let server = new TelegramServer(serverConfig);
server.start().then(()=>yourTests());
Options
You can pass options like this:
{
"port": 9000,
"host": "localhost",
"storage": "RAM",
"storeTimeout": 60
}
storeTimeout
- how many seconds you want to store user and bot messages which were not fetched by bot or client.storage
- where you want to store messages. Right now, onlyRAM
option is implemented.
Make requests
Requests from bot
You can use any bot API which allows custom Telegram URL like this:
const
TelegramBot = require('node-telegram-bot-api');
let botOptions = {polling: true, baseApiUrl: server.ApiURL};
telegramBot = new TelegramBot(token, botOptions);
Requests from client
Client emulation is very easy. You can use built in client class:
let client = server.getClient(token);
let message = client.makeMessage('/start');
client.sendMessage(message);
client.getUpdates();
Or you can take a look at src/modules/telegramClient
and make client in any
language you want.
Stop server
server.stop().then(()=>doMore());
Full sample
Your test code can look like this:
const TelegramServer = require('telegram-test-api');
const TelegramBot = require('node-telegram-bot-api');
describe('Telegram bot test', () => {
let serverConfig = {port: 9001};
const token = 'sampleToken';
let server;
let client;
beforeEach(() => {
server = new TelegramServer(serverConfig);
return server.start().then(() => {
client = server.getClient(token);
});
});
afterEach(function () {
this.slow(2000);
this.timeout(10000);
return server.stop();
});
it('should greet Masha and Sasha', function testFull() {
this.slow(400);
this.timeout(800);
let message = client.makeMessage('/start');
let telegramBot,
testBot;
return client.sendMessage(message)
.then(()=> {
let botOptions = {polling: true, baseApiUrl: server.ApiURL};
telegramBot = new TelegramBot(token, botOptions);
testBot = new TestBot(telegramBot);
return client.getUpdates();
})
.then((updates)=> {
console.log(`Client received messages: ${JSON.stringify(updates.result)}`);
if (updates.result.length !== 1) {
throw new Error('updates queue should contain one message!');
}
let keyboard = JSON.parse(updates.result[0].message.reply_markup).keyboard;
message = client.makeMessage(keyboard[0][0].text);
client.sendMessage(message);
return client.getUpdates();
})
.then((updates)=> {
console.log(`Client received messages: ${JSON.stringify(updates.result)}`);
if (updates.result.length !== 1) {
throw new Error('updates queue should contain one message!');
}
if (updates.result[0].message.text !== 'Hello, Masha!') {
throw new Error('Wrong greeting message!');
}
return true;
})
});
});
Debugging
This project uses debug
module for verbose logging, to enable it, please launch
your tests with env variable DEBUG=TelegramServer:*
, like DEBUG=TelegramServer:* ./node_modules/mocha/bin/mocha --use_strict --exit
.
Changelog
- 1.0.2 Move logging to debug module, clear storage when stopping server.
- 1.0.1 Fix slow server stop
- 1.0.0 Such much refactoring
- 0.0.4 Public release