-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: David Edler <david.edler@canonical.com>
- Loading branch information
Showing
20 changed files
with
1,806 additions
and
903 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| name: Test coverage | ||
| on: pull_request | ||
|
|
||
| jobs: | ||
| e2e-coverage: | ||
| name: e2e-test-coverage | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| job_status: ${{job.status}} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Install Dotrun | ||
| run: | | ||
| sudo pip3 install dotrun | ||
| - name: Restore cached keys | ||
| uses: actions/cache/restore@v3 | ||
| with: | ||
| path: keys | ||
| key: keys-folder | ||
|
|
||
| - name: Install LXD-UI dependencies | ||
| run: | | ||
| set -x | ||
| sudo chmod 0777 ../lxd-ui | ||
| dotrun install | ||
| - name: Run LXD-UI | ||
| env: | ||
| ENVIRONMENT: devel | ||
| PORT: 8407 | ||
| LXD_UI_BACKEND_IP: 172.17.0.1 | ||
| run: | | ||
| dotrun & | ||
| curl --head --fail --retry-delay 2 --retry 100 --retry-connrefused --insecure https://localhost:8407 | ||
| - name: Set keys permissions | ||
| run: | | ||
| set -x | ||
| sudo chmod -R 0666 keys | ||
| sudo chmod 0777 keys | ||
| - name: Save keys | ||
| uses: actions/cache/save@v3 | ||
| with: | ||
| path: keys | ||
| key: keys-folder | ||
|
|
||
| - name: Install LXD | ||
| uses: canonical/setup-lxd@v0.1.1 | ||
| with: | ||
| channel: "latest/edge" | ||
|
|
||
| - name: Setup LXD | ||
| shell: bash | ||
| run: | | ||
| set -x | ||
| sudo lxc config set core.https_address "[::]:8443" | ||
| sudo lxc config trust add keys/lxd-ui.crt | ||
| sudo lxc config set cluster.https_address "127.0.0.1" | ||
| sudo lxc cluster enable local | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
|
|
||
| - name: Install Playwright Browser | ||
| run: npx playwright install --with-deps chromium | ||
|
|
||
| - name: Run tests with coverage | ||
| run: yarn test-e2e-coverage | ||
|
|
||
| - name: Upload coverage report | ||
| if: always() | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: lxd-coverage | ||
| path: coverage/playwright-report | ||
| retention-days: 1 | ||
|
|
||
| publish-coverage-report: | ||
| name: publish-coverage-report | ||
| runs-on: ubuntu-latest | ||
| needs: e2e-coverage | ||
| continue-on-error: true | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: gh-pages | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Download coverage report artifact | ||
| uses: actions/download-artifact@master | ||
| with: | ||
| name: lxd-coverage | ||
| - name: Unzip artifact and cleanup | ||
| run: | | ||
| ls -lah | ||
| find / | ||
| rm -rf coverage | ||
| mkdir coverage | ||
| unzip lxd-coverage.zip -d coverage | ||
| rm -rf lxd-coverage.zip | ||
| # user git configs are needed for git commands to work | ||
| # actual authentication is done using secrets.GITHUB_TOKEN with write permission | ||
| - name: Set Git User | ||
| run: | | ||
| git config --global user.email "github-action@example.com" | ||
| git config --global user.name "GitHub Action" | ||
| - name: Push HTML Report | ||
| timeout-minutes: 3 | ||
| run: | | ||
| git add . | ||
| git commit -m "workflow: update coverage report" | ||
| # In case of another action job pushing to gh-pages while we are rebasing for the current job | ||
| while true; do | ||
| git pull --rebase | ||
| if [ $? -ne 0 ]; then | ||
| echo "Failed to rebase. Please review manually." | ||
| exit 1 | ||
| fi | ||
| git push | ||
| if [ $? -eq 0 ]; then | ||
| echo "Successfully pushed HTML report to repo." | ||
| exit 0 | ||
| fi | ||
| done | ||
| - name: Output Report URL as Worfklow Annotation | ||
| run: | | ||
| FULL_HTML_REPORT_URL=https://canonical.github.io/lxd-ui/coverage | ||
| echo "::notice title=Published Playwright Test Report::$FULL_HTML_REPORT_URL" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,5 +79,6 @@ dist/ | |
| /test-results/ | ||
| /playwright-report/ | ||
| /playwright/.cache/ | ||
| /coverage | ||
|
|
||
| haproxy-local.cfg | ||
| haproxy-local.cfg | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import { Page } from "@playwright/test"; | ||
| import fs from "fs"; | ||
| import { fromSource, removeMapFileComments } from "convert-source-map"; | ||
| import v8ToIstanbul from "v8-to-istanbul"; | ||
| import * as crypto from "crypto"; | ||
| import { CoverageMapData } from "istanbul-lib-coverage"; | ||
|
|
||
| export const startCoverage = async ( | ||
| page: Page, | ||
| hasCoverage: boolean, | ||
| ): Promise<void> => { | ||
| if (!hasCoverage) { | ||
| return; | ||
| } | ||
| await page.coverage.startJSCoverage(); | ||
| }; | ||
|
|
||
| export const finishCoverage = async ( | ||
| page: Page, | ||
| hasCoverage: boolean, | ||
| ): Promise<void> => { | ||
| if (!hasCoverage) { | ||
| return; | ||
| } | ||
| const coverage = await page.coverage.stopJSCoverage(); | ||
| for (const entry of coverage) { | ||
| if (entry.url.endsWith(".css")) { | ||
| continue; | ||
| } | ||
| if (entry.url.includes("@vite")) { | ||
| continue; | ||
| } | ||
| if (entry.url.includes("spice")) { | ||
| continue; | ||
| } | ||
| const fileMatcher = entry.url.match(/http(s)*:\/\/.*:8407\/(?<file>.*)/); | ||
| if (!fileMatcher?.groups) { | ||
| continue; | ||
| } | ||
| const path = fileMatcher.groups.file; | ||
| const source = removeMapFileComments(entry.source ?? ""); | ||
| const sourceMap = fromSource(entry.source ?? "") as { sourcemap: string }; | ||
|
|
||
| const converter = v8ToIstanbul(path, 0, { | ||
| source, | ||
| sourceMap, | ||
| }); | ||
| await converter.load(); | ||
| converter.applyCoverage(entry.functions); | ||
| const istanbulCoverage = converter.toIstanbul() as CoverageMapData & { | ||
| [key: string]: { _coverageSchema: string }; | ||
| }; | ||
|
|
||
| const generateUUID = (): string => { | ||
| return crypto.randomBytes(16).toString("hex"); | ||
| }; | ||
|
|
||
| // a unique name for this report | ||
| const uuid = generateUUID(); | ||
|
|
||
| // _coverageSchema is mandatory for nyc to parse the report | ||
| Object.entries(istanbulCoverage).forEach(([key]) => { | ||
| istanbulCoverage[key]["_coverageSchema"] = uuid; | ||
| }); | ||
|
|
||
| const outDir = "coverage/playwright"; | ||
| if (!fs.existsSync(outDir)) { | ||
| fs.mkdirSync(outDir, { recursive: true }); | ||
| } | ||
| fs.writeFileSync( | ||
| `${outDir}/playwright_coverage_${uuid}.json`, | ||
| JSON.stringify(istanbulCoverage), | ||
| ); | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,23 @@ | ||
| import { test as base } from "@playwright/test"; | ||
| import { finishCoverage, startCoverage } from "./coverage"; | ||
|
|
||
| export type LxdVersions = "5.0-stable" | "latest-edge"; | ||
| export type TestOptions = { | ||
| lxdVersion: LxdVersions; | ||
| hasCoverage: boolean; | ||
| }; | ||
|
|
||
| export const test = base.extend<TestOptions>({ | ||
| lxdVersion: ["latest-edge", { option: true }], | ||
| hasCoverage: [false, { option: true }], | ||
| }); | ||
|
|
||
| test.beforeEach(async ({ page, hasCoverage }) => { | ||
| await startCoverage(page, hasCoverage); | ||
| }); | ||
|
|
||
| test.afterEach(async ({ page, hasCoverage }) => { | ||
| await finishCoverage(page, hasCoverage); | ||
| }); | ||
|
|
||
| export const expect = test.expect; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.