Add Util to get Trex server mode --fix comments

HongJiangEric · leomaatEric · commit f669c699c5f7 · 2019-07-25T16:42:19.000+08:00
diff --git a/src/e2e-test/java/com/cisco/trex/stateless/TRexClientUtilTest.java b/src/e2e-test/java/com/cisco/trex/stateless/TRexClientUtilTest.java
@@ -0,0 +1,13 @@
+package com.cisco.trex.stateless;
+
+import com.cisco.trex.util.TRexClientUtil;
+import com.cisco.trex.util.TRexServerMode;
+import org.junit.Test;
+
+public class TRexClientUtilTest {
+    @Test
+    public void getModeTest() throws Exception {
+        TRexServerMode mode = TRexClientUtil.getMode("trex-host", "4501");
+        System.out.println(mode);
+    }
+}
diff --git a/src/e2e-test/java/com/cisco/trex/stateless/TrexClientUtilTest.java b/src/e2e-test/java/com/cisco/trex/stateless/TrexClientUtilTest.java
@@ -1,6 +1,5 @@
 package com.cisco.trex.stateless;
 
-import com.cisco.trex.util.TrexClientUtil;
 import com.cisco.trex.util.TrexServerMode;
 import org.junit.Test;
 
diff --git a/src/main/java/com/cisco/trex/ClientBase.java b/src/main/java/com/cisco/trex/ClientBase.java
@@ -13,6 +13,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 
+import com.cisco.trex.util.Constants;
 import org.apache.commons.lang.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -49,7 +50,6 @@
 public abstract class ClientBase {
 
     protected static final Logger LOGGER = LoggerFactory.getLogger(ClientBase.class);
-    protected static final String JSON_RPC_VERSION = "2.0";
     protected static final Gson GSON = buildGson();
     protected String host;
     protected String port;
@@ -74,7 +74,7 @@ private String buildRequest(String methodName, Map<String, Object> payload) {
         }
         Map<String, Object> parameters = new HashMap<>();
         parameters.put("id", "aggogxls");
-        parameters.put("jsonrpc", JSON_RPC_VERSION);
+        parameters.put("jsonrpc", Constants.JSON_RPC_VERSION);
         parameters.put("method", methodName);
         payload.put("api_h", apiH);
         parameters.put("params", payload);
@@ -232,7 +232,7 @@ public TRexCommand buildCommand(String methodName, Map<String, Object> parameter
         Map<String, Object> payload = new HashMap<>();
         int cmdId = randomizer.nextInt() & Integer.MAX_VALUE; //get a positive random value
         payload.put("id", cmdId);
-        payload.put("jsonrpc", JSON_RPC_VERSION);
+        payload.put("jsonrpc", Constants.JSON_RPC_VERSION);
         payload.put("method", methodName);
         if (!StringUtils.isEmpty(this.masterHandler)) {
             payload.put("handler", this.masterHandler);
diff --git a/src/main/java/com/cisco/trex/stateful/TRexAstfClient.java b/src/main/java/com/cisco/trex/stateful/TRexAstfClient.java
@@ -11,6 +11,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 
+import com.cisco.trex.util.Constants;
 import org.apache.commons.lang.StringUtils;
 
 import com.cisco.trex.ClientBase;
@@ -31,8 +32,6 @@
  */
 public class TRexAstfClient extends ClientBase {
 
-    private static final Integer API_VERSION_MAJOR = 1;
-    private static final Integer API_VERSION_MINOR = 7;
     private static final String ASTF = "ASTF";
 
     /**
@@ -52,14 +51,14 @@ public TRexAstfClient(String host, String port, String userName) {
     protected void serverAPISync() throws TRexConnectionException {
         LOGGER.info("Sync API with the TRex");
         Map<String, Object> apiVers = new HashMap<>();
-        apiVers.put("major", API_VERSION_MAJOR);
-        apiVers.put("minor", API_VERSION_MINOR);
+        apiVers.put("major", Constants.API_VERSION_MAJOR);
+        apiVers.put("minor", Constants.ASTF_API_VERSION_MINOR);
         apiVers.put("name", ASTF);
         TRexClientResult<ApiVersionHandler> result = callMethod("api_sync_v2", apiVers, ApiVersionHandler.class);
         if (result.get() == null) {
             TRexConnectionException e = new TRexConnectionException(
-                    "Unable to connect to TRex server. Required API version is " + API_VERSION_MAJOR + "."
-                            + API_VERSION_MINOR);
+                    "Unable to connect to TRex server. Required API version is " + Constants.API_VERSION_MAJOR + "."
+                            + Constants.ASTF_API_VERSION_MINOR);
             LOGGER.error("Unable to sync client with TRex server due to: API_H is null.", e.getMessage());
             throw e;
         }
diff --git a/src/main/java/com/cisco/trex/util/Constants.java b/src/main/java/com/cisco/trex/util/Constants.java
@@ -0,0 +1,10 @@
+package com.cisco.trex.util;
+
+/**
+ * Class for constants
+ */
+public final class Constants {
+    public static final String JSON_RPC_VERSION = "2.0";
+    public static Integer API_VERSION_MAJOR = 1;
+    public static Integer ASTF_API_VERSION_MINOR = 7;
+}
diff --git a/src/main/java/com/cisco/trex/util/TRexClientUtil.java b/src/main/java/com/cisco/trex/util/TRexClientUtil.java
@@ -15,38 +15,37 @@
 /**
  * Util class for Trex Client
  */
-public final class TrexClientUtil {
+public final class TRexClientUtil {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(TRexClientUtil.class);
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(TrexClientUtil.class);
-    private static final String JSON_RPC_VERSION = "2.0";
     private static final Random randomizer = new Random();
-    private static Integer API_VERSION_MAJOR = 1;
-    private static Integer API_VERSION_MINOR = 7;
+
     private static TRexTransport transport;
 
-    private TrexClientUtil() {
+    private TRexClientUtil() {
     }
 
-    public static TrexServerMode getMode(String host) {
-        transport = new TRexTransport(host, "4501", 3000);
+    public static TRexServerMode getMode(String host, String port) {
+        transport = new TRexTransport(host, port, 3000);
         Map<String, Object> parameters = new HashMap<>();
         parameters.put("name", "ASTF");
-        parameters.put("major", API_VERSION_MAJOR);
-        parameters.put("minor", API_VERSION_MINOR);
+        parameters.put("major", Constants.API_VERSION_MAJOR);
+        parameters.put("minor", Constants.ASTF_API_VERSION_MINOR);
         RPCResponse response = null;
         try {
             response = transport.sendCommand(buildCommand("api_sync_v2", parameters));
         } catch (IOException | NullPointerException e) {
             LOGGER.debug("Unable to sync client with TRex server .", e.getMessage());
-            return TrexServerMode.UNKNOWN;
+            return TRexServerMode.UNKNOWN;
         }
         if (!response.isFailed()) {
-            return TrexServerMode.ASTF;
+            return TRexServerMode.ASTF;
         }
         if ("RPC configuration mismatch - server RPC configuration: 'STL', client RPC configuration: 'ASTF'".equalsIgnoreCase(response.getError().getSpecificErr())) {
-            return TrexServerMode.STL;
+            return TRexServerMode.STL;
         }
-        return TrexServerMode.UNKNOWN;
+        return TRexServerMode.UNKNOWN;
     }
 
     /**
@@ -64,7 +63,7 @@ private static TRexCommand buildCommand(String methodName, Map<String, Object> p
         Map<String, Object> payload = new HashMap<>();
         int cmdId = randomizer.nextInt() & Integer.MAX_VALUE; //get a positive random value
         payload.put("id", cmdId);
-        payload.put("jsonrpc", JSON_RPC_VERSION);
+        payload.put("jsonrpc", Constants.JSON_RPC_VERSION);
         payload.put("method", methodName);
         payload.put("params", parameters);
         return new TRexCommand(cmdId, methodName, payload);
diff --git a/src/main/java/com/cisco/trex/util/TRexServerMode.java b/src/main/java/com/cisco/trex/util/TRexServerMode.java
@@ -0,0 +1,21 @@
+package com.cisco.trex.util;
+
+/**
+ * Class represent for Trex Server Mode
+ */
+public enum TRexServerMode {
+    ASTF("ASTF"),
+    STL("STL"),
+    UNKNOWN("UNKNOWN");
+
+    private String serverMode;
+
+    TRexServerMode(String serverMode) {
+        this.serverMode = serverMode;
+    }
+
+    public String getServerMode() {
+        return this.serverMode;
+    }
+
+}
