Enhancement Request 37169695 - [36401381->24.09.1] ENH: Improve the NSLookup -name option exception handling (ce-main->ce-24.09)

Remote remote.full on coherence-ce/release/coherence-ce-v24.09 success, changes 111926, synced @111936, job.9.20241015142728.4681

[git-p4: depot-paths = "//dev/coherence-ce/release/coherence-ce-v24.09/": change = 111941]

Author: jfialli

prj/coherence-discovery/src/main/java/com/tangosol/discovery/NSLookup.java

@@ -1013,13 +1013,25 @@ public void accept(String sClusterFound, String sResult)
                                 sCluster = sTok.nextToken().trim();
                                 try (Connection conn2 = Connection.open(sCluster, socketAddr, cTimeoutMillis))
                                     {
-                                    System.out.println("Cluster " + sCluster + ":\t" + conn2.lookup(NS_STRING_PREFIX + sName));
+                                    String sResultLookup = conn2.lookup(NS_STRING_PREFIX + sName);
+
+                                    System.out.println("Cluster " + sCluster + ":\t" + sResultLookup);
+                                    if (sResultLookup == null)
+                                        {
+                                        reportNameWarning(sName);
+                                        }
                                     }
                                 }
                             }
                         else
                             {
-                            System.out.println(conn.lookup(NS_STRING_PREFIX + sName));
+                            String sResultLookup = conn.lookup(NS_STRING_PREFIX + sName);
+
+                            System.out.println(sResultLookup);
+                            if (sResultLookup == null)
+                                {
+                                reportNameWarning(sName);
+                                }
                             }
                         }
                     ex = null;
@@ -1045,7 +1057,15 @@ public void accept(String sClusterFound, String sResult)
      */
     protected static void showInstructions()
         {
-        String sClass =  NSLookup.class.getCanonicalName();
+        String       sClass        = NSLookup.class.getCanonicalName();
+        StringBuffer sbLookupNames = new StringBuffer("Valid predefined lookup names for -" + COMMAND_NAME + " option: ");
+
+        for (String sName : VALID_PREDEFINED_LOOKUP_NAMES)
+            {
+            sbLookupNames.append(" " + sName + ",");
+            }
+        sbLookupNames.setCharAt(sbLookupNames.length() - 1, '.');
+
         System.out.println();
         System.out.println("java " + sClass + " <commands ...>");
         System.out.println();
@@ -1058,11 +1078,66 @@ protected static void showInstructions()
         System.out.println("\t-" + COMMAND_PORT + "    the cluster port; default "  + DEFAULT_CLUSTERPORT);
         System.out.println("\t-" + COMMAND_TIMEOUT + " the timeout (in seconds) of the lookup request; default " + (DEFAULT_TIMEOUT/1000));
         System.out.println();
+        System.out.println(sbLookupNames.toString());
+        System.out.println();
         System.out.println("Example:");
         System.out.println("\tjava " + sClass + " -" + COMMAND_HOST + " host.mycompany.com -" + COMMAND_NAME + " " + JMX_CONNECTOR_URL);
         System.out.println();
         }
 
+    /**
+     * Descriptive error feedback for a failed lookup of provided -name parameter.
+     *
+     * @param sName  value passed to -name argument
+     *
+     * @return null if no feedback or descriptive feedback
+     */
+    protected static String validateName(String sName)
+        {
+        for (String s : VALID_PREDEFINED_LOOKUP_NAMES)
+            {
+            if (s.equals(sName))
+                {
+                return null;
+                }
+            }
+
+        StringBuffer sb = new StringBuffer();
+
+        sb.append("Warning: provided -name parameter of \"" + sName + "\"");
+        sb.append(" does not match predefined Name Service lookups of ");
+        for (int i =0; i < VALID_PREDEFINED_LOOKUP_NAMES.length; i++)
+            {
+            sb.append("\"" + VALID_PREDEFINED_LOOKUP_NAMES[i] + "\"");
+            if (i + 1 < VALID_PREDEFINED_LOOKUP_NAMES.length)
+                {
+                sb.append(",");
+                }
+            else
+                {
+                sb.append(".");
+                }
+            }
+        sb.append(System.lineSeparator());
+        sb.append("warning: If looking up an extend proxy service, verify the scoped proxy service name is correct.");
+        return sb.toString();
+        }
+
+    /**
+     * Reports {@code -name} parameter warning when appropriate to standard error.
+     *
+     * @param sName Name Service looked up
+     */
+    protected static void reportNameWarning(String sName)
+        {
+        String sWarning = validateName(sName);
+
+        if (sWarning != null)
+            {
+            System.err.println(sWarning);
+            }
+        }
+
     // ----- static data members -------------------------------------------
 
     public static final String COMMAND_HELP    = "?";
@@ -1117,6 +1192,13 @@ protected static void showInstructions()
      */
     public static final String HTTP_HEALTH_URL = "health/HTTPHealthURL";
 
+    /**
+     * Cluster info lookup name.
+     *
+     * @since 25.03
+     */
+    public static final String CLUSTER_INFO = "Cluster/info";
+
     /**
      * The gRPC Proxy lookup name.
      *
@@ -1126,6 +1208,14 @@ protected static void showInstructions()
     // This value here must match the fully scoped name used for the gRPC proxy in the
     // grpc-proxy-cache-config.xml file and in the GrpcDependencies.DEFAULT_PROXY_NAME field
 
+    /**
+     * Valid predefined lookup names.
+     *
+     * @since 25.03
+     */
+    public static final String[] VALID_PREDEFINED_LOOKUP_NAMES =
+            {JMX_CONNECTOR_URL, HTTP_MANAGEMENT_URL, HTTP_METRICS_URL, HTTP_HEALTH_URL, GRPC_PROXY_URL, CLUSTER_INFO};
+
     /**
      * Default timeout in milliseconds
      */

prj/test/unit/coherence-tests/src/test/java/com/tangosol/discovery/NSLookupTest.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2000, 2024, Oracle and/or its affiliates.
+ *
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * https://oss.oracle.com/licenses/upl.
+ */
+
+package com.tangosol.discovery;
+
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+
+/**
+ * Unit test of the NSLookup class.
+ *
+ * @author jf  2024.10.07
+ */
+public class NSLookupTest
+    {
+    @Test
+    public void shouldReportNameWarning()
+        {
+        for (String sName : NSLookup.VALID_PREDEFINED_LOOKUP_NAMES)
+            {
+            StringBuffer sbTypo = new StringBuffer(sName);
+
+            sbTypo.setCharAt(0, Character.toUpperCase(sName.charAt(0)));
+            sbTypo.setCharAt(1, Character.toLowerCase(sName.charAt(1)));
+            sbTypo.setCharAt(2, Character.toUpperCase(sName.charAt(2)));
+            assertNotNull("assert predefined lookup name " + sbTypo + " with injected typo results in a warning",
+                          NSLookup.validateName(sbTypo.toString()));
+            }
+        }
+
+    @Test
+    public void mustNotReportNameWarning()
+        {
+        for (String sName : NSLookup.VALID_PREDEFINED_LOOKUP_NAMES)
+            {
+            assertNull("assert no warning for predefined lookup names", NSLookup.validateName(sName));
+            }
+        }
+    }