churn(test): use redislabs/client-libs-test for testing

bobymicroby · bobymicroby · commit 93b95c95fbd8 · 2025-02-14T10:07:29.000+02:00
This  switches our testing infrastructure from redis/redis-stack to
redislabs/client-libs-test Docker image across all packages. This change
also updates the default Docker version from 7.4.0-v1 to 8.0-M04-pre.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -21,8 +21,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ['18', '20', '22']
-        redis-version: ['6.2.6-v17', '7.2.0-v13', '7.4.0-v1']
+        node-version: [ '18', '20', '22' ]
+        redis-version: [ 'rs-7.2.0-v13', 'rs-7.4.0-v1', '8.0-M04-pre' ]
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/packages/bloom/lib/test-utils.ts b/packages/bloom/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import RedisBloomModules from '.';
 
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redisbloom-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: '8.0-M04-pre'
 });
 
 export const GLOBAL = {
diff --git a/packages/client/lib/test-utils.ts b/packages/client/lib/test-utils.ts
@@ -6,9 +6,9 @@ import { Command } from './RESP/types';
 import { BasicCommandParser } from './client/parser';
 
 const utils = new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redis-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: '8.0-M04-pre'
 });
 
 export default utils;
diff --git a/packages/entraid/lib/test-utils.ts b/packages/entraid/lib/test-utils.ts
@@ -4,9 +4,9 @@ import TestUtils from '@redis/test-utils';
 import { EntraidCredentialsProvider } from './entraid-credentials-provider';
 
 export const testUtils = new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redis-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: '8.0-M04-pre'
 });
 
 const DEBUG_MODE_ARGS = testUtils.isVersionGreaterThan([7]) ?
diff --git a/packages/graph/lib/test-utils.ts b/packages/graph/lib/test-utils.ts
@@ -1,10 +1,11 @@
 import TestUtils from '@redis/test-utils';
 import RedisGraph from '.';
 
