From f1ef7cd3f2892253f5a984aebd12009da87e7e1c Mon Sep 17 00:00:00 2001
From: Owen Rees <owenrees82@gmail.com>
Date: Tue, 20 Jun 2023 08:42:03 +0200
Subject: [PATCH] cypress best practices updated

---
 TODO                                 | 11 +-----
 app/contactez-nous/page.tsx          |  5 ++-
 app/page.tsx                         |  4 +-
 app/qui-sommes-nous/page.tsx         |  5 ++-
 components/Footer.tsx                |  5 ++-
 components/Hamburger.tsx             |  1 +
 components/Navbar.tsx                | 12 ++++--
 components/ThemeSwitcher.tsx         | 12 +++++-
 cypress/component/mounting.cy.tsx    | 16 +++++---
 cypress/component/themeToggle.cy.tsx | 10 ++---
 cypress/e2e/links.cy.ts              |  2 +-
 cypress/e2e/navbar.cy.tsx            | 12 +++---
 hooks/useTournamentFilter.tsx        | 56 ----------------------------
 13 files changed, 60 insertions(+), 91 deletions(-)
 delete mode 100644 hooks/useTournamentFilter.tsx

diff --git a/TODO b/TODO
index 6743d95..4186a4e 100644
--- a/TODO
+++ b/TODO
@@ -1,10 +1,8 @@
-// TODO change tests to follow best practices https://docs.cypress.io/guides/references/best-practices
 // TODO tests for tournament page:
     - map and table mounts in tournament page <- get data to send to map/table
 ----------------------------------------------------------------
-//TODO hover on table needs fixing - this only seemed to happen once I moved the logic into its own hook <- error is occurring on all hovers at the moment.
-//TODO fix table hover colours
------------------------------------------------------------------
+//TODO SRP for web and API data fetching
+//TODO API should not display __v and _id should just be id
 //TODO about page
 //TODO contact page needs working mailer
 //TODO font size on mobile screen
@@ -13,13 +11,8 @@
 ----------------------------------------------------------------
 //TODO logo for navbar and favicon
 //TODO mobile map needs improving
-
 //TODO multi-language i18n support - https://nextjs.org/docs/app/building-your-application/routing/internationalization
-
 //TODO error handling
-
 //TODO consider offering GraphQL support
-
 //TODO move smaller ui components into a new folder, and make them reusable - such as using generic prop names
-
 //TODO readme
