Skip to content

test(amazon Q): fix test failure caused by MockTelemetryExtension throwing NotAMockException #5258

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.

Sign up for GitHub

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 9 commits into from
Jan 21, 2025
Merged

test(amazon Q): fix test failure caused by MockTelemetryExtension throwing NotAMockException #5258

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e4357bd
fix test failure caused by NotAMock error
Will-ShaoHua Jan 14, 2025
0c989ef
should keep test implementation of TelemetryService
Will-ShaoHua Jan 16, 2025
2ba41bf
should revert replaceService in after hook
Will-ShaoHua Jan 16, 2025
2bb6c66
Merge remote-tracking branch 'upstream/main' into mockTelemetryService
Will-ShaoHua Jan 16, 2025
498cf35
Merge branch 'main' into mockTelemetryService
Will-ShaoHua Jan 17, 2025
5c8c08b
Merge branch 'main' into mockTelemetryService
rli Jan 17, 2025
ce5d664
Merge branch 'main' into mockTelemetryService
Will-ShaoHua Jan 17, 2025
298ea71
Merge branch 'main' into mockTelemetryService
Will-ShaoHua Jan 18, 2025
c9af00a
Merge branch 'main' into mockTelemetryService
Will-ShaoHua Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions plugins/core/jetbrains-community/resources/META-INF/aws.toolkit.core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
serviceImplementation="software.aws.toolkits.jetbrains.core.credentials.DefaultCredentialManager"
testServiceImplementation="software.aws.toolkits.jetbrains.core.credentials.MockCredentialsManager"/>
<applicationService serviceInterface="migration.software.aws.toolkits.jetbrains.services.telemetry.TelemetryService"
serviceImplementation="software.aws.toolkits.jetbrains.services.telemetry.DefaultTelemetryService"
testServiceImplementation="software.aws.toolkits.jetbrains.services.telemetry.NoOpTelemetryService"/>
serviceImplementation="software.aws.toolkits.jetbrains.services.telemetry.DefaultTelemetryService"/>
Copy link
Contributor

@rli rli Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we keep it as no-op so that tests dont send metrics by default, but you can add the rule if you want to assert metrics?

Copy link
Contributor Author

@Will-ShaoHua Will-ShaoHua Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aha that makes sense

<applicationService serviceInterface="migration.software.aws.toolkits.jetbrains.core.AwsResourceCache"
serviceImplementation="software.aws.toolkits.jetbrains.core.DefaultAwsResourceCache"
testServiceImplementation="software.aws.toolkits.jetbrains.core.MockResourceCache"/>
Expand Down
20 changes: 12 additions & 8 deletions ...ty/tstFixtures/software/aws/toolkits/jetbrains/services/telemetry/MockTelemetryService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

package software.aws.toolkits.jetbrains.services.telemetry

import com.intellij.openapi.components.service
import com.intellij.openapi.application.ApplicationManager
import com.intellij.testFramework.replaceService
import org.junit.jupiter.api.extension.AfterEachCallback
import org.junit.jupiter.api.extension.BeforeEachCallback
import org.junit.jupiter.api.extension.ExtensionContext
Expand All @@ -13,14 +14,11 @@ import org.mockito.kotlin.spy
import software.amazon.awssdk.services.toolkittelemetry.model.Sentiment
import software.aws.toolkits.core.telemetry.DefaultTelemetryBatcher
import software.aws.toolkits.core.telemetry.MetricEvent
import software.aws.toolkits.core.telemetry.TelemetryBatcher
import software.aws.toolkits.core.telemetry.TelemetryPublisher

class NoOpTelemetryService : TelemetryService(publisher, spy(DefaultTelemetryBatcher(publisher))) {
class NoOpTelemetryService(noOpPublisher: NoOpPublisher, batcher: TelemetryBatcher) : TelemetryService(noOpPublisher, batcher) {
fun batcher() = super.batcher

private companion object {
private val publisher: TelemetryPublisher by lazy { NoOpPublisher() }
}
}

class NoOpPublisher : TelemetryPublisher {
Expand All @@ -32,8 +30,14 @@ class NoOpPublisher : TelemetryPublisher {
}

sealed class MockTelemetryServiceBase : ExternalResource() {
private val mockTelemetryService: NoOpTelemetryService
get() = service<TelemetryService>() as NoOpTelemetryService
private val publisher: NoOpPublisher by lazy { NoOpPublisher() }
private val batcher: TelemetryBatcher by lazy { spy(DefaultTelemetryBatcher(publisher)) }

private val mockTelemetryService: NoOpTelemetryService by lazy { NoOpTelemetryService(publisher, batcher) }

override fun before() {
ApplicationManager.getApplication().replaceService(TelemetryService::class.java, mockTelemetryService, mockTelemetryService)
Copy link
Contributor

@rli rli Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replaceService needs to be reverted in the after()

}

override fun after() {
reset(batcher())
Expand Down
Loading