Add automated integration test for client list API.

- Connects via websocket
- Verifies user list exists
- If GeoIP data is available it will test that the geo property of a
  client is populated.
This commit is contained in:
Gabe Kangas 2021-08-12 16:49:40 -07:00 committed by Jannik
parent 6f57f570d2
commit bf17293e8b

View file

@ -1,66 +1,118 @@
const { test } = require('@jest/globals'); const { test } = require('@jest/globals');
var request = require('supertest'); var request = require('supertest');
request = request('http://127.0.0.1:8080'); request = request('http://127.0.0.1:8080');
const WebSocket = require('ws');
const fs = require('fs');
const registerChat = require('./lib/chat').registerChat; const registerChat = require('./lib/chat').registerChat;
const sendChatMessage = require('./lib/chat').sendChatMessage; const sendChatMessage = require('./lib/chat').sendChatMessage;
const testVisibilityMessage = { const testVisibilityMessage = {
body: "message " + Math.floor(Math.random() * 100), body: 'message ' + Math.floor(Math.random() * 100),
type: 'CHAT', type: 'CHAT',
}; };
var userId var userId;
var accessToken var accessToken;
test('can register a user', async (done) => { test('can register a user', async (done) => {
const registration = await registerChat(); const registration = await registerChat();
userId = registration.id; userId = registration.id;
accessToken = registration.accessToken; accessToken = registration.accessToken;
done(); done();
}); });
test('can send a chat message', async (done) => { test('can send a chat message', async (done) => {
sendChatMessage(testVisibilityMessage, accessToken, done); sendChatMessage(testVisibilityMessage, accessToken, done);
}); });
test('can disable a user', async (done) => { test('can disable a user', async (done) => {
// To allow for visually being able to see the test hiding the // To allow for visually being able to see the test hiding the
// message add a short delay. // message add a short delay.
await new Promise((r) => setTimeout(r, 1500)); await new Promise((r) => setTimeout(r, 1500));
await request.post('/api/admin/chat/users/setenabled').send({ "userId": userId, "enabled": false }) await request
.auth('admin', 'abc123').expect(200); .post('/api/admin/chat/users/setenabled')
.send({ userId: userId, enabled: false })
.auth('admin', 'abc123')
.expect(200);
done(); done();
}); });
test('verify user is disabled', async (done) => { test('verify user is disabled', async (done) => {
const response = await request.get('/api/admin/chat/users/disabled').auth('admin', 'abc123').expect(200); const response = await request
const tokenCheck = response.body.filter((user) => user.id === userId) .get('/api/admin/chat/users/disabled')
expect(tokenCheck).toHaveLength(1); .auth('admin', 'abc123')
done(); .expect(200);
const tokenCheck = response.body.filter((user) => user.id === userId);
expect(tokenCheck).toHaveLength(1);
done();
}); });
test('verify messages from user are hidden', async (done) => { test('verify messages from user are hidden', async (done) => {
const response = await request.get('/api/admin/chat/messages') const response = await request
.get('/api/admin/chat/messages')
.auth('admin', 'abc123') .auth('admin', 'abc123')
.expect(200); .expect(200);
const message = response.body.filter(obj => { const message = response.body.filter((obj) => {
return obj.user.id === userId; return obj.user.id === userId;
}); });
expect(message[0].hiddenAt).toBeTruthy(); expect(message[0].hiddenAt).toBeTruthy();
done(); done();
}); });
test('can re-enable a user', async (done) => { test('can re-enable a user', async (done) => {
await request.post('/api/admin/chat/users/setenabled').send({ "userId": userId, "enabled": true }) await request
.auth('admin', 'abc123').expect(200); .post('/api/admin/chat/users/setenabled')
done(); .send({ userId: userId, enabled: true })
.auth('admin', 'abc123')
.expect(200);
done();
}); });
test('verify user is enabled', async (done) => { test('verify user is enabled', async (done) => {
const response = await request.get('/api/admin/chat/users/disabled').auth('admin', 'abc123').expect(200); const response = await request
const tokenCheck = response.body.filter((user) => user.id === userId) .get('/api/admin/chat/users/disabled')
expect(tokenCheck).toHaveLength(0); .auth('admin', 'abc123')
.expect(200);
const tokenCheck = response.body.filter((user) => user.id === userId);
expect(tokenCheck).toHaveLength(0);
done();
});
test('verify user list is populated', async (done) => {
const ws = new WebSocket(
`ws://localhost:8080/ws?accessToken=${accessToken}`,
{
origin: 'http://localhost:8080',
}
);
ws.on('open', async function open() {
const response = await request
.get('/api/admin/chat/clients')
.auth('admin', 'abc123')
.expect(200);
expect(response.body.length).toBeGreaterThan(0);
// Optionally, if GeoIP is configured, check the location property.
if (fs.existsSync('../../data/GeoLite2-City.mmdb')) {
expect(response.body[0].geo.regionName).toBe('Localhost');
} else {
console.warn('GeoIP Data is not supplied. Skipping test. See https://owncast.online/docs/viewers/');
}
ws.close();
});
ws.on('error', function incoming(data) {
console.error(data);
ws.close();
});
ws.on('close', function incoming(data) {
done();
});
done();
}); });