diff --git a/app/contactez-nous/page.tsx b/app/contactez-nous/page.tsx
index 6902a99..3006137 100644
--- a/app/contactez-nous/page.tsx
+++ b/app/contactez-nous/page.tsx
@@ -6,7 +6,10 @@ export default function Contact() {
     <Layout>
       <section className="grid  place-items-center bg-white dark:bg-gray-800">
         <div className="pt-8 pb-32 lg:pt-16 px-4 mx-auto max-w-screen-md">
-          <h2 className="mb-4 text-4xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white">
+          <h2
+            className="mb-4 text-4xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white"
+            data-cy="header2"
+          >
             Contactez-Nous
           </h2>
           <p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
diff --git a/app/page.tsx b/app/page.tsx
index 047203e..7fb3e4b 100644
--- a/app/page.tsx
+++ b/app/page.tsx
@@ -16,7 +16,9 @@ export default function Home() {
           />
         </div>
         <div className="absolute text-center text-white">
-          <h1 className="text-5xl p-5">Echecs France</h1>
+          <h1 className="text-5xl p-5" data-cy="header1">
+            Echecs France
+          </h1>
           <h2 className="text-3xl p-5">
             Trouvez Vos Tournois d&apos;Echecs en France Sur Une Carte
           </h2>
diff --git a/app/qui-sommes-nous/page.tsx b/app/qui-sommes-nous/page.tsx
index df40855..8c5c878 100644
--- a/app/qui-sommes-nous/page.tsx
+++ b/app/qui-sommes-nous/page.tsx
@@ -6,7 +6,10 @@ export default function About() {
       <header className="grid h-[calc(100%-216px)] md:h-[calc(100%-174px)] place-items-center">
         <div className="relative h-full w-full bg-white dark:bg-gray-800"></div>
         <div className="absolute">
-          <h2 className="mb-4 text-4xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white">
+          <h2
+            className="mb-4 text-4xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white"
+            data-cy="header2"
+          >
             Qui Sommes-Nous?
           </h2>
           <p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
diff --git a/components/Footer.tsx b/components/Footer.tsx
index e2cb709..20b7e05 100644
--- a/components/Footer.tsx
+++ b/components/Footer.tsx
@@ -3,7 +3,10 @@ import { FaGithub, FaRegEnvelope } from "react-icons/fa";
 
 export default function Footer() {
   return (
-    <footer className="grid w-full fixed bottom-0 justify-items-center py-2 px-5 text-white bg-teal-600 text-gray-900 dark:bg-gray-700">
+    <footer
+      className="grid w-full fixed bottom-0 justify-items-center py-2 px-5 text-white bg-teal-600 text-gray-900 dark:bg-gray-700"
+      data-cy="footer"
+    >
       <div className="p-2">
         <p>&copy; {new Date().getFullYear()} - Owen Rees</p>
       </div>
diff --git a/components/Hamburger.tsx b/components/Hamburger.tsx
index abbace3..843c0d8 100644
--- a/components/Hamburger.tsx
+++ b/components/Hamburger.tsx
@@ -11,6 +11,7 @@ const Hamburger = () => {
       <div
         ref={hamburgerButtonRef}
         className="hamburger-button space-y-2 relative z-[99999]"
+        data-cy="hamburger-button"
         onClick={() => setMenuVisible(!menuVisible)}
       >
         <div
diff --git a/components/Navbar.tsx b/components/Navbar.tsx
index fae9465..22d7540 100644
--- a/components/Navbar.tsx
+++ b/components/Navbar.tsx
@@ -4,7 +4,10 @@ import Hamburger from "@/components/Hamburger";
 
 export default function Navbar() {
   return (
-    <nav className="w-full relative border-b-[1px] pt-5 mt-0 px-5 md:pt-2 bg-white dark:bg-gray-800 dark:border-gray-700 overflow-x-clip">
+    <nav
+      className="w-full relative border-b-[1px] pt-5 mt-0 px-5 md:pt-2 bg-white dark:bg-gray-800 dark:border-gray-700 overflow-x-clip"
+      data-cy="navbar"
+    >
       <div className="container mx-auto flex items-center">
         <div className="pb-3 justify-center flex w-full md:w-1/2 md:pb-0 md:justify-start font-extrabold">
           <Link
@@ -14,11 +17,14 @@ export default function Navbar() {
             <span className="text-2xl">Echecs France</span>
           </Link>
         </div>
-        <div className="mobile-menu pb-2 md:hidden">
+        <div className="pb-2 md:hidden" data-cy="mobile-menu">
           <Hamburger />
         </div>
 
-        <div className="desktop-menu hidden pt-2 justify-center md:flex md:w-1/2 md:justify-end">
+        <div
+          className="hidden pt-2 justify-center md:flex md:w-1/2 md:justify-end"
+          data-cy="desktop-menu"
+        >
           <ul className="list-reset text-gray-900 dark:text-white no-underline flex flex-1 justify-around md:flex-none items-center">
             <li className="mr-10">
               <Link
diff --git a/components/ThemeSwitcher.tsx b/components/ThemeSwitcher.tsx
index 86b80a1..86f9a08 100644
--- a/components/ThemeSwitcher.tsx
+++ b/components/ThemeSwitcher.tsx
@@ -20,11 +20,19 @@ const ThemeSwitcher = () => {
   return (
     <div>
       {colorTheme === "light" ? (
-        <div className="toggle-dark" onClick={() => setTheme("light")}>
+        <div
+          className="toggle-dark"
+          data-cy="toggle-dark"
+          onClick={() => setTheme("light")}
+        >
           <MdBrightness2 className="theme-icon-dark" />
         </div>
       ) : (
-        <div className="toggle" onClick={() => setTheme("dark")}>
+        <div
+          className="toggle"
+          data-cy="toggle"
+          onClick={() => setTheme("dark")}
+        >
           <MdCircle className="theme-icon" />
         </div>
       )}
diff --git a/cypress/component/mounting.cy.tsx b/cypress/component/mounting.cy.tsx
index 6361989..88baa1b 100644
--- a/cypress/component/mounting.cy.tsx
+++ b/cypress/component/mounting.cy.tsx
@@ -4,11 +4,11 @@ import Contact from "@/app/contactez-nous/page";
 
 const navbarFooterCheck = () => {
   it("includes navbar", () => {
-    cy.get("nav");
+    cy.get("[data-cy='navbar']");
   });
 
   it("includes footer", () => {
-    cy.get("footer");
+    cy.get("[data-cy='footer']");
   });
 };
 
@@ -19,7 +19,9 @@ describe("Verify component mount", () => {
     });
 
     it("correct h1 tags with website name included", () => {
-      cy.get("h1").contains("echecs france", { matchCase: false });
+      cy.get("[data-cy='header1']").contains("echecs france", {
+        matchCase: false,
+      });
     });
 
     navbarFooterCheck();
@@ -31,7 +33,9 @@ describe("Verify component mount", () => {
     });
 
     it("correct h1 tags with page title included", () => {
-      cy.get("h2").contains("qui sommes-nous", { matchCase: false });
+      cy.get("[data-cy='header2']").contains("qui sommes-nous", {
+        matchCase: false,
+      });
     });
 
     navbarFooterCheck();
@@ -43,7 +47,9 @@ describe("Verify component mount", () => {
     });
 
     it("correct h1 tags with page title included", () => {
-      cy.get("h2").contains("contactez-nous", { matchCase: false });
+      cy.get("[data-cy='header2']").contains("contactez-nous", {
+        matchCase: false,
+      });
     });
 
     navbarFooterCheck();
diff --git a/cypress/component/themeToggle.cy.tsx b/cypress/component/themeToggle.cy.tsx
index 410c86a..6475314 100644
--- a/cypress/component/themeToggle.cy.tsx
+++ b/cypress/component/themeToggle.cy.tsx
@@ -10,17 +10,17 @@ describe("ThemeSwitcher component", () => {
     cy.wait(100);
 
     // checking that the toggle is there and light mode is active
-    cy.get(".toggle").should("exist");
-    cy.get(".toggle").should(($toggle) => {
+    cy.get("[data-cy='toggle']").should("exist");
+    cy.get("[data-cy='toggle']").should(($toggle) => {
       const backgroundImage = $toggle.css("background-image");
       expect(backgroundImage).to.include(
         "linear-gradient(rgb(0, 255, 255), rgb(135, 206, 235)"
       );
     });
     // checking that the toggle is clickable and dark mode is active
-    cy.get(".toggle").click();
-    cy.get(".toggle-dark").should("exist");
-    cy.get(".toggle-dark").should(($toggle) => {
+    cy.get("[data-cy='toggle']").click();
+    cy.get("[data-cy='toggle-dark']").should("exist");
+    cy.get("[data-cy='toggle-dark']").should(($toggle) => {
       const backgroundImage = $toggle.css("background-image");
       expect(backgroundImage).to.include(
         "linear-gradient(rgb(25, 25, 112), rgb(102, 51, 153)"
diff --git a/cypress/e2e/links.cy.ts b/cypress/e2e/links.cy.ts
index 8410ec1..72ffcd8 100644
--- a/cypress/e2e/links.cy.ts
+++ b/cypress/e2e/links.cy.ts
@@ -9,7 +9,7 @@ describe("Test all links", () => {
     cy.viewport(600, 600);
     cy.visit("/");
     pages.forEach((page) => {
-      cy.get(".hamburger-button").click();
+      cy.get("[data-cy='hamburger-button']").click();
       cy.contains(page, { matchCase: false }).click();
       cy.location("pathname").should("eq", `/${navLinkToSlug(page)}`); // url path matches link name, replacing whitespace with hyphens
       cy.go("back");
diff --git a/cypress/e2e/navbar.cy.tsx b/cypress/e2e/navbar.cy.tsx
index 0335489..27ff4a2 100644
--- a/cypress/e2e/navbar.cy.tsx
+++ b/cypress/e2e/navbar.cy.tsx
@@ -5,12 +5,12 @@ describe("Mobile Navbar", () => {
   });
 
   it("hamburger menu on mobile screens", () => {
-    cy.get(".mobile-menu").should("be.not.hidden");
-    cy.get(".desktop-menu").should("be.hidden");
+    cy.get("[data-cy='mobile-menu']").should("be.visible");
+    cy.get("[data-cy='desktop-menu']").should("be.not.visible");
   });
 
   it("hamburger button available", () => {
-    cy.get(".hamburger-button").should("be.visible");
+    cy.get("[data-cy='hamburger-button']").should("be.visible");
   });
 });
 
@@ -21,11 +21,11 @@ describe("Desktop Navbar", () => {
   });
 
   it("desktop menu on larger screens", () => {
-    cy.get(".mobile-menu").should("be.hidden");
-    cy.get(".desktop-menu").should("be.not.hidden");
+    cy.get("[data-cy='mobile-menu']").should("be.hidden");
+    cy.get("[data-cy='desktop-menu']").should("be.not.hidden");
   });
 
   it("hamburger button hidden", () => {
-    cy.get(".hamburger-button").should("be.not.visible");
+    cy.get("[data-cy='hamburger-button']").should("be.not.visible");
   });
 });
diff --git a/hooks/useTournamentFilter.tsx b/hooks/useTournamentFilter.tsx
deleted file mode 100644
index dcf830e..0000000
--- a/hooks/useTournamentFilter.tsx
+++ /dev/null
@@ -1,56 +0,0 @@
-import { Tournament } from "@/types";
-import { useState } from "react";
-
-// TODO delete after testing
-const useTournamentDataFilter = (
-  initialState: Tournament[]
-): (any | ((searchQuery: string) => void))[] => {
-  const [filtered, setFiltered] = useState(initialState);
-  let state;
-  const setState = (searchQuery: string) => {
-    setFiltered(
-      initialState.filter((t) => t.town.includes(searchQuery.toUpperCase()))
-    );
-  };
-
-  if (filtered.length === 0) {
-    state = (
-      <tr className="bg-white text-gray-900 dark:bg-gray-800 dark:text-white">
-        <td colSpan={4} className="p-3">
-          No tournaments found
-        </td>
-      </tr>
-    );
-  } else {
-    state = filtered.map((t) => (
-      <tr
-        className="text-gray-900 bg-white dark:bg-gray-800 dark:text-white hover:bg-gray-400 hover:text-black"
-        key={t._id}
-      >
-        <td className="p-3">
-          <a href={t.url} target="_blank">
-            {t.date}
-          </a>
-        </td>
-        <td className="p-3">
-          <a href={t.url} target="_blank">
-            {t.town}
-          </a>
-        </td>
-        <td className="p-3">
-          <a href={t.url} target="_blank">
-            {t.tournament}
-          </a>
-        </td>
-        <td className="p-3">
-          <a href={t.url} target="_blank">
-            {t.time_control}
-          </a>
-        </td>
-      </tr>
-    ));
-  }
-  return [state, setState];
-};
-
-export default useTournamentDataFilter;