API e2e tests using Cypress. Github Action workflow.

.github/workflows/cypress.yml

@@ -0,0 +1,17 @@
+name: Cypress Tests
+
+on: push
+
+jobs:
+  cypress-run:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      # Install npm dependencies, cache them correctly
+      # and run all Cypress tests
+      - name: Cypress run
+        uses: cypress-io/github-action@v6
+        with:
+          build: yarn build
+          start: yarn start

README.md

@@ -1,12 +1,14 @@
 # Open Secrets PowerMapper
 
+[![Tests](https://github.com/OpenUpSA/open-secrets-powermapper/actions/workflows/cypress.yml/badge.svg)](https://github.com/OpenUpSA/open-secrets-powermapper/actions/workflows/cypress.yml)
+
 by [OpenUp](https://OpenUp.org.za).
 
 ## Development
 
 ```
 cp env.example .env
-``` 
+```
 
 Modify `.env` with real values.
 
@@ -17,8 +19,7 @@ yarn dev
 ## Deployment
 
 Deployed on Netlify:
-
-https://roaring-cactus-a582ea.netlify.app/
 
+https://roaring-cactus-a582ea.netlify.app/
 
-Automatic deployment of `main` and preview deployments of pull-requests.
+Automatic deployment of `main` and preview deployments of pull-requests.

cypress.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  e2e: {
+    supportFile: false,
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+});

cypress/e2e/api-entity-info.cy.ts

@@ -0,0 +1,10 @@
+describe("Test Entity Info API endpoint", () => {
+  it("passes", () => {
+    cy.request("http://localhost:3000/api/entity-info?id=rec2SisdBnuMAZZJb").as(
+      "entityInfo"
+    );
+    cy.get("@entityInfo").should((response) => {
+      expect(response.body).to.have.property("name");
+    });
+  });
+});

cypress/e2e/api-power-stations.cy.ts

@@ -0,0 +1,8 @@
+describe("Test Power Stations API endpoint", () => {
+  it("passes", () => {
+    cy.request("http://localhost:3000/api/power-stations").as("powerStations");
+    cy.get("@powerStations").should((response) => {
+      expect(response.body).to.have.property("powerStations");
+    });
+  });
+});

package.json

@@ -6,7 +6,8 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint"
+    "lint": "next lint",
+    "test": "cypress run"
   },
   "dependencies": {
     "@emotion/cache": "^11.11.0",
@@ -30,6 +31,7 @@
     "@types/node": "^20",
     "@types/react": "^18",
     "@types/react-dom": "^18",
+    "cypress": "^13.13.1",
     "eslint": "^8",
     "eslint-config-next": "14.2.3",
     "typescript": "^5"