NoElasticLogsBackend shouldn't activate otel.logs.exporter=otlp (#499)

* NoElasticLogsBackend shouldn't activate `otel.logs.exporter=otlp` * Add unit tests
jenkinsci · Aug 25, 2022 · 154caf8 · 154caf8
1 parent 386b392
commit 154caf8
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 1 deletion.
diff --git a/src/main/java/io/jenkins/plugins/opentelemetry/backend/ElasticBackend.java b/src/main/java/io/jenkins/plugins/opentelemetry/backend/ElasticBackend.java
@@ -10,6 +10,7 @@
 import hudson.util.FormValidation;
 import io.jenkins.plugins.opentelemetry.TemplateBindingsProvider;
 import io.jenkins.plugins.opentelemetry.backend.elastic.ElasticLogsBackend;
+import io.jenkins.plugins.opentelemetry.backend.elastic.NoElasticLogsBackend;
 import io.jenkins.plugins.opentelemetry.job.log.LogStorageRetriever;
 import org.apache.commons.lang.StringUtils;
 import org.jenkins.ui.icon.Icon;
@@ -199,7 +200,7 @@ public Map<String, String> getOtelConfigurationProperties() {
         if (elasticLogsBackend == null) {
             return Collections.emptyMap();
         } else {
-            return Collections.singletonMap("otel.logs.exporter", "otlp");
+            return elasticLogsBackend.getOtelConfigurationProperties();
         }
     }
 

diff --git a/src/main/java/io/jenkins/plugins/opentelemetry/backend/elastic/ElasticLogsBackend.java b/src/main/java/io/jenkins/plugins/opentelemetry/backend/elastic/ElasticLogsBackend.java
@@ -24,6 +24,8 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -76,6 +78,10 @@ public Template getBuildLogsVisualizationUrlTemplate() {
         return buildLogsVisualizationUrlGTemplate;
     }
 
+    public Map<String, String> getOtelConfigurationProperties() {
+        return Collections.singletonMap("otel.logs.exporter", "otlp");
+    }
+
     private String getKibanaSpaceIdentifier() {
         // FIXME implement getKibanaSpaceIdentifier
         return "";

diff --git a/src/main/java/io/jenkins/plugins/opentelemetry/backend/elastic/NoElasticLogsBackend.java b/src/main/java/io/jenkins/plugins/opentelemetry/backend/elastic/NoElasticLogsBackend.java
@@ -11,6 +11,9 @@
 import io.jenkins.plugins.opentelemetry.job.log.LogStorageRetriever;
 import org.kohsuke.stapler.DataBoundConstructor;
 
+import java.util.Collections;
+import java.util.Map;
+
 public class NoElasticLogsBackend extends ElasticLogsBackend {
     @DataBoundConstructor
     public NoElasticLogsBackend() {
@@ -21,6 +24,10 @@ public LogStorageRetriever newLogStorageRetriever(TemplateBindingsProvider templ
         return null;
     }
 
+    public Map<String, String> getOtelConfigurationProperties() {
+        return Collections.emptyMap();
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

diff --git a/src/test/java/io/jenkins/plugins/opentelemetry/backend/ElasticBackendTest.java b/src/test/java/io/jenkins/plugins/opentelemetry/backend/ElasticBackendTest.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright The Original Author or Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.jenkins.plugins.opentelemetry.backend;
+
+import io.jenkins.plugins.opentelemetry.backend.elastic.ElasticLogsBackendWithJenkinsVisualization;
+import io.jenkins.plugins.opentelemetry.backend.elastic.ElasticLogsBackendWithoutJenkinsVisualization;
+import io.jenkins.plugins.opentelemetry.backend.elastic.NoElasticLogsBackend;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.Collections;
+import java.util.Map;
+
+public class ElasticBackendTest {
+
+    @Test
+    public void testNoElasticLogsBackend() {
+        ElasticBackend elasticBackend = new ElasticBackend();
+        elasticBackend.setElasticLogsBackend(new NoElasticLogsBackend());
+        Map<String, String> actual = elasticBackend.getOtelConfigurationProperties();
+        Map<String, String> expected = Collections.emptyMap();
+        Assert.assertEquals(actual, expected);
+    }
+
+    @Test
+    public void testElasticLogsBackendWithJenkinsVisualization() {
+        ElasticBackend elasticBackend = new ElasticBackend();
+        elasticBackend.setElasticLogsBackend(new ElasticLogsBackendWithJenkinsVisualization());
+        Map<String, String> actual = elasticBackend.getOtelConfigurationProperties();
+        Map<String, String> expected = Collections.singletonMap("otel.logs.exporter", "otlp");
+        Assert.assertEquals(actual, expected);
+    }
+
+    @Test
+    public void testElasticLogsBackendWithoutJenkinsVisualization() {
+        ElasticBackend elasticBackend = new ElasticBackend();
+        elasticBackend.setElasticLogsBackend(new ElasticLogsBackendWithoutJenkinsVisualization());
+        Map<String, String> actual = elasticBackend.getOtelConfigurationProperties();
+        Map<String, String> expected = Collections.singletonMap("otel.logs.exporter", "otlp");
+        Assert.assertEquals(actual, expected);
+    }
+}