Added the following tests- When a custom check fails, the custom checks tab is auto-refreshed with the new failed custom check, A failing custom check that begins passing is auto-refreshed and removed from the list on the custom checks tab

Author: soujay

src/Frontend/test/preconditions/customChecks.ts

@@ -1,4 +1,4 @@
-import CustomCheck from "@/resources/CustomCheck";
+import CustomCheck, { Status } from "@/resources/CustomCheck";
 import { SetupFactoryOptions } from "../driver";
 const emptyContent = JSON.stringify([]);
 
@@ -88,3 +88,80 @@ export const hasCustomChecks =
       };
     });
   };
+
+export const setCustomChecksData = (failingCount: number, passingCount: number) => () => {
+  // Calculate total count
+  const totalCount = failingCount + passingCount;
+
+  // Create checks (both failing and passing)
+  const customChecks = Array.from({ length: totalCount }).map((_, index) => {
+    // Generate the date based on the index
+    const date = new Date();
+    date.setDate(date.getDate() - index); // Subtract `index` days from the current date
+    const reportedAt = date.toISOString(); // Convert to ISO string format
+
+    // Determine status and failure reason
+    const status = index < failingCount ? Status.Fail : Status.Pass;
+    const failureReason = status === Status.Fail ? `configured to fail on endpoint ${index}` : "";
+
+    // Generate a new GUID for the ID and host_id
+    const newGuid = generateGuid();
+    const originatingEndpointName = `endpoint ${index}`;
+    const originatingHost = `ABC ${index}`;
+    const customCategory = `Some Category ${index}`;
+    const customeCheckId = `SampleCustomeCheck ${index}`;
+
+    return {
+      ...customCheckTemplate,
+      id: `customcheck/${newGuid}`, // New GUID for ID
+      category: customCategory,
+      custom_check_id: customeCheckId,
+      status, // Fail or Pass based on index
+      failure_reason: failureReason, // Failure reason or empty for passing
+      reported_at: reportedAt, // Autogenerated reported_at based on index
+      originating_endpoint: {
+        name: originatingEndpointName, // Endpoint name based on index
+        host_id: newGuid, // New GUID for host_id
+        host: originatingHost, // Host name based on index
+      },
+    };
+  });
+  return customChecks;
+};
+
+export const getCustomChecks =
+  (customChecks: CustomCheck[]) =>
+  ({ driver }: SetupFactoryOptions) => {
+    const serviceControlInstanceUrl = window.defaultConfig.service_control_url;
+
+    const failedCustomChecks = customChecks.filter((check) => check.status === "Fail");
+
+    driver.mockEndpointDynamic(`${serviceControlInstanceUrl}customchecks`, (url) => {
+      const status = url.searchParams.get("status");
+      if (status === "fail") {
+        return {
+          body: failedCustomChecks,
+          headers: { "Total-Count": failedCustomChecks.length.toString() },
+        };
+      }
+
+      return {
+        body: customChecks,
+        headers: { "Total-Count": customChecks.length.toString() },
+      };
+    });
+  };
+
+export const updateCustomCheckItem = (data: CustomCheck[], status: string) => {
+  const itemToUpdate = data.find((item) => item.status === status);
+
+  if (itemToUpdate) {
+    if (status === "Pass") {
+      itemToUpdate.status = Status.Fail;
+      itemToUpdate.failure_reason = "Some reason I dont know";
+    } else {
+      itemToUpdate.status = Status.Pass;
+      itemToUpdate.failure_reason = "";
+    }
+  }
+};

src/Frontend/test/preconditions/index.ts

@@ -5,7 +5,7 @@ export { hasServiceControlMonitoringInstanceUrl } from "../preconditions/hasServ
 export { hasUpToDateServiceControl } from "../preconditions/hasUpToDateServiceControl";
 export { hasUpToDateServicePulse } from "../preconditions/hasUpToDateServicePulse";
 export { errorsDefaultHandler } from "../preconditions/hasNoErrors";
-export { hasCustomChecksEmpty, hasCustomChecks } from "./customChecks";
+export { hasCustomChecksEmpty, hasCustomChecks, setCustomChecksData, getCustomChecks,updateCustomCheckItem } from "./customChecks";
 export { hasNoDisconnectedEndpoints } from "../preconditions/hasNoDisconnectedEndpoints";
 export { hasNoMonitoredEndpoints, hasMonitoredEndpointsList, monitoredEndpointsNamed } from "../preconditions/hasMonitoredEndpoints";
 export { hasEventLogItems } from "../preconditions/hasEventLogItems";

