xmpp-bot/test/xmpp.js

405 lines
12 KiB
JavaScript
Raw Permalink Normal View History

'use strict'
2019-10-20 03:01:59 +02:00
process.env.NODE_ENV = 'production'
const sinon = require('sinon')
2019-11-24 16:41:51 +01:00
require('chai').should()
2019-10-20 03:01:59 +02:00
const EventEmitter = require('events').EventEmitter
const mock = require('mock-require')
const xml = require('@xmpp/xml')
const jid = require('@xmpp/jid')
2019-10-20 03:01:59 +02:00
describe('XMPP component', () => {
2019-11-24 16:41:51 +01:00
let logger, config, outgoingStub, outgoingStubRejected, xmppSendStub, xmppCloseStub, simpleXmppEvents, xmpp
2019-11-24 16:41:51 +01:00
before('Setup logger and config', (done) => {
// create default logger
logger = require('./../lib/logger')()
// get configuration
config = require('./../lib/config')(logger, './test/config.json')
// update logger with configuration
logger.updateConfig(config.logger)
2019-11-24 16:41:51 +01:00
// mock logger trace
sinon.stub(logger, 'trace')
done()
})
after('Remove mocks', (done) => {
mock.stopAll()
logger.trace.restore()
done()
})
beforeEach('Setup XMPP client with stub', function () {
simpleXmppEvents = new EventEmitter()
// mock outgoing module
outgoingStub = sinon.stub().resolves()
mock('./../lib/outgoing', outgoingStub)
// mock @xmpp/client module
xmppSendStub = sinon.stub().resolves()
2019-11-21 23:33:28 +01:00
xmppCloseStub = sinon.stub().resolves()
mock('@xmpp/client', {
client: () => {
this.start = async () => {}
2019-11-21 23:33:28 +01:00
this.stop = xmppCloseStub
this.send = xmppSendStub
this.on = (eventName, callback) => {
simpleXmppEvents.on(eventName, callback)
}
return this
},
xml: require('@xmpp/xml'),
jid: require('@xmpp/jid')
})
2019-11-24 16:41:51 +01:00
// reset stubs history
2019-10-20 03:01:59 +02:00
outgoingStub.resetHistory()
2019-11-21 23:33:28 +01:00
xmppSendStub.resetHistory()
xmppCloseStub.resetHistory()
2019-11-24 16:41:51 +01:00
// call module and emit online event
xmpp = require('./../lib/xmpp')(logger, config)
simpleXmppEvents.emit('online', jid('bot@domain-xmpp.ltd/resource'))
2019-10-20 03:01:59 +02:00
})
describe('Connect to XMPP server', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('status', 'connecting')
})
2019-10-20 03:01:59 +02:00
it('Should connect to XMPP server and join rooms when application start', (done) => {
sinon.assert.called(xmppSendStub)
// 1 "send" call for presence and n "send" calls for joining rooms
const roomsLength = config.xmpp.rooms.length
sinon.assert.callCount(xmppSendStub, roomsLength + 1)
for (let index = 1; index < roomsLength + 1; index++) {
const args = xmppSendStub.args[index]
args.should.have.length(1)
const occupantJid = config.xmpp.rooms[index - 1].id + '/' + 'bot'
const stanza = xml(
'presence', {
to: occupantJid
},
xml(
'x', {
xmlns: 'http://jabber.org/protocol/muc'
}
)
)
args[0].should.deep.equal(stanza)
2019-10-20 03:01:59 +02:00
}
done()
})
2019-11-21 23:33:28 +01:00
it('Should trace connection status', (done) => {
sinon.assert.calledWith(logger.trace, 'Status changed to connecting')
done()
})
})
2019-11-24 19:33:54 +01:00
describe('Connect to XMPP server but fail to start', () => {
let xmppStartStub
beforeEach(async () => {
xmppStartStub = sinon.stub().rejects(new Error('Stubed error message'))
mock('@xmpp/client', {
client: () => {
this.start = xmppStartStub
this.stop = xmppCloseStub
this.send = xmppSendStub
this.on = (eventName, callback) => {
simpleXmppEvents.on(eventName, callback)
}
return this
},
xml: require('@xmpp/xml'),
jid: require('@xmpp/jid')
})
xmpp = require('./../lib/xmpp')(logger, config)
})
it('Should log error', (done) => {
require('fs').readFile(config.logger.file.path + config.logger.file.filename, 'utf8', (err, data) => {
if (err) {
throw err
}
data.should.match(new RegExp('XMPP client encountered following error at connection: Stubed error message' + '\n$'))
done()
})
})
})
2019-11-21 23:33:28 +01:00
describe('Bot receive a presence stanza from someone', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('stanza', xml(
2019-11-21 23:33:28 +01:00
'presence', {
from: 'someone@domain-xmpp.ltd',
to: 'bot@domain-xmpp.ltd'
}
))
2019-11-24 16:41:51 +01:00
})
it('Should not trigger outgoing webhook', (done) => {
2019-11-21 23:33:28 +01:00
sinon.assert.notCalled(outgoingStub)
done()
})
})
describe('Bot receive an empty message from someone', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('stanza', xml(
2019-11-21 23:33:28 +01:00
'message', {
from: 'someone@domain-xmpp.ltd',
to: 'bot@domain-xmpp.ltd',
type: 'chat'
}
))
2019-11-24 16:41:51 +01:00
})
it('Should not trigger outgoing webhook', (done) => {
2019-11-21 23:33:28 +01:00
sinon.assert.notCalled(outgoingStub)
done()
})
2019-10-20 03:01:59 +02:00
})
describe('Bot receive a message from someone', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
xmppSendStub.resetHistory()
await simpleXmppEvents.emit('stanza', xml(
'message', {
from: 'someone@domain-xmpp.ltd',
to: 'bot@domain-xmpp.ltd',
2019-11-22 00:20:04 +01:00
type: 'chat',
id: 'fcdd3d8c'
},
xml(
'body', {
},
2019-11-22 00:20:04 +01:00
'This is the message text'),
xml(
'request', {
xmlns: 'urn:xmpp:receipts'
})
))
2019-11-24 16:41:51 +01:00
})
it('Should trigger outgoing webhook with valid arguments and send a message delivery receipt', (done) => {
2019-10-20 03:01:59 +02:00
sinon.assert.calledOnce(outgoingStub)
const args = outgoingStub.args[0]
args.should.have.length(8)
args[3].should.equal('someone')
args[4].should.equal('someone@domain-xmpp.ltd')
2019-10-20 03:01:59 +02:00
args[5].should.equal('This is the message text')
args[6].should.equal('chat')
2019-10-20 03:01:59 +02:00
args[7].should.equal('w1')
2019-11-22 00:20:04 +01:00
sinon.assert.calledOnce(xmppSendStub)
const receiptStanza = xml(
'message', {
to: 'someone@domain-xmpp.ltd'
},
xml(
'received', {
xmlns: 'urn:xmpp:receipts',
id: 'fcdd3d8c'
}
)
)
xmppSendStub.args[0][0].should.deep.equal(receiptStanza)
2019-10-20 03:01:59 +02:00
done()
})
})
2019-11-24 16:41:51 +01:00
describe('Bot receive a message from someone but webhook call failed', () => {
beforeEach(async () => {
simpleXmppEvents = new EventEmitter()
outgoingStubRejected = sinon.stub().rejects()
mock('./../lib/outgoing', outgoingStubRejected)
require('./../lib/xmpp')(logger, config)
simpleXmppEvents.emit('online', jid('bot@domain-xmpp.ltd/resource'))
xmppSendStub.resetHistory()
await simpleXmppEvents.emit('stanza', xml(
'message', {
from: 'someone@domain-xmpp.ltd',
to: 'bot@domain-xmpp.ltd',
type: 'chat',
id: 'fcdd3d8c'
},
xml(
'body', {
},
'Is it working?')
))
})
it('Should send a XMPP reply if webhook failed', () => {
sinon.assert.calledOnce(outgoingStubRejected)
const args = outgoingStubRejected.args[0]
args.should.have.length(8)
args[3].should.equal('someone')
args[4].should.equal('someone@domain-xmpp.ltd')
args[5].should.equal('Is it working?')
args[6].should.equal('chat')
args[7].should.equal('w1')
sinon.assert.calledOnce(xmppSendStub)
const receiptStanza = xml(
'message', {
to: 'someone@domain-xmpp.ltd',
type: 'chat'
},
xml(
'body', {
},
'Oops, something went wrong :('
)
)
xmppSendStub.args[0][0].should.deep.equal(receiptStanza)
})
})
2019-10-20 03:01:59 +02:00
describe('Bot receive a message from himself in a room', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('stanza', xml(
'message', {
from: 'roomname@conference.domain-xmpp.ltd/bot',
to: 'roomname@conference.domain-xmpp.ltd',
type: 'groupchat'
},
xml(
'body', {
},
'This is the message text')
))
2019-11-24 16:41:51 +01:00
})
it('Should not trigger outgoing webhook', (done) => {
2019-10-20 03:01:59 +02:00
sinon.assert.notCalled(outgoingStub)
done()
})
})
describe('Bot receive a message in an unknown room', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('stanza', xml(
'message', {
from: 'unknownroomname@conference.domain-xmpp.ltd/someone',
to: 'unknownroomname@conference.domain-xmpp.ltd',
type: 'groupchat'
},
xml(
'body', {
},
'This is the message text')
))
2019-11-24 16:41:51 +01:00
})
it('Should not trigger outgoing webhook', (done) => {
2019-10-20 03:01:59 +02:00
sinon.assert.notCalled(outgoingStub)
done()
})
})
describe('Bot receive an old message in a room', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('stanza', xml(
'message', {
from: 'roomname@conference.domain-xmpp.ltd/someone',
to: 'roomname@conference.domain-xmpp.ltd',
type: 'groupchat'
},
xml(
'body', {
},
'This is the message text'),
xml(
'delay', {
xmlns: 'urn:xmpp:delay',
from: 'roomname@conference.domain-xmpp.ltd'
},
'This is the message text')
))
2019-11-24 16:41:51 +01:00
})
it('Should not trigger outgoing webhook', (done) => {
2019-10-20 03:01:59 +02:00
sinon.assert.notCalled(outgoingStub)
done()
})
})
describe('Bot receive a message in a room', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await simpleXmppEvents.emit('stanza', xml(
'message', {
from: 'roomname@conference.domain-xmpp.ltd/someone',
to: 'roomname@conference.domain-xmpp.ltd',
type: 'groupchat'
},
xml(
'body', {
},
'This is the message text')
))
2019-11-24 16:41:51 +01:00
})
it('Should trigger outgoing webhook with valid arguments', (done) => {
2019-10-20 03:01:59 +02:00
sinon.assert.calledOnce(outgoingStub)
const args = outgoingStub.args[0]
args.should.have.length(8)
args[3].should.equal('someone')
args[4].should.equal('roomname@conference.domain-xmpp.ltd')
args[5].should.equal('This is the message text')
args[6].should.equal('groupchat')
2019-10-20 03:01:59 +02:00
args[7].should.equal('w1')
done()
})
})
2019-11-21 23:33:28 +01:00
describe('Send a message', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
xmppSendStub.resetHistory()
await xmpp.send('someone@domain-xmpp.ltd', 'This is the message text sent by bot', 'chat')
})
2019-11-21 23:33:28 +01:00
it('Should call xmpp/client.send() with valid stanza', (done) => {
sinon.assert.calledOnce(xmppSendStub)
const stanza = xml(
2019-11-21 23:33:28 +01:00
'message', {
to: 'someone@domain-xmpp.ltd',
type: 'chat'
},
xml(
'body', {
},
'This is the message text sent by bot')
)
const args = xmppSendStub.args[0]
args.should.have.length(1)
args[0].should.deep.equal(stanza)
done()
})
})
describe('Close connection', () => {
2019-11-24 16:41:51 +01:00
beforeEach(async () => {
await xmpp.close()
})
2019-11-21 23:33:28 +01:00
it('Should call xmpp/client.stop()', (done) => {
sinon.assert.calledOnce(xmppCloseStub)
done()
})
})
2019-10-20 03:01:59 +02:00
describe('XMPP server send an error', () => {
2019-11-24 16:41:51 +01:00
let errorText
beforeEach(async () => {
sinon.stub(process, 'exit')
2019-11-24 16:41:51 +01:00
errorText = 'This the error text'
await simpleXmppEvents.emit('error', new Error(errorText))
})
2019-11-24 16:41:51 +01:00
afterEach(() => {
process.exit.restore()
})
it('Should log error and exit with 99 code', (done) => {
2019-10-20 03:01:59 +02:00
require('fs').readFile(config.logger.file.path + config.logger.file.filename, 'utf8', (err, data) => {
if (err) {
throw err
}
2019-11-24 16:41:51 +01:00
data.should.match(new RegExp('XMPP client encountered following error: ' + errorText + '\n$'))
sinon.assert.calledWith(process.exit, 99)
2019-10-20 03:01:59 +02:00
done()
})
})
})
})