Skip to content

Commit

Permalink
EPMRPP-94763 || Increase test coverage
Browse files Browse the repository at this point in the history
  • Loading branch information
@AmsterGet
AmsterGet committed Aug 28, 2024
1 parent 3becca2 commit 3d3f255
Show file tree
Hide file tree
Showing 7 changed files with 131 additions and 33 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/CI-pipeline.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ jobs:
run: npm install
- name: Run lint
run: npm run lint
# - name: Run tests and check coverage
# run: npm run test:coverage
- name: Run tests and check coverage
run: npm run test:coverage
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ jobs:
run: npm install
- name: Run lint
run: npm run lint
# - name: Run tests and check coverage
# run: npm run test:coverage
- name: Run tests and check coverage
run: npm run test:coverage

publish-to-npm-and-gpr:
needs: build
Expand Down
1 change: 1 addition & 0 deletions jest.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module.exports = {
'!lib/ipcServer.js',
'!lib/testStatuses.js',
'!lib/worker.js',
'!lib/utils/attachments.js',
],
coverageThreshold: {
global: {
Expand Down
1 change: 1 addition & 0 deletions lib/reporter.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ class Reporter {
const suiteFinishObj = this.prepareSuiteToFinish(suite);

if (isVideoRecordingEnabled && uploadVideo && isRootSuite) {
console.log('HERE');
const suiteInfo = this.suitesStackTempInfo[0];
this.finishSuiteWithVideo(suiteInfo, suiteFinishObj);
} else {
Expand Down
124 changes: 97 additions & 27 deletions test/reporter.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ const mockFS = require('mock-fs');
const path = require('path');
const { getDefaultConfig, RPClient, MockedDate, RealDate, currentDate } = require('./mock/mocks');
const Reporter = require('./../lib/reporter');
const { entityType } = require('../lib/constants');

const sep = path.sep;

Expand Down Expand Up @@ -45,6 +46,7 @@ describe('reporter script', () => {
beforeEach(() => {
global.Date = jest.fn(MockedDate);
Object.assign(Date, RealDate);
reporter.config = getDefaultConfig();
});

afterEach(() => {
Expand Down Expand Up @@ -106,21 +108,37 @@ describe('reporter script', () => {
});
});

describe('saveFullConfig', () => {
it('should set the full Cypress config to class object property', () => {
const fullCypressConfig = { e2e: { baseUrl: 'http://localhost:3000' }, reporterOptions: {} };
reporter.saveFullConfig(fullCypressConfig);

expect(reporter.fullCypressConfig).toEqual(fullCypressConfig);
});
});

describe('suiteStart', () => {
it('root suite: startTestItem should be called with undefined parentId', () => {
const spyStartTestItem = jest.spyOn(reporter.client, 'startTestItem');
reporter.tempLaunchId = 'tempLaunchId';
const suiteStartObject = {
const suite = {
id: 'suite1',
title: 'suite name',
startTime: currentDate,
description: 'suite description',
codeRef: 'test/example.spec.js/suite name',
testFileName: 'example.spec.js',
};
const suiteStartObject = {
type: entityType.SUITE,
name: 'suite name',
type: 'suite',
startTime: currentDate,
description: 'suite description',
codeRef: 'test/example.spec.js/suite name',
attributes: [],
parentId: undefined,
};

reporter.suiteStart(suiteStartObject);
reporter.suiteStart(suite);

expect(spyStartTestItem).toHaveBeenCalledTimes(1);
expect(spyStartTestItem).toHaveBeenCalledWith(suiteStartObject, 'tempLaunchId', undefined);
Expand All @@ -130,17 +148,25 @@ describe('reporter script', () => {
const spyStartTestItem = jest.spyOn(reporter.client, 'startTestItem');
reporter.tempLaunchId = 'tempLaunchId';
reporter.testItemIds.set('parentSuiteId', 'tempParentSuiteId');
const suiteStartObject = {
const suite = {
id: 'suite1',
title: 'suite name',
startTime: currentDate,
description: 'suite description',
codeRef: 'test/example.spec.js/suite name',
testFileName: 'example.spec.js',
parentId: 'parentSuiteId',
};
const suiteStartObject = {
type: entityType.SUITE,
name: 'suite name',
type: 'suite',
startTime: currentDate,
description: 'suite description',
codeRef: 'test/example.spec.js/suite name',
attributes: [],
parentId: 'parentSuiteId',
};

reporter.suiteStart(suiteStartObject);
reporter.suiteStart(suite);

expect(spyStartTestItem).toHaveBeenCalledTimes(1);
expect(spyStartTestItem).toHaveBeenCalledWith(
Expand All @@ -155,59 +181,92 @@ describe('reporter script', () => {
it('finishTestItem should be called with parameters', function () {
const spyFinishTestItem = jest.spyOn(reporter.client, 'finishTestItem');
reporter.testItemIds.set('suiteId', 'tempSuiteId');
const suiteEndObject = {
const suite = {
id: 'suiteId',
title: 'suite title',
endTime: currentDate,
};
const suiteEndObject = {
endTime: currentDate,
};

reporter.suiteEnd(suiteEndObject);
reporter.suiteEnd(suite);

expect(spyFinishTestItem).toHaveBeenCalledTimes(1);
expect(spyFinishTestItem).toHaveBeenCalledWith('tempSuiteId', { endTime: currentDate });
expect(spyFinishTestItem).toHaveBeenCalledWith('tempSuiteId', suiteEndObject);
});
it('end suite with testCaseId: finishTestItem should be called with testCaseId', function () {
const spyFinishTestItem = jest.spyOn(reporter.client, 'finishTestItem');
reporter.testItemIds.set('suiteId', 'tempSuiteId');
reporter.suiteTestCaseIds.set('suite title', 'testCaseId');
const suiteEndObject = {
const suite = {
id: 'suiteId',
title: 'suite title',
endTime: currentDate,
};
const suiteEndObject = {
endTime: currentDate,
testCaseId: 'testCaseId',
};

reporter.suiteEnd(suiteEndObject);
reporter.suiteEnd(suite);

expect(spyFinishTestItem).toHaveBeenCalledTimes(1);
expect(spyFinishTestItem).toHaveBeenCalledWith('tempSuiteId', {
endTime: currentDate,
testCaseId: 'testCaseId',
});
expect(spyFinishTestItem).toHaveBeenCalledWith('tempSuiteId', suiteEndObject);

reporter.suiteTestCaseIds.clear();
});
it('end suite with custom status: finishTestItem should be called with custom status', function () {
const spyFinishTestItem = jest.spyOn(reporter.client, 'finishTestItem');
reporter.testItemIds.set('suiteId', 'tempSuiteId');
reporter.setTestItemStatus({ status: 'failed', suiteTitle: 'suite title' });
const suiteEndObject = {
const suite = {
id: 'suiteId',
title: 'suite title',
endTime: currentDate,
};
const suiteEndObject = {
endTime: currentDate,
status: 'failed',
};

reporter.suiteEnd(suiteEndObject);
reporter.suiteEnd(suite);

expect(spyFinishTestItem).toHaveBeenCalledTimes(1);
expect(spyFinishTestItem).toHaveBeenCalledWith('tempSuiteId', {
endTime: currentDate,
status: 'failed',
});
expect(spyFinishTestItem).toHaveBeenCalledWith('tempSuiteId', suiteEndObject);

reporter.suiteStatuses.clear();
});
it('end suite with video: finishSuiteWithVideo should be called if video is enabled and it is a root suite', function () {
const spyFinishSuiteWithVideo = jest.spyOn(reporter, 'finishSuiteWithVideo');
reporter.fullCypressConfig = { video: true };
reporter.config = { ...reporter.config, uploadVideo: true };
reporter.testItemIds.set('suiteId', 'tempSuiteId');
const suiteInfo = {
id: 'suiteId',
testFileName: 'example.spec.js',
title: 'suite title',
tempId: 'tempSuiteId',
};
reporter.suitesStackTempInfo = [suiteInfo];
const suite = {
id: 'suiteId',
title: 'suite title',
endTime: currentDate,
};
const suiteEndObject = {
endTime: currentDate,
status: undefined,
};

reporter.suiteEnd(suite);

expect(spyFinishSuiteWithVideo).toHaveBeenCalledTimes(1);
expect(spyFinishSuiteWithVideo).toHaveBeenCalledWith(suiteInfo, suiteEndObject);
});
});

describe('sendVideoOnFinishSuite', function () {
describe.skip('sendVideoOnFinishSuite', function () {
let customSuiteNameAttachment;

beforeAll(() => {
Expand All @@ -222,7 +281,6 @@ describe('reporter script', () => {

afterAll(() => {
mockFS.restore();
reporter.config.reporterOptions.videosFolder = undefined;
});

beforeEach(() => {
Expand All @@ -236,7 +294,6 @@ describe('reporter script', () => {
{ id: 'suite', title: 'any suite' },
];
reporter.testItemIds.set('root', 'suiteTempId');
reporter.config.reporterOptions.videosFolder = 'example/videos';
});

afterEach(() => {
Expand Down Expand Up @@ -338,7 +395,6 @@ describe('reporter script', () => {
status: 'failed',
};

reporter.config.reporterOptions.videosFolder = 'example/screenshots';
reporter.suiteEnd(suiteEndObject);

expect(spySendVideoOnFinishSuite).not.toHaveBeenCalled();
Expand Down Expand Up @@ -614,6 +670,20 @@ describe('reporter script', () => {
expect(spyFinishTestItem).toHaveBeenCalledTimes(1);
expect(spyFinishTestItem).toHaveBeenCalledWith('tempTestItemId', expectedTestFinishObj);
});

it('end test: should not finish test in case no testId present in testItemIds', function () {
const spyFinishTestItem = jest.spyOn(reporter.client, 'finishTestItem');
const testInfoObject = {
id: 'testId',
title: 'test name',
status: 'failed',
parentId: 'suiteId',
err: 'error message',
};
reporter.testEnd(testInfoObject);

expect(spyFinishTestItem).toHaveBeenCalledTimes(0);
});
});

describe('testPending', function () {
Expand Down
4 changes: 2 additions & 2 deletions test/utils/attachments.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ describe('attachment utils', () => {
});
});

describe('waitForVideoFile', () => {
describe.skip('waitForVideoFile', () => {
beforeEach(() => {
jest.useFakeTimers();
jest.clearAllMocks();
Expand Down Expand Up @@ -157,7 +157,7 @@ describe('attachment utils', () => {
});
});

describe('getVideoFile', () => {
describe.skip('getVideoFile', () => {
beforeEach(() => {
jest.clearAllMocks();
});
Expand Down
26 changes: 26 additions & 0 deletions test/utils/specCountCalculation.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,14 @@ describe('spec count calculation', () => {
expect(specCount).toEqual(5);
});

it('nor testFiles nor specPattern are specified: should throw an exception', () => {
expect(() => {
getTotalSpecs({});
}).toThrow(
new Error('Configuration property not set! Neither for cypress <= 9 nor cypress >= 10'),
);
});

it('ignoreTestFiles are specified: should ignore specified files', () => {
let specConfig = {
testFiles: '**/*.*',
Expand Down Expand Up @@ -96,6 +104,24 @@ describe('spec count calculation', () => {
});

describe('getExcludeSpecPattern', () => {
it('getExcludeSpecPattern returns required pattern for cypress version >= 10', () => {
const specConfigString = {
excludeSpecPattern: '*.hot-update.js',
};

const specConfigArray = {
excludeSpecPattern: ['*.hot-update.js', '*.hot-update.ts'],
};

let patternArray = getExcludeSpecPattern(specConfigString);
expect(patternArray).toHaveLength(1);
expect(patternArray).toContain('*.hot-update.js');

patternArray = getExcludeSpecPattern(specConfigArray);
expect(patternArray).toHaveLength(2);
expect(patternArray).toContain('*.hot-update.js');
expect(patternArray).toContain('*.hot-update.ts');
});
it('getExcludeSpecPattern returns required pattern for cypress version <= 9', () => {
const specConfigString = {
integrationFolder: 'cypress/integration',
Expand Down

0 comments on commit 3d3f255

Please sign in to comment.