Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use findSpecsOfType method in Cypress

Best JavaScript code snippet using cypress

specs.js

Source:specs.js

...29/**30 * Finds all spec files that pass the config for given type. Note that "commonSearchOptions" is31 * a subset of the project's "config" object32 */33function findSpecsOfType(searchFolder, commonSearchOptions, specPattern) {34    let fixturesFolderPath = undefined;35    // @ts-ignore - types are incorrect36    (0, lazy_ass_1.default)(check_more_types_1.default.maybe.strings(specPattern), 'invalid spec pattern', specPattern);37    (0, lazy_ass_1.default)(check_more_types_1.default.unemptyString(searchFolder), 'expected spec folder path in', commonSearchOptions);38    debug('looking for test specs in the folder:', searchFolder);39    if (specPattern) {40        debug('spec pattern "%s"', specPattern);41    }42    else {43        debug('there is no spec pattern');44    }45    // support files are not automatically46    // ignored because only _fixtures are hard47    // coded. the rest is simply whatever is in48    // the javascripts array49    if (typeof commonSearchOptions.fixturesFolder === 'string' && commonSearchOptions.fixturesFolder !== '') {50        // users should be allowed to set the fixtures folder51        // the same as the specs folder52        if (commonSearchOptions.fixturesFolder !== searchFolder) {53            fixturesFolderPath = path_1.default.join(commonSearchOptions.fixturesFolder, '**', '*');54        }55    }56    const supportFilePath = commonSearchOptions.supportFile || [];57    // TODO: think about moving this into config58    // ignore fixtures59    const options = {60        sort: true,61        absolute: true,62        nodir: true,63        cwd: searchFolder,64        ignore: lodash_1.default.compact(lodash_1.default.flatten([65            supportFilePath,66            fixturesFolderPath,67        ])),68    };69    // example of resolved paths in the returned spec object70    // filePath                          = /Users/bmann/Dev/my-project/cypress/integration/foo.js71    // integrationFolderPath             = /Users/bmann/Dev/my-project/cypress/integration72    // relativePathFromSearchFolder      = foo.js73    // relativePathFromProjectRoot       = cypress/integration/foo.js74    const relativePathFromSearchFolder = (file) => {75        return path_1.default.relative(searchFolder, file).replace(/\\/g, '/');76    };77    const relativePathFromProjectRoot = (file) => {78        return path_1.default.relative(commonSearchOptions.projectRoot, file).replace(/\\/g, '/');79    };80    const setNameParts = (file) => {81        debug('found spec file %s', file);82        if (!path_1.default.isAbsolute(file)) {83            throw new Error(`Cannot set parts of file from non-absolute path ${file}`);84        }85        return {86            name: relativePathFromSearchFolder(file),87            relative: relativePathFromProjectRoot(file),88            absolute: file,89        };90    };91    const ignorePatterns = [].concat(commonSearchOptions.ignoreTestFiles);92    // a function which returns true if the file does NOT match93    // all of our ignored patterns94    const doesNotMatchAllIgnoredPatterns = (file) => {95        // using {dot: true} here so that folders with a '.' in them are matched96        // as regular characters without needing an '.' in the97        // using {matchBase: true} here so that patterns without a globstar **98        // match against the basename of the file99        return lodash_1.default.every(ignorePatterns, (pattern) => {100            return !(0, minimatch_1.default)(file, pattern, MINIMATCH_OPTIONS);101        });102    };103    const matchesSpecPattern = (file) => {104        if (!specPattern) {105            return true;106        }107        const matchesPattern = (pattern) => {108            return (0, minimatch_1.default)(file, pattern, MINIMATCH_OPTIONS);109        };110        // check to see if the file matches111        // any of the spec patterns array112        return lodash_1.default113            .chain([])114            .concat(specPattern)115            .some(matchesPattern)116            .value();117    };118    // grab all the files119    debug('globbing test files "%s"', commonSearchOptions.testFiles);120    debug('glob options %o', options);121    // ensure we handle either a single string or a list of strings the same way122    const testFilesPatterns = [].concat(commonSearchOptions.testFiles);123    /**124     * Finds matching files for the given pattern, filters out specs to be ignored.125     */126    const findOnePattern = (pattern) => {127        return (0, glob_1.default)(pattern, options)128            .tap(debug)129            // filter out anything that matches our130            // ignored test files glob131            .filter(doesNotMatchAllIgnoredPatterns)132            .filter(matchesSpecPattern)133            .map(setNameParts)134            .tap((files) => {135            return debug('found %s: %o', (0, pluralize_1.default)('spec file', files.length, true), files);136        });137    };138    return bluebird_1.default.mapSeries(testFilesPatterns, findOnePattern).then(lodash_1.default.flatten);139}140const findIntegrationSpecs = (searchFolder, commonSearchOptions, specPattern) => {141    if (!searchFolder) {142        return [];143    }144    return findSpecsOfType(searchFolder, commonSearchOptions, specPattern)145        .then((val) => val.map((s) => (Object.assign(Object.assign({}, s), { specType: SPEC_TYPES.INTEGRATION }))));146};147const findComponentSpecs = (searchFolder, commonSearchOptions, specPattern) => {148    if (!searchFolder) {149        return [];150    }151    return findSpecsOfType(searchFolder, commonSearchOptions, specPattern)152        .then((val) => val.map((s) => (Object.assign(Object.assign({}, s), { specType: SPEC_TYPES.COMPONENT }))));153};154const printFoundSpecs = (foundSpecs) => {155    const table = new cli_table3_1.default({156        head: ['relative', 'specType'],157    });158    foundSpecs.forEach((spec) => {159        // @ts-ignore - types are incorrect160        table.push([spec.relative, spec.specType]);161    });162    /* eslint-disable no-console */163    console.error(table.toString());164};165/**...

specs-store.js

Source:specs-store.js

...46            testFiles: this.cypressConfig.testFiles,47            ignoreTestFiles: this.cypressConfig.ignoreTestFiles,48        };49        searchOptions.testFiles = this.testFiles;50        return specs_1.default.findSpecsOfType(this.specDirectory, searchOptions);51    }52    watch(options) {53        this.watcher = chokidar_1.default.watch(this.cypressConfig.testFiles, this.watchOptions);54        const onSpecsChanged = debounce(() => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {55            const newSpecs = yield this.getSpecFiles();56            if (lodash_1.default.isEqual(newSpecs, this.specFiles))57                return;58            this.specFiles = newSpecs;59            options.onSpecsChanged(newSpecs);60        }));61        this.watcher.on('add', onSpecsChanged);62        this.watcher.on('unlink', onSpecsChanged);63    }64    reset() {...

Using AI Code Generation

1describe('My First Test', function() {2  it('Does not do much!', function() {3    cy.findSpecsOfType('integration').then((specs) => {4      console.log(specs);5    });6  });7});8Cypress.Commands.add('findSpecsOfType', (type) => {9  const specs = Cypress.specs.filter((spec) => {10    return spec.relative.includes(type);11  });12  return specs;13});

Using AI Code Generation

1describe('test', () => {2  it('test', () => {3    cy.findSpecsOfType('integration').then((specs) => {4      console.log(specs);5    });6  });7});8Cypress.Commands.add('findSpecsOfType', (type) => {9  return cy.task('findSpecsOfType', type);10});11const fs = require('fs');12module.exports = (on, config) => {13  on('task', {14    findSpecsOfType(type) {15        .readdirSync('cypress/integration')16        .filter((file) => file.includes(type));17    },18  });19};

Using AI Code Generation

1describe("Test", () => {2  it("Test", () => {3    cy.findSpecsOfType("component")4      .then(specs => {5        console.log(specs);6      });7  });8});9Cypress.Commands.add("findSpecsOfType", type => {10  return new Cypress.Promise((resolve, reject) => {11    const specs = Cypress.specs.filter(spec => {12      return spec.name.includes(type);13    });14    resolve(specs);15  });16});17describe("Test", () => {18  before(() => {19    cy.findSpecsOfType("page")20      .then(specs => {21      });22  });23});

Using AI Code Generation

1import {findSpecsOfType} from 'cypress-test-utils'2describe('findSpecsOfType', () => {3  it('finds all spec files of a given type', () => {4    const specs = findSpecsOfType('integration')5    specs.forEach(spec => {6      expect(spec).to.include('integration')7    })8  })9})10describe('spec1', () => {11  it('is a spec file', () => {12    expect(true).to.equal(true)13  })14})15describe('spec2', () => {16  it('is a spec file', () => {17    expect(true).to.equal(true)18  })19})20describe('spec1', () => {21  it('is a component spec file', () => {22    expect(true).to.equal(true)23  })24})25describe('spec2', () => {26  it('is a component spec file', () => {27    expect(true).to.equal(true)28  })29})30describe('spec1', () => {31  it('is a unit spec file', () => {32    expect(true).to.equal(true)33  })34})35describe('spec2', () => {36  it('is a unit spec file', () => {37    expect(true).to.equal(true)38  })39})40import {findSpecsByGlob} from 'cypress-test-utils'41describe('findSpecsByGlob', () => {42  it('finds all spec files matching a given glob pattern', ()

Using AI Code Generation

1const { findSpecsOfType } = require('@cypress/webpack-preprocessor')2const specs = findSpecsOfType('feature', 'cypress/integration')3console.log(specs)4const webpack = require('@cypress/webpack-preprocessor')5const { findSpecsOfType } = require('@cypress/webpack-preprocessor')6const specs = findSpecsOfType('feature', 'cypress/integration')7console.log(specs)8const webpack = require('@cypress/webpack-preprocessor')9const { findSpecsOfType } = require('@cypress/webpack-preprocessor')10const specs = findSpecsOfType('feature', 'cypress/integration')11console.log(specs)12const webpack = require('@cypress/webpack-preprocessor')13const { findSpecsOfType } = require('@cypress/webpack-preprocessor')14const specs = findSpecsOfType('feature', 'cypress/integration')15console.log(specs)16const webpack = require('@cypress/webpack-preprocessor')17const { findSpecsOfType } = require('@cypress/webpack-preprocessor')18const specs = findSpecsOfType('feature', 'cypress/integration')19console.log(specs)20const webpack = require('@cypress/webpack-preprocessor')21const { findSpecsOfType } = require('@cypress/webpack-preprocessor')22const specs = findSpecsOfType('feature', 'cypress/integration')23console.log(specs)24const webpack = require('@cypress/

Using AI Code Generation

1const findSpecsOfType = require('cypress-finder').findSpecsOfType;2const specs = findSpecsOfType('component');3console.log(specs);4const findSpecsOfType = require('cypress-finder').findSpecsOfType;5const specs = findSpecsOfType('integration');6console.log(specs);7const findSpecsOfType = require('cypress-finder').findSpecsOfType;8const specs = findSpecsOfType('e2e');9console.log(specs);10const findSpecsOfType = require('cypress-finder').findSpecsOfType;11const specs = findSpecsOfType(['component', 'e2e']);12console.log(specs);13const findSpecsOfType = require('cypress-finder').findSpecsOfType;14const specs = findSpecsOfType(['component', 'e2e', 'integration']);

Using AI Code Generation

1const cypress = require('cypress')2const fs = require('fs');3const path = require('path');4const projectRoot = path.resolve(__dirname, '../')5const specs = cypress.findSpecs(projectRoot, specPattern)6console.log("specs: ", specs);7specs.then((specs) => {8  specs.forEach((spec) => {9    console.log("spec: ", spec);10    cypress.run({11    })12  })13})14const cypress = require('cypress')15const fs = require('fs');16const path = require('path');17const projectRoot = path.resolve(__dirname, '../')18const specs = cypress.findSpecs(projectRoot, specPattern)19console.log("specs: ", specs);20specs.then((specs) => {21  specs.forEach((spec) => {22    console.log("spec: ", spec);23    cypress.run({24    })25  })26})27const cypress = require('cypress')28const fs = require('fs');29const path = require('path');30const projectRoot = path.resolve(__dirname, '../')31const specs = cypress.findSpecs(projectRoot, specPattern)32console.log("specs: ", specs);33specs.then((specs) => {34  specs.forEach((spec) => {35    console.log("spec: ", spec);36    cypress.run({37      env: {38      }39    })40  })41})42const cypress = require('cypress')43const fs = require('fs');

Using AI Code Generation

1Cypress.specs.findSpecsOfType('integration').forEach(spec => {2  console.log(spec.relative)3})4Cypress.specs.findSpecsOfType('component').forEach(spec => {5  console.log(spec.relative)6})7Cypress.specs.findSpecsOfType('unit').forEach(spec => {8  console.log(spec.relative)9})10Cypress.specs.findSpecsOfType('e2e').forEach(spec => {11  console.log(spec.relative)12})

Cypress Tutorial

Cypress is a renowned Javascript-based open-source, easy-to-use end-to-end testing framework primarily used for testing web applications. Cypress is a relatively new player in the automation testing space and has been gaining much traction lately, as evidenced by the number of Forks (2.7K) and Stars (42.1K) for the project. LambdaTest’s Cypress Tutorial covers step-by-step guides that will help you learn from the basics till you run automation tests on LambdaTest.

Chapters:

What is Cypress? -
Why Cypress? - Learn why Cypress might be a good choice for testing your web applications.
Features of Cypress Testing - Learn about features that make Cypress a powerful and flexible tool for testing web applications.
Cypress Drawbacks - Although Cypress has many strengths, it has a few limitations that you should be aware of.
Cypress Architecture - Learn more about Cypress architecture and how it is designed to be run directly in the browser, i.e., it does not have any additional servers.
Browsers Supported by Cypress - Cypress is built on top of the Electron browser, supporting all modern web browsers. Learn browsers that support Cypress.
Selenium vs Cypress: A Detailed Comparison - Compare and explore some key differences in terms of their design and features.
Cypress Learning: Best Practices - Take a deep dive into some of the best practices you should use to avoid anti-patterns in your automation tests.
How To Run Cypress Tests on LambdaTest? - Set up a LambdaTest account, and now you are all set to learn how to run Cypress tests.

Certification

You can elevate your expertise with end-to-end testing using the Cypress automation framework and stay one step ahead in your career by earning a Cypress certification. Check out our Cypress 101 Certification.