benchmarks: moves dependency scope to test (#1422)

Signed-off-by: Adrian Cole <adrian@tetrate.io>
openzipkin · Mar 5, 2024 · d8dc495 · d8dc495
1 parent 5552507
commit d8dc495
Show file tree

Hide file tree

Showing 38 changed files with 134 additions and 57 deletions.
diff --git a/instrumentation/benchmarks/README.md b/instrumentation/benchmarks/README.md
@@ -5,7 +5,13 @@ benchmarks for Brave instrumentation. You can use these to measure overhead
 of using Brave.
 
 ### Running the benchmark
-From the project directory, run `./mvnw install -pl instrumentation/benchmarks -am -DskipTests` to build the benchmarks, and the following to run them:
+From the project directory, run this to build the benchmarks:
+
+```bash
+$ ./mvnw install -pl instrumentation/benchmarks -am -Dmaven.test.skip.exec=true`
+```
+
+and the following to run them:
 
 ```bash
 $ java -jar instrumentation/benchmarks/target/benchmarks.jar

diff --git a/instrumentation/benchmarks/pom.xml b/instrumentation/benchmarks/pom.xml
@@ -13,7 +13,9 @@
     the License.
 
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
     <groupId>io.zipkin.brave</groupId>
@@ -31,142 +33,147 @@
     <undertow-servlet.version>2.2.30.Final</undertow-servlet.version>
   </properties>
 
-  <!-- can't import brave-bom due to build-support/go-offline.sh -->
+  <!-- All dependencies are marked test, because benchmarks are a form of test.
+       This module is skipped on -DskipTests, ensuring it isn't deployed. -->
   <dependencies>
+    <!-- can't import brave-bom due to build-support/go-offline.sh -->
     <dependency>
       <groupId>org.openjdk.jmh</groupId>
       <artifactId>jmh-core</artifactId>
       <version>${jmh.version}</version>
-    </dependency>
-
-    <dependency>
-      <groupId>org.openjdk.jmh</groupId>
-      <artifactId>jmh-generator-annprocess</artifactId>
-      <version>${jmh.version}</version>
-      <scope>provided</scope>
-    </dependency>
-
-    <dependency>
-      <groupId>org.apache.logging.log4j</groupId>
-      <artifactId>log4j-core</artifactId>
-      <version>${log4j.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>com.amazonaws</groupId>
       <artifactId>aws-xray-recorder-sdk-core</artifactId>
       <version>2.15.1</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-http</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-httpclient</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-httpasyncclient</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.apache.httpcomponents</groupId>
       <artifactId>httpasyncclient</artifactId>
       <version>${httpasyncclient.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-spring-web</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.springframework</groupId>
       <artifactId>spring-web</artifactId>
       <version>${spring5.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-okhttp3</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>com.squareup.okhttp3</groupId>
       <artifactId>okhttp</artifactId>
       <version>${okhttp.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-jaxrs2</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>net.ltgt.jaxrs</groupId>
       <artifactId>resteasy-client-okhttp3</artifactId>
       <version>1.1</version>
+      <scope>test</scope>
     </dependency>
     <!-- Avoid CVE ridden version from resteasy-client-okhttp3 -->
     <dependency>
       <groupId>org.jboss.resteasy</groupId>
       <artifactId>resteasy-client</artifactId>
       <version>${resteasy.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-servlet</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-spring-webmvc</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.springframework</groupId>
       <artifactId>spring-webmvc</artifactId>
       <version>${spring5.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-jersey-server</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.glassfish.jersey.containers</groupId>
       <artifactId>jersey-container-servlet</artifactId>
       <version>${jersey.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-netty-codec-http</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.netty</groupId>
       <artifactId>netty-codec-http</artifactId>
       <version>${netty.version}</version>
-    </dependency>
-    <dependency>
-      <groupId>org.apache.logging.log4j</groupId>
-      <artifactId>log4j-slf4j-impl</artifactId>
-      <version>${log4j.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-kafka-clients</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.apache.kafka</groupId>
@@ -178,34 +185,40 @@
           <artifactId>slf4j-log4j12</artifactId>
         </exclusion>
       </exclusions>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-jms</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.apache.activemq</groupId>
       <artifactId>activemq-broker</artifactId>
       <version>${activemq.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-instrumentation-spring-rabbit</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.springframework.amqp</groupId>
       <artifactId>spring-rabbit</artifactId>
       <version>${spring-rabbit.version}</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>io.undertow</groupId>
       <artifactId>undertow-core</artifactId>
       <version>${undertow-servlet.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.undertow</groupId>
@@ -217,37 +230,49 @@
           <artifactId>jboss-servlet-api_3.1_spec</artifactId>
         </exclusion>
       </exclusions>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.jboss.resteasy</groupId>
       <artifactId>resteasy-undertow</artifactId>
       <version>${resteasy.version}</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>brave-context-log4j2</artifactId>
       <version>${project.version}</version>
+      <scope>test</scope>
     </dependency>
   </dependencies>
 
   <build>
+    <!-- use assembly instead of shade, as it naturally works for test-jar -->
     <plugins>
       <plugin>
-        <artifactId>maven-shade-plugin</artifactId>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <version>${maven-assembly-plugin.version}</version>
+        <configuration>
+          <descriptors>
+            <descriptor>src/test/assembly/test-jar.xml</descriptor>
+          </descriptors>
+        </configuration>
         <executions>
           <execution>
+            <id>make-assembly</id>
             <phase>package</phase>
             <goals>
-              <goal>shade</goal>
+              <goal>single</goal>
             </goals>
             <configuration>
+              <attach>true</attach>
               <finalName>benchmarks</finalName>
-              <transformers>
-                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+              <appendAssemblyId>false</appendAssemblyId>
+              <archive>
+                <manifest>
                   <mainClass>org.openjdk.jmh.Main</mainClass>
-                </transformer>
-              </transformers>
-              <createDependencyReducedPom>false</createDependencyReducedPom>
+                </manifest>
+              </archive>
             </configuration>
           </execution>
         </executions>
@@ -257,15 +282,22 @@
         <executions>
           <execution>
             <id>default-compile</id>
-            <phase>compile</phase>
+            <phase>test-compile</phase>
             <goals>
-              <goal>compile</goal>
+              <goal>testCompile</goal>
             </goals>
             <configuration combine.self="override">
               <!-- instead of javac-with-errorprone -->
               <compilerId>javac</compilerId>
               <!-- scrub errorprone compiler args -->
-              <compilerArgs />
+              <compilerArgs/>
+              <annotationProcessorPaths>
+                <path>
+                  <groupId>org.openjdk.jmh</groupId>
+                  <artifactId>jmh-generator-annprocess</artifactId>
+                  <version>${jmh.version}</version>
+                </path>
+              </annotationProcessorPaths>
             </configuration>
           </execution>
         </executions>

diff --git a/instrumentation/benchmarks/src/test/assembly/test-jar.xml b/instrumentation/benchmarks/src/test/assembly/test-jar.xml
@@ -0,0 +1,44 @@
+<!--
+
+    Copyright 2013-2024 The OpenZipkin Authors
+
+    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.
+
+-->
+<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.2.0 https://maven.apache.org/xsd/assembly-2.2.0.xsd">
+  <!-- This is an alternative to maven-shade-plugin, which makes an executable
+       jar from the test source tree. This was made due to lack of success
+       getting 'shadeTestJar' and similar configuration working. -->
+  <id>test-jar</id>
+  <formats>
+    <format>jar</format>
+  </formats>
+  <includeBaseDirectory>false</includeBaseDirectory>
+  <dependencySets>
+    <dependencySet>
+      <outputDirectory>/</outputDirectory>
+      <useProjectArtifact>true</useProjectArtifact>
+      <unpack>true</unpack>
+      <scope>test</scope>
+    </dependencySet>
+  </dependencySets>
+  <fileSets>
+    <fileSet>
+      <directory>${project.build.directory}/test-classes</directory>
+      <outputDirectory>/</outputDirectory>
+      <includes>
+        <include>**/*</include>
+      </includes>
+      <useDefaultExcludes>true</useDefaultExcludes>
+    </fileSet>
+  </fileSets>
+</assembly>
diff --git a/...c/main/java/brave/EndToEndBenchmarks.java → ...c/test/java/brave/EndToEndBenchmarks.java b/...c/main/java/brave/EndToEndBenchmarks.java → ...c/test/java/brave/EndToEndBenchmarks.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2020 The OpenZipkin Authors
+ * Copyright 2013-2024 The OpenZipkin Authors
  *
  * 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

diff --git a/...src/main/java/brave/TracerBenchmarks.java → ...src/test/java/brave/TracerBenchmarks.java b/...src/main/java/brave/TracerBenchmarks.java → ...src/test/java/brave/TracerBenchmarks.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2020 The OpenZipkin Authors
+ * Copyright 2013-2024 The OpenZipkin Authors
  *
  * 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

diff --git a/...baggage/BaggagePropagationBenchmarks.java → ...baggage/BaggagePropagationBenchmarks.java b/...baggage/BaggagePropagationBenchmarks.java → ...baggage/BaggagePropagationBenchmarks.java
diff --git a/.../brave/handler/MutableSpanBenchmarks.java → .../brave/handler/MutableSpanBenchmarks.java b/.../brave/handler/MutableSpanBenchmarks.java → .../brave/handler/MutableSpanBenchmarks.java
diff --git a/...java/brave/http/HttpClientBenchmarks.java → ...java/brave/http/HttpClientBenchmarks.java b/...java/brave/http/HttpClientBenchmarks.java → ...java/brave/http/HttpClientBenchmarks.java
diff --git a/...java/brave/http/HttpServerBenchmarks.java → ...java/brave/http/HttpServerBenchmarks.java b/...java/brave/http/HttpServerBenchmarks.java → ...java/brave/http/HttpServerBenchmarks.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2020 The OpenZipkin Authors
+ * Copyright 2013-2024 The OpenZipkin Authors
  *
  * 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

diff --git a/...ient/ApacheHttpAsyncClientBenchmarks.java → ...ient/ApacheHttpAsyncClientBenchmarks.java b/...ient/ApacheHttpAsyncClientBenchmarks.java → ...ient/ApacheHttpAsyncClientBenchmarks.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 The OpenZipkin Authors
+ * Copyright 2013-2024 The OpenZipkin Authors
  *
  * 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

diff --git a/...ttpclient/ApacheHttpClientBenchmarks.java → ...ttpclient/ApacheHttpClientBenchmarks.java b/...ttpclient/ApacheHttpClientBenchmarks.java → ...ttpclient/ApacheHttpClientBenchmarks.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 The OpenZipkin Authors
+ * Copyright 2013-2024 The OpenZipkin Authors
  *
  * 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