Refactor integration tests; Add PushGateway test

Author: fstab

OTEL_EXEMPLARS.md

@@ -8,9 +8,9 @@ If you want to see this in action, you can run the example from the `ExemplarsCl
 
 ```
 ./mvnw package
-cd integration_tests/exemplars_otel_agent/target/
+cd integration_tests/it_exemplars_otel_agent/target/
 curl -LO https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/download/v1.2.0/opentelemetry-javaagent-all.jar
-java -Dotel.traces.exporter=logging -Dotel.metrics.exporter=none -javaagent:./opentelemetry-javaagent-all.jar -jar ./sample-rest-application.jar
+java -Dotel.traces.exporter=logging -Dotel.metrics.exporter=none -javaagent:./opentelemetry-javaagent-all.jar -jar ./example-spring-boot-app.jar
 ```
 
 Now you have a Spring REST service running on [http://localhost:8080/hello](http://localhost:8080/hello) that is instrumented with the OpenTelemetry Java agent.
@@ -55,7 +55,7 @@ you can exclude the corresponding dependencies in your `pom.xml`:
     <artifactId>simpleclient</artifactId>
     <version>0.12.0</version>
     <exclusions>
-      <!-- The following will disable OpenTelemetry exemplars when your application uses OpenTelemetry directly -->
+      <!-- The following will disable OpenTelemetry exemplars when your application uses the OpenTelemetry API directly -->
       <exclusion>
         <groupId>io.prometheus</groupId>
         <artifactId>simpleclient_tracer_otel</artifactId>

integration_tests/exemplars_otel/src/test/java/io/prometheus/client/it/exemplars_otel/ExemplarsOtelIT.java

@@ -8,30 +8,29 @@
     <version>0.12.1-SNAPSHOT</version>
   </parent>
 
-  <artifactId>java_versions</artifactId>
-  <name>Integration Test - Java Versions Smoke Test</name>
+  <artifactId>it_common</artifactId>
+  <name>Integration Tests - Common Utilities</name>
 
   <dependencies>
     <dependency>
       <groupId>org.testcontainers</groupId>
       <artifactId>testcontainers</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>ch.qos.logback</groupId>
-      <artifactId>logback-classic</artifactId>
-      <version>1.2.3</version>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>com.squareup.okhttp3</groupId>
       <artifactId>okhttp</artifactId>
-      <version>4.9.1</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
 
   <build>
+    <testResources>
+      <testResource>
+        <directory>src/test/resources</directory>
+        <filtering>true</filtering>
+      </testResource>
+    </testResources>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -43,20 +42,11 @@
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-failsafe-plugin</artifactId>
+        <artifactId>maven-jar-plugin</artifactId>
         <executions>
           <execution>
-            <id>integration-test</id>
-            <phase>integration-test</phase>
-            <goals>
-              <goal>integration-test</goal>
-            </goals>
-          </execution>
-          <execution>
-            <id>verify</id>
-            <phase>verify</phase>
             <goals>
-              <goal>verify</goal>
+              <goal>test-jar</goal>
             </goals>
           </execution>
         </executions>

integration_tests/exemplars_otel/src/test/resources/Dockerfile

@@ -0,0 +1,37 @@
+package io.prometheus.client.it.common;
+
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+
+import java.io.*;
+import java.net.URISyntaxException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+public class Downloader {
+
+    /**
+     * Download a file from an HTTP URL and store it in the target/ directory.
+     */
+    public static void downloadToTarget(String url, String fileName) throws IOException, URISyntaxException {
+        Path destination = Paths.get(Downloader.class.getResource("/").toURI()).getParent().resolve(fileName);
+        if (Files.exists(destination)) {
+            return; // only download once
+        }
+        System.out.println("Downloading " + url);
+        OkHttpClient client = new OkHttpClient();
+        Request request = new Request.Builder().url(url).build();
+        Response response = client.newCall(request).execute();
+        InputStream responseBody = response.body().byteStream();
+        OutputStream output = new FileOutputStream(destination.toFile());
+        byte[] data = new byte[1024];
+        int count;
+        while ((count = responseBody.read(data)) != -1) {
+            output.write(data, 0, count);
+        }
+        output.close();
+        responseBody.close();
+    }
+}

integration_tests/exemplars_otel_agent/src/test/resources/Dockerfile

@@ -0,0 +1,36 @@
+package io.prometheus.client.it.common;
+
+import org.testcontainers.containers.output.OutputFrame;
+
+import java.util.function.Consumer;
+
+/**
+ * Print Docker logs from TestContainers to stdout or stderr.
+ */
+public class LogConsumer implements Consumer<OutputFrame> {
+
+    private final String prefix;
+
+    private LogConsumer(String prefix) {
+        this.prefix = prefix;
+    }
+
+    public static LogConsumer withPrefix(String prefix) {
+     return new LogConsumer(prefix);
+    }
+
+    @Override
+    public void accept(OutputFrame outputFrame) {
+        switch (outputFrame.getType()) {
+            case STDOUT:
+                System.out.print(prefix + " - " + outputFrame.getUtf8String());
+                break;
+            case END:
+                System.out.println(prefix + " - END");
+                break;
+            default: // STDERR or unexpected
+                System.err.print(prefix + " - " + outputFrame.getUtf8String());
+                break;
+        }
+    }
+}

integration_tests/java_versions/pom.xml integration_tests/it_common/pom.xml

@@ -0,0 +1,61 @@
+package io.prometheus.client.it.common;
+
+import okhttp3.Credentials;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.junit.Assert;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * Scrape metrics via HTTP
+ */
+public class Scraper {
+
+    /**
+     * Scrape metrics from url without authentication.
+     */
+    public static List<String> scrape(String url, long timeoutMillis) {
+        return scrape(url, null, null, timeoutMillis);
+    }
+
+    /**
+     * Scrape metrics from url with HTTP basic authentication.
+     */
+    public static List<String> scrape(String url, String user, String password, long timeoutMillis) {
+        OkHttpClient client = new OkHttpClient();
+        long start = System.currentTimeMillis();
+        Exception exception = null;
+        while (System.currentTimeMillis() - start < timeoutMillis) {
+            try {
+                Request.Builder requestBuilder = new Request.Builder()
+                        .header("Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8")
+                        .url(url);
+                if (user != null && password != null) {
+                    requestBuilder.header("Authorization", Credentials.basic(user, password));
+                }
+                Request request = requestBuilder.build();
+                try (Response response = client.newCall(request).execute()) {
+                    if (response.code() != 200) {
+                        throw new IOException("Received HTTP Status " + response.code() + ": " + response.body().string());
+                    }
+                    return Arrays.asList(response.body().string().split("\\n"));
+                }
+            } catch (Exception e) {
+                exception = e;
+                try {
+                    Thread.sleep(100);
+                } catch (InterruptedException ignored) {
+                }
+            }
+        }
+        if (exception != null) {
+            exception.printStackTrace();
+        }
+        Assert.fail("timeout while getting metrics from " + url);
+        return null; // will not happen
+    }
+}

integration_tests/it_common/src/test/java/io/prometheus/client/it/common/Downloader.java

@@ -0,0 +1,16 @@
+package io.prometheus.client.it.common;
+
+import java.io.IOException;
+import java.util.Properties;
+
+/**
+ * Utility to get the project version, like <tt>0.12.1-SNAPSHOT</tt>
+ */
+public class Version {
+
+    public static String loadProjectVersion() throws IOException {
+        Properties properties = new Properties();
+        properties.load(Volume.class.getResourceAsStream("/project_version.properties"));
+        return properties.getProperty("project.version");
+    }
+}