ci: add e2e vercel test action

This commit adds several end-to-end tests that can be used
to test whether the Vercel Preview deployment successfully
returns the cards.

Author: rickstaa

.github/workflows/e2e-test.yml

@@ -0,0 +1,20 @@
+name: Test Deployment
+on:
+  deployment_status:
+
+jobs:
+  preview:
+    if:
+      github.event_name == 'deployment_status' &&
+      github.event.deployment_status.state == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: npm ci
+        env:
+          CI: true
+      - name: Run end-to-end tests.
+        run: npm run test:e2e
+        env:
+          VERCEL_PREVIEW_URL: ${{ github.event.deployment_status.target_url }}

jest.config.js

@@ -3,4 +3,10 @@ export default {
   transform: {},
   testEnvironment: "jsdom",
   coverageProvider: "v8",
+  testPathIgnorePatterns: ["<rootDir>/node_modules/", "<rootDir>/tests/e2e/"],
+  modulePathIgnorePatterns: ["<rootDir>/node_modules/", "<rootDir>/tests/e2e/"],
+  coveragePathIgnorePatterns: [
+    "<rootDir>/node_modules/",
+    "<rootDir>/tests/E2E/",
+  ],
 };

jest.e2e.config.js

@@ -0,0 +1,7 @@
+export default {
+  clearMocks: true,
+  transform: {},
+  testEnvironment: "jsdom",
+  coverageProvider: "v8",
+  testMatch: ["<rootDir>/tests/e2e/**/*.test.js"],
+};

package.json

@@ -8,6 +8,7 @@
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
     "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
     "test:update:snapshot": "node --experimental-vm-modules node_modules/jest/bin/jest.js -u",
+    "test:e2e": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.e2e.config.js",
     "theme-readme-gen": "node scripts/generate-theme-doc",
     "preview-theme": "node scripts/preview-theme",
     "generate-langs-json": "node scripts/generate-langs-json",

tests/e2e/e2e.test.js

@@ -0,0 +1,45 @@
+/**
+ * @file Contains end-to-end tests for the vercel preview instance.
+ */
+import { describe } from "@jest/globals";
+import axios from "axios";
+import dotenv from "dotenv";
+dotenv.config();
+
+describe("Fetch Cards", () => {
+  let VERCEL_PREVIEW_URL;
+
+  beforeAll(() => {
+    VERCEL_PREVIEW_URL = process.env.VERCEL_PREVIEW_URL;
+  });
+
+  test("retrieve stats card", async () => {
+    expect(VERCEL_PREVIEW_URL).toBeDefined();
+    await expect(
+      axios.get(`${VERCEL_PREVIEW_URL}/api?username=anuraghazra`),
+    ).resolves.not.toThrow();
+  });
+
+  test("retrieve language card", async () => {
+    expect(VERCEL_PREVIEW_URL).toBeDefined();
+    await expect(
+      axios.get(`${VERCEL_PREVIEW_URL}/api/top-langs/?username=anuraghazra`),
+    ).resolves.not.toThrow();
+  });
+
+  test("retrieve WakaTime card", async () => {
+    expect(VERCEL_PREVIEW_URL).toBeDefined();
+    await expect(
+      axios.get(`${VERCEL_PREVIEW_URL}/api/wakatime?username=willianrod`),
+    ).resolves.not.toThrow();
+  });
+
+  test("retrieve repo card", async () => {
+    expect(VERCEL_PREVIEW_URL).toBeDefined();
+    await expect(
+      axios.get(
+        `${VERCEL_PREVIEW_URL}/api/pin/?username=anuraghazra&repo=github-readme-stats`,
+      ),
+    ).resolves.not.toThrow();
+  });
+});