Method testWithTlsClient

packages/test-utils/lib/index.ts:432–501

* Runs a test using a TLS-enabled Redis client. * Automatically spawns a TLS-enabled Redis container with both TLS and non-TLS ports, * extracts certificates, and configures the TLS client. * * @param title - Test title * @param fn - Test function receiving the TLS client and port inf

(
    title: string,
    fn: (
      client: RedisClientType<M, F, S, RESP, TYPE_MAPPING>,
      ports: { port: number; tlsPort: number },
    ) => unknown,
    options: TlsClientTestOptions<M, F, S, RESP, TYPE_MAPPING>,
  )

   * @param options - TLS client test options
   */
  testWithTlsClient<
    M extends RedisModules = {},
    F extends RedisFunctions = {},
    S extends RedisScripts = {},
    RESP extends RespVersions = 2,
    TYPE_MAPPING extends TypeMapping = {},
  >(
    title: string,
    fn: (
      client: RedisClientType<M, F, S, RESP, TYPE_MAPPING>,
      ports: { port: number; tlsPort: number },
    ) => unknown,
    options: TlsClientTestOptions<M, F, S, RESP, TYPE_MAPPING>,
  ): void {
    let dockerPromise: ReturnType<typeof spawnTlsRedisServer>;
    if (this.isVersionGreaterThan(options.minimumDockerVersion)) {
      const dockerImage = this.#DOCKER_IMAGE;
      before(function () {
        this.timeout(60000); // TLS setup takes longer

        dockerPromise = spawnTlsRedisServer(
          dockerImage,
          options.serverArguments,
          options.tls,
        );
        return dockerPromise;
      });
    }

    it(title, async function () {
      if (options.skipTest) return this.skip();
      if (!dockerPromise) return this.skip();

      const docker = await dockerPromise;

      // Create TLS client
      const client = createClient({
        ...options.clientOptions,
        socket: {
          ...options.clientOptions?.socket,
          port: docker.tlsPort,
          tls: true,
          ca: docker.certs.ca,
          cert: docker.certs.cert,
          key: docker.certs.key,
        },
      });

      const ports = { port: docker.port, tlsPort: docker.tlsPort };

      if (options.disableClientSetup) {
        return fn(client, ports);
      }

      await client.connect();

      try {
        await client.flushAll();