@smittey/newman-reporter-slackreporter/test/index.test.js

newman report to slack

const slackNewmanReporter = require('../index');
const { slackUtils } = require('../slackUtils');
const events = require('events');

jest.mock('../slackUtils');

describe('SlackNewmanReporter', () => {
    let mockEmitter;
    const mockStats = {
        requests: { total: 4, pending: 0, failed: 1 },
        assertions: { total: 2, failed: 1 }
    }

    const summary = {run: { stats: mockStats, failures: [{name: 'failed test 1'}], timings: {}}}

    beforeEach(() => {
        mockEmitter = new events.EventEmitter();
    });

    test('should show error if missing reporterOption values ', () => {
        const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
        
        slackNewmanReporter(mockEmitter, {}, {});
        
        expect(consoleErrorSpy).toBeCalledTimes(1);
        expect(slackUtils.send).not.toHaveBeenCalled();
        expect(slackUtils.slackMessage).not.toHaveBeenCalled();
    });

    test('should show error if missing channel override values ', () => {
        const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
        
        slackNewmanReporter(mockEmitter, {webhookurl: 'https://slack.com/api/chat.postMessage'}, {});
        
        expect(consoleErrorSpy).toBeCalledTimes(2);
        expect(slackUtils.send).not.toHaveBeenCalled();
        expect(slackUtils.slackMessage).not.toHaveBeenCalled();
    });

    
    test('should show error if emit error in emitter', () => {
        const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
        slackNewmanReporter(mockEmitter, {webhookurl: 'test'}, {});
        mockEmitter.emit('done', 'error');
        
        expect(consoleErrorSpy).toBeCalledTimes(1);
        expect(slackUtils.send).not.toHaveBeenCalled();
        expect(slackUtils.slackMessage).not.toHaveBeenCalled();
    });

    test('should start slack reporter given no errors for webhook', () => {
        const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });

        slackNewmanReporter(mockEmitter, {webhookurl: 'test'}, {});
        mockEmitter.emit('done', '', summary);

        expect(slackUtils.send).toHaveBeenCalled();
        expect(slackUtils.slackMessage).toHaveBeenCalled();
        expect(consoleErrorSpy).not.toHaveBeenCalled();
    });

    test('should start slack reporter given no errors for channel override', () => {
        const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });

        slackNewmanReporter(mockEmitter, {webhookurl: 'https://slack.com/api/chat.postMessage', token: 'testtoken', channel:'testchannel'}, {});
        mockEmitter.emit('done', '', summary);

        expect(slackUtils.send).toHaveBeenCalled();
        expect(slackUtils.slackMessage).toHaveBeenCalled();
        expect(consoleErrorSpy).not.toHaveBeenCalled();
    });

    test('should not start slack reporter if no failures and failureOnly flag set to true', () => {
        const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });

        const summaryNoFailures = {
            ...summary,
            run: {
                ...summary.run,
                failures: [],
            },
        }

        slackNewmanReporter(mockEmitter, {webhookurl: 'https://slack.com/api/chat.postMessage', token: 'testtoken', channel: 'testchannel', failureOnly: true}, {});
        mockEmitter.emit('done', '', summaryNoFailures);

        expect(slackUtils.send).not.toHaveBeenCalled();
        expect(slackUtils.slackMessage).not.toHaveBeenCalled();
        expect(consoleErrorSpy).not.toHaveBeenCalled();
    });

    afterEach(() => {
        jest.clearAllMocks();
    });
    
});