sts-sponsors team mailing list archive

[Peter Makowski <mp+443196@xxxxxxxxxxxxxxxxxx>]

Peter Makowski has proposed merging ~petermakowski/maas-site-manager:remove-test-warnings into maas-site-manager:main.

Commit message:
remove warnings in tests
- set isDev to read value from NODE_ENV
- render NoRegions inside a table to avoid warnings about invalid DOM nesting

Requested reviews:
  MAAS Committers (maas-committers)

For more details, see:
https://code.launchpad.net/~petermakowski/maas-site-manager/+git/site-manager/+merge/443196
-- 
Your team MAAS Committers is requested to review the proposed merge of ~petermakowski/maas-site-manager:remove-test-warnings into maas-site-manager:main.

diff --git a/frontend/src/components/NoRegions/NoRegions.test.tsx b/frontend/src/components/NoRegions/NoRegions.test.tsx
index b1eca0a..02d27db 100644
--- a/frontend/src/components/NoRegions/NoRegions.test.tsx
+++ b/frontend/src/components/NoRegions/NoRegions.test.tsx
@@ -6,13 +6,20 @@ import { createMockGetEnrollmentRequestsResolver } from "@/mocks/resolvers";
 import { createMockGetServer } from "@/mocks/server";
 import { getByTextContent, renderWithMemoryRouter, screen, waitFor } from "@/test-utils";
 
+const renderComponent = () =>
+  renderWithMemoryRouter(
+    // render inside a table to avoid warnings about invalid DOM nesting
+    <table>
+      <NoRegions />
+    </table>,
+  );
+
 describe("open enrollment requests available", () => {
   const enrollmentRequests = enrollmentRequestFactory.buildList(2);
   const mockServer = createMockGetServer(
     urls.enrollmentRequests,
     createMockGetEnrollmentRequestsResolver(enrollmentRequests),
   );
-
   beforeAll(() => {
     mockServer.listen();
   });
@@ -24,12 +31,11 @@ describe("open enrollment requests available", () => {
   });
 
   it("should display 'no enrolled regions' text", () => {
-    renderWithMemoryRouter(<NoRegions />);
-
+    renderComponent();
     expect(screen.getByText(/no enroled maas regions/i)).toBeInTheDocument();
   });
   it("should display link to enrollment docs", () => {
-    renderWithMemoryRouter(<NoRegions />);
+    renderComponent();
 
     expect(
       screen.getByRole("link", { name: /learn more about the enrolment process in the documentation\./i }),
@@ -37,8 +43,7 @@ describe("open enrollment requests available", () => {
   });
 
   it("should display a link to the request page if there are open requests", async () => {
-    renderWithMemoryRouter(<NoRegions />);
-
+    renderComponent();
     await waitFor(() =>
       expect(
         screen.getByRole("link", {
@@ -49,8 +54,7 @@ describe("open enrollment requests available", () => {
   });
 
   it("should display the amount of open enrollment requests", async () => {
-    renderWithMemoryRouter(<NoRegions />);
-
+    renderComponent();
     await waitFor(() =>
       expect(
         getByTextContent(new RegExp("You have 2 open enrolment requests, inspect them in the Requests page.", "i")),
@@ -77,8 +81,7 @@ describe("no open enrollment requests available", () => {
   });
 
   it("should display a link to the tokens page", async () => {
-    renderWithMemoryRouter(<NoRegions />);
-
+    renderComponent();
     await waitFor(() =>
       expect(
         screen.getByRole("link", {
@@ -89,8 +92,7 @@ describe("no open enrollment requests available", () => {
   });
 
   it("should display a link to enrollment process docs", () => {
-    renderWithMemoryRouter(<NoRegions />);
-
+    renderComponent();
     expect(
       screen.getByRole("link", {
         name: new RegExp("Learn more about the enrolment process in the documentation.", "i"),
diff --git a/frontend/src/constants.ts b/frontend/src/constants.ts
index 99b7c2a..215a164 100644
--- a/frontend/src/constants.ts
+++ b/frontend/src/constants.ts
@@ -1,2 +1,2 @@
-export const isDev = import.meta.env.DEV;
+export const isDev = import.meta.env.NODE_ENV === "development";
 export const useMockData = import.meta.env.VITE_USE_MOCK_DATA === "true";
diff --git a/frontend/src/main.tsx b/frontend/src/main.tsx
index e65a61b..458a4e5 100644
--- a/frontend/src/main.tsx
+++ b/frontend/src/main.tsx
@@ -17,8 +17,10 @@ if (useMockData) {
 const environment = process.env.NODE_ENV;
 const version = packageInfo.version;
 const release = import.meta.env.VITE_APP_VERSION;
-// eslint-disable-next-line no-console
-console.log(`%cMAAS Site Manager \n${version} ${release}\n${environment}`, "color: #e95420; font-weight: bold;");
+if (environment !== "test") {
+  // eslint-disable-next-line no-console
+  console.log(`%cMAAS Site Manager \n${version} ${release}\n${environment}`, "color: #e95420; font-weight: bold;");
+}
 
 // https://sentry.is.canonical.com/canonical/maas-site-manager/
 Sentry.init({