verify-redis-cache.spec.ts

import { expect, test } from "@support/coverage/test";
import Redis from "ioredis";

import { TechDocsPage } from "../support/pages/techdocs-page";
import { PortForwardSession } from "../utils/port-forward";

test.describe("Verify Redis Cache DB", () => {
  test.beforeAll(() => {
    test.info().annotations.push({
      type: "component",
      description: "core",
    });
  });

  test.describe.configure({ mode: "serial" });
  let techDocsPage: TechDocsPage;
  let portForward: PortForwardSession | null = null;
  let redis: Redis;

  test.beforeEach(async ({ guestPage }) => {
    techDocsPage = new TechDocsPage(guestPage);

    console.log("Starting port-forward process...");
    portForward = new PortForwardSession(
      {
        shellCommand: `
          oc login --token="${process.env.K8S_CLUSTER_TOKEN}" --server="${process.env.K8S_CLUSTER_URL}" --insecure-skip-tls-verify=true &&
          kubectl config set-context --current --namespace="${process.env.NAME_SPACE}" &&
          kubectl port-forward service/redis 6379:6379 --namespace="${process.env.NAME_SPACE}"
        `,
      },
      {
        readyPattern: /Forwarding from 127\\.0\\.0\\.1:6379/u,
      },
    );
    console.log("Waiting for port-forward to be ready...");
    await portForward.start();
  });

  test("Open techdoc and verify the cache generated in redis db", async () => {
    await techDocsPage.openDocFromFavorites("Red Hat Developer Hub");

    // ensure that the docs are generated. if redis configuration has an error, this page will hang and docs won't be generated
    await expect(async () => {
      await techDocsPage.verifyDocHeading("rhdh");
    }).toPass({
      intervals: [3_000],
      timeout: 60_000,
    });

    console.log("Connecting to Redis...");
    redis = new Redis(
      `redis://${process.env.REDIS_USERNAME}:${process.env.REDIS_PASSWORD}@localhost:6379`,
    );
    console.log("Verifying Redis keys...");
    await expect(async () => {
      const keys = (await redis.keys("*")).filter((k) => k.includes("techdocs"));
      expect(keys).toContainEqual(expect.stringContaining("techdocs"));
      const key = keys[0];
      console.log(`Verifying key format: ${key}`);
      expect(key).toMatch(/(?:techdocs):(?:[A-Za-z0-9+/]+={0,2})$/gmu);
    }).toPass({
      intervals: [3_000],
      timeout: 60_000,
    });
  });

  test.afterEach(async () => {
    if (redis?.status === "ready") {
      redis.disconnect();
    }
    await portForward?.stop();
  });
});