feat: add CI workflow for tests with Allure v3 reporting (#72)

* feat: add CI workflow for tests with Allure reporting

- Created a GitHub Actions workflow to run tests on pull requests to the main branch.
- Integrated Allure reporting for test results.
- Added configuration for Allure report generation in allurerc.mjs.
- Set up Vitest configuration to manage test projects and reporting.
- Introduced shared Vitest configuration for consistent test setup across projects.

* feat: add quality gate configuration to Allure report

* feat: update report name in Allure configuration to "Repository Tests"

* feat: add build step before running tests in CI workflow

* feat: update Allure reporting configuration and add css-js-gen tests

* feat: improve testing cases and implement Allure report

* feat: restructure CI workflows for Allure reporting and remove deprecated configuration

Author: Adammatthiesen

.changeset/blue-trams-serve.md

@@ -0,0 +1,5 @@
+---
+"css-js-gen": patch
+---
+
+Improve testing cases and implement allure report

.github/workflows/ci-pull-request.yml

@@ -59,16 +59,4 @@ jobs:
     secrets: inherit
     uses: withstudiocms/automations/.github/workflows/preview-pr.yml@f286863f2f7a414794b9a10ee6f1cadbb07f722f # main
     with:
-      build-cmd: "pnpm ci:build"
-
-  css-js-gen-tests:
-    name: Run css-js-gen Tests
-    if: github.event_name == 'pull_request'
-    permissions:
-      contents: read
-      pull-requests: write
-    uses: withstudiocms/automations/.github/workflows/run-pnpm.yml@f286863f2f7a414794b9a10ee6f1cadbb07f722f # main
-    secrets: inherit
-    with:
-      commands: > 
-        ["ci:test:css-js-gen"]
+      build-cmd: "pnpm ci:build"

.github/workflows/ci-testing-main.yml

@@ -0,0 +1,43 @@
+name: Tests with Allure Report
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  checks: write
+  contents: write
+  pull-requests: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Apollo Git Bot
+        id: bot-token
+        uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
+        with:
+          app-id: ${{ secrets.STUDIOCMS_GIT_BOT_APP_ID }}
+          private-key: ${{ secrets.STUDIOCMS_GIT_BOT_PRIVATE_KEY }}
+
+      - name: Checkout Repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+          token: ${{ steps.bot-token.outputs.token }}
+
+      - name: Install Tools & Dependencies
+        uses: withstudiocms/automations/.github/actions/install@f286863f2f7a414794b9a10ee6f1cadbb07f722f # main
+
+      - name: Build packages
+        run: pnpm ci:build
+
+      - name: Run tests and generate report
+        run: pnpm ci:test
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+        with:
+          github_token: ${{ steps.bot-token.outputs.token }}
+          publish_branch: test-report
+          publish_dir: ./allure-report

.github/workflows/ci-testing-pr.yml

@@ -0,0 +1,41 @@
+name: Tests with Allure Report
+
+on:
+  pull_request:
+    branches: [main]
+
+permissions:
+  pull-requests: write
+  checks: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Apollo Git Bot
+        id: bot-token
+        uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
+        with:
+          app-id: ${{ secrets.STUDIOCMS_GIT_BOT_APP_ID }}
+          private-key: ${{ secrets.STUDIOCMS_GIT_BOT_PRIVATE_KEY }}
+
+      - name: Checkout Repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+          token: ${{ steps.bot-token.outputs.token }}
+
+      - name: Install Tools & Dependencies
+        uses: withstudiocms/automations/.github/actions/install@f286863f2f7a414794b9a10ee6f1cadbb07f722f # main
+
+      - name: Build packages
+        run: pnpm ci:build
+
+      - name: Run tests and generate report
+        run: pnpm ci:test
+
+      - name: Run Allure Action
+        uses: allure-framework/allure-action@c24234151c027cfee99e00eb6ec2dac1eb350414 # v0.6.6
+        with:
+          report-directory: "./allure-report"
+          github-token: ${{ steps.bot-token.outputs.token }}

.gitignore

@@ -2,4 +2,10 @@ node_modules
 .npmrc
 .tsbuildinfo
 build
-dist
+dist
+
+# allure testing
+allure-results
+allure-report
+history.jsonl
+junit-report.xml

.vscode/settings.json

@@ -26,6 +26,7 @@
 	},
 	"cSpell.words": [
 		"Adammatthiesen",
+		"allurereport",
 		"astrojs",
 		"automations",
 		"codepaths",
@@ -41,6 +42,7 @@
 		"mondeja",
 		"noline",
 		"omglookatthis",
+		"peaceiris",
 		"recompiles",
 		"rehype",
 		"rgba",

allurerc.mjs

@@ -0,0 +1,36 @@
+import { defineConfig } from "allure";
+
+export default defineConfig({
+	name: "Allure Report",
+	output: "./allure-report",
+	historyPath: "./history.jsonl",
+	appendHistory: true,
+	qualityGate: {
+		rules: [
+			{
+				maxFailures: 0,
+				fastFail: true,
+			},
+		],
+	},
+	plugins: {
+		"css-js-gen": {
+			import: "@allurereport/plugin-awesome",
+			options: {
+				reportName: "css-js-gen Tests",
+				singleFile: false,
+				reportLanguage: "en",
+				open: false,
+				publish: true,
+				groupBy: ["parentSuite", "suite", "subSuite"],
+				filter: ({ labels }) =>
+					labels.find(({ name, value }) => name === "parentSuite" && value === "css-js-gen Tests"),
+			},
+		},
+		log: {
+			options: {
+				groupBy: "none",
+			},
+		},
+	},
+});

package.json

@@ -25,22 +25,29 @@
 
 		"build": "pnpm --filter './packages/*' build",
 		"dev": "pnpm --filter './packages/*' --filter playground -r --parallel dev",
-		"test": "pnpm --filter './packages/*' test",
+		"test": "vitest",
 
 		"ci:install": "pnpm install --frozen-lockfile",
 		"ci:version": "changeset version",
 		"ci:publish": "changeset publish",
 		"ci:build": "pnpm build",
 		"ci:lint": "pnpm lint",
-		"ci:test:css-js-gen": "pnpm --filter css-js-gen test"
+		"ci:test": "allure run -- pnpm test",
+
+		"allure:view": "allure open allure-report"
 	},
 	"devDependencies": {
+		"@allurereport/plugin-awesome": "^3.1.0",
 		"@biomejs/biome": "^2.3.14",
 		"@changesets/cli": "^2.29.8",
 		"@changesets/config": "^3.1.2",
 		"@changesets/changelog-github": "^0.5.2",
 		"@types/node": "catalog:",
 		"@vitest/ui": "^4.0.18",
+		"@vitest/runner": "^4.0.18",
+		"allure": "^3.1.0",
+		"allure-js-commons": "^3.4.5",
+		"allure-vitest": "^3.4.5",
 		"tsdown": "^0.20.3",
 		"typescript": "^5.9.3",
 		"pkg-pr-new": "^0.0.63",