Merge pull request actions#22 from FernandVEYRIER/feat/cypress-defaul…

…t-conf

feat: cypress default configuration

.github/workflows/cypress-testing.yml

@@ -0,0 +1,37 @@
+name: Run Cypress testing suite
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - development
+ pull_request:
+
+jobs:
+ cypress-run:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/setup-node@v4
+ with:
+ node-version: 20.10.0
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Cypress run
+ uses: cypress-io/github-action@v6
+ with:
+ build: yarn run build
+ start: yarn start
+ env:
+ CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ - uses: actions/upload-artifact@v4
+ if: failure()
+ with:
+ name: cypress-screenshots
+ path: cypress/screenshots
+ if-no-files-found: ignore
+ - uses: actions/upload-artifact@v4
+ if: failure()
+ with:
+ name: cypress-videos
+ path: cypress/videos
+ if-no-files-found: ignore

.gitignore

@@ -10,3 +10,4 @@ node_modules
 static/dist
 coverage
 junit.xml
+cypress/screenshots

cypress.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+ e2e: {
+ setupNodeEvents() {
+ // implement node event listeners here
+ },
+ experimentalStudio: true,
+ baseUrl: "http://localhost:8080",
+ },
+});

cypress/e2e/main.cy.ts

@@ -0,0 +1,11 @@
+describe("Homepage tests", () => {
+ it("Console is cleared of errors and warnings", () => {
+ cy.visit("/", {
+ onBeforeLoad(win) {
+ cy.stub(win.console, "error").as("consoleError");
+ },
+ });
+ cy.get("@consoleError").should("not.be.called");
+ cy.get("body").should("exist");
+ });
+});

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+ "name": "Using fixtures to represent data",
+ "email": "hello@cypress.io",
+ "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+// namespace Cypress {
+// interface Chainable {
+// login(email: string, password: string): Chainable<void>
+// drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+// dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+// visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+// }
+// }
+// }

cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import "./commands";
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package.json

@@ -18,7 +18,9 @@
  "knip": "knip",
  "knip-ci": "knip --no-exit-code --reporter json",
  "prepare": "husky install",
- "test": "jest --setupFiles dotenv/config --coverage"
+ "test": "jest --setupFiles dotenv/config --coverage",
+ "cy:open": "cypress open",
+ "cy:run": "cypress run"
  },
  "keywords": [
  "typescript",
@@ -42,6 +44,7 @@
  "@typescript-eslint/eslint-plugin": "^7.0.1",
  "@typescript-eslint/parser": "^7.0.1",
  "cspell": "^8.4.0",
+ "cypress": "13.6.6",
  "esbuild": "^0.20.1",
  "eslint": "^8.56.0",
  "eslint-config-prettier": "^9.1.0",

tests/main.test.ts

@@ -1,6 +1,7 @@
 import { db } from "./__mocks__/db";
 import { server } from "./__mocks__/node";
 import usersGet from "./__mocks__/users-get.json";
+import { expect, describe, beforeAll, beforeEach, afterAll, afterEach, it } from "@jest/globals";
 
 beforeAll(() => server.listen());
 afterEach(() => server.resetHandlers());