use onap logging 1.6.1 with needed workarounds
[vid.git] / vid-automation / src / test / java / org / onap / vid / more / LoggerFormatTest.java
index 20367ea..11a6932 100644 (file)
@@ -1,6 +1,25 @@
 package org.onap.vid.more;
 
+import static java.util.Collections.reverse;
+import static java.util.stream.Collectors.toList;
+import static org.hamcrest.CoreMatchers.containsString;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.allOf;
+import static org.hamcrest.Matchers.contains;
+import static org.hamcrest.Matchers.containsInRelativeOrder;
+import static org.hamcrest.Matchers.greaterThan;
+import static org.hamcrest.Matchers.greaterThanOrEqualTo;
+import static org.hamcrest.Matchers.hasSize;
+import static vid.automation.test.services.SimulatorApi.retrieveRecordedRequests;
+
 import com.fasterxml.jackson.databind.JsonNode;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -9,25 +28,18 @@ import org.onap.vid.api.BaseApiTest;
 import org.springframework.web.client.RestTemplate;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
-import vid.automation.test.infra.SkipTestUntil;
 import vid.automation.test.services.SimulatorApi;
-
-import java.net.URI;
-import java.util.HashMap;
-import java.util.Map;
-
-import static org.hamcrest.CoreMatchers.is;
-import static org.hamcrest.Matchers.greaterThan;
-import static org.hamcrest.Matchers.greaterThanOrEqualTo;
-import static org.junit.Assert.assertThat;
+import vid.automation.test.services.SimulatorApi.RecordedRequests;
 
 public class LoggerFormatTest extends BaseApiTest {
 
-
-    // See: https://wiki.web.att.com/display/KSAT/REST-based+Log+Checker
-    private final static String logChecker = "http://eelflogcheck.it.att.com:31820/validate";
+    private final static String logChecker = System.getProperty("EELF_LOG_CHECKER", "http://my-logchecker:8888/validate");
     private final Logger logger = LogManager.getLogger(LoggerFormatTest.class);
 
+    public enum LogName {
+        audit, error, audit2019, metrics2019, metrics
+    }
+
     @BeforeClass
     public void login() {
         super.login();
@@ -38,53 +50,120 @@ public class LoggerFormatTest extends BaseApiTest {
         SimulatorApi.registerExpectationFromPreset(new PresetAAIGetSubscribersGet(), SimulatorApi.RegistrationStrategy.CLEAR_THEN_SET);
     }
 
-    @SkipTestUntil("2019-08-22")
     @Test
     public void validateAuditLogsFormat() {
-        validateLogsFormat("audit");
+        validateLogsFormat(LogName.audit);
+    }
+
+    @Test
+    public void validateAudit2019LogsFormat() {
+        validateLogsFormat(LogName.audit2019, "audit-ELS-2019.11", 0);
     }
 
     @Test(enabled = false) // no total-score is returned for error-log
     public void validateErrorLogsFormat() {
-        validateLogsFormat("error");
+        validateLogsFormat(LogName.error);
     }
 
-    @SkipTestUntil("2019-08-22")
     @Test
     public void validateMetricsLogsFormat() {
-        validateLogsFormat("metrics", "metric");
+        validateLogsFormat(LogName.metrics, "metric");
+    }
+
+    @Test
+    public void validateMetrics2019LogsFormat() {
+        validateLogsFormat(LogName.metrics2019, "metric-ELS-2019.11");
+    }
+
+    private void validateLogsFormat(LogName logName) {
+        validateLogsFormat(logName, logName.name());
     }
 
-    private void validateLogsFormat(String logName) {
-        validateLogsFormat(logName, logName);
+    private void validateLogsFormat(LogName logName, String logType) {
+        validateLogsFormat(logName, logType, 0.95);
     }
 
-    private void validateLogsFormat(String logName, String logType) {
+    private void validateLogsFormat(LogName logName, String logType, double score) {
 
         String logLines = getLogLines(logName);
         logger.info("logLines are: "+logLines);
         JsonNode response = getCheckerResults(logType, logLines);
         logger.info("Response is:" + response.toString());
-        double fieldscore = response.path("summary").path("score").path("fieldscore").asDouble();
-        double overall = response.path("summary").path("score").path("overallscore").asDouble();
 
-        assertThat(fieldscore, is(greaterThan(0.95)));
-        assertThat(overall, is(greaterThan(0.95)));
+        int total_records = response.path("summary").path("total_records").asInt();
+        int valid_records = response.path("summary").path("valid_records").asInt();
 
+        assertThat(total_records, greaterThan(30)); //make sure we have at least 30 total records
+        assertThat((double)valid_records/total_records, is(greaterThanOrEqualTo(score)));
     }
 
-    private String getLogLines(String logname) {
+    private String getLogLines(LogName logname) {
         return getLogLines(logname, 5000, 30, restTemplate, uri);
     }
 
-    public static String getLogLines(String logname, int maxRows, int minRows, RestTemplate restTemplate, URI uri) {
-        String logLines = restTemplate.getForObject(uri + "/logger/" + logname + "?limit={maxRows}", String.class, maxRows);
-        assertThat("expecting at least " + minRows + " rows in " + logname,
+    public static String getLogLines(LogName logname, int maxRows, int minRows, RestTemplate restTemplate, URI uri) {
+        String logLines = restTemplate.getForObject(uri + "/logger/" + logname.name() + "?limit={maxRows}", String.class, maxRows);
+        assertThat("expecting at least " + minRows + " rows in " + logname.name(),
                 StringUtils.countMatches(logLines, '\n') + 1,
                 is(greaterThanOrEqualTo(minRows)));
         return logLines;
     }
 
+    /**
+     * @return Chronological-ordered list of recent log-lines of a given requestId
+     */
+    public static List<String> getRequestLogLines(String requestId, LogName logname, RestTemplate restTemplate, URI uri) {
+        String logLines = LoggerFormatTest.getLogLines(logname, 30, 1, restTemplate, uri);
+
+        // Split
+        List<String> lines = new ArrayList<>(Arrays.asList(logLines.split("(\\r?\\n)")));
+
+        // Filter
+        lines.removeIf(line -> !StringUtils.containsIgnoreCase(line, requestId));
+
+        // Reverse
+        reverse(lines);
+
+        return lines;
+    }
+
+    public static void assertHeadersAndMetricLogs(RestTemplate restTemplate, URI uri, String requestId, String path, int requestsSize) {
+        List<String> logLines =
+            getRequestLogLines(requestId, LogName.metrics2019, restTemplate, uri);
+
+        List<RecordedRequests> requests = retrieveRecordedRequests();
+        List<RecordedRequests> underTestRequests =
+            requests.stream().filter(x->x.path.startsWith(path)).collect(toList());
+
+        assertThat(underTestRequests, hasSize(requestsSize));
+
+        underTestRequests.forEach(request-> {
+            assertThat("X-ONAP-RequestID", request.headers.get("X-ONAP-RequestID"), contains(requestId));
+            assertThat("X-ECOMP-RequestID", request.headers.get("X-ECOMP-RequestID"), contains(requestId));
+            assertThat("X-ONAP-PartnerName", request.headers.get("X-ONAP-PartnerName"), contains("VID.VID"));
+        });
+
+        underTestRequests.forEach(request->{
+
+            List<String> invocationIds = request.headers.get("X-InvocationID");
+            assertThat(invocationIds, hasSize(1));
+
+            String invocationId = invocationIds.get(0);
+            assertThat("request id  and invocation id must be found in exactly two rows",
+                logLines,
+                containsInRelativeOrder(
+                    allOf(
+                        containsString("RequestID="+requestId),
+                        containsString("InvocationID="+ invocationId),
+                        containsString("Invoke")),
+                    allOf(
+                        containsString("RequestID="+requestId),
+                        containsString("InvocationID="+ invocationId),
+                        containsString("InvokeReturn"))
+                ));
+        });
+    }
+
     private JsonNode getCheckerResults(String logtype, String logLines) {
         Map<String, String> params = new HashMap<>();
         params.put("format", "raw");