Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reflect cypress 10 changes for getTotalSpecs #123

Closed
wants to merge 1 commit into from
Closed

Reflect cypress 10 changes for getTotalSpecs #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 41 additions & 26 deletions lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,44 +217,56 @@ const getHookStartObject = (hook) => {
codeRef: hook.codeRef,
};
};
const getFixtureFolderPattern = (config) => {
return [].concat(config.fixturesFolder ? path.join(config.fixturesFolder, '**', '*') : []);
};

const getTotalSpecs = ({
ignoreTestFiles,
testFiles,
integrationFolder,
fixturesFolder,
supportFile,
}) => {
const specConfig = Object.assign(
{},
DEFAULT_SPEC_CONFIG,
ignoreTestFiles && { ignoreTestFiles },
testFiles && { testFiles },
integrationFolder && { integrationFolder },
fixturesFolder && { fixturesFolder },
supportFile && { supportFile },
);
const getExcludeSpecPattern = (config) => {
// Return cypress >= 10 pattern.
if (config.excludeSpecPattern) {
const excludePattern = Array.isArray(config.excludeSpecPattern)
? config.excludeSpecPattern
: [config.excludeSpecPattern];
return [...excludePattern];
}

// Return cypress <= 9 pattern
const ignoreTestFilesPattern = Array.isArray(config.ignoreTestFiles)
? config.ignoreTestFiles
: [config.ignoreTestFiles] || [];

return [...ignoreTestFilesPattern];
};

const fixturesFolderPath = path.join(specConfig.fixturesFolder, '**', '*');
const getSpecPattern = (config) => {
if (config.specPattern) return [].concat(config.specPattern);

const supportFilePath = specConfig.supportFile || [];
return Array.isArray(config.testFiles)
? config.testFiles.map((file) => path.join(config.integrationFolder, file))
: [].concat(path.join(config.integrationFolder, config.testFiles));
};

const getTotalSpecs = (config) => {
if (!config.testFiles && !config.specPattern)
throw new Error('Configuration property not set! Neither for cypress <= 9 nor cypress >= 10');

const specPattern = getSpecPattern(config);

const excludeSpecPattern = getExcludeSpecPattern(config);

const options = {
sort: true,
absolute: true,
nodir: true,
cwd: specConfig.integrationFolder,
ignore: [supportFilePath, fixturesFolderPath],
ignore: [config.supportFile, path.join(config.fixturesFolder, '**', '*')],
};

const ignorePatterns = [].concat(specConfig.ignoreTestFiles);

const doesNotMatchAllIgnoredPatterns = (file) =>
ignorePatterns.every((pattern) => !minimatch(file, pattern, { dot: true, matchBase: true }));

const testFilesPatterns = [].concat(specConfig.testFiles);
excludeSpecPattern.every(
(pattern) => !minimatch(file, pattern, { dot: true, matchBase: true }),
);

const globResult = testFilesPatterns.reduce(
const globResult = specPattern.reduce(
(files, pattern) => files.concat(glob.sync(pattern, options) || []),
[],
);
Expand All @@ -279,4 +291,7 @@ module.exports = {
getHookStartObject,
getTotalSpecs,
getConfig,
getExcludeSpecPattern,
getFixtureFolderPattern,
getSpecPattern,
};
151 changes: 136 additions & 15 deletions test/utils.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ const {
getCodeRef,
getTotalSpecs,
getConfig,
getFixtureFolderPattern,
getExcludeSpecPattern,
getSpecPattern,
} = require('./../lib/utils');
const pjson = require('./../package.json');

Expand Down Expand Up @@ -755,14 +758,19 @@ describe('utils script', () => {
describe('getTotalSpecs', () => {
beforeEach(() => {
mock({
'example/tests': {
'cypress/tests': {
'example1.spec.js': '',
'example2.spec.js': '',
'example3.spec.js': '',
'example.ignore.js': '',
'example4.spec.ts': '',
'example.ignore.spec.js': '',
},
'example/support': {
'support.js': '',
'cypress/support': {
'index.js': '',
},
'cypress/fixtures': {
'fixtures1.js': '',
'fixtures2.js': '',
},
});
});
Expand All @@ -772,28 +780,141 @@ describe('utils script', () => {
});

it('testFiles, integrationFolder, supportFile are specified: should count all files from integration folder', () => {
const specConfig = {
let specConfig = {
testFiles: '**/*.*',
integrationFolder: 'example/tests',
supportFile: 'example/support',
ignoreTestFiles: '*.hot-update.js',
fixturesFolder: 'cypress/fixtures',
integrationFolder: 'cypress/tests',
supportFile: 'cypress/support/index.js',
};

const specCount = getTotalSpecs(specConfig);
let specCount = getTotalSpecs(specConfig);

expect(specCount).toEqual(4);
expect(specCount).toEqual(5);

specConfig = {
excludeSpecPattern: '*.hot-update.js',
specPattern: 'cypress/tests/**/*.spec.{js,ts}',
supportFile: 'cypress/support/index.js',
fixturesFolder: 'cypress/fixtures',
};

specCount = getTotalSpecs(specConfig);

expect(specCount).toEqual(5);
});

it('ignoreTestFiles are specified: should ignore specified files', () => {
const specConfig = {
ignoreTestFiles: '*.ignore.js',
let specConfig = {
testFiles: '**/*.*',
integrationFolder: 'example/tests',
supportFile: 'example/support',
ignoreTestFiles: ['*.hot-update.js', '*.ignore.*.*'],
fixturesFolder: 'cypress/fixtures',
integrationFolder: 'cypress/tests',
supportFile: 'cypress/support/index.js',
};

let specCount = getTotalSpecs(specConfig);

expect(specCount).toEqual(4);

specConfig = {
specPattern: 'cypress/tests/**/*.spec.{js,ts}',
excludeSpecPattern: ['*.hot-update.js', '*.ignore.spec.*'],
supportFile: 'cypress/support/index.js',
fixturesFolder: 'cypress/fixtures',
};

specCount = getTotalSpecs(specConfig);

expect(specCount).toEqual(4);
});
});

describe('getFixtureFolderPattern', () => {
it('returns a glob pattern forn fixtures folder', () => {
const specConfig = { fixturesFolder: 'cypress/fixtures' };

const specArray = getFixtureFolderPattern(specConfig);
expect(specArray).toHaveLength(1);
expect(specArray).toContain('cypress/fixtures/**/*');
});
});
describe('getExcludeSpecPattern', () => {
it('getExcludeSpecPattern returns required pattern for cypress version <= 9', () => {
const specConfigString = {
integrationFolder: 'cypress/integration',
ignoreTestFiles: '*.hot-update.js',
fixturesFolder: 'cypress/fixtures',
supportFile: 'cypress/support/index.js',
};

const specCount = getTotalSpecs(specConfig);
const specConfigArray = {
integrationFolder: 'cypress/integration',
ignoreTestFiles: ['*.hot-update.js', '*.hot-update.ts'],
fixturesFolder: 'cypress/fixtures',
supportFile: 'cypress/support/index.js',
};

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');
});
});

describe('getSpecPattern', () => {
it('returns the required glob pattern for cypress <=9 config when testFiles is an array', () => {
const specConfig = {
integrationFolder: 'cypress/integration',
testFiles: ['**/*.js', '**/*.ts'],
};

const patternArray = getSpecPattern(specConfig);
expect(patternArray).toHaveLength(2);
expect(patternArray[0]).toEqual(
path.join(specConfig.integrationFolder, specConfig.testFiles[0]),
);
expect(patternArray[1]).toEqual(
path.join(specConfig.integrationFolder, specConfig.testFiles[1]),
);
});

it('getSpecPattern returns the required glob pattern for cypress >= 10 config when specPattern is an array', () => {
const specConfig = {
specPattern: ['cypress/integration/**/*.js', 'cypress/integration/**/*.js'],
};

const patternArray = getSpecPattern(specConfig);
expect(patternArray).toHaveLength(2);
expect(patternArray[0]).toEqual(specConfig.specPattern[0]);
expect(patternArray[1]).toEqual(specConfig.specPattern[1]);
});

it('getSpecPattern returns the required glob pattern for cypress >= 10 config when specPattern is a string', () => {
const specConfig = {
specPattern: 'cypress/integration/**/*.js',
};

const patternArray = getSpecPattern(specConfig);
expect(patternArray).toHaveLength(1);
expect(patternArray[0]).toEqual(specConfig.specPattern);
});

it('getSpecPattern returns the required glob pattern for cypress <= 9 config when testFiles is a string', () => {
const specConfig = {
integrationFolder: 'cypress/integration',
testFiles: '**/*.js',
};

expect(specCount).toEqual(3);
const patternArray = getSpecPattern(specConfig);
expect(patternArray).toHaveLength(1);
expect(patternArray[0]).toEqual(
path.join(specConfig.integrationFolder, specConfig.testFiles),
);
});
});
});