Assert user agent when it is present (#7918)

Author: laurit

instrumentation/apache-httpclient/apache-httpclient-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/apachehttpclient/v5_0/AbstractApacheHttpClientTest.java

@@ -26,15 +26,11 @@
 
 abstract class AbstractApacheHttpClientTest<T extends HttpRequest>
     extends AbstractHttpClientTest<T> {
-
-  @Override
-  protected String userAgent() {
-    return "apachehttpclient";
-  }
+  private static final String USER_AGENT = "apachehttpclient";
 
   @Override
   protected void configure(HttpClientTestOptions.Builder optionsBuilder) {
-    optionsBuilder.setUserAgent(userAgent());
+    optionsBuilder.setUserAgent(USER_AGENT);
     optionsBuilder.enableTestReadTimeout();
     optionsBuilder.setHttpAttributes(this::getHttpAttributes);
   }
@@ -55,7 +51,7 @@ protected Set<AttributeKey<?>> getHttpAttributes(URI endpoint) {
   @Override
   public T buildRequest(String method, URI uri, Map<String, String> headers) {
     T request = createRequest(method, uri);
-    request.addHeader("user-agent", userAgent());
+    request.addHeader("user-agent", USER_AGENT);
     headers.forEach((key, value) -> request.setHeader(new BasicHeader(key, value)));
     return request;
   }

instrumentation/jaxrs-client/jaxrs-client-2.0-testing/src/test/groovy/JaxRsClientTest.groovy

@@ -140,6 +140,11 @@ class JerseyClientTest extends JaxRsClientTest {
     return new JerseyClientBuilder().withConfig(config)
   }
 
+  @Override
+  String userAgent() {
+    "Jersey"
+  }
+
   @Override
   SingleConnection createSingleConnection(String host, int port) {
     // Jersey JAX-RS client uses HttpURLConnection internally, which does not support pipelining nor
@@ -178,6 +183,11 @@ class CxfClientTest extends JaxRsClientTest {
     return exception
   }
 
+  @Override
+  String userAgent() {
+    "Apache"
+  }
+
   @Override
   ClientBuilder builder() {
     return new ClientBuilderImpl()

instrumentation/jodd-http-4.2/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/joddhttp/v4_2/JoddHttpTest.java

@@ -12,20 +12,15 @@
 import java.net.URI;
 import java.util.Map;
 import jodd.http.HttpRequest;
-import org.jetbrains.annotations.Nullable;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 public class JoddHttpTest extends AbstractHttpClientTest<HttpRequest> {
 
+  private static final String USER_AGENT = "Jodd HTTP";
+
   @RegisterExtension
   static final InstrumentationExtension testing = HttpClientInstrumentationExtension.forAgent();
 
-  @Nullable
-  @Override
-  protected String userAgent() {
-    return "Jodd HTTP";
-  }
-
   @Override
   public HttpRequest buildRequest(String method, URI uri, Map<String, String> headers) {
     HttpRequest request =
@@ -34,7 +29,7 @@ public HttpRequest buildRequest(String method, URI uri, Map<String, String> head
             .set(uri.toString())
             .followRedirects(true)
             .connectionKeepAlive(true)
-            .header("user-agent", userAgent());
+            .header("user-agent", USER_AGENT);
     for (Map.Entry<String, String> header : headers.entrySet()) {
       request.headerOverwrite(header.getKey(), header.getValue());
     }
@@ -45,8 +40,7 @@ public HttpRequest buildRequest(String method, URI uri, Map<String, String> head
   }
 
   @Override
-  public int sendRequest(HttpRequest request, String method, URI uri, Map<String, String> headers)
-      throws Exception {
+  public int sendRequest(HttpRequest request, String method, URI uri, Map<String, String> headers) {
     request.method(method).set(uri.toString());
     for (Map.Entry<String, String> header : headers.entrySet()) {
       request.headerOverwrite(header.getKey(), header.getValue());
@@ -60,5 +54,6 @@ protected void configure(HttpClientTestOptions.Builder optionsBuilder) {
     optionsBuilder.disableTestCallback();
     // Circular Redirects are not explicitly handled by jodd-http
     optionsBuilder.disableTestCircularRedirects();
+    optionsBuilder.setUserAgent(USER_AGENT);
   }
 }

testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/http/AbstractHttpClientTest.java

@@ -914,11 +914,17 @@ SpanDataAssert assertClientSpan(
               }
               if (httpClientAttributes.contains(SemanticAttributes.HTTP_USER_AGENT)) {
                 String userAgent = options.getUserAgent();
-                if (userAgent != null) {
+                if (userAgent != null || attrs.get(SemanticAttributes.HTTP_USER_AGENT) != null) {
                   assertThat(attrs)
                       .hasEntrySatisfying(
                           SemanticAttributes.HTTP_USER_AGENT,
-                          actual -> assertThat(actual).startsWith(userAgent));
+                          actual -> {
+                            if (userAgent != null) {
+                              assertThat(actual).startsWith(userAgent);
+                            } else {
+                              assertThat(actual).isNull();
+                            }
+                          });
                 }
               }
               if (attrs.get(SemanticAttributes.HTTP_REQUEST_CONTENT_LENGTH) != null) {