From e81e1090a5f0f7e7bc517d80064c14682f7a58b7 Mon Sep 17 00:00:00 2001 From: Alexander Dinauer Date: Mon, 16 Nov 2026 15:09:31 +0100 Subject: [PATCH 1/3] test(servlet): Test Servlet 3.1 on Tomcat 8.5 Run sentry-servlet against the minimum supported servlet container while keeping Servlet 3.1 as the production compile target. Exercise the service-loaded initializer through a real HTTP request and verify that request context reaches Sentry. --- gradle/libs.versions.toml | 1 + sentry-servlet/build.gradle.kts | 6 +- .../servlet/SentryServletIntegrationTest.kt | 100 ++++++++++++++++++ 3 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 88af43cd57..984c5713e5 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -266,6 +266,7 @@ gummy-bears-api21 = { module = "com.toasttab.android:gummy-bears-api-21", versio java8-signature = { module = "org.codehaus.mojo.signature:java18", version.ref = "java8Signature" } # tomcat libraries +tomcat85-embed-core = { module = "org.apache.tomcat.embed:tomcat-embed-core", version = "8.5.100" } tomcat-catalina = { module = "org.apache.tomcat:tomcat-catalina", version = "9.0.108" } tomcat-embed-jasper = { module = "org.apache.tomcat.embed:tomcat-embed-jasper", version = "9.0.108" } tomcat-catalina-jakarta = { module = "org.apache.tomcat:tomcat-catalina", version = "11.0.22" } diff --git a/sentry-servlet/build.gradle.kts b/sentry-servlet/build.gradle.kts index 42549c1f09..f564c9a0c5 100644 --- a/sentry-servlet/build.gradle.kts +++ b/sentry-servlet/build.gradle.kts @@ -35,10 +35,14 @@ dependencies { testImplementation(projects.sentryTestSupport) testImplementation(kotlin(Config.kotlinStdLib)) testImplementation(libs.awaitility.kotlin) + testImplementation(libs.google.truth) testImplementation(libs.kotlin.test.junit) testImplementation(libs.mockito.kotlin) testImplementation(libs.springboot.starter.test) - testImplementation(libs.springboot.starter.web) + testImplementation(libs.springboot.starter.web) { + exclude(group = "org.apache.tomcat.embed") + } + testImplementation(libs.tomcat85.embed.core) } tasks.withType().configureEach { diff --git a/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt b/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt new file mode 100644 index 0000000000..c3da46a740 --- /dev/null +++ b/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt @@ -0,0 +1,100 @@ +package io.sentry.servlet + +import com.google.common.truth.Truth.assertThat +import io.sentry.Sentry +import io.sentry.test.MockSentryServer +import io.sentry.test.event +import java.net.HttpURLConnection +import java.net.URI +import java.nio.file.Files +import java.util.ServiceLoader +import javax.servlet.ServletContainerInitializer +import javax.servlet.ServletContext +import javax.servlet.http.HttpServlet +import javax.servlet.http.HttpServletRequest +import javax.servlet.http.HttpServletResponse +import kotlin.test.AfterTest +import kotlin.test.BeforeTest +import kotlin.test.Test +import org.apache.catalina.startup.Tomcat +import org.apache.catalina.util.ServerInfo + +class SentryServletIntegrationTest { + private var server: MockSentryServer? = null + private var servletContext: ServletContext? = null + private var tomcat: Tomcat? = null + + @BeforeTest + fun setUp() { + val mockServer = MockSentryServer() + server = mockServer + Sentry.init { it.dsn = mockServer.dsn } + + tomcat = + Tomcat().apply { + setBaseDir(Files.createTempDirectory("tomcat-8.5").toString()) + setPort(0) + connector.setProperty("address", "127.0.0.1") + + val context = addContext("", Files.createTempDirectory("servlet-docbase").toString()) + context.effectiveMajorVersion = 3 + context.effectiveMinorVersion = 1 + context.parentClassLoader = javaClass.classLoader + Tomcat.addServlet(context, "capture", CaptureServlet()) + context.addServletMappingDecoded("/capture", "capture") + val initializer = + ServiceLoader.load(ServletContainerInitializer::class.java) + .filterIsInstance() + .single() + context.addServletContainerInitializer(initializer, emptySet()) + + start() + servletContext = context.servletContext + } + } + + @AfterTest + fun tearDown() { + Sentry.close() + tomcat?.stop() + tomcat?.destroy() + server?.close() + } + + @Test + fun `captures request data on Tomcat 8_5 with Servlet 3_1`() { + assertThat(ServerInfo.getServerNumber()).startsWith("8.5.") + assertThat(servletContext!!.effectiveMajorVersion).isEqualTo(3) + assertThat(servletContext!!.effectiveMinorVersion).isEqualTo(1) + + val port = tomcat!!.connector.localPort + val connection = + URI("http://127.0.0.1:$port/capture?customer=123").toURL().openConnection() + as HttpURLConnection + + try { + assertThat(connection.responseCode).isEqualTo(HttpServletResponse.SC_OK) + assertThat(connection.inputStream.bufferedReader().use { it.readText().trim() }) + .isEqualTo("captured") + } finally { + connection.disconnect() + } + + val event = server!!.awaitEnvelope { it.event()?.message?.formatted == MESSAGE }.event()!! + + assertThat(event.request?.method).isEqualTo("GET") + assertThat(event.request?.url).isEqualTo("http://127.0.0.1:$port/capture") + assertThat(event.request?.queryString).isEqualTo("customer=123") + } + + private class CaptureServlet : HttpServlet() { + override fun doGet(request: HttpServletRequest, response: HttpServletResponse) { + Sentry.captureMessage(MESSAGE) + response.writer.print("captured") + } + } + + private companion object { + const val MESSAGE = "captured from servlet integration test" + } +} From 6793b2450facaeee119c3446fa457edd99bebd88 Mon Sep 17 00:00:00 2001 From: Alexander Dinauer Date: Mon, 16 Nov 2026 15:21:03 +0100 Subject: [PATCH 2/3] test(servlet): Run integration test on Tomcat 9 Reuse the real-container servlet integration test with a Tomcat 9 and Servlet 4 runtime classpath. Keep the Tomcat 8.5 run as the minimum-runtime check and attach both runs to the verification lifecycle. --- gradle/libs.versions.toml | 1 + sentry-servlet/build.gradle.kts | 31 +++++++++++++++++++ .../servlet/SentryServletIntegrationTest.kt | 21 ++++++++----- 3 files changed, 46 insertions(+), 7 deletions(-) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 984c5713e5..e72a165566 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -267,6 +267,7 @@ java8-signature = { module = "org.codehaus.mojo.signature:java18", version.ref = # tomcat libraries tomcat85-embed-core = { module = "org.apache.tomcat.embed:tomcat-embed-core", version = "8.5.100" } +tomcat9-embed-core = { module = "org.apache.tomcat.embed:tomcat-embed-core", version = "9.0.108" } tomcat-catalina = { module = "org.apache.tomcat:tomcat-catalina", version = "9.0.108" } tomcat-embed-jasper = { module = "org.apache.tomcat.embed:tomcat-embed-jasper", version = "9.0.108" } tomcat-catalina-jakarta = { module = "org.apache.tomcat:tomcat-catalina", version = "11.0.22" } diff --git a/sentry-servlet/build.gradle.kts b/sentry-servlet/build.gradle.kts index f564c9a0c5..07650f9865 100644 --- a/sentry-servlet/build.gradle.kts +++ b/sentry-servlet/build.gradle.kts @@ -21,6 +21,13 @@ tasks.named("compileKotlin") { compilerOptions.apiVersion = org.jetbrains.kotlin.gradle.dsl.KotlinVersion.KOTLIN_1_9 } +val tomcat9TestRuntimeClasspath = + configurations.create("tomcat9TestRuntimeClasspath") { + isCanBeConsumed = false + isCanBeResolved = true + extendsFrom(configurations.testImplementation.get(), configurations.testRuntimeOnly.get()) + } + dependencies { api(projects.sentry) @@ -43,8 +50,32 @@ dependencies { exclude(group = "org.apache.tomcat.embed") } testImplementation(libs.tomcat85.embed.core) + add(tomcat9TestRuntimeClasspath.name, libs.tomcat9.embed.core) +} + +val testSourceSet = sourceSets["test"] + +tasks.named("test") { + systemProperty("io.sentry.test.tomcat-version-prefix", "8.5.") + systemProperty("io.sentry.test.servlet-major-version", "3") + systemProperty("io.sentry.test.servlet-minor-version", "1") } +val testTomcat9 = + tasks.register("testTomcat9") { + group = "verification" + description = "Runs the servlet integration test on Tomcat 9 and Servlet 4" + testClassesDirs = testSourceSet.output.classesDirs + classpath = testSourceSet.output + sourceSets["main"].output + tomcat9TestRuntimeClasspath + filter { includeTestsMatching("io.sentry.servlet.SentryServletIntegrationTest") } + systemProperty("io.sentry.test.tomcat-version-prefix", "9.0.") + systemProperty("io.sentry.test.servlet-major-version", "4") + systemProperty("io.sentry.test.servlet-minor-version", "0") + shouldRunAfter(tasks.test) + } + +tasks.named("check") { dependsOn(testTomcat9) } + tasks.withType().configureEach { options.errorprone { check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR) diff --git a/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt b/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt index c3da46a740..ec90cb46e9 100644 --- a/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt +++ b/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt @@ -20,6 +20,13 @@ import org.apache.catalina.startup.Tomcat import org.apache.catalina.util.ServerInfo class SentryServletIntegrationTest { + private val servletMajorVersion = + System.getProperty("io.sentry.test.servlet-major-version", "3").toInt() + private val servletMinorVersion = + System.getProperty("io.sentry.test.servlet-minor-version", "1").toInt() + private val tomcatVersionPrefix = + System.getProperty("io.sentry.test.tomcat-version-prefix", "8.5.") + private var server: MockSentryServer? = null private var servletContext: ServletContext? = null private var tomcat: Tomcat? = null @@ -32,13 +39,13 @@ class SentryServletIntegrationTest { tomcat = Tomcat().apply { - setBaseDir(Files.createTempDirectory("tomcat-8.5").toString()) + setBaseDir(Files.createTempDirectory("tomcat").toString()) setPort(0) connector.setProperty("address", "127.0.0.1") val context = addContext("", Files.createTempDirectory("servlet-docbase").toString()) - context.effectiveMajorVersion = 3 - context.effectiveMinorVersion = 1 + context.effectiveMajorVersion = servletMajorVersion + context.effectiveMinorVersion = servletMinorVersion context.parentClassLoader = javaClass.classLoader Tomcat.addServlet(context, "capture", CaptureServlet()) context.addServletMappingDecoded("/capture", "capture") @@ -62,10 +69,10 @@ class SentryServletIntegrationTest { } @Test - fun `captures request data on Tomcat 8_5 with Servlet 3_1`() { - assertThat(ServerInfo.getServerNumber()).startsWith("8.5.") - assertThat(servletContext!!.effectiveMajorVersion).isEqualTo(3) - assertThat(servletContext!!.effectiveMinorVersion).isEqualTo(1) + fun `captures request data on supported servlet container`() { + assertThat(ServerInfo.getServerNumber()).startsWith(tomcatVersionPrefix) + assertThat(servletContext!!.effectiveMajorVersion).isEqualTo(servletMajorVersion) + assertThat(servletContext!!.effectiveMinorVersion).isEqualTo(servletMinorVersion) val port = tomcat!!.connector.localPort val connection = From bc1635c4efd7688f7fe5a984307dbf851ecea2cc Mon Sep 17 00:00:00 2001 From: Alexander Dinauer Date: Tue, 17 Nov 2026 14:54:42 +0100 Subject: [PATCH 3/3] build(servlet): Use JVM test suites for Tomcat matrix Replace the hand-built Tomcat 9 test task with isolated JVM test suites. Run the shared servlet integration test with independent Tomcat 8.5 and Tomcat 9 dependency graphs and attach both suites to check. Co-Authored-By: Claude --- sentry-servlet/build.gradle.kts | 81 ++++++++++++------- .../servlet/SentryServletIntegrationTest.kt | 0 2 files changed, 50 insertions(+), 31 deletions(-) rename sentry-servlet/src/{test => integrationTest}/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt (100%) diff --git a/sentry-servlet/build.gradle.kts b/sentry-servlet/build.gradle.kts index 07650f9865..ae621bf39f 100644 --- a/sentry-servlet/build.gradle.kts +++ b/sentry-servlet/build.gradle.kts @@ -21,13 +21,6 @@ tasks.named("compileKotlin") { compilerOptions.apiVersion = org.jetbrains.kotlin.gradle.dsl.KotlinVersion.KOTLIN_1_9 } -val tomcat9TestRuntimeClasspath = - configurations.create("tomcat9TestRuntimeClasspath") { - isCanBeConsumed = false - isCanBeResolved = true - extendsFrom(configurations.testImplementation.get(), configurations.testRuntimeOnly.get()) - } - dependencies { api(projects.sentry) @@ -46,35 +39,61 @@ dependencies { testImplementation(libs.kotlin.test.junit) testImplementation(libs.mockito.kotlin) testImplementation(libs.springboot.starter.test) - testImplementation(libs.springboot.starter.web) { - exclude(group = "org.apache.tomcat.embed") - } - testImplementation(libs.tomcat85.embed.core) - add(tomcat9TestRuntimeClasspath.name, libs.tomcat9.embed.core) + testImplementation(libs.springboot.starter.web) } -val testSourceSet = sourceSets["test"] - -tasks.named("test") { - systemProperty("io.sentry.test.tomcat-version-prefix", "8.5.") - systemProperty("io.sentry.test.servlet-major-version", "3") - systemProperty("io.sentry.test.servlet-minor-version", "1") -} +testing { + suites { + register("integrationTest") { + useJUnit() + dependencies { + implementation(project()) + implementation(projects.sentryTestSupport) + implementation(libs.google.truth) + implementation(libs.kotlin.test.junit) + implementation(libs.tomcat85.embed.core) + } + targets.all { + testTask.configure { + description = "Runs the servlet integration test on Tomcat 8.5 and Servlet 3.1" + systemProperty("io.sentry.test.tomcat-version-prefix", "8.5.") + systemProperty("io.sentry.test.servlet-major-version", "3") + systemProperty("io.sentry.test.servlet-minor-version", "1") + } + } + } -val testTomcat9 = - tasks.register("testTomcat9") { - group = "verification" - description = "Runs the servlet integration test on Tomcat 9 and Servlet 4" - testClassesDirs = testSourceSet.output.classesDirs - classpath = testSourceSet.output + sourceSets["main"].output + tomcat9TestRuntimeClasspath - filter { includeTestsMatching("io.sentry.servlet.SentryServletIntegrationTest") } - systemProperty("io.sentry.test.tomcat-version-prefix", "9.0.") - systemProperty("io.sentry.test.servlet-major-version", "4") - systemProperty("io.sentry.test.servlet-minor-version", "0") - shouldRunAfter(tasks.test) + register("integrationTestTomcat9") { + useJUnit() + dependencies { + implementation(project()) + implementation(projects.sentryTestSupport) + implementation(libs.google.truth) + implementation(libs.kotlin.test.junit) + implementation(libs.tomcat9.embed.core) + } + sources { + java.setSrcDirs(sourceSets["integrationTest"].allJava.srcDirs) + resources.setSrcDirs(sourceSets["integrationTest"].resources.srcDirs) + } + targets.all { + testTask.configure { + description = "Runs the servlet integration test on Tomcat 9 and Servlet 4" + systemProperty("io.sentry.test.tomcat-version-prefix", "9.0.") + systemProperty("io.sentry.test.servlet-major-version", "4") + systemProperty("io.sentry.test.servlet-minor-version", "0") + } + } + } } +} -tasks.named("check") { dependsOn(testTomcat9) } +tasks.check { + dependsOn( + testing.suites.named("integrationTest"), + testing.suites.named("integrationTestTomcat9"), + ) +} tasks.withType().configureEach { options.errorprone { diff --git a/sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt b/sentry-servlet/src/integrationTest/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt similarity index 100% rename from sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt rename to sentry-servlet/src/integrationTest/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt