differ acquire/release behaviors between STL and ASTF mode

Signed-off-by: Leo Ma <[email protected]>

Author: leomaatEric

src/main/java/com/cisco/trex/ClientBase.java

@@ -88,8 +88,7 @@ private String call(String json) {
   }
 
   private List<TRexCommand> buildRemoveCaptureCommand(List<Integer> captureIds) {
-    return captureIds
-        .stream()
+    return captureIds.stream()
         .map(
             captureId -> {
               Map<String, Object> parameters = new HashMap<>();
@@ -108,8 +107,7 @@ private List<TRexCommand> buildRemoveCaptureCommand(List<Integer> captureIds) {
   public List<Port> getPorts() {
     LOGGER.debug("Getting ports list.");
     List<Port> ports = getSystemInfo().getPorts();
-    ports
-        .stream()
+    ports.stream()
         .forEach(
             port -> {
               TRexClientResult<PortStatus> result = getPortStatus(port.getIndex());
@@ -136,8 +134,7 @@ public Port getPortByIndex(int portIndex) {
       LOGGER.error(
           String.format("Port with index %s was not found. Returning empty port", portIndex));
     }
-    return getPorts()
-        .stream()
+    return getPorts().stream()
         .filter(p -> p.getIndex() == portIndex)
         .findFirst()
         .orElse(new Port());
@@ -511,23 +508,6 @@ public SystemInfo getSystemInfo() {
     return GSON.fromJson(getResultFromResponse(json), SystemInfo.class);
   }
 
-  /**
-   * Release Port
-   *
-   * @param portIndex
-   * @return PortStatus
-   */
-  public PortStatus releasePort(int portIndex) {
-    Map<String, Object> payload = createPayload(portIndex);
-    payload.put("user", userName);
-    String result = callMethod("release", payload);
-    if (result.contains("must acquire the context")) {
-      LOGGER.info("Port is not owned by this session, already released or never acquired");
-    }
-    portHandlers.remove(portIndex);
-    return getPortStatus(portIndex).get();
-  }
-
   protected Map<String, Object> createPayload(int portIndex) {
     Map<String, Object> payload = new HashMap<>();
     payload.put(PORT_ID, portIndex);
@@ -552,13 +532,4 @@ protected Map<String, Object> createPayload(int portIndex, String profileId) {
   }
 
   protected abstract void serverAPISync() throws TRexConnectionException;
-
-  /**
-   * Acquire Port to be able to apply configuration to it
-   *
-   * @param port
-   * @param force
-   * @return PortStatus
-   */
-  public abstract PortStatus acquirePort(int port, Boolean force);
 }

src/main/java/com/cisco/trex/stateful/TRexAstfClient.java

@@ -8,7 +8,6 @@
 import com.cisco.trex.stateful.model.stats.MetaData;
 import com.cisco.trex.stateless.exception.TRexConnectionException;
 import com.cisco.trex.stateless.model.ApiVersionHandler;
-import com.cisco.trex.stateless.model.PortStatus;
 import com.cisco.trex.stateless.model.TRexClientResult;
 import com.cisco.trex.util.Constants;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -219,12 +218,15 @@ public void updateLatencyTrafficRate(int mult) {
     this.callMethod("update_latency", payload);
   }
 
-  @Override
-  public PortStatus acquirePort(int portIndex, Boolean force) {
+  /**
+   * In ASTF mode all ports will be acquired in a single call, not support to acquire a single port
+   *
+   * @param force
+   */
+  public void acquirePorts(Boolean force) {
     Map<String, Object> payload = createPayload();
     payload.put("user", userName);
     payload.put("force", force);
-    payload.put(PORT_ID, portIndex);
     String json = callMethod("acquire", payload);
     Set<Entry<String, JsonElement>> entrySet;
     try {
@@ -243,7 +245,21 @@ public PortStatus acquirePort(int portIndex, Boolean force) {
       portHandlers.put(Integer.parseInt(entry.getKey()), entry.getValue().getAsString());
     }
     LOGGER.info("portHandlers is: {} ", portHandlers);
-    return getPortStatus(portIndex).get();
+  }
+
+  /** Release Ports */
+  public void releasePorts() {
+    if (StringUtils.isEmpty(masterHandler)) {
+      LOGGER.debug("No handler assigned, ports are not acquired.");
+    } else {
+      Map<String, Object> payload = createPayload();
+      payload.put("user", userName);
+      String result = callMethod("release", payload);
+      if (result.contains("must acquire the context")) {
+        LOGGER.info("Ports are not owned by this session, already released or never acquired");
+      }
+      portHandlers.clear();
+    }
   }
 
   /**
@@ -306,6 +322,9 @@ public void clearProfile(String profileId) {
    * @return profile id list
    */
   public List<String> getProfileIds() {
+    if (StringUtils.isEmpty(masterHandler)) {
+      return Collections.emptyList();
+    }
     Map<String, Object> payload = createPayload();
     String json = callMethod("get_profile_list", payload);
     JsonArray ids = getResultFromResponse(json).getAsJsonArray();

src/main/java/com/cisco/trex/stateless/TRexClient.java

@@ -122,8 +122,6 @@ protected void serverAPISync() throws TRexConnectionException {
     LOGGER.info("Received api_H: {}", apiH);
   }
 
-  @Deprecated
-  @Override
   public PortStatus acquirePort(int portIndex, Boolean force) {
     Map<String, Object> payload = createPayload(portIndex);
     payload.put("session_id", SESSON_ID);
@@ -135,6 +133,27 @@ public PortStatus acquirePort(int portIndex, Boolean force) {
     return getPortStatus(portIndex).get();
   }
 
+  /**
+   * Release Port
+   *
+   * @param portIndex
+   * @return PortStatus
+   */
+  public PortStatus releasePort(int portIndex) {
+    if (!portHandlers.containsKey(portIndex)) {
+      LOGGER.debug("No handler assigned, port is not acquired.");
+    } else {
+      Map<String, Object> payload = createPayload(portIndex);
+      payload.put("user", userName);
+      String result = callMethod("release", payload);
+      if (result.contains("must acquire the context")) {
+        LOGGER.info("Port is not owned by this session, already released or never acquired");
+      }
+      portHandlers.remove(portIndex);
+    }
+    return getPortStatus(portIndex).get();
+  }
+
   /**
    * Reset port stop traffic, remove all streams, remove rx queue, disable service mode and release
    * port