Skip to content
This repository was archived by the owner on Sep 1, 2024. It is now read-only.

Commit 606e56d

Browse files
ramosbugsramosbugs
committed
Add Cypress plugin
1 parent 8f2d407 commit 606e56d

File tree

152 files changed

+15441
-323
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+15441
-323
lines changed

‎.eslintignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# TypeScript uniques files that are included in a project twice via symlinks. eslint complains that
2+
# the symlinked files aren't included in tsconfig.json (due to the deduping), so we ignore the
3+
# symlinked copies and just lint the canonical location at:
4+
# packages/cypress-plugin/test/integration-input/cypress/component
5+
packages/cypress-plugin/test/integration-input*/cypress/e2e
6+
7+
# Cypress produces screenshot folders with names that match the *.ts glob, and eslint complains.
8+
packages/cypress-plugin/test/**/cypress/screenshots/*.ts
9+
10+
# Don't lint output files.
11+
packages/**/dist

‎.github/workflows/ci.yaml‎

Lines changed: 103 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ on:
1212
- cron: 0 18 * * *
1313

1414
# Allows you to run this workflow manually from the Actions tab
15-
workflow_dispatch: { }
15+
workflow_dispatch: {}
1616

1717
jobs:
1818
check:
@@ -24,19 +24,32 @@ jobs:
2424

2525
- uses: actions/setup-node@v3
2626
with:
27-
node-version: '16'
27+
node-version: "16"
2828
cache: yarn
2929

30-
- uses: actions/cache@v3
31-
with:
32-
path: '**/node_modules'
33-
key: ${{ runner.os }}-modules-${{ hashFiles('yarn.lock') }}
34-
3530
- id: install
3631
run: yarn install --immutable
3732

3833
- run: yarn build
3934

35+
- run: yarn workspace @unflakable/cypress-plugin pack
36+
- uses: actions/upload-artifact@v3
37+
with:
38+
name: cypress-plugin
39+
path: packages/cypress-plugin/package.tgz
40+
41+
- run: yarn workspace @unflakable/jest-plugin pack
42+
- uses: actions/upload-artifact@v3
43+
with:
44+
name: jest-plugin
45+
path: packages/jest-plugin/package.tgz
46+
47+
- run: yarn workspace @unflakable/js-api pack
48+
- uses: actions/upload-artifact@v3
49+
with:
50+
name: js-api
51+
path: packages/js-api/package.tgz
52+
4053
- if: ${{ always() && steps.install.outcome == 'success' }}
4154
run: yarn lint
4255

@@ -56,6 +69,13 @@ jobs:
5669
# it's ignored for PR events, but that's fine.
5770
base: ${{ github.ref }}
5871
filters: |
72+
cypress:
73+
- package.json
74+
- tsconfig.json
75+
- .github/workflows/ci.yaml
76+
- packages/cypress-plugin/**
77+
- packages/js-api/**
78+
- packages/plugins-common/**
5979
jest:
6080
- package.json
6181
- tsconfig.json
@@ -65,10 +85,86 @@ jobs:
6585
- packages/plugins-common/**
6686
- scripts/set-jest-version.ts
6787
outputs:
88+
affects_cypress: ${{ steps.affects_plugins.outputs.cypress }}
6889
affects_jest: ${{ steps.affects_plugins.outputs.jest }}
6990

91+
cypress_integration_tests:
92+
name: "Cypress Integration Tests: Cypress ${{ matrix.cypress }} + Node ${{ matrix.node }}"
93+
# FIXME: also test on Windows
94+
runs-on: ubuntu-latest
95+
timeout-minutes: 45
96+
needs:
97+
# Don't incur the cost of the test matrix if the basic build fails.
98+
- check
99+
if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || needs.check.outputs.affects_cypress == 'true'
100+
strategy:
101+
fail-fast: false
102+
matrix:
103+
node:
104+
- 16
105+
- 18
106+
- 20
107+
cypress:
108+
# FIXME: support earlier versions
109+
#- "10.0"
110+
#- "10.11"
111+
#- "11.0"
112+
- "11.2"
113+
- "12.0"
114+
- "12.10"
115+
- "12.14"
116+
steps:
117+
- uses: actions/checkout@v3
118+
119+
- uses: actions/setup-node@v3
120+
with:
121+
node-version: ${{ matrix.node }}
122+
cache: yarn
123+
124+
- name: Cache Cypress binary
125+
uses: actions/cache@v3
126+
with:
127+
path: ~/.cache/Cypress
128+
key: cypress-${{ runner.os }}-node${{ matrix.node }}-cypress${{ matrix.cypress }}-modules-${{ hashFiles('yarn.lock') }}
129+
130+
- id: install
131+
run: yarn install --immutable
132+
133+
- name: Set Cypress version
134+
run: |
135+
yarn set resolution "cypress@npm:10 - 12" ${{ matrix.cypress }}
136+
grep --after-context=1 "^\".*cypress.*" yarn.lock
137+
138+
- run: yarn build:plugins && yarn build:cypress-tests
139+
140+
- name: Test
141+
env:
142+
# Enable debug logs within the Jest tests that run Cypress. WARNING: these are very
143+
# verbose but are useful for seeing the raw chalk terminal codes.
144+
# DEBUG: unflakable:*
145+
146+
# Enable debug logs within the Cypress plugin.
147+
# TEST_DEBUG: unflakable:*
148+
149+
# Enable terminal colors for debug() output.
150+
DEBUG_COLORS: "1"
151+
152+
# Make chalk emit TTY colors.
153+
FORCE_COLOR: "1"
154+
run: |
155+
if [ "${{ github.repository }}" == "unflakable/unflakable-javascript" ]; then
156+
export UNFLAKABLE_SUITE_ID=2QwtGckRudLNUGBsdkVEoSknck1
157+
else
158+
export UNFLAKABLE_SUITE_ID=2Qwt9RyPIbOI95C6qjXCzcTelni
159+
fi
160+
UNFLAKABLE_API_KEY=${{ secrets.UNFLAKABLE_API_KEY }} \
161+
yarn workspace cypress-integration test \
162+
--reporters @unflakable/jest-plugin/dist/reporter \
163+
--runner @unflakable/jest-plugin/dist/runner
164+
70165
jest_integration_tests:
71166
name: "Jest Integration Tests: Jest ${{ matrix.jest }} + Node ${{ matrix.node }}"
167+
# FIXME: also test on Windows
72168
runs-on: ubuntu-latest
73169
timeout-minutes: 15
74170
needs:
@@ -118,11 +214,6 @@ jobs:
118214
node-version: ${{ matrix.node }}
119215
cache: yarn
120216

121-
- uses: actions/cache@v3
122-
with:
123-
path: '**/node_modules'
124-
key: ${{ runner.os }}-node${{ matrix.node }}-jest${{ matrix.jest }}-modules-${{ hashFiles('yarn.lock') }}
125-
126217
- id: install
127218
run: yarn install --immutable
128219

