Pre-requisite Services

Overlay Documentation

This page covers writing tests within rhdh-plugin-export-overlays. For using rhdh-e2e-test-utils in external projects, see the Guide.

Some plugins require external services or dependencies to be running before RHDH starts. This page explains how to handle such pre-requisites.

When You Need This

Your plugin tests may require pre-requisites when:

• Plugin reads data from an external API or service
• Plugin requires a database or storage backend
• Plugin integrates with third-party services
• Test fixtures must be deployed to the cluster before RHDH starts

The Pattern

Deploy pre-requisites after rhdh.configure() but before rhdh.deploy():

test.beforeAll(async ({ rhdh }) => {
  const project = rhdh.deploymentConfig.namespace;

  // 1. Configure RHDH first
  await rhdh.configure({ auth: "keycloak" });

  // 2. Deploy pre-requisite service (see examples below)
  // ...

  // 3. Set environment variable if needed for RHDH config
  process.env.MY_SERVICE_URL = "...";

  // 4. Deploy RHDH (uses the environment variable)
  await rhdh.deploy();
});

Examples

Using TypeScript / k8sClient

You can deploy pre-requisites directly in TypeScript using the Kubernetes client:

import { test } from "rhdh-e2e-test-utils/test";

test.beforeAll(async ({ rhdh }) => {
  const project = rhdh.deploymentConfig.namespace;
  const k8s = rhdh.k8sClient;

  await rhdh.configure({ auth: "keycloak" });

  // Create a ConfigMap
  await k8s.applyConfigMapFromObject(
    "my-config",
    { "config.json": JSON.stringify({ key: "value" }) },
    project,
  );

  // Create a Secret
  await k8s.applySecretFromObject(
    "my-secret",
    { stringData: { API_KEY: process.env.VAULT_API_KEY } },
    project,
  );

  await rhdh.deploy();
});

Using Shell Commands

For OpenShift-specific operations, use the $ utility:

import { test } from "rhdh-e2e-test-utils/test";
import { $ } from "rhdh-e2e-test-utils/utils";

test.beforeAll(async ({ rhdh }) => {
  const project = rhdh.deploymentConfig.namespace;

  await rhdh.configure({ auth: "keycloak" });

  // Deploy an app from image
  await $`oc new-app my-image:tag --name=my-service --namespace=${project}`;
  await $`oc expose svc/my-service --namespace=${project}`;

  // Get service URL
  process.env.MY_SERVICE_URL = await rhdh.k8sClient.getRouteLocation(
    project,
    "my-service",
  );

  await rhdh.deploy();
});

Using a Script File

For complex deployments, you can use a separate script file:

import { $ } from "rhdh-e2e-test-utils/utils";
import path from "path";

const setupScript = path.join(import.meta.dirname, "deploy-service.sh");

test.beforeAll(async ({ rhdh }) => {
  const project = rhdh.deploymentConfig.namespace;

  await rhdh.configure({ auth: "keycloak" });
  await $`bash ${setupScript} ${project}`;
  await rhdh.deploy();
});

Real Example: Tech Radar

The tech-radar plugin requires an external data provider:

test.beforeAll(async ({ rhdh }) => {
  const project = rhdh.deploymentConfig.namespace;

  await rhdh.configure({ auth: "keycloak" });

  // Deploy the data provider service
  await $`bash ${setupScript} ${project}`;

  // Get URL and set as env var for rhdh-secrets.yaml substitution
  process.env.TECH_RADAR_DATA_URL = (
    await rhdh.k8sClient.getRouteLocation(
      project,
      "test-backstage-customization-provider",
    )
  ).replace("http://", "");

  await rhdh.deploy();
});

Related Pages

• Spec Files - Test file structure
• Configuration Files - Using environment variables in configs
• Tech Radar Example - Complete example with pre-requisites