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

Author: bobymicroby

.github/workflows/tests.yml

@@ -21,8 +21,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ['18', '20', '22']
-        redis-version: [ 'rs-7.4.0-v1', '8.0-M04-pre']
+        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:

packages/bloom/lib/test-utils.ts

@@ -3,7 +3,7 @@ import RedisBloomModules from '.';
 
 export default new TestUtils({
   dockerImageName: 'redislabs/client-libs-test',
-  dockerImageVersionArgument: 'redisbloom-version',
+  dockerImageVersionArgument: 'redis-version',
   defaultDockerVersion: '8.0-M04-pre'
 });
 

packages/graph/lib/test-utils.ts

@@ -4,7 +4,7 @@ import RedisGraph from '.';
 
 export default new TestUtils({
   dockerImageName: 'redislabs/client-libs-test',
-  dockerImageVersionArgument: 'redisgraph-version',
+  dockerImageVersionArgument: 'redis-version',
   defaultDockerVersion: '8.0-M04-pre'
 });
 

packages/json/lib/test-utils.ts

@@ -3,7 +3,7 @@ import RedisJSON from '.';
 
 export default new TestUtils({
   dockerImageName: 'redislabs/client-libs-test',
-  dockerImageVersionArgument: 'redisgraph-version',
+  dockerImageVersionArgument: 'redis-version',
   defaultDockerVersion: '8.0-M04-pre'
 });
 

packages/search/lib/test-utils.ts

@@ -3,7 +3,7 @@ import RediSearch from '.';
 
 export default new TestUtils({
     dockerImageName: 'redislabs/client-libs-test',
-    dockerImageVersionArgument: 'redisearch-version',
+    dockerImageVersionArgument: 'redis-version',
     defaultDockerVersion: '8.0-M04-pre'
 });
 

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;
@@ -50,10 +52,25 @@ 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
+  ];
 
-  const port = (await portIterator.next()).value
-  const command = `docker run -e PORT="${port.toString()}"  -d --network host ${image}:${version} --port ${port.toString()} ${serverArguments.join(' ')}`
-  const { stdout, stderr } = await execAsync(command);
+  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}`);
@@ -68,7 +85,6 @@ async function spawnRedisServerDocker({
     dockerId: stdout.trim()
   };
 }
-
 const RUNNING_SERVERS = new Map<Array<string>, ReturnType<typeof spawnRedisServerDocker>>();
 
 export function spawnRedisServer(dockerConfig: RedisServerDockerConfig, serverArguments: Array<string>): Promise<RedisServerDocker> {
@@ -83,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}`);
   }
@@ -135,10 +151,10 @@ 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);
 
@@ -227,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);
       }
 
@@ -260,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;

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>;

packages/time-series/lib/test-utils.ts

@@ -3,7 +3,7 @@ import TimeSeries from '.';
 
 export default new TestUtils({
   dockerImageName: 'redislabs/client-libs-test',
-  dockerImageVersionArgument: 'timeseries-version',
+  dockerImageVersionArgument: 'redis-version',
   defaultDockerVersion: '8.0-M04-pre'
 });