Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16] #4015

ggivo · 2024-11-10T17:33:24Z

We use docker composer to bring up the test env using redislabs/client-libs-test image.

Example command to bring up test env for dev/test

Redis 8.0-M01

      export REDIS_VERSION=8.0-M01
      docker compose --env-file src/test/resources/env/.env -f src/test/resources/env/docker-compose.yml up

Redis 7.4.1

      export REDIS_VERSION=7.4.1
      docker compose --env-file src/test/resources/env/.env -f src/test/resources/env/docker-compose.yml up

Redis 7.2.6

      export REDIS_VERSION=7.2.6
      docker compose --env-file src/test/resources/env/.env -f src/test/resources/env/docker-compose.yml up

Redis 6.2.16
- NOTE : 6.2.16 uses a dedicated .env.v6.12.16 file, since some of the redis configuration settings are not supported in 6.2.16
docker compose --env-file src/test/resources/env/.env.v6.12.16 -f src/test/resources/env/docker-compose.yml up

Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16]

When run against older Redis version it appears that some tests are using commands available only in newer Redis server versions. To resolve this we are introducing two new annotations/rules

Introduce SinceRedisVersion annotation/Rule - for conditionally running tests based on Redis server version contacted
Introduce EnableOnCommad annotation/Rule - for conditionally running tests based on command availability on the server

And mark respective tests with the least Redis Version required by the test

SinceRedisVersion ("7.4.0") - Mark tests using commands/modifiers introduced with Redis 7.4.0
SinceRedisVersion ("7.2.0") - Mark tests using commands/modifiers introduced with Redis 7.2.0
SinceRedisVersion ("7.0.0") - Mark tests using commands/modifiers introduced with Redis 7.0.0

The same approach used to mark CSC tests

Disabled client-side caching tests for versions below 7.4

Fix in Jedis Client (Redis 6.x)

Fix NPE on CommandInfo - some of the array elements returned are available since ( Redis server 6.0/7.0)
(see NPE thrown when invoking Jedis#commandInfo against Redis server 6.2.16 #4017 )
Fix NPE when reading AccessControlLogEntry
(see NPE thrown on jedis.aclLog() used against Redis server 7.2.0< #4016)

Fixed Test failures against 6.x

Fix JedisPooledClientSideCacheTest
Fix AccessControlListCommandsTest.aclLogTest:372 » NullPointer
Fix AccessControlListCommandsTest.aclLogWithEntryID:473 » NullPointer
Fix StreamsCommandsTest
Fix StreamsPipelineCommandsTest xadd - Starting with Redis version 7.0.0: Added support for the -* explicit ID form.

- Test env migrated to use native Redis server TLS instead of using stunnel

There are still Cluster SSL tests failing against 6.2.16 env. see Revisit TLS Cluster tests to drop stunnel #4018
The primary reason for those failures is the Redis server 6.2.16 is returning the non-TLS port in the CLUSTER SLOTS command in contrast to Redis Server 7.2.0+. I suggest reviewing & addressing Cluster SSL related test failures with follow-up PR.

Ignored tests during migration

Disabled ModuleTest in containerized test env.
ModuleTest uses a custom test module to test load/unload/sendCommand. Requires pre-build test module on the same os like test container to avoid errors
Disable UDS tests in containerized test env
No easy way to make unix sockets work on MAC with docker

Closes #4016, Closes #4017

src/test/java/redis/clients/jedis/util/TlsUtil.java

… 6.2.16] Use docker composer to bring up the test env using `redislabs/client-libs-test` image. When run against older Redis version some tests are using commands available only in newer Redis server versions. To resolve this we are introducing two new annotations/rules - Introduce `SinceRedisVersion` annotation/Rule - for conditionally running tests based on Redis server version contacted - Introduce `EnableOnCommad` annotation/Rule - for conditionally running tests based on command availability on the server And mark respective tests with the least Redis Version required by the test - SinceRedisVersion ("7.4.0") - Mark tests using commands/modifiers introduced with Redis 7.4.0 - SinceRedisVersion ("7.2.0") - Mark tests using commands/modifiers introduced with Redis 7.2.0 - SinceRedisVersion ("7.0.0") - Mark tests using commands/modifiers introduced with Redis 7.0.0 The same approach used to mark CSC tests - Disabled client-side caching tests for versions below 7.4 Fix in Jedis Client against Redis server 6.x - Fix NPW on CommandInfo - some of the array elements returned are available based from given RedisServer aclCategories (as of Redis 6.0) , tips , (as of Redis 7.0) subcommands - Fix NPE AccessControlLogEntry when used against Redis 6 Starting with Redis version 7.2.0: Added entry ID, timestamp created, and timestamp last updated fields. Fix Test failures against 6.x - Fix JedisPooledClientSideCacheTest - Fix AccessControlListCommandsTest.aclLogTest:372 » NullPointer - Fix AccessControlListCommandsTest.aclLogWithEntryID:473 » NullPointer - Fix StreamsCommandsTest - Fix StreamsPipelineCommandsTest xadd - Starting with Redis version 7.0.0: Added support for the <ms>-* explicit ID form. - Test env migrated to use native Redis server TLS instead of using stunnel Not all tests were migrated - Disable Modules test in containerized test env ModuleTest uses custom test module to test load/unload/sendCommand. Requires pre-build test module on the same os like test container to avoid errors - Disable UDS tests in containerized test env No easy way to make unix sockets work on MAC with docker

java.lang.AssertionError: Expected :[(2.1909382939338684,41.433790281840835), (2.187376320362091,41.40634178640635)] Actual :[(2.1909382939338684,41.43379028184083), (2.187376320362091,41.40634178640635)] Compare with tolerance to avoid error on returned precision on mac

…Test.commandInfo

Adding ignored unit test for repro

tishun · 2024-11-12T11:07:49Z

src/test/java/redis/clients/jedis/SSLJedisClusterTest.java

@@ -27,7 +29,7 @@ public class SSLJedisClusterTest extends JedisClusterTestBase {
    int port = hostAndPort.getPort();
    if (host.equals("127.0.0.1")) {
      host = "localhost";
-      port = port + 1000;
+      //port = port + 1000;


Is this a leftover?

tishun · 2024-11-12T11:08:00Z

src/test/java/redis/clients/jedis/SSLJedisClusterTest.java

@@ -37,61 +39,90 @@ public class SSLJedisClusterTest extends JedisClusterTestBase {
    if ("localhost".equals(hostAndPort.getHost())) {
      return hostAndPort;
    }
-    return new HostAndPort(hostAndPort.getHost(), hostAndPort.getPort() + 1000);
+    //return new HostAndPort(hostAndPort.getHost(), hostAndPort.getPort() + 1000);


...and this?

tishun · 2024-11-12T11:08:35Z

src/test/java/redis/clients/jedis/SSLJedisSentinelPoolTest.java

@@ -19,7 +23,8 @@ public class SSLJedisSentinelPoolTest {

  @BeforeClass
  public static void prepare() {
-    SSLJedisTest.setupTrustStore();
+    TlsUtil.createAndSaveEnvTruststore("redis9-sentinel", "changeit");
+    //TlsUtil.setJvmTrustStore(envTruststore("redis9-sentinel"));


... and this? :)

tishun · 2024-11-12T14:33:56Z

.github/workflows/test-on-docker.yml

@@ -0,0 +1,128 @@
+---
+
+name: Build and Test using containerized environment


Would we keep both workflows (the old one and this one)?

This was the initial idea. However, this will require extra effort since the current approach for setting up infra for the tests uses stunnel with TLS termination causing some SSL-related cluster tests to fail ( Redis server port announce non-tls port and hence the above mappers used to change the port).
I see three options here:

keep only the containerized setup

update the current infra to use the Redis Server with native TLS port,

or revisit the failing SSL and rewrite them to support both modes.

Will ping @sazzad16 and choose which path to update the review..

tishun · 2024-11-13T08:43:00Z

LGTM, the code looks much neater this way!

This reverts commit f932e59.

ggivo self-assigned this Nov 10, 2024

github-advanced-security bot found potential problems Nov 10, 2024

View reviewed changes

src/test/java/redis/clients/jedis/util/TlsUtil.java Dismissed Show dismissed Hide dismissed

src/test/java/redis/clients/jedis/util/TlsUtil.java Dismissed Show dismissed Hide dismissed

ggivo force-pushed the migrate_to_clients_test_image branch from eb4bb8c to 68c372a Compare November 10, 2024 19:14

ggivo added 2 commits November 10, 2024 21:28

ggivo force-pushed the migrate_to_clients_test_image branch from 68c372a to 0aa9343 Compare November 10, 2024 19:30

ggivo marked this pull request as ready for review November 11, 2024 06:03

This was referenced Nov 11, 2024

Revisit TLS Cluster tests to drop stunnel #4018

Open

Fix AccessControlListCommandsTest tests against Redis 6.2.16 #4019

Open

ggivo added 3 commits November 11, 2024 09:47

REDIS_VERSION env var for setting test container version

e2dd227

Remove accidentally submitted conf directive

9af7dcc

Revert changes in integration action

a691416

ggivo force-pushed the migrate_to_clients_test_image branch from 77f7e4e to a691416 Compare November 11, 2024 08:36

ggivo and others added 9 commits November 11, 2024 11:17

EnabledOnCommandRule get info only for requested command

1895d09

Remove accidentally added SinceRedisVersion 7.0.0 for ControlCommands…

12c2ce4

…Test.commandInfo

Found issue with CommandInfo command

6f2ced5

Adding ignored unit test for repro

Use SinceRedisVersion instead of "EnableOnCmmand" because of redis#4020

7862280

Use SinceRedisVersion instead of "EnableOnCommand" because of redis#4020

3587b4c

switch default TEST_ENV_PROVIDER

2b3fb84

Merge branch 'master' into migrate_to_clients_test_image

d679f01

Use CommandInfo for subcommand

918dc5f

Get Iterable from Map

05ef43a

sazzad16 added the testing label Nov 12, 2024

ggivo and others added 2 commits November 12, 2024 13:35

Use client-libs-test image based on redis-server-stack

f932e59

Fix: command and subcommand are concatenated with a pipe

c79c437

tishun reviewed Nov 13, 2024

View reviewed changes

ggivo added 2 commits November 13, 2024 15:14

Remove commented out code

8c42cbe

Revert "Use client-libs-test image based on redis-server-stack"

23be75b

This reverts commit f932e59.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16] #4015

Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16] #4015

ggivo commented Nov 10, 2024 •

edited

Loading

tishun Nov 12, 2024

tishun Nov 12, 2024

tishun Nov 12, 2024

tishun Nov 12, 2024

ggivo Nov 13, 2024

tishun commented Nov 13, 2024

		@@ -0,0 +1,128 @@
		---

		name: Build and Test using containerized environment

Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16] #4015

Are you sure you want to change the base?

Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16] #4015

Conversation

ggivo commented Nov 10, 2024 • edited Loading

Example command to bring up test env for dev/test

Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16]

Fix in Jedis Client (Redis 6.x)

Fixed Test failures against 6.x

- Test env migrated to use native Redis server TLS instead of using stunnel

Ignored tests during migration

tishun Nov 12, 2024

Choose a reason for hiding this comment

tishun Nov 12, 2024

Choose a reason for hiding this comment

tishun Nov 12, 2024

Choose a reason for hiding this comment

tishun Nov 12, 2024

Choose a reason for hiding this comment

ggivo Nov 13, 2024

Choose a reason for hiding this comment

tishun commented Nov 13, 2024

ggivo commented Nov 10, 2024 •

edited

Loading