Skip to content

Migrate Android instrumented tests to JUnit 4 #9260

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

Closed
one-kash wants to merge 1 commit into from
Closed

Migrate Android instrumented tests to JUnit 4 #9260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 4 additions & 14 deletions android-test/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
plugins {
id("com.android.library")
kotlin("android")
id("de.mannodermaus.android-junit5")
}

val androidBuild = property("androidBuild").toString().toBoolean()
Expand All @@ -16,12 +15,10 @@ android {
defaultConfig {
minSdk = 21

// Make sure to use the AndroidJUnitRunner (or a sub-class) in order to hook in the JUnit 5 Test Builder
// Use standard AndroidJUnitRunner for JUnit 4 tests (compatible with API 21+)
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
testInstrumentationRunnerArguments += mapOf(
"runnerBuilder" to "de.mannodermaus.junit5.AndroidJUnit5Builder",
"notPackage" to "org.bouncycastle",
"configurationParameters" to "junit.jupiter.extensions.autodetection.enabled=true"
"notPackage" to "org.bouncycastle"
)
}

Expand Down Expand Up @@ -107,13 +104,6 @@ dependencies {
androidTestImplementation(libs.squareup.okio.fakefilesystem)

androidTestImplementation(libs.androidx.test.runner)
androidTestImplementation(libs.junit.jupiter.api)
androidTestImplementation(libs.junit5android.core)
androidTestRuntimeOnly(libs.junit5android.runner)
}

junitPlatform {
filters {
excludeTags("Remote")
Copy link
Collaborator

@yschimke yschimke Jan 25, 2026

Choose a reason for hiding this comment

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

This shouldn't be removed.

}
// Use JUnit 4 for Android instrumented tests (compatible with API 21+)
androidTestImplementation(libs.junit)
}
87 changes: 38 additions & 49 deletions android-test/src/androidTest/java/okhttp/android/test/OkHttpTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ import javax.net.ssl.TrustManagerFactory
import javax.net.ssl.X509TrustManager
import mockwebserver3.MockResponse
import mockwebserver3.MockWebServer
import mockwebserver3.junit5.StartStop
import okhttp3.Cache
import okhttp3.Call
import okhttp3.CallEvent.CallEnd
Expand Down Expand Up @@ -77,7 +76,6 @@ import okhttp3.Gzip
import okhttp3.Headers
import okhttp3.HttpUrl.Companion.toHttpUrl
import okhttp3.OkHttpClient
import okhttp3.OkHttpClientTestRule
import okhttp3.Protocol
import okhttp3.Request
import okhttp3.TlsVersion
Expand All @@ -90,46 +88,32 @@ import okhttp3.internal.platform.AndroidPlatform
import okhttp3.internal.platform.Platform
import okhttp3.internal.platform.PlatformRegistry
import okhttp3.logging.LoggingEventListener
import okhttp3.testing.PlatformRule
import okhttp3.tls.HandshakeCertificates
import okhttp3.tls.internal.TlsUtil.localhost
import okhttp3.zstd.Zstd
import okio.ByteString.Companion.toByteString
import org.bouncycastle.jce.provider.BouncyCastleProvider
import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider
import org.conscrypt.Conscrypt
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertFalse
import org.junit.jupiter.api.Assertions.assertNotNull
import org.junit.jupiter.api.Assertions.assertNull
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Assertions.fail
import org.junit.jupiter.api.Assumptions.assumeTrue
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Disabled
import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.RegisterExtension
import org.opentest4j.TestAbortedException

@Tag("Slow")
import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertNotNull
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Assert.fail
import org.junit.After
import org.junit.Assume.assumeTrue
import org.junit.Before
import org.junit.Ignore
import org.junit.Test
import org.junit.runner.RunWith
import androidx.test.ext.junit.runners.AndroidJUnit4
import org.junit.AssumptionViolatedException

@RunWith(AndroidJUnit4::class)
class OkHttpTest {
@Suppress("RedundantVisibilityModifier")
@JvmField
@RegisterExtension
public val platform = PlatformRule()

@Suppress("RedundantVisibilityModifier")
@JvmField
@RegisterExtension
public val clientTestRule =
OkHttpClientTestRule().apply {
logger = Logger.getLogger(OkHttpTest::class.java.name)
}

private var client: OkHttpClient =
clientTestRule
.newClientBuilder()
OkHttpClient.Builder()
.addInterceptor(CompressionInterceptor(Zstd, Brotli, Gzip))
.build()

Expand All @@ -141,13 +125,18 @@ class OkHttpTest {

private val handshakeCertificates = localhost()

@StartStop
private val server = MockWebServer()

@BeforeEach
@Before
fun setup() {
// Needed because of Platform.resetForTests
PlatformRegistry.applicationContext = ApplicationProvider.getApplicationContext<Context>()
server.start()
}

@After
fun tearDown() {
server.shutdown()
}

@Test
Expand Down Expand Up @@ -225,7 +214,7 @@ class OkHttpTest {
OkHttpClient
.Builder()
.eventListenerFactory(
clientTestRule.wrap(
(
object : EventListener() {
override fun connectionAcquired(
call: Call,
Expand Down Expand Up @@ -296,7 +285,7 @@ class OkHttpTest {
try {
ProviderInstaller.installIfNeeded(InstrumentationRegistry.getInstrumentation().targetContext)
} catch (gpsnae: GooglePlayServicesNotAvailableException) {
throw TestAbortedException("Google Play Services not available", gpsnae)
throw AssumptionViolatedException("Google Play Services not available", gpsnae)
}

val request = Request.Builder().url("https://facebook.com/robots.txt").build()
Expand All @@ -308,7 +297,7 @@ class OkHttpTest {
OkHttpClient
.Builder()
.eventListenerFactory(
clientTestRule.wrap(
(
object : EventListener() {
override fun connectionAcquired(
call: Call,
Expand Down Expand Up @@ -340,7 +329,7 @@ class OkHttpTest {
try {
ProviderInstaller.installIfNeeded(InstrumentationRegistry.getInstrumentation().targetContext)
} catch (gpsnae: GooglePlayServicesNotAvailableException) {
throw TestAbortedException("Google Play Services not available", gpsnae)
throw AssumptionViolatedException("Google Play Services not available", gpsnae)
}

val clientCertificates =
Expand Down Expand Up @@ -389,7 +378,7 @@ class OkHttpTest {
client
.newBuilder()
.eventListenerFactory(
clientTestRule.wrap(
(
object : EventListener() {
override fun connectionAcquired(
call: Call,
Expand Down Expand Up @@ -452,7 +441,7 @@ class OkHttpTest {
}

@Test
@Disabled("cleartext required for additional okhttp wide tests")
@Ignore("cleartext required for additional okhttp wide tests")
fun testHttpRequestBlocked() {
assumeTrue(Build.VERSION.SDK_INT >= 23)

Expand All @@ -479,7 +468,7 @@ class OkHttpTest {
)

@Test
@Disabled
@Ignore
fun testSSLFeatures() {
assumeNetwork()

Expand Down Expand Up @@ -581,7 +570,7 @@ class OkHttpTest {
client =
client
.newBuilder()
.eventListenerFactory(clientTestRule.wrap(eventRecorder))
.eventListenerFactory((eventRecorder))
.build()

server.enqueue(MockResponse(body = "abc1"))
Expand Down Expand Up @@ -652,7 +641,7 @@ class OkHttpTest {
client
.newBuilder()
.eventListenerFactory(
clientTestRule.wrap(
(
object : EventListener() {
override fun connectionAcquired(
call: Call,
Expand Down Expand Up @@ -697,7 +686,7 @@ class OkHttpTest {
client =
client
.newBuilder()
.eventListenerFactory(clientTestRule.wrap(LoggingEventListener.Factory()))
.eventListenerFactory((LoggingEventListener.Factory()))
.build()

val dohDns = buildCloudflareIp(client)
Expand Down Expand Up @@ -872,7 +861,7 @@ class OkHttpTest {
}

@Test
@Disabled("breaks conscrypt test")
@Ignore("breaks conscrypt test")
fun testBouncyCastleRequest() {
assumeNetwork()

Expand Down Expand Up @@ -901,7 +890,7 @@ class OkHttpTest {
.newBuilder()
.sslSocketFactory(sslContext.socketFactory, trustManager)
.eventListenerFactory(
clientTestRule.wrap(
(
object : EventListener() {
override fun connectionAcquired(
call: Call,
Expand Down Expand Up @@ -930,7 +919,7 @@ class OkHttpTest {
}

@Test
@Disabled("TODO: currently logging okhttp3.internal.concurrent.TaskRunner, okhttp3.internal.http2.Http2")
@Ignore("TODO: currently logging okhttp3.internal.concurrent.TaskRunner, okhttp3.internal.http2.Http2")
fun testLoggingLevels() {
enableTls()

Expand Down Expand Up @@ -1076,7 +1065,7 @@ class OkHttpTest {
try {
InetAddress.getByName("www.google.com")
} catch (uhe: UnknownHostException) {
throw TestAbortedException(uhe.message, uhe)
throw AssumptionViolatedException(uhe.message, uhe)
}
}

Expand Down
2 changes: 1 addition & 1 deletion android-test/src/androidTest/java/okhttp/android/test/SingleAndroidTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import okhttp3.ConnectionPool
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.tls.internal.TlsUtil.localhost
import org.junit.jupiter.api.Test
import org.junit.Test

/**
* This single Junit 4 test is our Android test suite on API 21-25.
Expand Down
11 changes: 6 additions & 5 deletions android-test/src/androidTest/java/okhttp/android/test/StrictModeTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,17 @@ import okhttp3.HttpUrl.Companion.toHttpUrl
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.internal.platform.Platform
import org.junit.jupiter.api.AfterEach
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.parallel.Isolated
import org.junit.After
import org.junit.Test
import org.junit.runner.RunWith
import androidx.test.ext.junit.runners.AndroidJUnit4

@Isolated
@RunWith(AndroidJUnit4::class)
@SdkSuppress(minSdkVersion = 28)
class StrictModeTest {
private val violations = mutableListOf<Violation>()

@AfterEach
@After
fun cleanup() {
StrictMode.setThreadPolicy(
ThreadPolicy
Expand Down
7 changes: 4 additions & 3 deletions android-test/src/androidTest/java/okhttp/android/test/alpn/AlpnOverrideTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ import okhttp3.DelegatingSSLSocketFactory
import okhttp3.EventListener
import okhttp3.OkHttpClient
import okhttp3.Request
import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Test
import org.junit.Test
import org.junit.runner.RunWith
import androidx.test.ext.junit.runners.AndroidJUnit4

/**
* Tests for ALPN overriding on Android.
*/
@Tag("Remote")
@RunWith(AndroidJUnit4::class)
class AlpnOverrideTest {
class CustomSSLSocketFactory(
delegate: SSLSocketFactory,
Expand Down
7 changes: 4 additions & 3 deletions android-test/src/androidTest/java/okhttp/android/test/letsencrypt/LetsEncryptClientTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ import okhttp3.Protocol
import okhttp3.Request
import okhttp3.tls.HandshakeCertificates
import okhttp3.tls.decodeCertificatePem
import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Test
import org.junit.Test
import org.junit.runner.RunWith
import androidx.test.ext.junit.runners.AndroidJUnit4

/**
* Test for new Let's Encrypt Root Certificate.
*/
@Tag("Remote")
@RunWith(AndroidJUnit4::class)
class LetsEncryptClientTest {
@Test fun get() {
// These tests wont actually run before Android 8.0 as per
Expand Down
9 changes: 5 additions & 4 deletions android-test/src/androidTest/java/okhttp/android/test/sni/SniOverrideTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,15 @@ import okhttp3.Dns
import okhttp3.OkHttpClient
import okhttp3.Protocol
import okhttp3.Request
import org.junit.jupiter.api.Assumptions.assumeTrue
import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Test
import org.junit.Assume.assumeTrue
import org.junit.Test
import org.junit.runner.RunWith
import androidx.test.ext.junit.runners.AndroidJUnit4

/**
* Tests for SNI overriding on Android.
*/
@Tag("Remote")
Copy link
Collaborator

@yschimke yschimke Jan 25, 2026

Choose a reason for hiding this comment

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

Why remove the tag?

@RunWith(AndroidJUnit4::class)
class SniOverrideTest {
var client =
OkHttpClient
Expand Down
Loading