chore: adding cypress integration tests (faker-js#240)

Co-authored-by: Daniel Bannert <[email protected]>
Co-authored-by: Shinigami92 <[email protected]>

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
 
 jobs:
-  test:
+  unit-test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -20,7 +20,7 @@ jobs:
             node_version: 16
       fail-fast: false
 
-    name: 'Build & Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
+    name: 'Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -45,6 +45,24 @@ jobs:
       - name: Test
         run: pnpm run test
 
+  e2e-test:
+    runs-on: ubuntu-latest
+    name: 'E2E Doc Test: node-16, ubuntu-latest'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 6
+
+      - name: Install deps
+        run: pnpm install
+
+      - name: Run E2E
+        run: pnpm run docs:build:ci
+
   lint:
     runs-on: ubuntu-latest
     name: 'Lint: node-16, ubuntu-latest'

cypress.json

@@ -0,0 +1,11 @@
+{
+  "video": false,
+  "e2e": {
+    "baseUrl": "http://localhost:5000",
+    "integrationFolder": "cypress/e2e",
+    "testFiles": "**/*.cy.*",
+    "pluginsFile": false,
+    "supportFile": false,
+    "fixturesFolder": false
+  }
+}

cypress/e2e/smoke.cy.ts

@@ -0,0 +1,11 @@
+describe('Smoke Test', () => {
+  it('compiles the guide page', () => {
+    cy.visit('/guide/');
+    cy.contains('Getting Started');
+  });
+
+  // it('compiles the playground page', () => {
+  //   cy.visit('/playground/');
+  //   cy.contains('Playground under construction');
+  // });
+});

cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "ES5",
+    "lib": ["ES5", "DOM"],
+    "types": ["cypress"]
+  },
+  "include": ["**/*.ts"]
+}

package.json

@@ -67,7 +67,11 @@
     "format": "prettier --write .",
     "lint": "echo 'TODO eslint'",
     "test": "vitest",
-    "coverage": "vitest run --coverage"
+    "coverage": "vitest run --coverage",
+    "cypress": "cypress",
+    "docs:test:e2e:ci": "run-s docs:build:ci docs:test:e2e:run",
+    "docs:test:e2e:run": "run-p --race docs:serve \"cypress run\"",
+    "docs:test:e2e:open": "run-p --race docs:serve \"cypress open\""
   },
   "simple-git-hooks": {
     "pre-commit": "npx lint-staged --concurrent false",
@@ -85,6 +89,7 @@
     "@vitest/ui": "~0.1.24",
     "c8": "~7.11.0",
     "conventional-changelog-cli": "~2.2.2",
+    "cypress": "~9.3.1",
     "esbuild": "~0.14.13",
     "eslint": "^6.5.1",
     "esno": "~0.13.0",