Skip to content

Commit e81e109

Browse files
committed
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.
1 parent 48a9334 commit e81e109

3 files changed

Lines changed: 106 additions & 1 deletion

File tree

‎gradle/libs.versions.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@ gummy-bears-api21 = { module = "com.toasttab.android:gummy-bears-api-21", versio
266266
java8-signature = { module = "org.codehaus.mojo.signature:java18", version.ref = "java8Signature" }
267267

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

‎sentry-servlet/build.gradle.kts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,14 @@ dependencies {
3535
testImplementation(projects.sentryTestSupport)
3636
testImplementation(kotlin(Config.kotlinStdLib))
3737
testImplementation(libs.awaitility.kotlin)
38+
testImplementation(libs.google.truth)
3839
testImplementation(libs.kotlin.test.junit)
3940
testImplementation(libs.mockito.kotlin)
4041
testImplementation(libs.springboot.starter.test)
41-
testImplementation(libs.springboot.starter.web)
42+
testImplementation(libs.springboot.starter.web) {
43+
exclude(group = "org.apache.tomcat.embed")
44+
}
45+
testImplementation(libs.tomcat85.embed.core)
4246
}
4347

4448
tasks.withType<JavaCompile>().configureEach {
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
package io.sentry.servlet
2+
3+
import com.google.common.truth.Truth.assertThat
4+
import io.sentry.Sentry
5+
import io.sentry.test.MockSentryServer
6+
import io.sentry.test.event
7+
import java.net.HttpURLConnection
8+
import java.net.URI
9+
import java.nio.file.Files
10+
import java.util.ServiceLoader
11+
import javax.servlet.ServletContainerInitializer
12+
import javax.servlet.ServletContext
13+
import javax.servlet.http.HttpServlet
14+
import javax.servlet.http.HttpServletRequest
15+
import javax.servlet.http.HttpServletResponse
16+
import kotlin.test.AfterTest
17+
import kotlin.test.BeforeTest
18+
import kotlin.test.Test
19+
import org.apache.catalina.startup.Tomcat
20+
import org.apache.catalina.util.ServerInfo
21+
22+
class SentryServletIntegrationTest {
23+
private var server: MockSentryServer? = null
24+
private var servletContext: ServletContext? = null
25+
private var tomcat: Tomcat? = null
26+
27+
@BeforeTest
28+
fun setUp() {
29+
val mockServer = MockSentryServer()
30+
server = mockServer
31+
Sentry.init { it.dsn = mockServer.dsn }
32+
33+
tomcat =
34+
Tomcat().apply {
35+
setBaseDir(Files.createTempDirectory("tomcat-8.5").toString())
36+
setPort(0)
37+
connector.setProperty("address", "127.0.0.1")
38+
39+
val context = addContext("", Files.createTempDirectory("servlet-docbase").toString())
40+
context.effectiveMajorVersion = 3
41+
context.effectiveMinorVersion = 1
42+
context.parentClassLoader = javaClass.classLoader
43+
Tomcat.addServlet(context, "capture", CaptureServlet())
44+
context.addServletMappingDecoded("/capture", "capture")
45+
val initializer =
46+
ServiceLoader.load(ServletContainerInitializer::class.java)
47+
.filterIsInstance<SentryServletContainerInitializer>()
48+
.single()
49+
context.addServletContainerInitializer(initializer, emptySet())
50+
51+
start()
52+
servletContext = context.servletContext
53+
}
54+
}
55+
56+
@AfterTest
57+
fun tearDown() {
58+
Sentry.close()
59+
tomcat?.stop()
60+
tomcat?.destroy()
61+
server?.close()
62+
}
63+
64+
@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)
69+
70+
val port = tomcat!!.connector.localPort
71+
val connection =
72+
URI("http://127.0.0.1:$port/capture?customer=123").toURL().openConnection()
73+
as HttpURLConnection
74+
75+
try {
76+
assertThat(connection.responseCode).isEqualTo(HttpServletResponse.SC_OK)
77+
assertThat(connection.inputStream.bufferedReader().use { it.readText().trim() })
78+
.isEqualTo("captured")
79+
} finally {
80+
connection.disconnect()
81+
}
82+
83+
val event = server!!.awaitEnvelope { it.event()?.message?.formatted == MESSAGE }.event()!!
84+
85+
assertThat(event.request?.method).isEqualTo("GET")
86+
assertThat(event.request?.url).isEqualTo("http://127.0.0.1:$port/capture")
87+
assertThat(event.request?.queryString).isEqualTo("customer=123")
88+
}
89+
90+
private class CaptureServlet : HttpServlet() {
91+
override fun doGet(request: HttpServletRequest, response: HttpServletResponse) {
92+
Sentry.captureMessage(MESSAGE)
93+
response.writer.print("captured")
94+
}
95+
}
96+
97+
private companion object {
98+
const val MESSAGE = "captured from servlet integration test"
99+
}
100+
}

0 commit comments

Comments
 (0)