From 5ed4131720e60c38a4b0a5873f23d1c082d52d9f Mon Sep 17 00:00:00 2001
From: Jack Michaud <jack@lomz.me>
Date: Tue, 3 Jan 2023 20:51:11 -0500
Subject: [PATCH] ci: run contract tests through separate cypress command and
 add into CI

---
 .github/workflows/test-api-contract.yaml              | 10 +++++++++-
 scripts/frontend-development/run-contract-test.sh     | 11 +++++++++++
 website/cypress.config.contract.js                    |  9 +++++++++
 .../{e2e => contract}/oasst_api_contract_tests.cy.ts  |  1 +
 website/package.json                                  |  1 +
 5 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100755 scripts/frontend-development/run-contract-test.sh
 create mode 100644 website/cypress.config.contract.js
 rename website/cypress/{e2e => contract}/oasst_api_contract_tests.cy.ts (93%)

diff --git a/.github/workflows/test-api-contract.yaml b/.github/workflows/test-api-contract.yaml
index 3707f4de..a541e887 100644
--- a/.github/workflows/test-api-contract.yaml
+++ b/.github/workflows/test-api-contract.yaml
@@ -15,6 +15,9 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: "3.10"
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
 
       - run: cd oasst-shared && pip install -e .
 
@@ -22,9 +25,14 @@ jobs:
 
       - run: cd backend && pip install -r requirements.txt
 
+      - run: cd frontend && npm install
+
       - run: ./scripts/backend-development/start-mock-server.sh
 
-      - name: Run contract tests
+      - name: Run Python OasstApiClient contract tests
         run: ./scripts/oasst-shared-development/test.sh
 
+      - name: Run JavaScript OasstApiClient contract tests
+        run: ./scripts/frontend-development/run-contract-test.sh
+
       - run: ./scripts/backend-development/stop-mock-server.sh
diff --git a/scripts/frontend-development/run-contract-test.sh b/scripts/frontend-development/run-contract-test.sh
new file mode 100755
index 00000000..6bedc903
--- /dev/null
+++ b/scripts/frontend-development/run-contract-test.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+
+# switch to website directory
+pushd "$parent_path/../../website"
+
+set -xe
+
+npm run cypress:run:contract
+
+popd
diff --git a/website/cypress.config.contract.js b/website/cypress.config.contract.js
new file mode 100644
index 00000000..f4461158
--- /dev/null
+++ b/website/cypress.config.contract.js
@@ -0,0 +1,9 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  e2e: {
+    // No baseUrl here, because we don't need it for contract testing
+    baseUrl: null,
+    specPattern: "cypress/contract/*.cy.{ts,js}",
+  },
+});
diff --git a/website/cypress/e2e/oasst_api_contract_tests.cy.ts b/website/cypress/contract/oasst_api_contract_tests.cy.ts
similarity index 93%
rename from website/cypress/e2e/oasst_api_contract_tests.cy.ts
rename to website/cypress/contract/oasst_api_contract_tests.cy.ts
index 94545358..2570acec 100644
--- a/website/cypress/e2e/oasst_api_contract_tests.cy.ts
+++ b/website/cypress/contract/oasst_api_contract_tests.cy.ts
@@ -1,6 +1,7 @@
 import OasstApiClient from "src/lib/oasst_api_client";
 
 describe("Contract test for Oasst API", function () {
+  // Assumes this is running the mock server.
   const oasstApiClient = new OasstApiClient("http://localhost:8080", "test");
 
   it("can fetch a task", async () => {
diff --git a/website/package.json b/website/package.json
index c1d0c3d2..e5240727 100644
--- a/website/package.json
+++ b/website/package.json
@@ -12,6 +12,7 @@
     "build-storybook": "build-storybook",
     "cypress": "cypress open",
     "cypress:run": "cypress run",
+    "cypress:run:contract": "cypress run --config-file ./cypress.config.contract.js",
     "cypress:image-baseline": "cypress-image-diff -u",
     "fix:lint": "eslint --fix src/ --ext .js,.jsx,.ts,.tsx",
     "fix:format": "prettier --write ./src",