+
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redisgraph-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: '8.0-M04-pre'
 });
 
 export const GLOBAL = {
diff --git a/packages/json/lib/test-utils.ts b/packages/json/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import RedisJSON from '.';
 
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redisgraph-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: '8.0-M04-pre'
 });
 
 export const GLOBAL = {
diff --git a/packages/search/lib/test-utils.ts b/packages/search/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import RediSearch from '.';
 
 export default new TestUtils({
-    dockerImageName: 'redis/redis-stack',
+    dockerImageName: 'redislabs/client-libs-test',
     dockerImageVersionArgument: 'redisearch-version',
-    defaultDockerVersion: '7.4.0-v1'
+    defaultDockerVersion: '8.0-M04-pre'
 });
 
 export const GLOBAL = {
diff --git a/packages/search/package.json b/packages/search/package.json
@@ -9,7 +9,8 @@
     "!dist/tsconfig.tsbuildinfo"
   ],
   "scripts": {
-    "test": "nyc -r text-summary -r lcov mocha -r tsx './lib/**/*.spec.ts'"
+    "test": "nyc -r text-summary -r lcov mocha -r tsx './lib/**/*.spec.ts'",
+    "test-sourcemap": "mocha -r ts-node/register/transpile-only './lib/**/*.spec.ts'"
   },
   "peerDependencies": {
     "@redis/client": "^5.0.0-next.6"
diff --git a/packages/test-utils/lib/dockers.ts b/packages/test-utils/lib/dockers.ts
@@ -4,9 +4,11 @@ import { once } from 'node:events';
 import { createClient } from '@redis/client/index';
 import { setTimeout } from 'node:timers/promises';
 // import { ClusterSlotsReply } from '@redis/client/dist/lib/commands/CLUSTER_SLOTS';
+
+import { execFile as execFileCallback } from 'node:child_process';
 import { promisify } from 'node:util';
-import { exec } from 'node:child_process';
-const execAsync = promisify(exec);
+
+const execAsync = promisify(execFileCallback);
 
 interface ErrorWithCode extends Error {
   code: string;
@@ -46,11 +48,29 @@ export interface RedisServerDocker {
   dockerId: string;
 }
 
-async function spawnRedisServerDocker({ image, version }: RedisServerDockerConfig, serverArguments: Array<string>): Promise<RedisServerDocker> {
-  const port = (await portIterator.next()).value,
-    { stdout, stderr } = await execAsync(
-      `docker run -e REDIS_ARGS="--port ${port.toString()} ${serverArguments.join(' ')}" -d --network host ${image}:${version}`
-    );
+async function spawnRedisServerDocker({
+  image,
+  version
+}: RedisServerDockerConfig, serverArguments: Array<string>): Promise<RedisServerDocker> {
+  const port = (await portIterator.next()).value;
+  const portStr = port.toString();
+
+  const dockerArgs = [
+    'run',
+    '-e', `PORT=${portStr}`,
+    '-d',
+    '--network', 'host',
+    `${image}:${version}`,
+    '--port', portStr
+  ];
+
+  if (serverArguments.length > 0) {
+    dockerArgs.push(...serverArguments);
+  }
+
+  console.log(`[Docker] Spawning Redis container - Image: ${image}:${version}, Port: ${port}`);
+
+  const { stdout, stderr } = await execAsync('docker', dockerArgs);
 
   if (!stdout) {
     throw new Error(`docker run error - ${stderr}`);
@@ -65,7 +85,6 @@ async function spawnRedisServerDocker({ image, version }: RedisServerDockerConfi
     dockerId: stdout.trim()
   };
 }
-
 const RUNNING_SERVERS = new Map<Array<string>, ReturnType<typeof spawnRedisServerDocker>>();
 
 export function spawnRedisServer(dockerConfig: RedisServerDockerConfig, serverArguments: Array<string>): Promise<RedisServerDocker> {
@@ -80,7 +99,7 @@ export function spawnRedisServer(dockerConfig: RedisServerDockerConfig, serverAr
 }
 
 async function dockerRemove(dockerId: string): Promise<void> {
-  const { stderr } = await execAsync(`docker rm -f ${dockerId}`);
+  const { stderr } = await execAsync('docker', ['rm', '-f', dockerId]);
   if (stderr) {
     throw new Error(`docker rm error - ${stderr}`);
   }
@@ -132,15 +151,15 @@ async function spawnRedisClusterNodeDockers(
         '5000'
       ], clientConfig).then(async replica => {
 
-        const requirePassIndex = serverArguments.findIndex((x)=>x==='--requirepass');
-        if(requirePassIndex!==-1) {
-          const password = serverArguments[requirePassIndex+1];
-          await replica.client.configSet({'masterauth': password})
+        const requirePassIndex = serverArguments.findIndex((x) => x === '--requirepass');
+        if (requirePassIndex !== -1) {
+          const password = serverArguments[requirePassIndex + 1];
+          await replica.client.configSet({ 'masterauth': password })
         }
         await replica.client.clusterMeet('127.0.0.1', master.docker.port);
 
         while ((await replica.client.clusterSlots()).length === 0) {
-          await setTimeout(50);
+          await setTimeout(25);
         }
 
         await replica.client.clusterReplicate(
@@ -224,7 +243,7 @@ async function spawnRedisClusterDockers(
       while (
         totalNodes(await client.clusterSlots()) !== nodes.length ||
         !(await client.sendCommand<string>(['CLUSTER', 'INFO'])).startsWith('cluster_state:ok') // TODO
-      ) {
+        ) {
         await setTimeout(50);
       }
 
@@ -257,7 +276,7 @@ export function spawnRedisCluster(
     return runningCluster;
   }
 
-  const dockersPromise = spawnRedisClusterDockers(dockersConfig, serverArguments,clientConfig);
+  const dockersPromise = spawnRedisClusterDockers(dockersConfig, serverArguments, clientConfig);
 
   RUNNING_CLUSTERS.set(serverArguments, dockersPromise);
   return dockersPromise;
diff --git a/packages/test-utils/lib/index.spec.ts b/packages/test-utils/lib/index.spec.ts
@@ -0,0 +1,37 @@
+import { strict as assert } from 'node:assert';
+import TestUtils from './index';
+
+describe('TestUtils', () => {
+  describe('parseVersionNumber', () => {
+    it('should handle special versions', () => {
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('latest'), [Infinity]);
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('edge'), [Infinity]);
+    });
+
+    it('should parse simple version numbers', () => {
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('7.4.0'), [7, 4, 0]);
+    });
+
+    it('should handle versions with multiple dashes and prefixes', () => {
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('rs-7.4.0-v2'), [7, 4, 0]);
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('rs-7.4.0'), [7, 4, 0]);
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('7.4.0-v2'), [7, 4, 0]);
+    });
+
+    it('should handle various version number formats', () => {
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('10.5'), [10, 5]);
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('8.0.0'), [8, 0, 0]);
+      assert.deepStrictEqual(TestUtils.parseVersionNumber('rs-6.2.4-v1'), [6, 2, 4]);
+    });
+
+    it('should throw TypeError for invalid version strings', () => {
+      ['', 'invalid', 'rs-', 'v2', 'rs-invalid-v2'].forEach(version => {
+        assert.throws(
+          () => TestUtils.parseVersionNumber(version),
+          TypeError,
+          `Expected TypeError for version string: ${version}`
+        );
+      });
+    });
+  });
+});
diff --git a/packages/test-utils/lib/index.ts b/packages/test-utils/lib/index.ts
@@ -19,12 +19,38 @@ import { RedisServerDockerConfig, spawnRedisServer, spawnRedisCluster } from './
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
+
 interface TestUtilsConfig {
+  /**
+   * The name of the Docker image to use for spawning Redis test instances.
+   * This should be a valid Docker image name that contains a Redis server.
+   *
+   * @example 'redislabs/client-libs-test'
+   */
   dockerImageName: string;
+
+  /**
+   * The command-line argument name used to specify the Redis version.
+   * This argument can be passed when running tests / GH actions.
+   *
+   * @example
+   * If set to 'redis-version', you can run tests with:
+   * ```bash
+   * npm test -- --redis-version="6.2"
+   * ```
+   */
   dockerImageVersionArgument: string;
+
+  /**
+   * The default Redis version to use if no version is specified via command-line arguments.
+   * Can be a specific version number (e.g., '6.2'), 'latest', or 'edge'.
+   * If not provided, defaults to 'latest'.
+   *
+   * @optional
+   * @default 'latest'
+   */
   defaultDockerVersion?: string;
 }
-
 interface CommonTestOptions {
   serverArguments: Array<string>;
   minimumDockerVersion?: Array<number>;
@@ -83,22 +109,27 @@ interface Version {
 }
 
 export default class TestUtils {
-  static #parseVersionNumber(version: string): Array<number> {
+  static parseVersionNumber(version: string): Array<number> {
     if (version === 'latest' || version === 'edge') return [Infinity];
 
-    const dashIndex = version.indexOf('-');
-    return (dashIndex === -1 ? version : version.substring(0, dashIndex))
-      .split('.')
-      .map(x => {
-        const value = Number(x);
-        if (Number.isNaN(value)) {
-          throw new TypeError(`${version} is not a valid redis version`);
-        }
 
-        return value;
-      });
-  }
+    // Match complete version number patterns
+    const versionMatch = version.match(/(^|\-)\d+(\.\d+)*($|\-)/);
+    if (!versionMatch) {
+      throw new TypeError(`${version} is not a valid redis version`);
+    }
+
+    // Extract just the numbers and dots between first and last dash (or start/end)
+    const versionNumbers = versionMatch[0].replace(/^\-|\-$/g, '');
 
+    return versionNumbers.split('.').map(x => {
+      const value = Number(x);
+      if (Number.isNaN(value)) {
+        throw new TypeError(`${version} is not a valid redis version`);
+      }
+      return value;
+    });
+  }
   static #getVersion(argumentName: string, defaultVersion = 'latest'): Version {
     return yargs(hideBin(process.argv))
       .option(argumentName, {
@@ -108,7 +139,7 @@ export default class TestUtils {
       .coerce(argumentName, (version: string) => {
         return {
           string: version,
-          numbers: TestUtils.#parseVersionNumber(version)
+          numbers: TestUtils.parseVersionNumber(version)
         };
       })
       .demandOption(argumentName)
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
@@ -3,6 +3,9 @@
   "private": true,
   "main": "./dist/lib/index.js",
   "types": "./dist/lib/index.d.ts",
+  "scripts": {
+    "test": "nyc -r text-summary -r lcov mocha -r tsx './lib/**/*.spec.ts'"
+  },
   "peerDependencies": {
     "@redis/client": "*"
   },
diff --git a/packages/time-series/lib/test-utils.ts b/packages/time-series/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import TimeSeries from '.';
 
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'timeseries-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: '8.0-M04-pre'
 });
 
 export const GLOBAL = {
