Types Reference

type MountCifsShareOptions = {
  mountPoint: string;
  password: string;
  share: string;
  username: string;
};

const options: MountCifsShareOptions = {
  mountPoint: "/Volumes/shared",
  password: "secret",
  share: "//server/share",
  username: "wolf",
};

type StartOpenVpnOptions = {
  configPath: string;
  routeHosts?: string[];
  routeIps?: string[];
  routeNoPull?: boolean;
};

const options: StartOpenVpnOptions = {
  configPath: "/tmp/test.ovpn",
  routeHosts: ["internal.example.com"],
};

type StartWireGuardOptions = {
  configPath: string;
};

const options: StartWireGuardOptions = {
  configPath: "/tmp/test.conf",
};

type Screenshotable = {
  screenshot: (screenshotOptions?: unknown) => Promise<Buffer>;
};

const pageLike: Screenshotable = {
  screenshot: async () => Buffer.from("image"),
};

type SaveBaselineScreenshot = (
  pageOrLocator: Screenshotable,
  name: string,
  screenshotOptions?: unknown,
) => Promise<void>;

await saveBaselineScreenshot(page, "login-page");
await saveBaselineScreenshot(locator, "login-form", {
  animations: "disabled",
});

type SaveSnapshot = (name: string, bytes: Buffer) => Promise<void>;

const saveSnapshot: SaveSnapshot = async (name, bytes) => {
  console.log(name, bytes.length);
};

type TestkitPorts = {
  mountCifsShare: (options: MountCifsShareOptions) => Promise<string>;
  saveSnapshot?: SaveSnapshot;
  startOpenVpn: (options: StartOpenVpnOptions) => Promise<string>;
  startWireGuard: (options: StartWireGuardOptions) => Promise<string>;
};

const ports: TestkitPorts = {
  mountCifsShare: async ({ mountPoint }) => mountPoint,
  saveSnapshot: async (name, bytes) => {
    console.log(name, bytes.length);
  },
  startOpenVpn: async ({ configPath }) => configPath,
  startWireGuard: async ({ configPath }) => configPath,
};

import { createTestkitClient } from "@qawolf/testkit/client";

const client = createTestkitClient({
  mountCifsShare: async ({ mountPoint }) => mountPoint,
  startOpenVpn: async ({ configPath }) => configPath,
  startWireGuard: async ({ configPath }) => configPath,
});

console.log(client.saveBaselineScreenshot); // undefined without saveSnapshot