Add tests for Spring Monitor (Azure#36498)

Author: jeanbisutti

eng/versioning/external_dependencies.txt

@@ -24,6 +24,7 @@ com.github.spotbugs:spotbugs-annotations;4.2.2
 com.github.spotbugs:spotbugs-maven-plugin;4.2.2
 com.google.code.gson:gson;2.10
 com.google.guava:guava;32.0.1-jre
+com.h2database:h2;2.1.214
 com.h3xstream.findsecbugs:findsecbugs-plugin;1.9.0
 com.microsoft.azure:applicationinsights-core;3.4.1
 com.microsoft.azure:azure-annotations;1.7.0
@@ -127,6 +128,7 @@ org.springframework.boot:spring-boot-starter-actuator;2.7.14
 org.springframework.boot:spring-boot-starter-aop;2.7.14
 org.springframework.boot:spring-boot-starter-cache;2.7.14
 org.springframework.boot:spring-boot-starter-data-redis;2.7.14
+org.springframework.boot:spring-boot-starter-data-jdbc;2.7.14
 org.springframework.boot:spring-boot-starter-integration;2.7.14
 org.springframework.boot:spring-boot-starter-logging;2.7.14
 org.springframework.boot:spring-boot-starter-test;2.7.14
@@ -204,8 +206,10 @@ io.opentelemetry:opentelemetry-api-logs;1.26.0-alpha
 io.opentelemetry:opentelemetry-sdk-testing;1.28.0
 io.opentelemetry:opentelemetry-sdk-extension-autoconfigure;1.28.0
 io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi;1.28.0
-io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry-java8;1.27.0-alpha
-io.opentelemetry.instrumentation:opentelemetry-spring-boot-starter;1.27.0-alpha
+io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry-java8;1.28.0-alpha
+io.opentelemetry.instrumentation:opentelemetry-spring-boot-starter;1.28.0-alpha
+io.opentelemetry.instrumentation:opentelemetry-jdbc;1.28.0-alpha
+io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0;1.28.0-alpha
 io.projectreactor:reactor-test;3.4.31
 io.github.hakky54:logcaptor;2.9.0
 com.squareup.okio:okio;3.3.0
@@ -268,6 +272,7 @@ net.jonathangiles.tools:dependencyChecker-maven-plugin;1.0.6
 net.jonathangiles.tools:whitelistgenerator-maven-plugin;1.0.2
 org.apache.commons:commons-collections4;4.4
 org.apache.commons:commons-text;1.10.0
+org.apache.commons:commons-dbcp2;2.9.0
 org.apache.maven:maven-plugin-api;3.8.6
 org.apache.maven:maven-project;2.2.1
 org.apache.maven.plugin-tools:maven-plugin-annotations;3.6.4

sdk/spring/spring-cloud-azure-starter-monitor-test/pom.xml

@@ -31,11 +31,36 @@
       <artifactId>spring-cloud-azure-starter-monitor</artifactId>
       <version>1.0.0-beta.1</version> <!-- {x-version-update;com.azure.spring:azure-monitor-spring-native;dependency} -->
     </dependency>
+
+    <!-- OTel dependencies -->
+    <dependency>
+      <groupId>io.opentelemetry.instrumentation</groupId>
+      <artifactId>opentelemetry-jdbc</artifactId>
+      <version>1.28.0-alpha</version><!-- {x-version-update;io.opentelemetry.instrumentation:opentelemetry-jdbc;external_dependency} -->
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry.instrumentation</groupId>
+      <artifactId>opentelemetry-logback-appender-1.0</artifactId>
+      <version>1.28.0-alpha</version><!-- {x-version-update;io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0;external_dependency} -->
+      <scope>runtime</scope>
+    </dependency>
+    <!-- End of OTel dependencies -->
+
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
       <version>2.7.14</version> <!-- {x-version-update;org.springframework.boot:spring-boot-starter-web;external_dependency} -->
     </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-data-jdbc</artifactId>
+      <version>2.7.14</version><!-- {x-version-update;org.springframework.boot:spring-boot-starter-data-jdbc;external_dependency} -->
+    </dependency>
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-dbcp2</artifactId>
+      <version>2.9.0</version> <!-- {x-version-update;org.apache.commons:commons-dbcp2;external_dependency} -->
+    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
@@ -48,6 +73,11 @@
       <version>1.19.0</version> <!-- {x-version-update;com.azure:azure-core-test;dependency} -->
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.h2database</groupId>
+      <artifactId>h2</artifactId>
+      <version>2.1.214</version> <!-- {x-version-update;com.h2database:h2;external_dependency} -->
+    </dependency>
   </dependencies>
 
   <!-- Apply checkstyle, spotbugs, and revapi for all java versions -->

sdk/spring/spring-cloud-azure-starter-monitor-test/src/main/java/com/azure/Application.java

@@ -1,3 +1,5 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 package com.azure;
 
 import org.springframework.boot.SpringApplication;

sdk/spring/spring-cloud-azure-starter-monitor-test/src/main/java/com/azure/Controller.java

@@ -1,11 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 package com.azure;
 
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 public class Controller {
-
     public static final String URL = "/controller-url";
 
     @GetMapping(URL)

sdk/spring/spring-cloud-azure-starter-monitor-test/src/main/java/com/azure/DatasourceConfig.java

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+package com.azure;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.jdbc.datasource.OpenTelemetryDataSource;
+import javax.sql.DataSource;
+import org.apache.commons.dbcp2.BasicDataSource;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class DatasourceConfig {
+
+  @Bean
+  public DataSource dataSource(OpenTelemetry openTelemetry) {
+    BasicDataSource dataSource = new BasicDataSource();
+    dataSource.setDriverClassName("org.h2.Driver");
+    dataSource.setUrl("jdbc:h2:mem:db");
+    dataSource.setUsername("username");
+    dataSource.setPassword("pwd");
+    return new OpenTelemetryDataSource(dataSource, openTelemetry);
+  }
+}

sdk/spring/spring-cloud-azure-starter-monitor-test/src/main/java/com/azure/SqlExecutor.java

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+package com.azure;
+
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.event.EventListener;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.stereotype.Component;
+
+@Component
+public class SqlExecutor {
+
+  private final JdbcTemplate jdbcTemplate;
+
+  public SqlExecutor(JdbcTemplate jdbcTemplate) {
+    this.jdbcTemplate = jdbcTemplate;
+  }
+
+  @EventListener(ApplicationReadyEvent.class)
+  public void createDatabaseTable() {
+    jdbcTemplate.execute("create table test_table (id bigint not null, primary key (id))");
+  }
+}

sdk/spring/spring-cloud-azure-starter-monitor-test/src/main/resources/logback.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+  <appender name="OpenTelemetry"
+            class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender">
+  </appender>
+
+  <root level="INFO">
+    <appender-ref ref="OpenTelemetry"/>
+  </root>
+
+</configuration>

sdk/spring/spring-cloud-azure-starter-monitor-test/src/test/java/com/azure/CustomValidationPolicy.java

@@ -1,3 +1,5 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 package com.azure;
 
 import com.azure.core.http.HttpPipelineCallContext;

sdk/spring/spring-cloud-azure-starter-monitor-test/src/test/java/com/azure/SpringMonitorTest.java

@@ -0,0 +1,102 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+package com.azure;
+
+import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.azure.core.http.*;
+import com.azure.core.http.policy.HttpPipelinePolicy;
+import com.azure.monitor.opentelemetry.exporter.implementation.models.*;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.List;
+import java.util.concurrent.CountDownLatch;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import reactor.util.annotation.Nullable;
+
+@SpringBootTest(
+    classes = {Application.class, SpringMonitorTest.TestConfiguration.class},
+    webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
+    properties = {
+      "applicationinsights.connection.string=InstrumentationKey=00000000-0000-0000-0000-0FEEDDADBEEF;IngestionEndpoint=https://test.in.applicationinsights.azure.com/;LiveEndpoint=https://test.livediagnostics.monitor.azure.com/"
+    })
+public class SpringMonitorTest {
+
+  private static CountDownLatch countDownLatch;
+
+  private static CustomValidationPolicy customValidationPolicy;
+
+  @Autowired private TestRestTemplate restTemplate;
+
+  @Configuration(proxyBeanMethods = false)
+  static class TestConfiguration {
+
+    @Bean
+    HttpPipeline httpPipeline() {
+      countDownLatch = new CountDownLatch(2);
+      customValidationPolicy = new CustomValidationPolicy(countDownLatch);
+      return getHttpPipeline(customValidationPolicy);
+    }
+
+    HttpPipeline getHttpPipeline(@Nullable HttpPipelinePolicy policy) {
+      return new HttpPipelineBuilder()
+          .httpClient(HttpClient.createDefault())
+          .policies(policy)
+          .build();
+    }
+  }
+
+  @Test
+  public void shouldMonitor() throws InterruptedException, MalformedURLException {
+    String response = restTemplate.getForObject(Controller.URL, String.class);
+    assertThat(response).isEqualTo("OK!");
+
+    countDownLatch.await(10, SECONDS);
+
+    assertThat(customValidationPolicy.url)
+        .isEqualTo(new URL("https://test.in.applicationinsights.azure.com/v2.1/track"));
+
+    List<TelemetryItem> telemetryItems = customValidationPolicy.actualTelemetryItems;
+    assertThat(telemetryItems.size()).isEqualTo(5);
+
+    // Log telemetry
+    TelemetryItem telemetry1 = telemetryItems.get(0);
+    assertThat(telemetry1.getName()).isEqualTo("Message");
+    MonitorDomain logBaseData = telemetry1.getData().getBaseData();
+    MessageData logData = (MessageData) logBaseData;
+    assertThat(logData.getMessage())
+        .isEqualTo("Initializing Spring DispatcherServlet 'dispatcherServlet'");
+    assertThat(logData.getSeverityLevel()).isEqualTo(SeverityLevel.INFORMATION);
+
+    TelemetryItem telemetry2 = telemetryItems.get(1);
+    assertThat(telemetry2.getName()).isEqualTo("Message");
+
+    TelemetryItem telemetry3 = telemetryItems.get(2);
+    assertThat(telemetry3.getName()).isEqualTo("Message");
+
+    // SQL telemetry
+    TelemetryItem telemetry4 = telemetryItems.get(3);
+    assertThat(telemetry4.getName()).isEqualTo("RemoteDependency");
+    MonitorDomain remoteBaseData = telemetry4.getData().getBaseData();
+    RemoteDependencyData remoteDependencyData = (RemoteDependencyData) remoteBaseData;
+    assertThat(remoteDependencyData.getType()).isEqualTo("SQL");
+    assertThat(remoteDependencyData.getData())
+        .isEqualTo("create table test_table (id bigint not null, primary key (id))");
+
+    // HTTP telemetry
+    TelemetryItem telemetry5 = telemetryItems.get(4);
+    assertThat(telemetry5.getName()).isEqualTo("Request");
+    MonitorDomain requestBaseData = telemetry5.getData().getBaseData();
+    RequestData requestData = (RequestData) requestBaseData;
+    assertThat(requestData.getUrl()).contains(Controller.URL);
+    assertThat(requestData.isSuccess()).isTrue();
+    assertThat(requestData.getResponseCode()).isEqualTo("200");
+    assertThat(requestData.getName()).isEqualTo("GET /controller-url");
+  }
+}