config.yml

# https://circleci.com/docs/2.0/configuration-reference/
version: 2.1
orbs:
  # https://github.com/cypress-io/circleci-orb
  cypress: cypress-io/cypress@3.0.0 # used to run e2e tests
  win: circleci/windows@5.0.0 # run a test job on Windows

jobs:
  lint:
    description: Checks the code formatting
    docker:
      - image: cimg/node:21.7.1
        environment:
          # we don't need Cypress to check code style
          CYPRESS_INSTALL_BINARY: '0'
    steps:
      - attach_workspace:
          at: ~/
      - run:
          name: Code style check 🧹
          command: npm run format:check
      - run: npm run check:markdown
  
  install_and_persist:
    executor: cypress/default
    steps:
      - cypress/install
      - run: npm run check:markdown
      - persist_to_workspace:
          paths:
              - .cache/Cypress
              - project
          root: ~/

  windows_test:
    executor:
      # executor comes from the "windows" orb
      name: win/default
      shell: bash.exe
    steps:
      - checkout
      - run:
          name: Install node 16
          command: nvm install 16.16.0
      - run:
          name: Use node 16
          command: nvm use 16.16.0
      - run:
          name: Install deps for code coverage
          command: npm ci
      - cypress/run-tests:
          # no-workspace: true
          start-command: npm run start:windows --prefix test-apps/all-files
          # wait-on: 'http://localhost:1234'
          cypress-command: npx cypress run --project test-apps/all-files
          # store screenshots and videos
          # store_artifacts: true          
      - run:
          # make sure the examples captures 100% of code
          name: Verify Code Coverage
          command: npm run coverage:verify
          working_directory: test-apps/all-files
      - run:
          name: Check code coverage files 📈
          # we will check the final coverage report
          # to make sure it only has files we are interested in
          # because there are files covered at 0 in the report
          command: npm i -D check-code-coverage && npm run coverage:check-files
          working_directory: test-apps/all-files

  publish:
    description: Publishes the new version of the plugin to NPM
    docker:
      - image: cimg/node:21.7.1
    environment:
      # we don't need Cypress to do the release
      CYPRESS_INSTALL_BINARY: '0'
      # trick semantic-release into thinking this is NOT a pull request
      # (under the hood the module env-ci is used to check if this is a PR)
      CIRCLE_PR_NUMBER: ''
      CIRCLE_PULL_REQUEST: ''
      CI_PULL_REQUEST: ''
    steps:
      - attach_workspace:
          at: ~/
      - run: npm run semantic-release

  cyrun:
    docker:
      - image: cypress/base:16.18.1
    parameters:
      jobname:
        type: string
    steps:
      - attach_workspace:
          at: ~/
      - run:
          command: npm run test
          working_directory: test-apps/<< parameters.jobname >>
      - store_artifacts:
          path: test-apps/<< parameters.jobname >>/coverage
      - run:
          name: Verify Code Coverage
          command: npm run coverage:verify
          working_directory: test-apps/<< parameters.jobname >>
      - run:
          name: Check code coverage files 📈
          # we will check the final coverage report
          # to make sure it only has files we are interested in
          # because there are files covered at 0 in the report
          command: npm run coverage:check-files
          working_directory: test-apps/<< parameters.jobname >>

  test-code-coverage-plugin:
    docker:
      - image: cypress/base:16.18.1
    steps:
      - attach_workspace:
          at: ~/
      - run:
          command: npm run test
      - store_artifacts:
          path: coverage
      - run:
          name: Verify Code Coverage
          command: npm run coverage:verify

workflows:
  build:
    jobs:
      - install_and_persist
      - lint:
          requires:
            - install_and_persist

      - test-code-coverage-plugin:
          requires:
            - install_and_persist

      - cyrun:
          name: test-<< matrix.jobname>>
          requires:
            - install_and_persist
          matrix:
            parameters:
              jobname:
                - all-files
                - backend
                - before-all-visit
                - before-each-visit
                - cra-e2e-and-ct
                - exclude-files
                - frontend
                - fullstack
                - one-spec
                - same-folder
                - support-files
                - ts-example
                - unit-tests-js
                - use-webpack
                - redirect
      - windows_test
      - publish:
          filters:
            branches:
              only:
                - master
                - beta
                - next
                - dev
          requires:
            - lint
            - test-code-coverage-plugin
            - test-all-files
            - test-backend
            - test-before-all-visit
            - test-before-each-visit
            - test-cra-e2e-and-ct
            - test-exclude-files
            - test-frontend
            - test-fullstack
            - test-one-spec
            - test-same-folder
            - test-support-files
            - test-ts-example
            - test-unit-tests-js
            - test-use-webpack
            - test-redirect
            - windows_test