diff --git a/circle.yml b/circle.yml index c20f5c6..32e3059 100644 --- a/circle.yml +++ b/circle.yml @@ -7,17 +7,31 @@ executors: resource_class: medium workflows: - version: 2.1 main: jobs: - lint - test-v8 - test-v9 + + - build-test-project + - test-test-project: + matrix: + parameters: + eslint-version: ['9'] + config-file: [ + # configurations correspond to examples in README + 'default', + 'recommended', + 'globals', + ] + requires: + - build-test-project - release: requires: - lint - test-v8 - test-v9 + - test-test-project filters: branches: only: @@ -72,6 +86,63 @@ jobs: name: Test ESLint 9 command: npm test + build-test-project: + executor: docker-executor + steps: + - checkout + - run: + name: Install dependencies + command: npm ci + - run: + name: Build tarball + command: npm pack + - run: + name: Get version + command: | + echo "PLUGIN_VERSION=$(jq -r '.version' package.json)" >> $BASH_ENV + cp $BASH_ENV bash.env + - persist_to_workspace: + root: . + paths: + - eslint-plugin-cypress-*.tgz + - bash.env + + test-test-project: + description: Run ESLint with different configurations + parameters: + eslint-version: + description: Version of ESLint to use + default: 'latest' + type: string + config-file: + description: Configuration file + default: 'default' + type: string + executor: docker-executor + working_directory: ./test-project + steps: + - checkout: + path: ../ + - attach_workspace: + at: . + - run: + name: Get plugin version + command: | + cat bash.env >> $BASH_ENV + - run: + name: Install dependencies + command: | + npm install eslint@<< parameters.eslint-version>> ./eslint-plugin-cypress-$PLUGIN_VERSION.tgz -D + - run: + name: Display ESLint version + command: | + npx eslint --version + - run: echo Testing a << parameters.config-file >> configuration + - run: + name: Lint with example configuration + command: | + npx eslint --config ./eslint-configs/eslint.<< parameters.config-file >>.mjs . + release: executor: docker-executor steps: diff --git a/eslint.config.mjs b/eslint.config.mjs index 8d5bd83..e3465a3 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -7,6 +7,7 @@ export default [ pluginJs.configs.recommended, eslintPlugin.configs['flat/recommended'], mochaPlugin.configs.flat.recommended, + {ignores: ['test-project/']}, { languageOptions: { globals: globals.node diff --git a/test-project/.gitignore b/test-project/.gitignore new file mode 100644 index 0000000..56b8755 --- /dev/null +++ b/test-project/.gitignore @@ -0,0 +1,8 @@ +package-lock.json + +cypress/downloads/ +cypress/screenshots/ +cypress/videos/ + +cypress/fixtures/profile.json +cypress/fixtures/users.json diff --git a/test-project/README.md b/test-project/README.md new file mode 100644 index 0000000..b8e5bfd --- /dev/null +++ b/test-project/README.md @@ -0,0 +1,48 @@ +# Test-project + +This test project was generated via the Cypress App. + +This project can be updated to the latest Cypress default scaffolded E2E test specs by carrying out the following steps in the directory `/test-project`: + +```shell +rm -rf cypress cypress.config.js +npm install cypress@latest --no-package-lock +npx cypress open +``` + +- Select "Continue" for "What's New in Cypress" if displayed +- Select "E2E Testing" +- Select "Continue" in "Configuration files" +- Select "Electron" browser +- Select "Start E2E Testing in Electron" +- Select "Scaffold example specs" +- Close all Cypress windows + +Test that scaffolded specs run: + +```shell +npm test +``` + +Remove Cypress from `package.json`: + +```shell +npm uninstall cypress --no-package-lock +``` + +## Tests + +Tests are run via [circle.yml](../circle.yml). + +To test the project locally: + +```shell +cd test-project +npm install eslint@latest eslint-plugin-cypress@latest cypress@latest -D +npx cypress run +npx eslint +``` + +Do not commit the changes from installing the above dependencies. +The CircleCI pipeline dynamically installs the latest `eslint*` dependencies. +Cypress is not needed for the CircleCI tests. diff --git a/test-project/cypress.config.js b/test-project/cypress.config.js new file mode 100644 index 0000000..97f47c4 --- /dev/null +++ b/test-project/cypress.config.js @@ -0,0 +1,9 @@ +const { defineConfig } = require("cypress"); + +module.exports = defineConfig({ + e2e: { + setupNodeEvents(on, config) { + // implement node event listeners here + }, + }, +}); diff --git a/test-project/cypress/e2e/1-getting-started/todo.cy.js b/test-project/cypress/e2e/1-getting-started/todo.cy.js new file mode 100644 index 0000000..4768ff9 --- /dev/null +++ b/test-project/cypress/e2e/1-getting-started/todo.cy.js @@ -0,0 +1,143 @@ +/// + +// Welcome to Cypress! +// +// This spec file contains a variety of sample tests +// for a todo list app that are designed to demonstrate +// the power of writing tests in Cypress. +// +// To learn more about how Cypress works and +// what makes it such an awesome testing tool, +// please read our getting started guide: +// https://on.cypress.io/introduction-to-cypress + +describe('example to-do app', () => { + beforeEach(() => { + // Cypress starts out with a blank slate for each test + // so we must tell it to visit our website with the `cy.visit()` command. + // Since we want to visit the same URL at the start of all our tests, + // we include it in our beforeEach function so that it runs before each test + cy.visit('https://example.cypress.io/todo') + }) + + it('displays two todo items by default', () => { + // We use the `cy.get()` command to get all elements that match the selector. + // Then, we use `should` to assert that there are two matched items, + // which are the two default items. + cy.get('.todo-list li').should('have.length', 2) + + // We can go even further and check that the default todos each contain + // the correct text. We use the `first` and `last` functions + // to get just the first and last matched elements individually, + // and then perform an assertion with `should`. + cy.get('.todo-list li').first().should('have.text', 'Pay electric bill') + cy.get('.todo-list li').last().should('have.text', 'Walk the dog') + }) + + it('can add new todo items', () => { + // We'll store our item text in a variable so we can reuse it + const newItem = 'Feed the cat' + + // Let's get the input element and use the `type` command to + // input our new list item. After typing the content of our item, + // we need to type the enter key as well in order to submit the input. + // This input has a data-test attribute so we'll use that to select the + // element in accordance with best practices: + // https://on.cypress.io/selecting-elements + cy.get('[data-test=new-todo]').type(`${newItem}{enter}`) + + // Now that we've typed our new item, let's check that it actually was added to the list. + // Since it's the newest item, it should exist as the last element in the list. + // In addition, with the two default items, we should have a total of 3 elements in the list. + // Since assertions yield the element that was asserted on, + // we can chain both of these assertions together into a single statement. + cy.get('.todo-list li') + .should('have.length', 3) + .last() + .should('have.text', newItem) + }) + + it('can check off an item as completed', () => { + // In addition to using the `get` command to get an element by selector, + // we can also use the `contains` command to get an element by its contents. + // However, this will yield the