From 44ed1607456a9710d7249ade7627a231ce7fec03 Mon Sep 17 00:00:00 2001 From: Manos Konstantinidis Date: Sat, 7 Aug 2021 14:04:49 +0100 Subject: [PATCH 1/6] chore: Run tests on GitHub Actions --- .github/workflows/ci.yml | 41 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..c2bda260 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,41 @@ +name: CI + +on: + pull_request: + push: + branches: main + +jobs: + run-tests: + name: Checks + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Get yarn cache directory path + id: yarn-cache-dir-path + run: echo "::set-output name=dir::$(yarn cache dir)" + + - uses: actions/cache@v2 + id: yarn-cache + with: + path: ${{ steps.yarn-cache-dir-path.outputs.dir }} + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + + - name: Install Dependencies + run: yarn install --frozen-lockfile + + - name: Run ESLint + run: yarn lint + + - name: Run Prettier (Check) + run: yarn lint:prettier + + - name: Run Typechecking + run: yarn type-check + + - name: Run Jest + run: yarn test From 3edf5b1db1feceb1081d3baefcd6dc00c6339e38 Mon Sep 17 00:00:00 2001 From: Manos Konstantinidis Date: Sat, 7 Aug 2021 14:09:48 +0100 Subject: [PATCH 2/6] Temporary run on push on this branch --- .github/workflows/ci.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c2bda260..19056787 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,7 +3,9 @@ name: CI on: pull_request: push: - branches: main + branches: + - main + - migrate-gh-actions # FIXME: Remove before merging jobs: run-tests: From baa64d1ff9938da15ff1cd09463a3f3d1592afbe Mon Sep 17 00:00:00 2001 From: Manos Konstantinidis Date: Sat, 7 Aug 2021 14:20:10 +0100 Subject: [PATCH 3/6] Add an empty prettier config to run prettier automatically on VSCode Attempt to run visual regressions tests on GH Actions --- .github/workflows/ci.yml | 48 +++++++++++++++++++++++++++++++++++----- .prettierrc.js | 1 + 2 files changed, 44 insertions(+), 5 deletions(-) create mode 100644 .prettierrc.js diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 19056787..fb441bd8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,7 +5,7 @@ on: push: branches: - main - - migrate-gh-actions # FIXME: Remove before merging + - migrate-gh-actions # FIXME: Remove before merging jobs: run-tests: @@ -31,13 +31,51 @@ jobs: run: yarn install --frozen-lockfile - name: Run ESLint - run: yarn lint + run: yarn run lint - name: Run Prettier (Check) - run: yarn lint:prettier + run: yarn run lint:prettier - name: Run Typechecking - run: yarn type-check + run: yarn run type-check - name: Run Jest - run: yarn test + run: yarn run test + + run-visual-regression: + name: Visual Regression + runs-on: ubuntu-latest + needs: run-tests + + steps: + - uses: actions/checkout@v2 + + - name: Get yarn cache directory path + id: yarn-cache-dir-path + run: echo "::set-output name=dir::$(yarn cache dir)" + + - uses: actions/cache@v2 + id: yarn-cache + with: + path: ${{ steps.yarn-cache-dir-path.outputs.dir }} + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + + - name: Install Dependencies + run: yarn install --frozen-lockfile + + - name: Run ESLint + run: yarn run lint + + - name: Run Cosmos + run: yarn run cosmos & + + - name: Run Puppeteer + run: yarn run visual-regression:exec + + - name: Store image snapshots + uses: actions/upload-artifact@v2 + with: + name: image-snapshots + path: src/panel/__image_snapshots__/__diff_output__/ diff --git a/.prettierrc.js b/.prettierrc.js new file mode 100644 index 00000000..f053ebf7 --- /dev/null +++ b/.prettierrc.js @@ -0,0 +1 @@ +module.exports = {}; From a9a901073bf7821f8d08105b00750d78dc414fac Mon Sep 17 00:00:00 2001 From: Manos Konstantinidis Date: Sat, 7 Aug 2021 18:53:33 +0100 Subject: [PATCH 4/6] Use tmate for debugging Move tmate --- .github/workflows/ci.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fb441bd8..aa488e3d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -45,7 +45,7 @@ jobs: run-visual-regression: name: Visual Regression runs-on: ubuntu-latest - needs: run-tests + # needs: run-tests # FIXME: Remove comment - wait for run-tests first steps: - uses: actions/checkout@v2 @@ -65,15 +65,17 @@ jobs: - name: Install Dependencies run: yarn install --frozen-lockfile - - name: Run ESLint - run: yarn run lint - - name: Run Cosmos run: yarn run cosmos & - name: Run Puppeteer run: yarn run visual-regression:exec + - name: Setup tmate session + uses: mxschmitt/action-tmate@v3 + if: ${{ failure() }} + timeout-minutes: 15 + - name: Store image snapshots uses: actions/upload-artifact@v2 with: From 3d7936df9224cbb29d3a5220b9212962223315e3 Mon Sep 17 00:00:00 2001 From: Manos Konstantinidis Date: Sat, 7 Aug 2021 19:09:55 +0100 Subject: [PATCH 5/6] Pass default host & port for cosmos --- .circleci/config.yml | 2 +- .github/workflows/ci.yml | 18 ++++--- package.json | 3 +- src/panel/visual-regression.test.ts | 10 ++-- yarn.lock | 75 +++++++++++++++++++++++++++++ 5 files changed, 92 insertions(+), 16 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index f32b5c04..767f9bf8 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -90,7 +90,7 @@ jobs: command: yarn cosmos background: true - run: - command: sleep 5 && yarn run visual-regression:exec + command: sleep 5 && yarn run visual-regression:ci environment: PUPPETEER_EXECUTABLE_PATH: /usr/bin/google-chrome - store_artifacts: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index aa488e3d..51671281 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -45,7 +45,7 @@ jobs: run-visual-regression: name: Visual Regression runs-on: ubuntu-latest - # needs: run-tests # FIXME: Remove comment - wait for run-tests first + needs: run-tests steps: - uses: actions/checkout@v2 @@ -68,16 +68,18 @@ jobs: - name: Run Cosmos run: yarn run cosmos & - - name: Run Puppeteer - run: yarn run visual-regression:exec + - name: Wait for Cosmos + run: yarn wait-on http://localhost:5000 - - name: Setup tmate session - uses: mxschmitt/action-tmate@v3 - if: ${{ failure() }} - timeout-minutes: 15 + - name: Run Puppeteer + run: yarn run visual-regression:ci + env: + COSMOS_HOST: locahost + COSMOS_PORT: 5000 - - name: Store image snapshots + - name: Store image diffs uses: actions/upload-artifact@v2 + if: ${{ failure() }} with: name: image-snapshots path: src/panel/__image_snapshots__/__diff_output__/ diff --git a/package.json b/package.json index a17b64b1..5cd6f1a7 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "start": "electron dist/electron/main.js", "test": "jest --testPathIgnorePatterns visual-regression", "visual-regression": "./scripts/regression.sh --watch", - "visual-regression:exec": "jest --no-cache visual-regression --runInBand", + "visual-regression:ci": "jest --no-cache visual-regression --runInBand", "webpack:electron": "webpack --config webpack/webpack.electron.config.js", "webpack:extension": "webpack --config webpack/webpack.extension.config.js", "type-check": "yarn tsc" @@ -144,6 +144,7 @@ "terser-webpack-plugin": "^4.2.2", "ts-jest": "^26.3.0", "typescript": "^4.0.3", + "wait-on": "^6.0.0", "web-ext": "^5.1.0", "webpack": "^4.44.1", "webpack-cli": "^3.3.12", diff --git a/src/panel/visual-regression.test.ts b/src/panel/visual-regression.test.ts index 9bb97d28..30c5bd61 100644 --- a/src/panel/visual-regression.test.ts +++ b/src/panel/visual-regression.test.ts @@ -2,11 +2,9 @@ import { detectCosmosConfig, getFixtures2, FixtureApi } from "react-cosmos"; import { toMatchImageSnapshot } from "jest-image-snapshot"; expect.extend({ toMatchImageSnapshot }); -const fixtures = getFixtures2({ - ...detectCosmosConfig(), - hostname: process.env.COSMOS_HOST, - port: Number(process.env.COSMOS_PORT), -}).reduce<[string, FixtureApi][]>( +const cosmosConfig = detectCosmosConfig(); + +const fixtures = getFixtures2(cosmosConfig).reduce<[string, FixtureApi][]>( (p, c) => [...p, [`${c.fileName} - ${c.name}`, c]], [] ); @@ -49,7 +47,7 @@ describe.each(parallelize(fixtures))("%s", (id, { rendererUrl }) => { const element = await page.$("[data-snapshot=true]"); if (element === null) { - console.warn(`No snapshot for fixture: ${id}`); + console.info(`No snapshot for fixture: ${id}`); return; } diff --git a/yarn.lock b/yarn.lock index abfc07a1..7acb6c31 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1367,6 +1367,18 @@ resolved "https://registry.yarnpkg.com/@graphql-typed-document-node/core/-/core-3.1.0.tgz#0eee6373e11418bfe0b5638f654df7a4ca6a3950" integrity sha512-wYn6r8zVZyQJ6rQaALBEln5B1pzxb9shV5Ef97kTvn6yVGrqyXVnDqnU24MXnFubR+rZjBY9NWuxX3FB2sTsjg== +"@hapi/hoek@^9.0.0": + version "9.2.0" + resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.2.0.tgz#f3933a44e365864f4dad5db94158106d511e8131" + integrity sha512-sqKVVVOe5ivCaXDWivIJYVSaEgdQK9ul7a4Kity5Iw7u9+wBAPbX1RMSnLLmp7O4Vzj0WOWwMAJsTL00xwaNug== + +"@hapi/topo@^5.0.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@hapi/topo/-/topo-5.1.0.tgz#dc448e332c6c6e37a4dc02fd84ba8d44b9afb012" + integrity sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg== + dependencies: + "@hapi/hoek" "^9.0.0" + "@istanbuljs/load-nyc-config@^1.0.0": version "1.1.0" resolved "https://registry.yarnpkg.com/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz#fd3db1d59ecf7cf121e80650bb86712f9b55eced" @@ -1680,6 +1692,23 @@ dependencies: mkdirp "^1.0.4" +"@sideway/address@^4.1.0": + version "4.1.2" + resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.2.tgz#811b84333a335739d3969cfc434736268170cad1" + integrity sha512-idTz8ibqWFrPU8kMirL0CoPH/A29XOzzAzpyN3zQ4kAWnzmNfFmRaoMNN6VI8ske5M73HZyhIaW4OuSFIdM4oA== + dependencies: + "@hapi/hoek" "^9.0.0" + +"@sideway/formula@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@sideway/formula/-/formula-3.0.0.tgz#fe158aee32e6bd5de85044be615bc08478a0a13c" + integrity sha512-vHe7wZ4NOXVfkoRb8T5otiENVlT7a3IAiw7H5M2+GO+9CDgcVUUsX1zalAztCmwyOr2RUTGJdgB+ZvSVqmdHmg== + +"@sideway/pinpoint@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@sideway/pinpoint/-/pinpoint-2.0.0.tgz#cff8ffadc372ad29fd3f78277aeb29e632cc70df" + integrity sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ== + "@sindresorhus/is@^0.14.0": version "0.14.0" resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-0.14.0.tgz#9fb3a3cf3132328151f353de4632e01e52102bea" @@ -3066,6 +3095,13 @@ aws4@^1.8.0: resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.10.0.tgz#a17b3a8ea811060e74d47d306122400ad4497ae2" integrity sha512-3YDiu347mtVtjpyV3u5kVqQLP242c06zwDOgpeRnybmXlYYsLbtTrUBUm8i8srONt+FWobl5aibnU1030PeeuA== +axios@^0.21.1: + version "0.21.1" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.1.tgz#22563481962f4d6bde9a76d516ef0e5d3c09b2b8" + integrity sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA== + dependencies: + follow-redirects "^1.10.0" + babel-jest@^26.3.0: version "26.3.0" resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-26.3.0.tgz#10d0ca4b529ca3e7d1417855ef7d7bd6fc0c3463" @@ -6074,6 +6110,11 @@ follow-redirects@^1.0.0: dependencies: debug "^3.0.0" +follow-redirects@^1.10.0: + version "1.14.1" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.1.tgz#d9114ded0a1cfdd334e164e6662ad02bfd91ff43" + integrity sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg== + for-each@^0.3.3: version "0.3.3" resolved "https://registry.yarnpkg.com/for-each/-/for-each-0.3.3.tgz#69b447e88a0a5d32c3e7084f3f1710034b21376e" @@ -8012,6 +8053,17 @@ jetpack-id@1.0.0: resolved "https://registry.yarnpkg.com/jetpack-id/-/jetpack-id-1.0.0.tgz#2cf9fbae46d8074fc16b7de0071c8efebca473a6" integrity sha1-LPn7rkbYB0/Ba33gBxyO/rykc6Y= +joi@^17.4.0: + version "17.4.2" + resolved "https://registry.yarnpkg.com/joi/-/joi-17.4.2.tgz#02f4eb5cf88e515e614830239379dcbbe28ce7f7" + integrity sha512-Lm56PP+n0+Z2A2rfRvsfWVDXGEWjXxatPopkQ8qQ5mxCEhwHG+Ettgg5o98FFaxilOxozoa14cFhrE/hOzh/Nw== + dependencies: + "@hapi/hoek" "^9.0.0" + "@hapi/topo" "^5.0.0" + "@sideway/address" "^4.1.0" + "@sideway/formula" "^3.0.0" + "@sideway/pinpoint" "^2.0.0" + js-select@~0.6.0: version "0.6.0" resolved "https://registry.yarnpkg.com/js-select/-/js-select-0.6.0.tgz#c284e22824d5927aec962dcdf247174aefb0d190" @@ -10852,6 +10904,13 @@ rxjs@^6.6.2: dependencies: tslib "^1.9.0" +rxjs@^7.1.0: + version "7.3.0" + resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.3.0.tgz#39fe4f3461dc1e50be1475b2b85a0a88c1e938c6" + integrity sha512-p2yuGIg9S1epc3vrjKf6iVb3RCaAYjYskkO+jHIaV0IjOPlJop4UnodOoFb2xeNwlguqLYvGw1b1McillYb5Gw== + dependencies: + tslib "~2.1.0" + safe-buffer@5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1: version "5.1.2" resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" @@ -12171,6 +12230,11 @@ tslib@^1.10.0, tslib@^1.8.1, tslib@^1.9.0: resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.13.0.tgz#c881e13cc7015894ed914862d276436fa9a47043" integrity sha512-i/6DQjL8Xf3be4K/E6Wgpekn5Qasl1usyw++dAA35Ue5orEn65VIxOA+YvNNl9HV3qv70T7CNwjODHZrLwvd1Q== +tslib@~2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.1.0.tgz#da60860f1c2ecaa5703ab7d39bc05b6bf988b97a" + integrity sha512-hcVC3wYEziELGGmEEXue7D75zbwIIVUMWAVbHItGPx0ziyXxrOMQx4rQEVEV45Ut/1IotuEvwqPopzIOkDMf0A== + tsutils@^3.17.1: version "3.17.1" resolved "https://registry.yarnpkg.com/tsutils/-/tsutils-3.17.1.tgz#ed719917f11ca0dee586272b2ac49e015a2dd759" @@ -12581,6 +12645,17 @@ w3c-xmlserializer@^2.0.0: dependencies: xml-name-validator "^3.0.0" +wait-on@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/wait-on/-/wait-on-6.0.0.tgz#7e9bf8e3d7fe2daecbb7a570ac8ca41e9311c7e7" + integrity sha512-tnUJr9p5r+bEYXPUdRseolmz5XqJTTj98JgOsfBn7Oz2dxfE2g3zw1jE+Mo8lopM3j3et/Mq1yW7kKX6qw7RVw== + dependencies: + axios "^0.21.1" + joi "^17.4.0" + lodash "^4.17.21" + minimist "^1.2.5" + rxjs "^7.1.0" + walker@^1.0.7, walker@~1.0.5: version "1.0.7" resolved "https://registry.yarnpkg.com/walker/-/walker-1.0.7.tgz#2f7f9b8fd10d677262b18a884e28d19618e028fb" From 48e4dbc3188b271e891f272de4365e4198fee2a3 Mon Sep 17 00:00:00 2001 From: Manos Konstantinidis Date: Sun, 8 Aug 2021 13:01:06 +0100 Subject: [PATCH 6/6] Remove temp workaround for running on push --- .github/workflows/ci.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 51671281..86f6d45c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,9 +3,7 @@ name: CI on: pull_request: push: - branches: - - main - - migrate-gh-actions # FIXME: Remove before merging + branches: main jobs: run-tests: