You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by dp...@apache.org on 2026/10/14 09:52:31 UTC

(ignite) branch master updated: IGNITE-24619 Describe regexPattern in cache list help (#13530)

This is an automated email from the ASF dual-hosted git repository.

dspavlov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git


The following commit(s) were added to refs/heads/master by this push:
     new f921a377e45 IGNITE-24619 Describe regexPattern in cache list help (#13530)
f921a377e45 is described below

commit f921a377e45c6f8e9a40e6b43c15dbd513d3cefc
Author: ignitetcbot <43...@users.noreply.github.com>
AuthorDate: Wed Oct 14 12:52:22 2026 +0300

    IGNITE-24619 Describe regexPattern in cache list help (#13530)
    
    Codex co-authored-by: Dmitriy Pavlov <dp...@apache.org>
---
 .../commandline/CommandHandlerParsingTest.java        | 19 +++++++++++++++++++
 .../management/cache/CacheListCommandArg.java         |  3 ++-
 ...CommandHandlerClusterByClassTest_cache_help.output |  1 +
 ...HandlerClusterByClassWithSSLTest_cache_help.output |  1 +
 4 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/modules/control-utility/src/test/java/org/apache/ignite/internal/commandline/CommandHandlerParsingTest.java b/modules/control-utility/src/test/java/org/apache/ignite/internal/commandline/CommandHandlerParsingTest.java
index 0fc350ab7c8..bf180045bfc 100644
--- a/modules/control-utility/src/test/java/org/apache/ignite/internal/commandline/CommandHandlerParsingTest.java
+++ b/modules/control-utility/src/test/java/org/apache/ignite/internal/commandline/CommandHandlerParsingTest.java
@@ -30,6 +30,7 @@ import java.util.Set;
 import java.util.UUID;
 import java.util.function.Consumer;
 import java.util.function.Predicate;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import org.apache.ignite.IgniteCheckedException;
 import org.apache.ignite.IgniteException;
@@ -93,6 +94,8 @@ import org.apache.ignite.internal.util.typedef.F;
 import org.apache.ignite.internal.util.typedef.T2;
 import org.apache.ignite.internal.util.typedef.internal.U;
 import org.apache.ignite.testframework.GridTestUtils;
+import org.apache.ignite.testframework.ListeningTestLogger;
+import org.apache.ignite.testframework.LogListener;
 import org.apache.ignite.testframework.junits.SystemPropertiesRule;
 import org.apache.ignite.testframework.junits.WithSystemProperty;
 import org.jetbrains.annotations.Nullable;
@@ -110,6 +113,7 @@ import static org.apache.ignite.internal.QueryMXBeanImpl.EXPECTED_GLOBAL_QRY_ID_
 import static org.apache.ignite.internal.commandline.ArgumentParser.CMD_VERBOSE;
 import static org.apache.ignite.internal.commandline.CommandHandler.DFLT_HOST;
 import static org.apache.ignite.internal.commandline.CommandHandler.DFLT_PORT;
+import static org.apache.ignite.internal.commandline.CommandHandler.EXIT_CODE_OK;
 import static org.apache.ignite.internal.management.api.CommandUtils.cmdText;
 import static org.apache.ignite.internal.management.api.CommandUtils.executable;
 import static org.apache.ignite.internal.management.api.CommandUtils.visitCommandParams;
@@ -130,6 +134,21 @@ import static org.junit.Assert.fail;
  */
 @WithSystemProperty(key = IGNITE_ENABLE_EXPERIMENTAL_COMMAND, value = "true")
 public class CommandHandlerParsingTest {
+    /** */
+    @Test
+    public void testCacheListHelpDescribesRegexPattern() {
+        ListeningTestLogger testLog = new ListeningTestLogger();
+        LogListener regexDescription = LogListener.matches(Pattern.compile(
+            "regexPattern\\s+- Java regular expression for filtering cache, group, or sequence names.*" +
+                "'\\^account-\\.\\*' matches names starting with 'account-'"
+        )).build();
+
+        testLog.registerListener(regexDescription);
+
+        assertEquals(EXIT_CODE_OK, new CommandHandler(testLog).execute(asList("--cache", "help")));
+        assertTrue(regexDescription.check());
+    }
+
     /** */
     @ClassRule public static final TestRule classRule = new SystemPropertiesRule();
 
diff --git a/modules/core/src/main/java/org/apache/ignite/internal/management/cache/CacheListCommandArg.java b/modules/core/src/main/java/org/apache/ignite/internal/management/cache/CacheListCommandArg.java
index 0ad65387156..ae8f54c6089 100644
--- a/modules/core/src/main/java/org/apache/ignite/internal/management/cache/CacheListCommandArg.java
+++ b/modules/core/src/main/java/org/apache/ignite/internal/management/cache/CacheListCommandArg.java
@@ -33,7 +33,8 @@ public class CacheListCommandArg extends IgniteDataTransferObject {
     /** */
     @Order(0)
     @Positional
-    @Argument(example = "regexPattern")
+    @Argument(description = "Java regular expression for filtering cache, group, or sequence names. " +
+        "Examples: '.' matches all names, '^account-.*' matches names starting with 'account-'", example = "regexPattern")
     String regex;
 
     /** */
diff --git a/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassTest_cache_help.output b/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassTest_cache_help.output
index fbb731ec85d..41d82d68466 100644
--- a/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassTest_cache_help.output
+++ b/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassTest_cache_help.output
@@ -50,6 +50,7 @@ Arguments: --cache help --yes
     control.(sh|bat) --cache list regexPattern [nodeId] [--config] [--output-format multi-line] [--groups|--seq]
 
     Parameters:
+      regexPattern                - Java regular expression for filtering cache, group, or sequence names. Examples: '.' matches all names, '^account-.*' matches names starting with 'account-'.
       --config                    - print all configuration parameters for each cache.
       --output-format multi-line  - print configuration parameters per line. This option has effect only when used with --config and without [--groups|--seq].
       --groups                    - print information about groups.
diff --git a/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassWithSSLTest_cache_help.output b/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassWithSSLTest_cache_help.output
index fbb731ec85d..41d82d68466 100644
--- a/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassWithSSLTest_cache_help.output
+++ b/modules/core/src/test/resources/org.apache.ignite.util/GridCommandHandlerClusterByClassWithSSLTest_cache_help.output
@@ -50,6 +50,7 @@ Arguments: --cache help --yes
     control.(sh|bat) --cache list regexPattern [nodeId] [--config] [--output-format multi-line] [--groups|--seq]
 
     Parameters:
+      regexPattern                - Java regular expression for filtering cache, group, or sequence names. Examples: '.' matches all names, '^account-.*' matches names starting with 'account-'.
       --config                    - print all configuration parameters for each cache.
       --output-format multi-line  - print configuration parameters per line. This option has effect only when used with --config and without [--groups|--seq].
       --groups                    - print information about groups.