-
-
Notifications
You must be signed in to change notification settings - Fork 455
Add E2E tests for Logback #4599
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3ad9291
Add E2E tests for Logback
adinauer 5058719
Format code
getsentry-bot 9ed25b5
Merge branch 'main' into 08-04-add_e2e_tests_for_logback
adinauer d6eb984
code review fixes
adinauer 99acd14
Merge branch 'main' into 08-04-add_e2e_tests_for_logback
adinauer 2858e13
enable system tests for logback on GH
adinauer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,80 @@ | ||
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile | ||
|
||
plugins { | ||
java | ||
application | ||
kotlin("jvm") | ||
alias(libs.plugins.gradle.versions) | ||
id("com.github.johnrengelman.shadow") version "8.1.1" | ||
} | ||
|
||
application { mainClass.set("io.sentry.samples.logback.Main") } | ||
|
||
java.sourceCompatibility = JavaVersion.VERSION_17 | ||
|
||
java.targetCompatibility = JavaVersion.VERSION_17 | ||
|
||
repositories { mavenCentral() } | ||
|
||
configure<JavaPluginExtension> { | ||
sourceCompatibility = JavaVersion.VERSION_1_8 | ||
targetCompatibility = JavaVersion.VERSION_1_8 | ||
sourceCompatibility = JavaVersion.VERSION_17 | ||
targetCompatibility = JavaVersion.VERSION_17 | ||
} | ||
|
||
tasks.withType<KotlinCompile>().configureEach { | ||
kotlinOptions { | ||
freeCompilerArgs = listOf("-Xjsr305=strict") | ||
jvmTarget = JavaVersion.VERSION_17.toString() | ||
} | ||
} | ||
|
||
dependencies { | ||
implementation(projects.sentryLogback) | ||
implementation(libs.logback.classic) | ||
|
||
testImplementation(kotlin(Config.kotlinStdLib)) | ||
testImplementation(projects.sentry) | ||
testImplementation(projects.sentrySystemTestSupport) | ||
testImplementation(libs.kotlin.test.junit) | ||
testImplementation(libs.slf4j.api) | ||
testImplementation(libs.slf4j.jdk14) | ||
} | ||
|
||
// Configure the Shadow JAR (executable JAR with all dependencies) | ||
tasks.shadowJar { | ||
manifest { attributes["Main-Class"] = "io.sentry.samples.logback.Main" } | ||
archiveClassifier.set("") // Remove the classifier so it replaces the regular JAR | ||
mergeServiceFiles() | ||
} | ||
|
||
// Make the regular jar task depend on shadowJar | ||
tasks.jar { | ||
enabled = false | ||
dependsOn(tasks.shadowJar) | ||
} | ||
|
||
// Fix the startScripts task dependency | ||
tasks.startScripts { dependsOn(tasks.shadowJar) } | ||
|
||
configure<SourceSetContainer> { test { java.srcDir("src/test/java") } } | ||
|
||
tasks.register<Test>("systemTest").configure { | ||
group = "verification" | ||
description = "Runs the System tests" | ||
|
||
outputs.upToDateWhen { false } | ||
|
||
maxParallelForks = 1 | ||
|
||
// Cap JVM args per test | ||
minHeapSize = "128m" | ||
maxHeapSize = "1g" | ||
|
||
filter { includeTestsMatching("io.sentry.systemtest*") } | ||
} | ||
|
||
tasks.named("test").configure { | ||
require(this is Test) | ||
|
||
filter { excludeTestsMatching("io.sentry.systemtest.*") } | ||
} |
12 changes: 12 additions & 0 deletions
12
sentry-samples/sentry-samples-logback/src/test/kotlin/io/sentry/DummyTest.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
package io.sentry | ||
|
||
import kotlin.test.Test | ||
import kotlin.test.assertTrue | ||
|
||
class DummyTest { | ||
@Test | ||
fun `the only test`() { | ||
// only needed to have more than 0 tests and not fail the build | ||
assertTrue(true) | ||
} | ||
} |
67 changes: 67 additions & 0 deletions
67
...ntry-samples-logback/src/test/kotlin/io/sentry/systemtest/ConsoleApplicationSystemTest.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
package io.sentry.systemtest | ||
|
||
import io.sentry.SentryLevel | ||
import io.sentry.systemtest.util.TestHelper | ||
import java.util.concurrent.TimeUnit | ||
import org.junit.Assert | ||
import org.junit.Before | ||
import org.junit.Test | ||
|
||
class ConsoleApplicationSystemTest { | ||
lateinit var testHelper: TestHelper | ||
|
||
@Before | ||
fun setup() { | ||
testHelper = TestHelper("http://localhost:8000") | ||
testHelper.reset() | ||
} | ||
|
||
@Test | ||
fun `logback application sends expected events when run as JAR`() { | ||
val jarFile = testHelper.findJar("sentry-samples-logback") | ||
val process = | ||
testHelper.launch( | ||
jarFile, | ||
mapOf( | ||
"SENTRY_DSN" to testHelper.dsn, | ||
"SENTRY_TRACES_SAMPLE_RATE" to "1.0", | ||
"SENTRY_ENABLE_PRETTY_SERIALIZATION_OUTPUT" to "false", | ||
"SENTRY_DEBUG" to "true", | ||
), | ||
) | ||
|
||
process.waitFor(30, TimeUnit.SECONDS) | ||
Assert.assertEquals(0, process.exitValue()) | ||
|
||
// Verify that we received the expected events | ||
verifyExpectedEvents() | ||
} | ||
|
||
private fun verifyExpectedEvents() { | ||
// Verify we received the RuntimeException | ||
testHelper.ensureErrorReceived { event -> | ||
event.exceptions?.any { ex -> | ||
ex.type == "RuntimeException" && ex.value == "Invalid productId=445" | ||
} == true && | ||
event.message?.formatted == "Something went wrong" && | ||
event.level?.name == "ERROR" | ||
} | ||
|
||
testHelper.ensureErrorReceived { event -> | ||
event.breadcrumbs?.firstOrNull { | ||
it.message == "Hello Sentry!" && it.level == SentryLevel.DEBUG | ||
} != null | ||
} | ||
|
||
testHelper.ensureErrorReceived { event -> | ||
event.breadcrumbs?.firstOrNull { | ||
it.message == "User has made a purchase of product: 445" && it.level == SentryLevel.INFO | ||
} != null | ||
} | ||
|
||
testHelper.ensureLogsReceived { logs, _ -> | ||
testHelper.doesContainLogWithBody(logs, "User has made a purchase of product: 445") && | ||
testHelper.doesContainLogWithBody(logs, "Something went wrong") | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.