codacy-coverage/test/reporter.js

Code Coverage reporter for Codacy.com

(function (Joi, request, reporter, helper) {
    'use strict';

    var expect = helper.chai.expect;

    describe('Codacy Reporter', function () {
        var bodyValidator,
            sampleCoverageData;

        beforeEach(function () {
            bodyValidator = Joi.object({
                total: Joi.number().valid(50),
                fileReports: Joi.array().items(Joi.object({
                    filename: Joi.string().valid('filename.js'),
                    total: Joi.number().valid(10),
                    coverage: Joi.object({
                        1: Joi.number().valid(1),
                        2: Joi.number().valid(3)
                    })
                }))
            });

            sampleCoverageData = {
                total: 50,
                fileReports: [
                    {
                        filename: 'filename.js',
                        total: 10,
                        coverage: {
                            1: 1,
                            2: 3
                        }
                    }
                ]
            };
        });

        it('should be able to use the mock end-point', function () {
            return helper.setupMockEndpoint('1234', '4321', bodyValidator)
                .then(function () {
                    return expect(request({
                        url: 'https://api.codacy.com/2.0/coverage/4321/javascript',
                        method: 'POST',
                        json: sampleCoverageData,
                        resolveWithFullResponse: true
                    }).promise()).to.eventually.satisfy(function (res) {
                        expect(res.statusCode).to.equal(200);
                        return true;
                    });
                });
        });
        it('should be able to use the account api mock end-point', function() {
            return helper.setupMockAccountApiEndpoint('1234', '4321', 'username', 'project-name', bodyValidator)
                .then(function() {
                    return expect(request({
                        url: 'https://api.codacy.com/2.0/username/project-name/commit/4321/coverage/javascript',
                        method: 'POST',
                        json: sampleCoverageData,
                        resolveWithFullResponse: true
                    }).promise()).to.eventually.satisfy(function (res) {
                        expect(res.statusCode).to.equal(200);
                        return true;
                    });
                });
        });
        it('shouldn\'t be able to create a reporter with invalid options', function () {
            return expect(function () {
                reporter({endpoint: 1});
            }).to.throw(Error, 'child "endpoint" fails because ["endpoint" must be a string]');
        });
        it('should be able to use the reporter to send coverage data', function () {
            return helper.setupMockEndpoint('1234', '4321', bodyValidator)
                .then(function () {
                    return expect(reporter({})
                        .sendCoverage('1234', '4321', 'javascript', sampleCoverageData))
                        .to.eventually.be.fulfilled();
                });
        });
        it('should receive error when non-200 status code', function () {
            return helper.setupMockEndpoint('1234', '4321', bodyValidator, 204)
                .then(function () {
                    return expect(reporter({})
                        .sendCoverage('1234', '4321', 'javascript', sampleCoverageData))
                        .to.eventually.be.rejectedWith(Error, 'Expected Status Code of 200, but got [204]');
                });
        });
        it('should receive error when 400 level status code', function () {
            return helper.setupMockEndpoint('1234', '4321', bodyValidator, 418)
                .then(function () {
                    return expect(reporter({})
                        .sendCoverage('1234', '4321', 'javascript', sampleCoverageData))
                        .to.eventually.be.rejectedWith(Error, 'Expected Successful Status Code, but got [418]');
                });
        });
        it('should be able to report data with an api token', function() {
            return helper.setupMockAccountApiEndpoint('1234', '4321', 'username', 'project-name', bodyValidator)
                .then(function() {
                    return expect(reporter({accountToken: '1234'})
                        .sendCoverage(null, '4321', 'javascript', sampleCoverageData, '1234', 'username', 'project-name'))
                        .to.eventually.be.fulfilled();
                });
        });
        it('should not report data without a project name', function() {
            return helper.setupMockAccountApiEndpoint('1234', '4321', 'username', 'project-name', bodyValidator)
                .then(function() {
                    return expect(reporter({accountToken: '1234'})
                        .sendCoverage(null, '4321', 'javascript', sampleCoverageData, '1234', null, 'project-name'))
                        .to.eventually.be.rejected();
                });
        });
    });

}(require('joi'), require('request-promise'), require('../lib/reporter'), require('./helper')));