test: cypress setup and dropdown test

.eslintrc.js

@@ -77,6 +77,15 @@ module.exports = {
       },
     ],
     //#endregion  //*======== Import Sort ===========
+
+    // #region   //*========= Cypress files =========
+    '@typescript-eslint/no-namespace': [
+      'error',
+      {
+        allowDeclarations: true,
+      },
+    ],
+    // #endregion   //*========= Cypress files =========
   },
   globals: {
     React: true,

README.md

@@ -82,6 +82,10 @@ This project is using [conventional commits](https://www.conventionalcommits.org
 
 // TODO [cypress](https://www.cypress.io/)
 
+- **Running Cypress**
+
+  - `pnpm run cypress:open`
+
 ## Deployment
 
 // TODO [vercel](https://vercel.com/)

cypress.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  component: {
+    devServer: {
+      framework: 'next',
+      bundler: 'webpack',
+    },
+  },
+});

cypress/component/Dropdown.cy.tsx

@@ -0,0 +1,37 @@
+/* eslint-disable simple-import-sort/imports */
+
+import { Dropdown } from '@/app/ui/Dropdown';
+import '@/app/globals.css';
+
+describe('Dropdown.cy.tsx', () => {
+  const initialVal = 'Initial Val';
+  const options = ['Option 1', 'Options2'];
+
+  it('dropdown selects first option', () => {
+    const action = cy.spy().as('onDropdownChange');
+    cy.mount(<Dropdown value={initialVal} items={options} action={action} />);
+    cy.get('[data-cy="dropdown"]').click();
+    cy.get('[data-cy="dropdown-item"]').first().click();
+    cy.get('@onDropdownChange').should('have.been.calledWith', options[0]);
+  });
+
+  it('dropdown selects second option', () => {
+    const action = cy.spy().as('onDropdownChange');
+    cy.mount(<Dropdown value={initialVal} items={options} action={action} />);
+    cy.get('[data-cy="dropdown"]').click();
+    cy.get('[data-cy="dropdown-item"]').first().next().click();
+    cy.get('@onDropdownChange').should('have.been.calledWith', options[1]);
+  });
+
+  it('dropdown with no items and close dropdown', () => {
+    const action = cy.spy().as('onDropdownChange');
+    cy.mount(<Dropdown value={initialVal} items={[]} action={action} />);
+    cy.get('[data-cy="dropdown"]').click();
+    cy.get('[data-cy="dropdown-item"]').should('not.exist');
+    cy.get('@onDropdownChange').should('not.have.been.calledWith', options[0]);
+    cy.get('@onDropdownChange').should('not.have.been.calledWith', options[1]);
+
+    // Outside click
+    cy.get('body').click();
+  });
+});

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "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/component-index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <title>Components App</title>
+    <!-- Used by Next.js to inject CSS. -->
+    <div id="__next_css__DO_NOT_USE__"></div>
+  </head>
+  <body>
+    <div data-cy-root></div>
+  </body>
+</html>

cypress/support/component.ts

@@ -0,0 +1,39 @@
+// ***********************************************************
+// This example support/component.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
+// ***********************************************************
+
+/* eslint-disable simple-import-sort/imports */
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+// require('./commands') // Alternatively you can use CommonJS syntax:
+
+import { mount } from 'cypress/react18';
+
+// Augment the Cypress namespace to include type definitions for
+// your custom command.
+// Alternatively, can be defined in cypress/support/component.d.ts
+// with a <reference path="./component" /> at the top of your spec.
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      mount: typeof mount;
+    }
+  }
+}
+
+Cypress.Commands.add('mount', mount);
+
+// Example use:
+// cy.mount(<MyComponent />)

package.json

@@ -18,7 +18,8 @@
     "release": "release-it",
     "release-dry": "release-it --dry-run",
     "start": "next start",
-    "typecheck": "tsc --pretty --noEmit --incremental false"
+    "typecheck": "tsc --pretty --noEmit --incremental false",
+    "cypress:open": "cypress open"
   },
   "dependencies": {
     "axios": "latest",
@@ -41,6 +42,7 @@
     "@typescript-eslint/eslint-plugin": "latest",
     "@typescript-eslint/parser": "latest",
     "autoprefixer": "latest",
+    "cypress": "latest",
     "daisyui": "latest",
     "eslint": "latest",
     "eslint-config-next": "latest",