‎.github/workflows/cypress-realworld-app.yaml‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
name: Cypress Real World App
2+
3+
# Controls when the workflow will run
4+
on:
5+
# Run daily so that we get continuous dogfooding.
6+
schedule:
7+
# Run at 7pm UTC/11am Pacific, which is after the CI pipeline runs so that we can use the
8+
# latest build each day.
9+
- cron: 0 19 * * *
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch: {}
13+
14+
jobs:
15+
ui-chrome-tests:
16+
timeout-minutes: 15
17+
runs-on: ubuntu-latest
18+
container:
19+
image: cypress/browsers:node16.16.0-chrome105-ff104-edge
20+
options: --user 1001
21+
steps:
22+
- name: Check out latest cypress-io/cypress-realworld-app
23+
uses: actions/checkout@v3
24+
with:
25+
repository: cypress-io/cypress-realworld-app
26+
27+
- name: Get yarn cache directory path
28+
id: yarn-cache-dir-path
29+
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
30+
31+
- uses: actions/cache@v3
32+
id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
33+
with:
34+
path: |
35+
${{ steps.yarn-cache-dir-path.outputs.dir }}
36+
~/.cache/Cypress
37+
key: yarn-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
38+
restore-keys: |
39+
yarn-${{ runner.os }}-
40+
41+
- name: Download latest cypress-realworld-app build
42+
uses: dawidd6/action-download-artifact@v2
43+
with:
44+
repo: cypress-io/cypress-realworld-app
45+
workflow: main.yml
46+
branch: develop
47+
name: build
48+
path: build
49+
search_artifacts: true
50+
51+
- name: Download latest Cypress plugin build
52+
uses: dawidd6/action-download-artifact@v2
53+
with:
54+
workflow: ci.yaml
55+
workflow_conclusion: success
56+
branch: main
57+
58+
- run: yarn install --frozen-lockfile
59+
60+
- name: Install @unflakable/cypress-plugin
61+
# We clean the Yarn cache here to make sure we're installing the package contents from the
62+
# tarballs. Otherwise, Yarn may install the previously cached version from an earlier build
63+
# with the same package version number.
64+
run: |
65+
curl -Lo jq https://github.com/jqlang/jq/releases/download/jq-1.6/jq-linux64
66+
chmod +x jq
67+
68+
yarn cache clean @unflakable/js-api
69+
yarn cache clean @unflakable/cypress-plugin
70+
# See https://github.com/yarnpkg/yarn/issues/5357#issuecomment-748434801.
71+
rm -rf "$(yarn cache dir)/.tmp"
72+
73+
# Make sure Yarn resolves @unflakable/js-api to the tarball. If we just try to install
74+
# both packages at the same time, Yarn will complain if the js-api package version number
75+
# doesn't exist in the public NPM registry.
76+
cat package.json \
77+
| ./jq '. + {"resolutions": (.resolutions + {"@unflakable/js-api": "file:./js-api/package.tgz"})}' \
78+
> package-new.json
79+
mv package-new.json package.json
80+
81+
yarn add --dev file:./cypress-plugin/package.tgz
82+
83+
- name: Cypress info
84+
run: yarn cypress info
85+
86+
- name: Node info
87+
run: node -v
88+
89+
- name: __e Dir
90+
run: ls /__e
91+
92+
- name: "UI Tests - Chrome"
93+
env:
94+
DEBUG: "@cypress/github-action,unflakable:*"
95+
UNFLAKABLE_SUITE_ID: 2RBwks266ZvV5jn9zR5Ula9XK7m
96+
UNFLAKABLE_API_KEY: ${{ secrets.UNFLAKABLE_API_KEY }}
97+
uses: cypress-io/github-action@v5
98+
with:
99+
install: false
100+
command: yarn exec cypress-unflakable --
101+
start: yarn start:ci
102+
wait-on: "http://localhost:3000"
103+
wait-on-timeout: 120
104+
browser: chrome
105+
record: true
106+
parallel: true
107+
group: "UI - Chrome"
108+
spec: cypress/tests/ui/*
109+
config-file: cypress.config.js
110+
111+
- name: Save screenshots
112+
if: always()
113+
uses: actions/upload-artifact@v3
114+
# add the line below to store screenshots only on failures
115+
# if: failure()
116+
with:
117+
name: cypress-screenshots
118+
path: cypress/screenshots
119+
if-no-files-found: ignore # 'warn' or 'error' are also available, defaults to `warn`
120+
121+
- name: Save videos
122+
if: always()
123+
uses: actions/upload-artifact@v3
124+
with:
125+
name: cypress-videos
126+
path: cypress/videos
127+
if-no-files-found: ignore # 'warn' or 'error' are also available, defaults to `warn`

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16.20.0

‎.prettierignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.yarn
2+
packages/cypress-plugin/**/cypress/screenshots/*.ts
3+
packages/**/dist

‎.yarnrc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
yarnPath: .yarn/releases/yarn-3.5.1.cjs
22
nodeLinker: node-modules
3+
nmMode: hardlinks-local
34

45
# By default, publish packages privately to GitHub for internal testing instead of to NPM.
56
npmScopes:

‎README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ and TypeScript.
1616
Refer to our [Getting Started](https://docs.unflakable.com/getting-started) documentation
1717
for instructions on getting started using Unflakable.
1818

19+
## Cypress Plugin
20+
21+
This Unflakable plugin enables users of the [Cypress](https://cypress.io) JavaScript test framework
22+
to quarantine flaky tests and track test results.
23+
24+
Refer to the [Cypress Plugin](https://docs.unflakable.com/plugins/cypress) documentation for
25+
complete usage instructions.
26+
27+
### Compatibility
28+
29+
This plugin maintains compatibility with the Cypress and Node.js versions listed below:
30+
31+
[![11.2.0+ | 12.0.0+](https://img.shields.io/badge/Cypress-11.2.0%2B%20%7C%2012.0.0%2B-17202C?logo=cypress&labelColor=white&logoColor=17202C&style=flat)](https://cypress.io)
32+
[![16 | 18 | 20](https://img.shields.io/badge/Node.js-16%20%7C%2018%20%7C%2020-339933?logo=node.js&labelColor=white&logoColor=339933&style=flat)](https://nodejs.org)
33+
1934
## Jest Plugin
2035

2136
The Jest plugin enables users of the [Jest](https://jestjs.io) JavaScript test framework

‎package.json‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
"@babel/core": "^7.21.5",
66
"@babel/preset-env": "^7.21.5",
77
"@babel/preset-typescript": "^7.21.5",
8-
"@rollup/plugin-node-resolve": "^15.0.2",
9-
"@rollup/plugin-typescript": "^11.1.0",
108
"@types/debug": "^4.1.7",
119
"@types/js-yaml": "^4.0.5",
1210
"@types/node": "^14.18.43",
@@ -16,33 +14,39 @@
1614
"debug": "^4.3.3",
1715
"eslint": "^8.39.0",
1816
"eslint-import-resolver-typescript": "^3.5.5",
17+
"eslint-plugin-cypress": "^2.13.3",
1918
"eslint-plugin-import": "^2.27.5",
2019
"eslint-plugin-jest": "^27.2.1",
2120
"js-yaml": "^4.1.0",
2221
"prettier": "^2.5.1",
23-
"rollup": "^3.21.1",
2422
"semver": "^7.5.1",
2523
"ts-node": "^10.7.0",
2624
"typescript": "^4.9.5"
2725
},
2826
"scripts": {
2927
"audit": "yarn npm audit --all --recursive",
30-
"build": "yarn build:plugins && yarn typecheck:scripts && yarn typecheck:tests",
31-
"build:plugins": "yarn build:js-api && yarn build:plugins-common && yarn build:jest-plugin",
28+
"build": "yarn build:plugins && yarn typecheck:scripts && yarn build:tests",
29+
"build:plugins": "yarn build:js-api && yarn build:plugins-common && yarn build:cypress-plugin && yarn build:jest-plugin",
3230
"build:js-api": "yarn workspace @unflakable/js-api build",
33-
"build:plugins-common": "yarn workspace @unflakable/plugins-common build",
31+
"build:cypress-plugin": "yarn workspace @unflakable/cypress-plugin build",
3432
"build:jest-plugin": "yarn workspace @unflakable/jest-plugin build",
33+
"build:plugins-common": "yarn workspace @unflakable/plugins-common build",
3534
"typecheck:scripts": "tsc --noEmit --types node -p scripts",
36-
"typecheck:tests": "yarn workspace jest-integration typecheck && yarn workspace jest-integration-input typecheck",
37-
"lint": "eslint packages/**/src/**/*.{ts,js} scripts/**/*.{ts,js}",
38-
"prettier": "prettier --write packages/**/src/*.{ts,js}",
39-
"prettier:check": "prettier --check packages/**/src/*.{ts,js}",
35+
"build:tests": "yarn build:cypress-tests && yarn typecheck:jest-tests",
36+
"build:cypress-tests": "yarn workspace cypress-integration-common build && yarn workspace cypress-integration typecheck && yarn workspace cypress-integration-input typecheck && yarn workspace cypress-integration-input-esm typecheck",
37+
"typecheck:jest-tests": "yarn workspace jest-integration typecheck && yarn workspace jest-integration-input typecheck",
38+
"lint": "eslint .",
39+
"prettier": "prettier --write .",
40+
"prettier:check": "prettier --check .",
4041
"publish": "yarn workspace @unflakable/js-api npm publish --access public && yarn workspace @unflakable/jest-plugin npm publish --access public",
4142
"set-jest-version": "ts-node scripts/set-jest-version.ts"
4243
},
4344
"workspaces": [
4445
"packages/*",
45-
"packages/jest-plugin/test/integration",
46-
"packages/jest-plugin/test/integration-input"
46+
"packages/*/test/integration",
47+
"packages/*/test/integration-common",
48+
"packages/*/test/integration-input",
49+
"packages/*/test/integration-input-esm",
50+
"packages/*/test/integration-input-manual"
4751
]
4852
}

0 commit comments

Comments
 (0)