Merge pull request #53 from cisco-open/fix/bugs/rel-21.11

Fix bugs from issues #47, #48 and #49 for Nov '21 v0.9.0 release

Author: preet-dev

src/main/java/io/opentelemetry/contrib/generator/core/dto/EntityDefinition.java

@@ -58,9 +58,7 @@ private void validateMandatoryFields() {
     }
 
     private void validateAttributes() {
-        if (MapUtils.emptyIfNull(attributes).isEmpty()) {
-            throw new GeneratorException("At least one item must be available in 'attributes' for entity " + name);
-        }
+        attributes = attributes == null ? new HashMap<>() :  attributes;
         Map<String, String> attrs = new HashMap<>();
         for (Map.Entry<String, String> eachAttribute: attributes.entrySet()) {
             if (eachAttribute.getKey().trim().length() == 0 || eachAttribute.getValue().trim().length() == 0) {

src/main/java/io/opentelemetry/contrib/generator/telemetry/cli/CLIProcessor.java

@@ -33,6 +33,8 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
 
 @Slf4j
 public class CLIProcessor {
@@ -127,6 +129,11 @@ private static PayloadHandler getPayloadHandler(String targetEnvYAML) {
                     targetEnvironmentDetails.getPassword());
         }
         if (!nonNullRestURL.isBlank()) {
+            try {
+                new URI(nonNullRestURL);
+            } catch (URISyntaxException e) {
+                log.warn("Invalid rest URL provided in environment target YAML", e);
+            }
             return new RESTPayloadHandler(nonNullRestURL, authHandler);
         }
         int gRPCPort;

src/main/java/io/opentelemetry/contrib/generator/telemetry/traces/dto/Traces.java

@@ -51,6 +51,7 @@ public void validate(String requestID, Set<String> allEntityTypes) {
         if (rootSpanNames.size() < rootSpans.size()) {
             throw new GeneratorException("Root span names are not unique");
         }
+        childSpans = childSpans == null ? new ArrayList<>() : childSpans;
         Set<String> childSpanNames = childSpans.stream().map(SpanDefinition::getName).collect(Collectors.toSet());
         if (childSpanNames.size() < childSpans.size()) {
             throw new GeneratorException("Child span names are not unique");

src/test/java/io/opentelemetry/contrib/generator/core/TestGeneratorsUsingEntityWithNoAttrs.java

@@ -0,0 +1,36 @@
+package io.opentelemetry.contrib.generator.core;
+
+import io.opentelemetry.contrib.generator.telemetry.TelemetryGenerator;
+import io.opentelemetry.contrib.generator.telemetry.dto.GeneratorInput;
+import io.opentelemetry.contrib.generator.telemetry.helpers.TestPayloadHandler;
+import io.opentelemetry.contrib.generator.telemetry.transport.PayloadHandler;
+import org.testng.Assert;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+import java.nio.file.Paths;
+
+public class TestGeneratorsUsingEntityWithNoAttrs {
+
+    private final String ENTITIES_YAML = Paths.get(System.getProperty("user.dir"), "src", "test", "resources",
+            "test-definitions", "entity-definition-noattrs.yaml").toString();
+    private final String METRICS_YAML = Paths.get(System.getProperty("user.dir"), "src", "test", "resources",
+            "test-definitions", "metrics-noattrsentity.yaml").toString();
+    private final PayloadHandler payloadStore = new TestPayloadHandler();
+    private TestPayloadHandler testStore;
+
+    @BeforeClass
+    public void generateData() {
+        GeneratorInput generatorInput = new GeneratorInput.YAMLFilesBuilder(ENTITIES_YAML)
+                .withMetricDefinitionYAML(METRICS_YAML)
+                .build();
+        TelemetryGenerator telemetryGenerator = new TelemetryGenerator(generatorInput, payloadStore, true);
+        telemetryGenerator.runGenerator();
+        testStore = (TestPayloadHandler) payloadStore;
+    }
+
+    @Test
+    public void validatePacketCounts() {
+        Assert.assertEquals(testStore.getMetricsPacketCount(), 1800);
+    }
+}

src/test/java/io/opentelemetry/contrib/generator/telemetry/TestTracesGenerator.java

@@ -24,7 +24,6 @@
 import io.opentelemetry.proto.trace.v1.ScopeSpans;
 import io.opentelemetry.proto.trace.v1.Span;
 import org.testng.Assert;
-import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
 
 import java.nio.file.Paths;
@@ -39,26 +38,27 @@ public class TestTracesGenerator {
 
     private final String ENTITIES_YAML = Paths.get(System.getProperty("user.dir"), "src", "test", "resources",
             "test-definitions", "entities-traces-test.yaml").toString();
-    private final String TRACES_YAML = Paths.get(System.getProperty("user.dir"), "src", "test", "resources",
-            "test-definitions", "trace-definition.yaml").toString();
+    private final String TEST_DEFS_PATH = Paths.get(System.getProperty("user.dir"), "src", "test", "resources",
+            "test-definitions").toString();
+    private final String TRACES_YAML = Paths.get(TEST_DEFS_PATH, "trace-definition.yaml").toString();
     private final PayloadHandler payloadStore = new TestPayloadHandler();
     private TestPayloadHandler testStore;
 
-    @BeforeClass
+    @Test
     public void generateData() {
         GeneratorInput generatorInput = new GeneratorInput.YAMLFilesBuilder(ENTITIES_YAML).withTraceDefinitionYAML(TRACES_YAML).build();
         TelemetryGenerator telemetryGenerator = new TelemetryGenerator(generatorInput, payloadStore, true);
         telemetryGenerator.runGenerator();
         testStore = (TestPayloadHandler) payloadStore;
     }
 
-    @Test
+    @Test(dependsOnMethods = "generateData")
     public void testResourceSpansCount() {
         int totalExpectedResourceSpans = 11518;
         Assert.assertEquals(testStore.getTracePacketCount(), totalExpectedResourceSpans, "Mismatch in resource span counts");
     }
 
-    @Test
+    @Test(dependsOnMethods = "generateData")
     public void testSpanCounts() {
         Assert.assertNotNull(testStore.getSpanCount(), "No spans were stored in the test payload handler");
         Map<String, AtomicInteger> spanCounts = testStore.getSpanCount();
@@ -161,7 +161,7 @@ public void testSpanCounts() {
         Assert.assertEquals(spanCounts.get("searchAccountsRequest").get(), searchAccountsRequest, "Mismatch in span count for searchAccountsRequest");
     }
 
-    @Test
+    @Test(dependsOnMethods = "generateData")
     public void testSpanTimes() {
         //Grab a single payload for the trace trees to check
         ExportTraceServiceRequest updateAccountTrace = null;
@@ -236,6 +236,18 @@ public void testSpanTimes() {
                 "Mismatch in end time for deleteAccountQuery span");
     }
 
+    @Test
+    public void testWithOnlyRootSpans() {
+        String onlyRootSpanTraces =  Paths.get(TEST_DEFS_PATH, "trace-definition-onlyrootspans.yaml").toString();
+        GeneratorInput rootSpansGeneratorInput = new GeneratorInput.YAMLFilesBuilder(ENTITIES_YAML)
+                .withTraceDefinitionYAML(onlyRootSpanTraces).build();
+        PayloadHandler rootSpansStore = new TestPayloadHandler();
+        TelemetryGenerator rootSpansTelemetryGenerator = new TelemetryGenerator(rootSpansGeneratorInput, rootSpansStore, false);
+        rootSpansTelemetryGenerator.runGenerator();
+        TestPayloadHandler rootSpansTestStore = (TestPayloadHandler) rootSpansStore;
+        Assert.assertEquals(90, rootSpansTestStore.getTracePacketCount());
+    }
+
     private long[] getSpanStartTimeEndTime(ExportTraceServiceRequest trace, String spanName) {
         Span span = trace.getResourceSpansList().stream()
                 .map(ResourceSpans::getScopeSpansList)

src/test/resources/test-definitions/entity-definition-noattrs.yaml

@@ -0,0 +1,31 @@
+#
+# Copyright 2022 AppDynamics Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+entities:
+  - name: service_instance
+    count: 150
+    childrenDistribution:
+      instance_endpoint: 'distribution(1, 0, 0)'
+    attributes:
+      service.instance.id: '"instance.id-".concat(alphanumericSequence("ceewewsdc"))'
+      service.name: '"service.name-".concat(alphanumericSequence("ksdj3"))'
+      service.namespace: '"service.namespace-".concat(alphanumericSequence("gnrtrvv4"))'
+  - name: instance_endpoint
+    count: 150
+    attributeOperations:
+      - 'copyFromParent("service_instance", "service.instance.id")'
+      - 'copyFromParent("service_instance", "service.name")'
+      - 'copyFromParent("service_instance", "service.namespace")'

src/test/resources/test-definitions/metrics-noattrsentity.yaml

@@ -0,0 +1,38 @@
+#
+# Copyright 2022 AppDynamics Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+payloadFrequencySeconds: 10
+payloadCount: 6
+metrics:
+  - name: system.network.in.kb.sec
+    unit: kBy/s
+    otelType: summary
+    valueFunction: 'absoluteCosineSequenceSummary("*7000", 5)'
+    isDouble: true
+    quantiles: [0, 50, 100]
+    reportingEntities: [service_instance, instance_endpoint]
+    attributes:
+      system.internal.ip: 'IPv4Sequence("10.134.1.34")'
+  - name: system.network.out.kb.sec
+    unit: kBy/s
+    otelType: summary
+    valueFunction: 'randomSummary(1, 10, "*400", 7)'
+    isDouble: true
+    quantiles: [0, 50, 100]
+    reportingEntities: [service_instance, instance_endpoint]
+    attributes:
+      system.internal.ip: 'IPv4Sequence("10.121.17.65")'
+      network.device.type: 'roundRobin(["ethernet", "wired", "wireless"])'

src/test/resources/test-definitions/trace-definition-onlyrootspans.yaml

@@ -0,0 +1,31 @@
+#
+# Copyright 2022 AppDynamics Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+traceCompletionTimeoutSecs: 120
+rootSpans:
+  - name: "healthCheck"
+    spanKind: SPAN_KIND_SERVER
+    reportingResource: http_backend
+    attributes:
+      type: 'roundRobin(["REST"])'
+      url: 'roundRobin(["/healthcheck"])'
+    payloadCount: 5
+    payloadFrequencySeconds: 15
+  - name: "getAccountDetails"
+    spanKind: SPAN_KIND_SERVER
+    reportingResource: request
+    payloadCount: 5
+    copyCount: 17