src/Frontend/test/specs/customchecks/questions/failedCustomChecks.ts

@@ -1,5 +1,4 @@
 import { screen } from "@testing-library/vue";
-import { Console } from "console";
 import moment from "moment";
 
 export function customChecksMessageElement() {

src/Frontend/test/specs/customchecks/viewing-failing-custom-checks.spec.ts

@@ -3,6 +3,7 @@ import { expect } from "vitest";
 import * as precondition from "../../preconditions";
 import { customChecksFailedRowsList, customChecksListElement, customChecksMessageElement, customChecksFailedReasonList, customChecksListPaginationElement, customChecksReportedDateList } from "./questions/failedCustomChecks";
 import { waitFor } from "@testing-library/vue";
+import { updateCustomCheckItem } from "../../preconditions";
 
 describe("FEATURE: Failing custom checks", () => {
   describe("RULE: Failed custom checks should be displayed", () => {
@@ -71,7 +72,6 @@ describe("FEATURE: Failing custom checks", () => {
       await waitFor(async () => {
         expect(await customChecksListElement()).toBeInTheDocument(); //failed list is visisble
       });
-      expect(customChecksListPaginationElement()).not.toBeInTheDocument(); //pagination not  vsible
       await waitFor(async () => {
         expect(await customChecksFailedRowsList()).toHaveLength(3); //count of failed checks matches failing count set
       });
@@ -85,21 +85,52 @@ describe("FEATURE: Failing custom checks", () => {
     });
   });
   describe("RULE: Custom checks should auto-refresh", () => {
-    test.todo("EXAMPLE: When a custom check fails, the custom checks tab is auto-refreshed with the new failed custom check");
-
-    /* SCENARIO
-          Given 2 passing custom checks
-          And the custom checks page is open
-          When the endpoint reports a failing custom check
-          Then the failing custom check should be rendered
-        */
-
-    test.todo("EXAMPLE: A failing custom check that begins passing is auto-refreshed and removed from the list on the custom checks tab");
-    /* SCENARIO
-          Given 2 failing custom checks
-          And the custom checks page is open
-          When one of the custom checks passes
-          Then the passing custom check should be removed from the list
-        */
+    test("EXAMPLE:When a custom check fails, the custom checks tab is auto-refreshed with the new failed custom check", async ({ driver }) => {
+      await driver.setUp(precondition.serviceControlWithMonitoring);
+      const customCheckItems = precondition.setCustomChecksData(3, 2)();
+      await driver.setUp(precondition.getCustomChecks(customCheckItems));
+
+      await driver.goTo("/custom-checks");
+
+      await waitFor(async () => {
+        expect(await customChecksListElement()).toBeInTheDocument(); //failed list is visisble
+      });
+      await waitFor(async () => {
+        expect(await customChecksFailedRowsList()).toHaveLength(3); //count of failed checks matches failing count set
+      });
+
+      updateCustomCheckItem(customCheckItems, "Pass"); // Fail an existing item that is passing
+
+      await driver.setUp(precondition.getCustomChecks(customCheckItems));
+
+      await driver.goTo("/custom-checks");
+      await waitFor(async () => {
+        expect(await customChecksFailedRowsList()).toHaveLength(4); // Now it should be 4
+      });
+    });
+
+    test("EXAMPLE: A failing custom check that begins passing is auto-refreshed and removed from the list on the custom checks tab", async ({ driver }) => {
+      await driver.setUp(precondition.serviceControlWithMonitoring);
+      const customCheckItems = precondition.setCustomChecksData(3, 2)();
+      await driver.setUp(precondition.getCustomChecks(customCheckItems));
+
+      await driver.goTo("/custom-checks");
+
+      await waitFor(async () => {
+        expect(await customChecksListElement()).toBeInTheDocument(); //failed list is visisble
+      });
+      await waitFor(async () => {
+        expect(await customChecksFailedRowsList()).toHaveLength(3); //count of failed checks matches failing count set
+      });
+
+      updateCustomCheckItem(customCheckItems, "Fail"); // Pass an existing item that is failing
+
+      await driver.setUp(precondition.getCustomChecks(customCheckItems));
+
+      await driver.goTo("/custom-checks");
+      await waitFor(async () => {
+        expect(await customChecksFailedRowsList()).toHaveLength(2); // Now it should be 2
+      });
+    });
   });
 });