Release 0.2.0 (#4)

* Add wrapDispatcher method. * chore: suggestions with mockserver * Add request, assertions and allow-mocking modules. --------- Co-authored-by: Jacek Marchwicki <[email protected]>
appunite · Apr 19, 2024 · 475275f · 475275f
1 parent 9e29b19
commit 475275f
Show file tree

Hide file tree

Showing 21 changed files with 168 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -34,32 +34,18 @@ repositories {
 Add the dependency:
 ```kotlin
 dependencies {
-    androidTestImplementation 'com.github.appunite:MockWebServer-Extensions:0.1.0'
+    androidTestImplementation 'com.github.appunite.MockWebServer-Extensions:mockwebserver-extensions:0.2.0'
+    androidTestImplementation 'com.github.appunite.MockWebServer-Extensions:mockwebserver-request:0.2.0'
+    implementation 'com.github.appunite.MockWebServer-Extensions:mockwebserver-interceptor:0.2.0'
 }
 ```
 
-### Add a Network Security Configuration file
+### Add a Network Security Configuration
 
-#### Add `app/src/debug/res/xml/network_security_config.xml` file.
-
-```xml
-<?xml version="1.0" encoding="utf-8"?>
-<network-security-config>
-    <domain-config cleartextTrafficPermitted="true">
-        <domain includeSubdomains="true">localhost</domain>
-    </domain-config>
-</network-security-config>
-```
-
-#### Add `network_security_config.xml` to the debug AndroidManifest.
-
-```xml
-<?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
-
-    <application android:networkSecurityConfig="@xml/network_security_config">
-    </application>
-</manifest>
+```kotlin
+dependencies {
+    debugImplementation 'com.github.appunite.MockWebServer-Extensions:mockwebserver-allow-mocking:0.2.0'
+}
 ```
 
 ### Add TestInterceptor to your HTTP Client.
@@ -83,6 +69,15 @@ val retrofit = Retrofit.Builder()
     .build()
 ```
 
+### Optional Assertions using okhttp
+
+```kotlin
+dependencies {
+    androidTestImplementation 'com.github.appunite.MockWebServer-Extensions:mockwebserver-assertions:0.2.0'
+}
+```
+
+
 You can check full example in the [app module](https://github.com/appunite/MockWebServer/tree/main/app/src).
 And more examples in the [Loudius - Android playground](https://github.com/appunite/Loudius) in the [app-shared-tests module](https://github.com/appunite/Loudius/tree/develop/app-shared-tests/src/main/java/com/appunite/loudius).
 

diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -55,7 +55,10 @@ android {
 dependencies {
 
     androidTestImplementation(project(":mockwebserver-extensions"))
+    androidTestImplementation(project(":mockwebserver-assertions"))
+    androidTestImplementation(project(":mockwebserver-request"))
     implementation(project(":mockwebserver-interceptor"))
+    debugImplementation(project(":mockwebserver-allow-mocking"))
 
     implementation("androidx.core:core-ktx:1.12.0")
     implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.7.0")

diff --git a/app/src/androidTest/java/com/appunite/mockwebserverextensions/ExampleInstrumentedTest.kt b/app/src/androidTest/java/com/appunite/mockwebserverextensions/ExampleInstrumentedTest.kt
@@ -5,9 +5,9 @@ import androidx.compose.ui.test.junit4.createAndroidComposeRule
 import androidx.compose.ui.test.onNodeWithText
 import androidx.compose.ui.test.performClick
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.appunite.mockwebserver_assertions.path
+import com.appunite.mockwebserver_assertions.url
 import com.appunite.mockwebserverextensions.util.jsonResponse
-import com.appunite.mockwebserverextensions.util.path
-import com.appunite.mockwebserverextensions.util.url
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.Rule

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,4 +4,5 @@ plugins {
     id("org.jetbrains.kotlin.android") version "1.9.0" apply false
     id("org.jetbrains.kotlin.jvm") version "1.9.0" apply false
     id("org.jetbrains.kotlin.plugin.serialization") version "1.7.10" apply false
+    id("com.android.library") version "8.2.2" apply false
 }
diff --git a/mockwebserver-allow-mocking/.gitignore b/mockwebserver-allow-mocking/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/mockwebserver-allow-mocking/build.gradle.kts b/mockwebserver-allow-mocking/build.gradle.kts
@@ -0,0 +1,51 @@
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+    id("maven-publish")
+}
+
+android {
+    namespace = "com.appunite.mockwebserver_allow_mocking"
+    compileSdk = 34
+
+    defaultConfig {
+        minSdk = 24
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+
+    implementation("androidx.core:core-ktx:1.12.0")
+    implementation("androidx.appcompat:appcompat:1.6.1")
+    implementation("com.google.android.material:material:1.11.0")
+    testImplementation("junit:junit:4.13.2")
+    androidTestImplementation("androidx.test.ext:junit:1.1.5")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("release") {
+            groupId = "com.github.appunite.MockWebServer-Extensions"
+            artifactId = "mockwebserver-allow-mocking"
+            version = "0.2.0"
+
+            afterEvaluate {
+                from(components["release"])
+            }
+        }
+    }
+}
diff --git a/app/src/debug/AndroidManifest.xml → ...llow-mocking/src/main/AndroidManifest.xml b/app/src/debug/AndroidManifest.xml → ...llow-mocking/src/main/AndroidManifest.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
-
     <application android:networkSecurityConfig="@xml/network_security_config">
     </application>
-</manifest>
+</manifest>
diff --git a/...debug/res/xml/network_security_config.xml → .../main/res/xml/network_security_config.xml b/...debug/res/xml/network_security_config.xml → .../main/res/xml/network_security_config.xml
diff --git a/mockwebserver-assertions/.gitignore b/mockwebserver-assertions/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/mockwebserver-assertions/build.gradle.kts b/mockwebserver-assertions/build.gradle.kts
@@ -0,0 +1,30 @@
+plugins {
+    id("java-library")
+    id("org.jetbrains.kotlin.jvm")
+    id("maven-publish")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            groupId = "com.github.appunite.MockWebServer-Extensions"
+            artifactId = "mockwebserver-assertions"
+            version = "0.2.0"
+
+            afterEvaluate {
+                from(components["java"])
+            }
+        }
+    }
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_17
+    targetCompatibility = JavaVersion.VERSION_17
+}
+
+dependencies {
+    implementation(project(":mockwebserver-request"))
+    implementation("com.squareup.okhttp3:okhttp:4.12.0")
+    implementation("io.strikt:strikt-mockk:0.34.1")
+}
diff --git a/...ockwebserverextensions/util/Assertions.kt → ...te/mockwebserver_assertions/Assertions.kt b/...ockwebserverextensions/util/Assertions.kt → ...te/mockwebserver_assertions/Assertions.kt
@@ -1,6 +1,6 @@
-package com.appunite.mockwebserverextensions.util
+package com.appunite.mockwebserver_assertions
 
-import com.appunite.mockwebserverextensions.Request
+import com.appunite.mockwebserver_request.Request
 import okhttp3.Headers
 import okhttp3.HttpUrl
 import okhttp3.Response

diff --git a/mockwebserver-extensions/build.gradle.kts b/mockwebserver-extensions/build.gradle.kts
@@ -9,7 +9,7 @@ publishing {
         create<MavenPublication>("maven") {
             groupId = "com.github.appunite.MockWebServer-Extensions"
             artifactId = "mockwebserver-extensions"
-            version = "0.1.1"
+            version = "0.2.0"
 
             afterEvaluate {
                 from(components["java"])
@@ -29,10 +29,11 @@ kotlin {
 
 dependencies {
     implementation(project(":mockwebserver-interceptor"))
-    implementation("com.squareup.okhttp3:okhttp:4.12.0")
+    implementation(project(":mockwebserver-request"))
     implementation("com.squareup.okhttp3:mockwebserver:4.12.0")
     implementation("io.strikt:strikt-mockk:0.34.1")
 
+    testImplementation(project(":mockwebserver-assertions"))
     testImplementation("io.mockk:mockk:1.13.5")
     testImplementation("junit:junit:4.13.2")
 }
diff --git a/...webserver-extensions/src/main/java/com/appunite/mockwebserverextensions/MockDispatcher.kt b/...webserver-extensions/src/main/java/com/appunite/mockwebserverextensions/MockDispatcher.kt
@@ -1,5 +1,6 @@
 package com.appunite.mockwebserverextensions
 
+import com.appunite.mockwebserver_request.Request
 import com.appunite.mockwebserverextensions.util.MultipleFailuresError
 import com.appunite.mockwebserverextensions.util.ResponseGenerator
 import okhttp3.HttpUrl.Companion.toHttpUrl

diff --git a/...server-extensions/src/main/java/com/appunite/mockwebserverextensions/MockWebServerRule.kt b/...server-extensions/src/main/java/com/appunite/mockwebserverextensions/MockWebServerRule.kt
@@ -5,6 +5,7 @@ import com.appunite.mockwebserverextensions.intercept.UrlOverrideInterceptor
 import com.appunite.mockwebserverextensions.util.ResponseGenerator
 import okhttp3.Interceptor
 import okhttp3.internal.closeQuietly
+import okhttp3.mockwebserver.Dispatcher
 import okhttp3.mockwebserver.MockWebServer
 import org.junit.rules.TestWatcher
 import org.junit.runner.Description
@@ -19,28 +20,27 @@ open class MockWebServerRule(
         val LOG: Logger = Logger.getLogger(MockWebServerRule::class.java.name)
     }
 
-    open var mockDispatcher: MockDispatcher = MockDispatcher()
-    open var mockWebServer: MockWebServer? = null
+    val mockDispatcher: MockDispatcher = MockDispatcher()
+    val mockWebServer: MockWebServer = MockWebServer().apply {
+        dispatcher = wrapDispatcher(mockDispatcher)
+    }
 
     override fun register(response: ResponseGenerator) = mockDispatcher.register(response)
 
     override fun clear() = mockDispatcher.clear()
 
     override fun starting(description: Description?) {
-        val server = MockWebServer()
-        server.dispatcher = mockDispatcher
-        TestInterceptor.testInterceptor = interceptor ?: UrlOverrideInterceptor(server.url("/"))
+        TestInterceptor.testInterceptor = interceptor ?: UrlOverrideInterceptor(mockWebServer.url("/"))
         LOG.info("TestInterceptor installed")
-        mockWebServer = server
     }
 
     override fun finished(description: Description) {
         LOG.info("TestInterceptor uninstalled")
         TestInterceptor.testInterceptor = null
 
-        mockWebServer?.closeQuietly()
-        mockWebServer = null
-
+        mockWebServer.closeQuietly()
         MultipleFailureException.assertEmpty(mockDispatcher.errors)
     }
+
+    open fun wrapDispatcher(mockDispatcher: Dispatcher): Dispatcher = mockDispatcher
 }
diff --git a/...r-extensions/src/main/java/com/appunite/mockwebserverextensions/util/ResponseGenerator.kt b/...r-extensions/src/main/java/com/appunite/mockwebserverextensions/util/ResponseGenerator.kt
@@ -1,6 +1,6 @@
 package com.appunite.mockwebserverextensions.util
 
-import com.appunite.mockwebserverextensions.Request
+import com.appunite.mockwebserver_request.Request
 import okhttp3.mockwebserver.MockResponse
 import org.intellij.lang.annotations.Language
 

diff --git a/...-extensions/src/test/kotlin/com/appunite/mockwebserverextensions/MockWebServerRuleTest.kt b/...-extensions/src/test/kotlin/com/appunite/mockwebserverextensions/MockWebServerRuleTest.kt
@@ -1,19 +1,20 @@
 package com.appunite.mockwebserverextensions
 
+import com.appunite.mockwebserver_assertions.body
+import com.appunite.mockwebserver_assertions.bodyString
+import com.appunite.mockwebserver_assertions.code
+import com.appunite.mockwebserver_assertions.header
+import com.appunite.mockwebserver_assertions.headers
+import com.appunite.mockwebserver_assertions.host
+import com.appunite.mockwebserver_assertions.method
+import com.appunite.mockwebserver_assertions.path
+import com.appunite.mockwebserver_assertions.url
+import com.appunite.mockwebserver_assertions.utf8
 import com.appunite.mockwebserver_interceptor.TestInterceptor
+import com.appunite.mockwebserver_request.Request
 import com.appunite.mockwebserverextensions.util.MultipleFailuresError
 import com.appunite.mockwebserverextensions.util.ResponseGenerator
-import com.appunite.mockwebserverextensions.util.body
-import com.appunite.mockwebserverextensions.util.bodyString
-import com.appunite.mockwebserverextensions.util.code
-import com.appunite.mockwebserverextensions.util.header
-import com.appunite.mockwebserverextensions.util.headers
-import com.appunite.mockwebserverextensions.util.host
 import com.appunite.mockwebserverextensions.util.jsonResponse
-import com.appunite.mockwebserverextensions.util.method
-import com.appunite.mockwebserverextensions.util.path
-import com.appunite.mockwebserverextensions.util.url
-import com.appunite.mockwebserverextensions.util.utf8
 import io.mockk.CapturingSlot
 import io.mockk.every
 import io.mockk.mockk

diff --git a/mockwebserver-interceptor/build.gradle.kts b/mockwebserver-interceptor/build.gradle.kts
@@ -9,7 +9,7 @@ publishing {
         create<MavenPublication>("maven") {
             groupId = "com.github.appunite.MockWebServer-Extensions"
             artifactId = "mockwebserver-interceptor"
-            version = "0.1.1"
+            version = "0.2.0"
 
             afterEvaluate {
                 from(components["java"])

diff --git a/mockwebserver-request/.gitignore b/mockwebserver-request/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/mockwebserver-request/build.gradle.kts b/mockwebserver-request/build.gradle.kts
@@ -0,0 +1,28 @@
+plugins {
+    id("java-library")
+    id("org.jetbrains.kotlin.jvm")
+    id("maven-publish")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            groupId = "com.github.appunite.MockWebServer-Extensions"
+            artifactId = "mockwebserver-request"
+            version = "0.2.0"
+
+            afterEvaluate {
+                from(components["java"])
+            }
+        }
+    }
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_17
+    targetCompatibility = JavaVersion.VERSION_17
+}
+
+dependencies {
+    implementation("com.squareup.okhttp3:okhttp:4.12.0")
+}
diff --git a/...punite/mockwebserverextensions/Request.kt → ...appunite/mockwebserver_request/Request.kt b/...punite/mockwebserverextensions/Request.kt → ...appunite/mockwebserver_request/Request.kt
@@ -1,4 +1,4 @@
-package com.appunite.mockwebserverextensions
+package com.appunite.mockwebserver_request
 
 import okhttp3.Headers
 import okhttp3.HttpUrl

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -17,3 +17,6 @@ rootProject.name = "MockWebServer Extensions"
 include(":app")
 include(":mockwebserver-extensions")
 include(":mockwebserver-interceptor")
+include(":mockwebserver-allow-mocking")
+include(":mockwebserver-assertions")
+include(":mockwebserver-request")