minor changes

Author: bhautikpip

validator/build.gradle

@@ -41,9 +41,6 @@ dependencies {
     // yaml reader
     compile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.11.1'
 
-    // json reader
-    compile group: 'com.googlecode.json-simple', name: 'json-simple', version: '1.1'
-
     // json flattener
     compile group: 'com.github.wnameless', name: 'json-flattener', version: '0.1.0'
 

validator/src/main/java/com/amazon/aoc/callers/HttpCaller.java

@@ -30,7 +30,7 @@ public SampleAppResponse callSampleApp() throws Exception {
 
     AtomicReference<SampleAppResponse> sampleAppResponseAtomicReference = new AtomicReference<>();
     RetryHelper.retry(
-        3,
+        30,
         () -> {
           try (Response response = client.newCall(request).execute()) {
             String responseBody = response.body().string();

validator/src/main/java/com/amazon/aoc/exception/ExceptionCode.java

@@ -30,6 +30,7 @@ public enum ExceptionCode {
   TRACE_SPAN_NOT_MATCHED(50003, "trace span not matched"),
   TRACE_LIST_NOT_MATCHED(50004, "trace list has different length"),
   DATA_EMITTER_UNAVAILABLE(50005, "the data emitter is unavailable to ping"),
+  EMPTY_LIST(50007, "list is empty or null"),
 
   // build validator
   VALIDATION_TYPE_NOT_EXISTED(60001, "validation type not existed"),

validator/src/main/java/com/amazon/aoc/fileconfigs/ExpectedTrace.java

@@ -20,8 +20,8 @@
 @Getter
 public enum ExpectedTrace implements FileConfig {
   DEFAULT_EXPECTED_TRACE("/expected-data-template/defaultExpectedTrace.mustache"),
-  AWSSDK_EXPECTED_TRACE("/expected-data-template/expectedAWSSDKTrace.json"),
-  HTTP_EXPECTED_TRACE("/expected-data-template/expectedHTTPTrace.json")
+  AWSSDK_EXPECTED_TRACE("/expected-data-template/expectedAWSSDKTrace.mustache"),
+  HTTP_EXPECTED_TRACE("/expected-data-template/expectedHTTPTrace.mustache")
   ;
 
   private String path;

validator/src/main/java/com/amazon/aoc/validators/TraceValidator.java

@@ -19,30 +19,30 @@
 import com.amazon.aoc.exception.BaseException;
 import com.amazon.aoc.exception.ExceptionCode;
 import com.amazon.aoc.fileconfigs.FileConfig;
+import com.amazon.aoc.helpers.MustacheHelper;
 import com.amazon.aoc.models.Context;
 import com.amazon.aoc.models.SampleAppResponse;
 import com.amazon.aoc.services.XRayService;
 import com.amazonaws.services.xray.model.Trace;
 import com.github.wnameless.json.flattener.JsonFlattener;
 import lombok.extern.log4j.Log4j2;
-import org.json.simple.JSONObject;
-import org.json.simple.parser.JSONParser;
 
-import java.io.FileReader;
 import java.util.*;
 import java.util.concurrent.TimeUnit;
 
 @Log4j2
 public class TraceValidator implements IValidator {
-  private static int MAX_RETRY_COUNT = 3;
-  private XRayService xrayService;
-  private ICaller caller;
-  private FileConfig expectedTrace;
+    private MustacheHelper mustacheHelper = new MustacheHelper();
+    private XRayService xrayService;
+    private ICaller caller;
+    private Context context;
+    private FileConfig expectedTrace;
 
     @Override
     public void init(Context context, ICaller caller, FileConfig expectedTrace) throws Exception {
         this.xrayService = new XRayService(context.getRegion());
         this.caller = caller;
+        this.context = context;
         this.expectedTrace = expectedTrace;
     }
 
@@ -60,12 +60,14 @@ public void validate() throws Exception {
 
         // validation of trace id
         if (!storedTrace.get("trace_id").equals(retrievedTrace.get("trace_id"))) {
+            log.error("trace id validation failed");
             throw new BaseException(ExceptionCode.TRACE_ID_NOT_MATCHED);
         }
 
         // data model validation of other fields of segment document
         for (Map.Entry<String, Object> entry : storedTrace.entrySet()) {
             if (!entry.getValue().equals(retrievedTrace.get(entry.getKey()))) {
+                log.error("data model validation failed");
                 log.info("mis matched data model field list");
                 log.info("value of stored trace map: {}", entry.getValue());
                 log.info("value of retrieved map: {}",retrievedTrace.get(entry.getKey()));
@@ -78,35 +80,56 @@ public void validate() throws Exception {
     // this method will hit get trace from x-ray service and get retrieved trace
     private Map<String, Object> getRetrievedTrace(List<String> traceIdList) throws Exception {
         Map<String, Object> flattenedJsonMapForRetrievedTrace = null;
+        List<Trace> retrieveTraceList = null;
+        int MAX_RETRY_COUNT = 3;
+        int count = 1;
+
+        while (retrieveTraceList == null || retrieveTraceList.isEmpty()) {
+            // wait for sample app to send trace data to x-ray
+            log.info("sleeping for 15 seconds before retrieving data from x-ray service");
+            TimeUnit.SECONDS.sleep(15);
+
+            try {
+                retrieveTraceList = xrayService.listTraceByIds(traceIdList);
+            } catch (Exception e) {
+                log.error("exception while retrieving trace data from x-ray service" + e.getMessage());
+                e.printStackTrace();
+            }
 
-        // retrieve trace from x-ray service
-        TimeUnit.SECONDS.sleep(15);
-        List<Trace> retrieveTraceList = xrayService.listTraceByIds(traceIdList);
+            if (count == MAX_RETRY_COUNT) {
+                break;
+            }
 
-        try {
-            // flattened JSON object to a map
-            flattenedJsonMapForRetrievedTrace = JsonFlattener.flattenAsMap(retrieveTraceList.get(0).getSegments().get(0).getDocument());
-        } catch (Exception e) {
-            e.printStackTrace();
+            count++;
+        }
+
+        // flattened JSON object to a map
+        if (retrieveTraceList != null && !retrieveTraceList.isEmpty()) {
+            try{
+                flattenedJsonMapForRetrievedTrace = JsonFlattener.flattenAsMap(retrieveTraceList.get(0).getSegments().get(0).getDocument());
+            } catch (Exception e) {
+                log.error("exception while flattening the retrieved trace: " + e.getMessage());
+                e.printStackTrace();
+            }
+        } else {
+            log.error("retrieved trace list is empty or null");
+            throw new BaseException(ExceptionCode.EMPTY_LIST);
         }
 
         return flattenedJsonMapForRetrievedTrace;
     }
 
     // this method will hit a http endpoints of sample web apps and get stored trace
     private Map<String, Object> getStoredTrace() throws Exception {
-        String PATH = "src/main/resources";
         Map<String, Object> flattenedJsonMapForStoredTraces = null;
 
         SampleAppResponse sampleAppResponse = this.caller.callSampleApp();
 
-        JSONParser parser = new JSONParser();
-        try {
-            Object obj = parser.parse(new FileReader(PATH + this.expectedTrace.getPath()));
-            JSONObject jsonObject = (JSONObject) obj;
+        String jsonExpectedTrace = mustacheHelper.render(this.expectedTrace, context);
 
+        try {
             // flattened JSON object to a map
-            flattenedJsonMapForStoredTraces = JsonFlattener.flattenAsMap(jsonObject.toString());
+            flattenedJsonMapForStoredTraces = JsonFlattener.flattenAsMap(jsonExpectedTrace);
             flattenedJsonMapForStoredTraces.put("trace_id", sampleAppResponse.getTraceId());
         } catch (Exception e) {
             e.printStackTrace();

validator/src/main/resources/expected-data-template/expectedAWSSDKTrace.json renamed to validator/src/main/resources/expected-data-template/expectedAWSSDKTrace.mustache

@@ -5,7 +5,7 @@
   "throttle": false,
   "http": {
     "request": {
-      "url": "http://127.0.0.1:8080/aws-sdk-call",
+      "url": "{{endpoint}}/aws-sdk-call",
       "method": "GET"
     },
     "response": {
@@ -26,7 +26,7 @@
           "throttle": false,
           "http": {
             "request": {
-              "url": "https://s3.us-west-2.amazonaws.com/",
+              "url": "https://s3.{{region}}.amazonaws.com/",
               "method": "GET"
             },
             "response": {
@@ -36,14 +36,14 @@
           "namespace": "aws",
           "subsegments": [
             {
-              "name": "s3.us-west-2.amazonaws.com",
+              "name": "s3.{{region}}.amazonaws.com",
               "fault": false,
               "error": false,
               "throttle": false,
               "http": {
                 "request": {
-                  "url": "https://s3.us-west-2.amazonaws.com/",
-                  "method": "GET",
+                  "url": "https://s3.{{region}}.amazonaws.com/",
+                  "method": "GET"
                 },
                 "response": {
                   "status": 200

validator/src/main/resources/expected-data-template/expectedHTTPTrace.json renamed to validator/src/main/resources/expected-data-template/expectedHTTPTrace.mustache

@@ -5,7 +5,7 @@
   "throttle": false,
   "http": {
     "request": {
-      "url": "http://127.0.0.1:8080/outgoing-http-call",
+      "url": "{{endpoint}}/outgoing-http-call",
       "method": "GET"
     },
     "response": {