diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 93fc79f4a2..c2eaf195f6 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -17,6 +17,8 @@ updates: ignore: - dependency-name: "org.springframework.boot*" - dependency-name: "io.opentelemetry*" + # Servlet 3.1 is the minimum supported API and must remain the production compile target. + - dependency-name: "javax.servlet:javax.servlet-api" # DGS 5+ needs Spring Boot 3; the sample is on Spring Boot 2. - dependency-name: "com.netflix.graphql.dgs*" commit-message: diff --git a/.github/workflows/integration-tests.yml b/.github/workflows/integration-tests.yml new file mode 100644 index 0000000000..d9d75cab29 --- /dev/null +++ b/.github/workflows/integration-tests.yml @@ -0,0 +1,62 @@ +name: Integration Tests + +on: + push: + branches: + - main + pull_request: + +permissions: + contents: read + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + integration-tests: + name: Integration Tests + timeout-minutes: 30 + runs-on: ubuntu-latest + + steps: + - name: Checkout Repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + ref: ${{ github.event.pull_request.head.sha || github.sha }} + + - name: Setup Java Version + uses: actions/setup-java@77dd5b2ce225ea11469928ac317850245a74ae78 # v6.2.0 + with: + distribution: 'temurin' + java-version: '21' + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@8da46b539cd8fe6ab27ca75128919a18d757604c # v6.4.1 + + - name: Run integration tests + # Spring Boot integration suites run in their version-matrix workflows. + run: | + ./gradlew \ + :sentry-servlet:integrationTest \ + :sentry-servlet:integrationTestTomcat9 + + - name: Upload test results + if: always() + uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7 + with: + name: test-results-integration-tests + path: | + **/build/reports/* + **/build/test-results/**/*.xml + + - name: Test Report + uses: phoenix-actions/test-reporting@7317eea6e13c47348dd0bb318669485157c518d6 # pin@v16 + if: always() + with: + name: JUnit Integration Tests + path: | + **/build/test-results/**/*.xml + reporter: java-junit + output-to: step-summary + fail-on-error: false diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index cccdf3d82b..0167d8786d 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -53,6 +53,7 @@ springboot4 = "4.1.0" springKafka2 = "2.8.11" springKafka3 = "3.3.5" sqldelight = "2.4.1" +tomcat9 = "9.0.108" vanniktechMavenPublish = "0.37.0" # Android @@ -266,9 +267,11 @@ 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 -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.27" } +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.ref = "tomcat9" } +tomcat-catalina = { module = "org.apache.tomcat:tomcat-catalina", version.ref = "tomcat9" } +tomcat-embed-jasper = { module = "org.apache.tomcat.embed:tomcat-embed-jasper", version.ref = "tomcat9" } +tomcat-catalina-jakarta = { module = "org.apache.tomcat:tomcat-catalina", version = "11.0.22" } tomcat-embed-jasper-jakarta = { module = "org.apache.tomcat.embed:tomcat-embed-jasper", version = "11.0.22" } # The version comes from the Spring Boot BOM of whichever Spring line uses it. tomcat-embed-core = { module = "org.apache.tomcat.embed:tomcat-embed-core" } diff --git a/sentry-servlet/build.gradle.kts b/sentry-servlet/build.gradle.kts index 42549c1f09..4612ecef83 100644 --- a/sentry-servlet/build.gradle.kts +++ b/sentry-servlet/build.gradle.kts @@ -41,6 +41,52 @@ dependencies { testImplementation(libs.springboot.starter.web) } +val integrationTest = + testing.suites.register("integrationTest") { + useJUnit() + dependencies { + implementation(project()) + implementation(projects.sentryTestSupport) + implementation(libs.google.truth) + implementation(libs.kotlin.test.junit) + compileOnly(libs.tomcat85.embed.core) + runtimeOnly(libs.tomcat85.embed.core) + } + targets.named("integrationTest") { + 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 integrationTestSourceSet = sourceSets["integrationTest"] +val integrationTestTomcat9RuntimeClasspath = + configurations.resolvable("integrationTestTomcat9RuntimeClasspath") { + extendsFrom(configurations[integrationTestSourceSet.implementationConfigurationName]) + attributes.addAllLater( + configurations[integrationTestSourceSet.runtimeClasspathConfigurationName].attributes, + ) + } + +dependencies { + add(integrationTestTomcat9RuntimeClasspath.name, libs.tomcat9.embed.core) +} + +integrationTest { + targets.register("integrationTestTomcat9") { + testTask.configure { + description = "Runs the servlet integration test on Tomcat 9 and Servlet 4" + classpath = integrationTestSourceSet.output + integrationTestTomcat9RuntimeClasspath.get() + 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.withType().configureEach { options.errorprone { check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR) diff --git a/sentry-servlet/src/integrationTest/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt b/sentry-servlet/src/integrationTest/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt new file mode 100644 index 0000000000..ec90cb46e9 --- /dev/null +++ b/sentry-servlet/src/integrationTest/kotlin/io/sentry/servlet/SentryServletIntegrationTest.kt @@ -0,0 +1,107 @@ +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 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 + + @BeforeTest + fun setUp() { + val mockServer = MockSentryServer() + server = mockServer + Sentry.init { it.dsn = mockServer.dsn } + + tomcat = + Tomcat().apply { + setBaseDir(Files.createTempDirectory("tomcat").toString()) + setPort(0) + connector.setProperty("address", "127.0.0.1") + + val context = addContext("", Files.createTempDirectory("servlet-docbase").toString()) + context.effectiveMajorVersion = servletMajorVersion + context.effectiveMinorVersion = servletMinorVersion + 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 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 = + 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" + } +}