CI: Add Test reports

remileduc · Nov 9, 2023 · 809ca26 · 809ca26
1 parent 66318fc
commit 809ca26
Show file tree

Hide file tree

Showing 7 changed files with 123 additions and 42 deletions.
diff --git a/.github/workflows/_build-lint.yaml b/.github/workflows/_build-lint.yaml
@@ -7,8 +7,11 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: 📥 Install
-        uses: remileduc/vcards-io/.github/actions/package-install@${{ github.ref_name }}
+        uses: ./.github/actions/package-install
 
       - name: Build
         run: npm run build

diff --git a/.github/workflows/_tests.yaml b/.github/workflows/_tests.yaml
@@ -14,4 +14,24 @@ jobs:
         uses: ./.github/actions/package-install
 
       - name: Run tests
-        run: npm test
+        run: npm run testci
+        env:
+          JEST_JUNIT_OUTPUT_DIR: coverage/reports
+          JEST_JUNIT_OUTPUT_NAME: jest-junit.xml
+          JEST_JUNIT_ANCESTOR_SEPARATOR: " > "
+          JEST_JUNIT_UNIQUE_OUTPUT_NAME: false
+          JEST_JUNIT_SUITE_NAME: "{filepath}"
+          JEST_JUNIT_CLASSNAME: "{classname}"
+          JEST_JUNIT_TITLE: "{title}"
+
+      - name: Report test results
+        if: success() || failure()
+        uses: dorny/test-reporter@v1
+        with:
+          name: Jest Tests
+          path: coverage/reports/jest-*.xml
+          reporter: jest-junit
+          list-suites: failed
+          list-tests: failed
+          fail-on-error: false
+          token: ${{ github.token  }}
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,6 +1,19 @@
 name: ⚙️ CI
 
-on: push
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  actions: read
+  checks: write
 
 jobs:
   call-build-lint:

diff --git a/lib/VcardIO.ts b/lib/VcardIO.ts
@@ -382,7 +382,7 @@ export class VCardIO
 	 */
 	fromString(str: string)
 	{
-		const vcard = stringutils.unfold(str).split("\r\n").filter((f) => f.length !== 0 && !/^\s+$/.test(f));
+		var vcard = stringutils.unfold(str).split("\r\n").filter((f) => f.length !== 0 && !/^\s+$/.test(f));
 		if (vcard.length < 3 || vcard.shift()?.toUpperCase() !== "BEGIN:VCARD" || vcard.pop()?.toUpperCase() !== "END:VCARD")
 			throw new Error("Invalid vCard: missing keywords");
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,39 +1,41 @@
 {
-  "name": "vcards-io",
-  "version": "0.1.0",
-  "description": "vCard reader and writer - represents a vCard as a JSON object that can be exported",
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "prepublish": "npm run build",
-    "build": "tsc",
-    "clean": "tsc --build --clean",
-    "test": "jest",
-	"lint": "eslint lib/",
-    "doc": "typedoc --plugin @mxssfd/typedoc-theme --theme my-theme --cleanOutputDir --includeVersion --readme ./README.md --out ./docs/ ./lib/index.ts"
-  },
-  "keywords": [
-    "vCard",
-    "vCards",
-	"vcf",
-    "contacts"
-  ],
-  "author": {
-    "name": "Rémi Ducceschi",
-    "url": "https://github.com/remileduc",
-    "email": "[email protected]"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "@mxssfd/typedoc-theme": "^1.1.3",
-    "@types/jest": "^29.5.7",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
-    "eslint": "^8.53.0",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
-    "typedoc": "^0.25.3",
-    "typescript": "^5.2.2"
-  }
+	"name": "vcards-io",
+	"version": "0.1.0",
+	"description": "vCard reader and writer - represents a vCard as a JSON object that can be exported",
+	"type": "module",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"prepublish": "npm run build",
+		"build": "tsc",
+		"clean": "tsc --build --clean",
+		"test": "jest",
+		"testci": "jest --ci --testResultsProcessor='jest-junit'",
+		"lint": "eslint lib/",
+		"doc": "typedoc --plugin @mxssfd/typedoc-theme --theme my-theme --cleanOutputDir --includeVersion --readme ./README.md --out ./docs/ ./lib/index.ts"
+	},
+	"keywords": [
+		"vCard",
+		"vCards",
+		"vcf",
+		"contacts"
+	],
+	"author": {
+		"name": "Rémi Ducceschi",
+		"url": "https://github.com/remileduc",
+		"email": "[email protected]"
+	},
+	"license": "MIT",
+	"devDependencies": {
+		"@mxssfd/typedoc-theme": "^1.1.3",
+		"@types/jest": "^29.5.7",
+		"@typescript-eslint/eslint-plugin": "^6.10.0",
+		"@typescript-eslint/parser": "^6.10.0",
+		"eslint": "^8.53.0",
+		"jest": "^29.7.0",
+		"jest-junit": "^16.0.0",
+		"ts-jest": "^29.1.1",
+		"typedoc": "^0.25.3",
+		"typescript": "^5.2.2"
+	}
 }
diff --git a/tests/stringutils.test.ts b/tests/stringutils.test.ts
@@ -15,7 +15,7 @@ describe("ICaseMap", () => {
 		const icaseMap = new stringutils.ICaseMap<string>();
 		icaseMap.set("KEY1", "Value1");
 
-		expect(icaseMap.has("key1")).toBe(true);
+		expect(icaseMap.has("key")).toBe(true);
 		expect(icaseMap.has("Key1")).toBe(true);
 		expect(icaseMap.has("nonExistentKey")).toBe(false);
 	});