Merge pull request #71 from enxxjmn/MJE-15700

support template group stats RPCs

Author: leomaatEric

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

@@ -1,9 +1,16 @@
 package com.cisco.trex.stateful;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.gson.JsonObject;
+
+import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -24,7 +31,6 @@
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
-import com.google.gson.JsonObject;
 import com.cisco.trex.stateful.model.stats.LatencyStats;
 import com.cisco.trex.stateful.model.stats.LatencyPortData;
 
@@ -252,7 +258,7 @@ public PortStatus acquirePort(int portIndex, Boolean force) {
      * @param profile
      */
     public void loadProfile(String profile) {
-        loadProfile(profile, "");
+        loadProfile("", profile);
     }
 
     /**
@@ -319,7 +325,7 @@ public List<String> getProfileIds() {
 
     /**
      * Get ASTF counters of profile associated with specified profile id
-     * 
+     *
      * @param profileId
      * @return AstfStatistics
      */
@@ -331,7 +337,7 @@ public AstfStatistics getAstfStatistics(String profileId) {
 
     /**
      * Get ASTF total counters for all profiles
-     * 
+     *
      * @return AstfStatistics
      */
     public AstfStatistics getAstfTotalStatistics() {
@@ -390,4 +396,95 @@ public String getVersion() {
         }
     }
 
+    /**
+     * get template group names
+     *
+     * @return template group names
+     */
+    public List<String> getTemplateGroupNames() {
+        return this.getTemplateGroupNames("");
+    }
+
+    /**
+     * get template group names
+     *
+     * @param profileId
+     * @return template group names
+     */
+    public List<String> getTemplateGroupNames(String profileId) {
+        Map<String, Object> payload = createPayload(profileId);
+        payload.put("initialized", false);
+        String json = callMethod("get_tg_names", payload);
+        JsonElement response = new JsonParser().parse(json);
+        JsonArray names = response.getAsJsonArray().get(0).getAsJsonObject().get("result").getAsJsonObject()
+                .get("tg_names").getAsJsonArray();
+        return StreamSupport.stream(names.spliterator(), false)
+                .map(JsonElement::getAsString)
+                .collect(Collectors.toList());
+    }
+
+    /**
+     * get template group statistics
+     *
+     * @param tgNames
+     * @return
+     */
+    public Map<String, AstfStatistics> getTemplateGroupStatistics(List<String> tgNames) {
+        return getTemplateGroupStatistics("", tgNames);
+    }
+
+    /**
+     * get template group statistics
+     *
+     * @param profileId
+     * @param tgNames
+     * @return Map key:tgName, value:AstfStatistics
+     */
+    public Map<String, AstfStatistics> getTemplateGroupStatistics(String profileId, List<String> tgNames) {
+
+        //remove duplicated tgNames in input list
+        tgNames = new ArrayList<>(new HashSet<>(tgNames));
+        Map<String, AstfStatistics> stats = new LinkedHashMap<>(tgNames.size());
+
+        Map<String, Object> payload = createPayload(profileId);
+        payload.put("epoch", 1);
+        Map<String, Integer> name2Id = translateNames2Ids(profileId, tgNames);
+        payload.put("tg_ids", new ArrayList<>(name2Id.values()));
+
+        String json = callMethod("get_tg_id_stats", payload);
+        JsonElement response = new JsonParser().parse(json);
+        JsonObject result = response.getAsJsonArray().get(0).getAsJsonObject().get("result").getAsJsonObject();
+        MetaData metaData = getAstfStatsMetaData();
+        name2Id.forEach((tgName, tgId) ->{
+            try {
+                AstfStatistics astfStatistics = new ObjectMapper().readValue(result.get(tgId.toString()).toString(), AstfStatistics.class);
+                astfStatistics.setCounterNames(metaData);
+                stats.put(tgName, astfStatistics);
+            } catch (IOException e) {
+                LOGGER.error("Error occurred during processing output of get_tg_id_stats method", e);
+            }
+        });
+
+        return  stats;
+    }
+
+    /**
+     * translate template group names to ids
+     * getTemplateGroupNames with return all template group names, this method will map an id for each name,
+     * the id is an increasing integer starting at 1. and filter names by input name list
+     * @param profileId
+     * @param tgNames
+     * @return Map key:tgName, value:tgId
+     */
+    private Map<String, Integer> translateNames2Ids(String profileId, List<String> tgNames) {
+        Map<String, Integer> name2Id = new LinkedHashMap<>(tgNames.size());
+        List<String> allTgNames = getTemplateGroupNames(profileId);
+        for (int i = 0; i < allTgNames.size(); i++) {
+            if(tgNames.contains(allTgNames.get(i)))
+                name2Id.put(allTgNames.get(i), i+1);
+        }
+
+        return name2Id;
+    }
+
 }

src/main/java/com/cisco/trex/stateful/api/lowlevel/ASTFProfile.java

@@ -2,6 +2,7 @@
 
 import com.google.gson.JsonArray;
 import com.google.gson.JsonObject;
+import java.util.LinkedHashMap;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -26,6 +27,9 @@ public class ASTFProfile {
     private ASTFGlobalInfo astfServerGlobalInfo;
     private List<ASTFTemplate> astfTemplateList;
     private List<ASTFCapInfo> astfCapInfoList;
+
+    private Map<String, Integer> tgName2TgId = new LinkedHashMap<>(); //template group name -> template group id
+
     /**
      * construct
      *
@@ -55,6 +59,19 @@ public ASTFProfile(ASTFIpGen defaultIpGen, ASTFGlobalInfo astfClientGlobalInfo,
         this.astfTemplateList = astfTemplateList;
         this.astfCapInfoList = astfCapInfoList;
 
+        for (ASTFTemplate template : astfTemplateList) {
+            if (template.getTgName() == null) {
+                template.setTgId(0);
+                continue;
+            }
+
+            String tgName = template.getTgName();
+            if (!tgName2TgId.containsKey(tgName)) {
+                tgName2TgId.put(tgName, tgName2TgId.size() + 1);
+            }
+            template.setTgId(tgName2TgId.get(tgName));
+        }
+
         /**
          * for pcap file parse scenario
          */
@@ -165,6 +182,11 @@ public JsonObject toJson() {
             jsonArray.add(astfTemplate.toJson());
         }
         json.add("templates", jsonArray);
+
+        JsonArray tgNames = new JsonArray();
+        tgName2TgId.keySet().forEach(name -> tgNames.add(name));
+        json.add("tg_names", tgNames);
+
         return json;
     }
 

src/main/java/com/cisco/trex/stateful/api/lowlevel/ASTFTemplate.java

@@ -33,8 +33,11 @@
  * </p>
  */
 public class ASTFTemplate {
+
     private ASTFTCPClientTemplate astfTcpClientTemplate;
     private ASTFTCPServerTemplate astfTcpServerTemplate;
+    private String tgName;
+    private Integer tgId;
 
     /**
      * construct
@@ -43,11 +46,35 @@ public class ASTFTemplate {
      * @param astfTcpServerTemplate
      */
     public ASTFTemplate(ASTFTCPClientTemplate astfTcpClientTemplate, ASTFTCPServerTemplate astfTcpServerTemplate) {
+        this(astfTcpClientTemplate, astfTcpServerTemplate, null);
+    }
+
+    /**
+     * construct
+     *
+     * @param astfTcpClientTemplate
+     * @param astfTcpServerTemplate
+     * @param tgName
+     */
+    public ASTFTemplate(ASTFTCPClientTemplate astfTcpClientTemplate, ASTFTCPServerTemplate astfTcpServerTemplate, String tgName) {
         if (astfTcpClientTemplate.isStream() != astfTcpServerTemplate.isStream()) {
             throw new IllegalStateException(String.format(" Client template stream mode is %s and different from server template mode %s", astfTcpClientTemplate.isStream(), astfTcpServerTemplate.isStream()));
         }
         this.astfTcpClientTemplate = astfTcpClientTemplate;
         this.astfTcpServerTemplate = astfTcpServerTemplate;
+        this.tgName = tgName;
+    }
+
+    public String getTgName() {
+        return tgName;
+    }
+
+    Integer getTgId() {
+        return tgId;
+    }
+
+    void setTgId(Integer tgId) {
+        this.tgId = tgId;
     }
 
     /**
@@ -59,6 +86,7 @@ public JsonObject toJson() {
         JsonObject json = new JsonObject();
         json.add("client_template", astfTcpClientTemplate.toJson());
         json.add("server_template", astfTcpServerTemplate.toJson());
+        json.addProperty("tg_id", tgId);
         return json;
     }
 }