Ajoute des tests navigateur automatisé (#593)

* install cypress and setup example tests

* add placeholder account spec file

* add tests to write

* add test instructions in readme

* test audit creation

---------

Co-authored-by: Quentin Bellanger <[email protected]>

README.md

@@ -1,10 +1,27 @@
 # Ara
 
-Réaliser des audits d'accessibilité numérique sur la base du référentiel général d'amélioration de l'accessibilité (RGAA). 
+Réaliser des audits d'accessibilité numérique sur la base du référentiel général d'amélioration de l'accessibilité (RGAA).
 Générer et consulter les rapports de ces audits et les déclarations d'accessibilité.
 
 ## Développement
 
 - La partie front est une application Vue.js 3 avec Typescript. [Voir les instructions de développement](https://github.com/DISIC/Ara/blob/main/confiture-web-app/README.md).
 - La partie back est une API Nest.js et utilise une base de données PostgreSQL. [Voir les instructions de développement](https://github.com/DISIC/Ara/blob/main/confiture-rest-api/README.md).
 
+## Tests
+
+[Cypress](https://www.cypress.io/) est utilisé pour lancer des tests end-to-end (e2e) dans un navigateur pour reproduire le comportement des utilisateurs.
+
+Les tests peuvent être lancés de 2 manières :
+
+- Via l’application Cypress avec :
+
+  ```sh
+  yarn cypress open
+  ```
+
+- Via le terminal avec :
+
+  ```sh
+  yarn cypress run
+  ```

confiture-web-app/src/components/audit/AuditGeneralInformationsForm.vue

@@ -194,6 +194,7 @@ const previousRoute = usePreviousRoute();
           class="fr-btn fr-btn--tertiary-no-outline page-delete-button"
           type="button"
           :disabled="pages.length === 1"
+          data-cy="delete"
           @click="deletePage(i)"
         >
           Supprimer

cypress.config.ts

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

cypress/e2e/account.cy.ts

@@ -0,0 +1,11 @@
+describe("Account", () => {
+  // it.skip("User can create a new account", () => {});
+  // it.skip("User can sign in with their account", () => {});
+  // it.skip("User can update their user profile", () => {});
+  // it.skip("User can update their password", () => {});
+  // it.skip("User can reset their password", () => {});
+  // it.skip("User can update their email address", () => {});
+  // it.skip("User can delete their account from Ara", () => {});
+  // it.skip("User can access all their audits", () => {});
+  // it.skip("User profile info are prefilled on new audits", () => {});
+});

cypress/e2e/audit.cy.ts

@@ -0,0 +1,67 @@
+import * as auditJson from "../fixtures/audit.json";
+
+describe("Audit", () => {
+  it("User can create an audit", () => {
+    function fillPageField(pageIndex: number, field: string, content: string) {
+      cy.contains("Page " + pageIndex)
+        .parent()
+        .parent()
+        .contains(field)
+        .parent()
+        .find("input")
+        .type(content);
+    }
+
+    cy.visit("http://localhost:3000");
+
+    // Navigate to new audit page
+    cy.contains("Je démarre un audit").click();
+
+    // Fill fields
+    cy.contains("Complet, de conformité").click();
+
+    cy.contains("Nom du site à auditer")
+      .parent()
+      .find("input")
+      .type(auditJson.procedureName);
+
+    fillPageField(1, "Nom de la page", auditJson.pages[0].name);
+    fillPageField(1, "URL de la page", auditJson.pages[0].url);
+
+    fillPageField(2, "Nom de la page", auditJson.pages[1].name);
+    fillPageField(2, "URL de la page", auditJson.pages[1].url);
+
+    // Delete empty pages "Supprimer" buttons
+    cy.get('[data-cy="delete"]').eq(2).click();
+    cy.get('[data-cy="delete"]').eq(2).click();
+    cy.get('[data-cy="delete"]').eq(2).click();
+    cy.get('[data-cy="delete"]').eq(2).click();
+    cy.get('[data-cy="delete"]').eq(2).click();
+
+    // Fill auditor informations
+    cy.contains("Prénom et nom (optionnel)")
+      .parent()
+      .find("input")
+      .type(auditJson.procedureAuditorName);
+
+    cy.contains("Adresse e-mail")
+      .parent()
+      .find("input")
+      .type(auditJson.procedureAuditorEmail);
+
+    // Submit new audit form
+    cy.contains("Valider les paramètres").click();
+
+    // Check user is redirect to audit overview page
+    cy.get("h1").contains(auditJson.procedureName);
+  });
+  // it.skip("User can fill an audit (status, description, recommendation, image, impact, easy to fix)", () => {});
+  // it.skip("User can check Markdown syntax", () => {});
+  // it.skip("User can complete a11y statement", () => {});
+  // it.skip("User can update notes", () => {});
+  // it.skip("User can filter criteria", () => {});
+  // it.skip("User can search criteria", () => {});
+  // it.skip("User can copy an audit", () => {});
+  // it.skip("User can delete an audit", () => {});
+  // it.skip("User can downlaod an audit", () => {});
+});

cypress/e2e/report.cy.ts

@@ -0,0 +1,4 @@
+describe("Report", () => {
+  //   it.skip("User can filter errors", () => {});
+  //   it.skip("User can download results", () => {});
+});

cypress/examples/1-getting-started/todo.cy.js

@@ -0,0 +1,143 @@
+/// <reference types="cypress" />
+
+// Welcome to Cypress!
+//
+// This spec file contains a variety of sample tests
+// for a todo list app that are designed to demonstrate
+// the power of writing tests in Cypress.
+//
+// To learn more about how Cypress works and
+// what makes it such an awesome testing tool,
+// please read our getting started guide:
+// https://on.cypress.io/introduction-to-cypress
+
+describe('example to-do app', () => {
+  beforeEach(() => {
+    // Cypress starts out with a blank slate for each test
+    // so we must tell it to visit our website with the `cy.visit()` command.
+    // Since we want to visit the same URL at the start of all our tests,
+    // we include it in our beforeEach function so that it runs before each test
+    cy.visit('https://example.cypress.io/todo')
+  })
+
+  it('displays two todo items by default', () => {
+    // We use the `cy.get()` command to get all elements that match the selector.
+    // Then, we use `should` to assert that there are two matched items,
+    // which are the two default items.
+    cy.get('.todo-list li').should('have.length', 2)
+
+    // We can go even further and check that the default todos each contain
+    // the correct text. We use the `first` and `last` functions
+    // to get just the first and last matched elements individually,
+    // and then perform an assertion with `should`.
+    cy.get('.todo-list li').first().should('have.text', 'Pay electric bill')
+    cy.get('.todo-list li').last().should('have.text', 'Walk the dog')
+  })
+
+  it('can add new todo items', () => {
+    // We'll store our item text in a variable so we can reuse it
+    const newItem = 'Feed the cat'
+
+    // Let's get the input element and use the `type` command to
+    // input our new list item. After typing the content of our item,
+    // we need to type the enter key as well in order to submit the input.
+    // This input has a data-test attribute so we'll use that to select the
+    // element in accordance with best practices:
+    // https://on.cypress.io/selecting-elements
+    cy.get('[data-test=new-todo]').type(`${newItem}{enter}`)
+
+    // Now that we've typed our new item, let's check that it actually was added to the list.
+    // Since it's the newest item, it should exist as the last element in the list.
+    // In addition, with the two default items, we should have a total of 3 elements in the list.
+    // Since assertions yield the element that was asserted on,
+    // we can chain both of these assertions together into a single statement.
+    cy.get('.todo-list li')
+      .should('have.length', 3)
+      .last()
+      .should('have.text', newItem)
+  })
+
+  it('can check off an item as completed', () => {
+    // In addition to using the `get` command to get an element by selector,
+    // we can also use the `contains` command to get an element by its contents.
+    // However, this will yield the <label>, which is lowest-level element that contains the text.
+    // In order to check the item, we'll find the <input> element for this <label>
+    // by traversing up the dom to the parent element. From there, we can `find`
+    // the child checkbox <input> element and use the `check` command to check it.
+    cy.contains('Pay electric bill')
+      .parent()
+      .find('input[type=checkbox]')
+      .check()
+
+    // Now that we've checked the button, we can go ahead and make sure
+    // that the list element is now marked as completed.
+    // Again we'll use `contains` to find the <label> element and then use the `parents` command
+    // to traverse multiple levels up the dom until we find the corresponding <li> element.
+    // Once we get that element, we can assert that it has the completed class.
+    cy.contains('Pay electric bill')
+      .parents('li')
+      .should('have.class', 'completed')
+  })
+
+  context('with a checked task', () => {
+    beforeEach(() => {
+      // We'll take the command we used above to check off an element
+      // Since we want to perform multiple tests that start with checking
+      // one element, we put it in the beforeEach hook
+      // so that it runs at the start of every test.
+      cy.contains('Pay electric bill')
+        .parent()
+        .find('input[type=checkbox]')
+        .check()
+    })
+
+    it('can filter for uncompleted tasks', () => {
+      // We'll click on the "active" button in order to
+      // display only incomplete items
+      cy.contains('Active').click()
+
+      // After filtering, we can assert that there is only the one
+      // incomplete item in the list.
+      cy.get('.todo-list li')
+        .should('have.length', 1)
+        .first()
+        .should('have.text', 'Walk the dog')
+
+      // For good measure, let's also assert that the task we checked off
+      // does not exist on the page.
+      cy.contains('Pay electric bill').should('not.exist')
+    })
+
+    it('can filter for completed tasks', () => {
+      // We can perform similar steps as the test above to ensure
+      // that only completed tasks are shown
+      cy.contains('Completed').click()
+
+      cy.get('.todo-list li')
+        .should('have.length', 1)
+        .first()
+        .should('have.text', 'Pay electric bill')
+
+      cy.contains('Walk the dog').should('not.exist')
+    })
+
+    it('can delete all completed tasks', () => {
+      // First, let's click the "Clear completed" button
+      // `contains` is actually serving two purposes here.
+      // First, it's ensuring that the button exists within the dom.
+      // This button only appears when at least one task is checked
+      // so this command is implicitly verifying that it does exist.
+      // Second, it selects the button so we can click it.
+      cy.contains('Clear completed').click()
+
+      // Then we can make sure that there is only one element
+      // in the list and our element does not exist
+      cy.get('.todo-list li')
+        .should('have.length', 1)
+        .should('not.have.text', 'Pay electric bill')
+
+      // Finally, make sure that the clear button no longer exists.
+      cy.contains('Clear completed').should('not.exist')
+    })
+  })
+})