Merge pull request #21 from StaticJsCMS/feature/cypress

feat: add cypress test to ensure admin page is loading

Author: KaneFreeman

cypress.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  projectId: "63isgs",
+  fixturesFolder: false,
+
+  e2e: {
+    baseUrl: "http://localhost:3000",
+    supportFile: false,
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+});

cypress/e2e/admin.cy.ts

@@ -0,0 +1,8 @@
+export {};
+
+describe("admin page", () => {
+  it("loads", () => {
+    cy.visit("/admin");
+    cy.contains("button", "Login with Netlify Identity").should("be.visible");
+  });
+});

netlify.toml

@@ -1,6 +1,17 @@
 [build]
-  publish = ".next"
-  command = "npm run build"
+publish = ".next"
+command = "npm run build"
+
+[build.environment]
+# cache Cypress binary in local "node_modules" folder
+# so Netlify caches it
+CYPRESS_CACHE_FOLDER = "./node_modules/CypressBinary"
+
+[[plugins]]
+package = "@netlify/plugin-nextjs"
 
 [[plugins]]
-  package = "@netlify/plugin-nextjs"
+# runs Cypress tests against the deployed URL
+package = "netlify-plugin-cypress"
+  [plugins.inputs]
+  record = true

package.json

@@ -37,9 +37,11 @@
     "@types/js-yaml": "4.0.5",
     "@types/node": "18.14.5",
     "@types/react": "18.0.28",
+    "cypress": "^12.7.0",
     "eslint-config-next": "13.2.3",
     "jest": "29.4.3",
     "js-yaml-loader": "1.2.2",
+    "netlify-plugin-cypress": "^2.2.1",
     "ts-jest": "29.0.5",
     "typescript": "4.9.5"
   }

tsconfig.json

@@ -17,7 +17,8 @@
     "resolveJsonModule": true,
     "isolatedModules": true,
     "jsx": "preserve",
-    "incremental": true
+    "incremental": true,
+    "types": ["cypress", "node"]
   },
   "exclude": [
     "node_modules"