Skip to content

Commit db8bb6c

Browse files
committed
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.
1 parent 7417551 commit db8bb6c

3 files changed

Lines changed: 46 additions & 7 deletions

File tree

‎gradle/libs.versions.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ java8-signature = { module = "org.codehaus.mojo.signature:java18", version.ref =
267267

268268
# tomcat libraries
269269
tomcat85-embed-core = { module = "org.apache.tomcat.embed:tomcat-embed-core", version = "8.5.100" }
270+
tomcat9-embed-core = { module = "org.apache.tomcat.embed:tomcat-embed-core", version = "9.0.108" }
270271
tomcat-catalina = { module = "org.apache.tomcat:tomcat-catalina", version = "9.0.108" }
271272
tomcat-embed-jasper = { module = "org.apache.tomcat.embed:tomcat-embed-jasper", version = "9.0.108" }
272273
tomcat-catalina-jakarta = { module = "org.apache.tomcat:tomcat-catalina", version = "11.0.22" }

‎sentry-servlet/build.gradle.kts‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ tasks.named<KotlinCompile>("compileKotlin") {
2121
compilerOptions.apiVersion = org.jetbrains.kotlin.gradle.dsl.KotlinVersion.KOTLIN_1_9
2222
}
2323

24+
val tomcat9TestRuntimeClasspath =
25+
configurations.create("tomcat9TestRuntimeClasspath") {
26+
isCanBeConsumed = false
27+
isCanBeResolved = true
28+
extendsFrom(configurations.testImplementation.get(), configurations.testRuntimeOnly.get())
29+
}
30+
2431
dependencies {
2532
api(projects.sentry)
2633

@@ -43,8 +50,32 @@ dependencies {
4350
exclude(group = "org.apache.tomcat.embed")
4451
}
4552
testImplementation(libs.tomcat85.embed.core)
53+
add(tomcat9TestRuntimeClasspath.name, libs.tomcat9.embed.core)
54+
}
55+
56+
val testSourceSet = sourceSets["test"]
57+
58+
tasks.named<Test>("test") {
59+
systemProperty("io.sentry.test.tomcat-version-prefix", "8.5.")
60+
systemProperty("io.sentry.test.servlet-major-version", "3")
61+
systemProperty("io.sentry.test.servlet-minor-version", "1")
4662
}
4763

64+
val testTomcat9 =
65+
tasks.register<Test>("testTomcat9") {
66+
group = "verification"
67+
description = "Runs the servlet integration test on Tomcat 9 and Servlet 4"
68+
testClassesDirs = testSourceSet.output.classesDirs
69+
classpath = testSourceSet.output + sourceSets["main"].output + tomcat9TestRuntimeClasspath
70+
filter { includeTestsMatching("io.sentry.servlet.SentryServletIntegrationTest") }
71+
systemProperty("io.sentry.test.tomcat-version-prefix", "9.0.")
72+
systemProperty("io.sentry.test.servlet-major-version", "4")
73+
systemProperty("io.sentry.test.servlet-minor-version", "0")
74+
shouldRunAfter(tasks.test)
75+
}
76+
77+
tasks.named("check") { dependsOn(testTomcat9) }
78+
4879
tasks.withType<JavaCompile>().configureEach {
4980
options.errorprone {
5081
check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR)

‎sentry-servlet/src/test/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ import org.apache.catalina.startup.Tomcat
2020
import org.apache.catalina.util.ServerInfo
2121

2222
class SentryServletIntegrationTest {
23+
private val servletMajorVersion =
24+
System.getProperty("io.sentry.test.servlet-major-version", "3").toInt()
25+
private val servletMinorVersion =
26+
System.getProperty("io.sentry.test.servlet-minor-version", "1").toInt()
27+
private val tomcatVersionPrefix =
28+
System.getProperty("io.sentry.test.tomcat-version-prefix", "8.5.")
29+
2330
private var server: MockSentryServer? = null
2431
private var servletContext: ServletContext? = null
2532
private var tomcat: Tomcat? = null
@@ -32,13 +39,13 @@ class SentryServletIntegrationTest {
3239

3340
tomcat =
3441
Tomcat().apply {
35-
setBaseDir(Files.createTempDirectory("tomcat-8.5").toString())
42+
setBaseDir(Files.createTempDirectory("tomcat").toString())
3643
setPort(0)
3744
connector.setProperty("address", "127.0.0.1")
3845

3946
val context = addContext("", Files.createTempDirectory("servlet-docbase").toString())
40-
context.effectiveMajorVersion = 3
41-
context.effectiveMinorVersion = 1
47+
context.effectiveMajorVersion = servletMajorVersion
48+
context.effectiveMinorVersion = servletMinorVersion
4249
context.parentClassLoader = javaClass.classLoader
4350
Tomcat.addServlet(context, "capture", CaptureServlet())
4451
context.addServletMappingDecoded("/capture", "capture")
@@ -62,10 +69,10 @@ class SentryServletIntegrationTest {
6269
}
6370

6471
@Test
65-
fun `captures request data on Tomcat 8_5 with Servlet 3_1`() {
66-
assertThat(ServerInfo.getServerNumber()).startsWith("8.5.")
67-
assertThat(servletContext!!.effectiveMajorVersion).isEqualTo(3)
68-
assertThat(servletContext!!.effectiveMinorVersion).isEqualTo(1)
72+
fun `captures request data on supported servlet container`() {
73+
assertThat(ServerInfo.getServerNumber()).startsWith(tomcatVersionPrefix)
74+
assertThat(servletContext!!.effectiveMajorVersion).isEqualTo(servletMajorVersion)
75+
assertThat(servletContext!!.effectiveMinorVersion).isEqualTo(servletMinorVersion)
6976

7077
val port = tomcat!!.connector.localPort
7178
val connection =

0 commit comments

Comments
 (0)