Add Unit Test

Author: chsbuffer

DEVELOPMENT.md

@@ -0,0 +1,215 @@
+# Development Guide
+
+## Project Structure
+
+The primary hook entry point is [MainHook.kt](app/src/main/java/io/github/chsbuffer/revancedxposed/MainHook.kt).
+
+### Patch Organization and Conventions
+
+Patches adhere to a specific structure:
+
+```text
+📦your.patches.app.category
+ ├ Fingerprints.kt
+ └ SomePatch.kt
+```
+
+-   **Project-specific patches:** [app/src/main/java/io/github/chsbuffer/revancedxposed](app/src/main/java/io/github/chsbuffer/revancedxposed)
+-   **Upstream patches:** [revanced-patches/patches/src/main/kotlin/app/revanced/patches](revanced-patches/patches/src/main/kotlin/app/revanced/patches)
+
+Upstream patches are included via Git submodule for reference and to utilize shared extension code. They are not modified within this project.
+
+### Example: Patch Implementation (Contoso App)
+
+#### `Fingerprints.kt`
+```kotlin
+package io.github.chsbuffer.revancedxposed.contoso.misc.unlock.plus
+
+import io.github.chsbuffer.revancedxposed.AccessFlags
+import io.github.chsbuffer.revancedxposed.fingerprint
+import org.luckypray.dexkit.query.enums.StringMatchType
+
+val isPlusUnlockedFingerprint = fingerprint {
+    returns("Z")
+    strings("genius")
+}
+```
+
+#### `UnlockPlusPatch.kt`
+```kotlin
+package io.github.chsbuffer.revancedxposed.contoso.misc.unlock.plus
+
+import static de.robv.android.xposed.XC_MethodReplacement.returnConstant
+import io.github.chsbuffer.revancedxposed.contoso.ContosoHook
+
+fun ContosoHook.UnlockPlus() {
+    ::isPlusUnlockedFingerprint.hookMethod(returnConstant(true))
+}
+```
+
+#### `ContosoHook.kt`
+```kotlin
+package io.github.chsbuffer.revancedxposed.contoso
+
+import android.app.Application
+import de.robv.android.xposed.callbacks.XC_LoadPackage
+import io.github.chsbuffer.revancedxposed.BaseHook
+import io.github.chsbuffer.revancedxposed.contoso.misc.unlock.plus.UnlockPlus
+
+class ContosoHook(app: Application, lpparam: XC_LoadPackage.LoadPackageParam) : BaseHook(
+    app, lpparam
+) {
+    override val hooks = arrayOf(::UnlockPlus)
+}
+```
+
+### Porting Upstream Patches
+
+The [FingerprintCompat.kt](app/src/main/java/io/github/chsbuffer/revancedxposed/FingerprintCompat.kt) utility assists in translating ReVanced Patcher API calls to DexKit Matchers. While simple fingerprints can often be directly copied, consider the following translation patterns for complex cases:
+
+1.  **Literal Mapping:**
+    If an upstream patch defines a literal within the patch file (e.g., `aLiteral = resourceMappings["id", "aLiteral"]`) for use in a fingerprint, convert it to a getter property in the corresponding `Fingerprints.kt` file.
+
+    *From (Upstream):*
+    ```kotlin
+    // In ***Patch.kt beside the Fingerprints.kt
+    // val aLiteral = resourceMappings["id", "aLiteral"]
+    fingerprint { literal { aLiteral } }
+    ```
+
+    *To (This Project's Fingerprints.kt):*
+    ```kotlin
+    val aLiteral get() = resourceMappings["id", "aLiteral"] // Defined in Fingerprints.kt
+    fingerprint { literal { aLiteral } }
+    ```
+
+2.  **Custom Class and Method Matchers:**
+
+    *From (Upstream):*
+    ```kotlin
+    fingerprint {
+        custom { method, classDef ->
+            method.name == "onCreate" && classDef.endsWith("/MusicActivity;")
+        }
+    }
+    ```
+
+    *To (This Project):*
+    ```kotlin
+    fingerprint {
+        methodMatcher { name = "onCreate" }
+        classMatcher { className(".MusicActivity", StringMatchType.EndsWith) }
+    }
+    ```
+
+3.  **Instruction-based Method Reference:**
+
+    *From (Upstream):*
+    ```kotlin
+    fun indexOfTranslationInstruction(method: Method) =
+        method.indexOfFirstInstructionReversed {
+            getReference<MethodReference>()?.name == "setTranslationY"
+        }
+
+    val motionEventFingerprint = fingerprint {
+        custom { method, _ ->
+            indexOfTranslationInstruction(method) >= 0
+        }
+    }
+    ```
+
+    *To (This Project):*
+    ```kotlin
+    val motionEventFingerprint = fingerprint {
+        methodMatcher { addInvoke { name = "setTranslationY" } }
+    }
+    ```
+
+4.  **Matching Specific Class Types or Defining Classes:**
+    When an upstream `custom` block primarily checks `classDef.type` (the type of the matched class) or `method.definingClass` (the class defining the matched method), this translates to a `classMatcher` in this project. The `classMatcher` directly specifies the target class descriptor.
+
+    *From (Upstream Example):*
+    ```kotlin
+    // Upstream: Using custom to check classDef.type
+    fingerprint {
+        custom { _, classDef ->
+            classDef.type == "Lcom/example/SomeClass;"
+        }
+        // other matchers...
+    }
+
+    // Upstream: Using custom to check method.definingClass
+    fingerprint {
+        custom { method, _ ->
+            method.definingClass == "Lcom/example/AnotherClass;"
+        }
+        // other method matchers...
+    }
+    ```
+    *To (This Project's Fingerprints.kt Example):*
+    ```kotlin
+    // This Project: Using classMatcher for classDef.type
+    fingerprint {
+        classMatcher { descriptor = "Lcom/example/SomeClass;" }
+        // methodMatcher { ... } // if needed for method properties
+    }
+
+    // This Project: Using classMatcher for method.definingClass
+    fingerprint {
+        // Targets methods within Lcom/example/AnotherClass;
+        classMatcher { descriptor = "Lcom/example/AnotherClass;" }
+        methodMatcher {
+            // specific method properties, e.g., name = "targetMethod"
+        }
+    }
+    ```
+5.  **Porting Complex `custom` Logic or Chained Lookups with Direct Finders:**
+    For intricate upstream fingerprints with complex `custom` logic or chained lookups not easily mapped to standard matchers, this project uses direct finder functions (e.g., `findMethodDirect`, `findClassDirect`) from `FingerprintCompat.kt`. This approach combines DexKit's efficient initial filtering with the power of Kotlin's collection processing for subsequent, more granular refinement.
+
+    *From (Upstream Example with complex `custom` logic):*
+    ```kotlin
+    internal val complexCustomFingerprint = fingerprint {
+        returns("Lcom/example/ReturnType;")
+        custom { method, _ ->
+            method.name.startsWith("get") &&
+            method.parameterTypes.size == 1 &&
+            method.parameterTypes.first() == "Lcom/example/ParameterType;" &&
+            method.definingClass == "Lcom/example/HostClass;"
+            // ... potentially more complex conditions
+        }
+    }
+    ```
+    *To (This Project using `findMethodDirect`):*
+    ```kotlin
+    val complexCustomFingerprint = findMethodDirect {
+        // Initial, broader filtering with DexKit matchers
+        findMethod {
+            matcher {
+                returns("Lcom/example/ReturnType;")
+                declaredClass { descriptor = "Lcom/example/HostClass;" }
+                // Other simple matchers convertible from the original custom block
+            }
+        }
+        // Refine results using Kotlin's collection functions for complex logic
+        .filter { methodData -> methodData.name.startsWith("get") }
+        .single { methodData -> // Assuming a unique result after all filters
+            methodData.paramTypes.size == 1 &&
+            methodData.paramTypes.firstOrNull()?.descriptor == "Lcom/example/ParameterType;"
+            // ... other Kotlin-based checks
+        }
+    }
+    ```
+    This allows leveraging DexKit for initial efficient filtering, then applying precise Kotlin logic to the narrowed-down candidates.
+
+### Extension Modules
+
+As per ReVanced Patcher documentation:
+> Instead of involving many abstract changes in one patch or writing entire methods or classes in a patch, you can write code in extensions.
+
+This project shares extension code with the upstream project, located at `./revanced-patches/extensions`. Upstream organizes extensions into separate modules (e.g., `./revanced-patches/extensions/<appAlias>/src/main/java/app/revanced/extension/<appAlias>`). Modifications to shared extensions and other code under `revanced-patches` are minimized.
+
+## Unit Testing
+
+Refer to [FingerprintsKtTest.kt](app/src/test/java/io/github/chsbuffer/revancedxposed/FingerprintsKtTest.kt) for testing examples.
+
+For running tests, place necessary APKs into the `./app/binaries/` directory. APK filenames should be prefixed with their respective package names (e.g., `com.example.app-1.0.0.apk`).

app/binaries/.gitignore

@@ -0,0 +1 @@
+*.apk

app/build.gradle.kts

@@ -101,6 +101,10 @@ android {
     }
 }
 
+tasks.withType<Test> {
+    useJUnitPlatform()
+}
+
 dependencies {
 //    implementation(libs.dexkit)
     implementation(group = "", name = "dexkit-android", ext = "aar")
@@ -109,6 +113,10 @@ dependencies {
     implementation(libs.gson)
     implementation(libs.kotlinx.coroutines.android)
     implementation(libs.fuel)
+    testImplementation(kotlin("test-junit5"))
+    testImplementation(libs.junit.jupiter.params)
+    testImplementation(libs.jadx.core)
+    testImplementation(libs.slf4j.simple)
     debugImplementation(kotlin("reflect"))
     compileOnly(libs.xposed)
     compileOnly(project(":stub"))

app/src/main/java/io/github/chsbuffer/revancedxposed/UnitTestAnnotations.kt

@@ -0,0 +1,6 @@
+package io.github.chsbuffer.revancedxposed
+
+// Skip Unit Test on unused fingerprint.
+// Use with caution!!!
+@Target(AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.FUNCTION)
+annotation class SkipTest()

app/src/main/java/io/github/chsbuffer/revancedxposed/spotify/layout/hide/createbutton/Fingerprints.kt

@@ -2,9 +2,11 @@ package io.github.chsbuffer.revancedxposed.spotify.layout.hide.createbutton
 
 import io.github.chsbuffer.revancedxposed.AccessFlags
 import io.github.chsbuffer.revancedxposed.Opcode
+import io.github.chsbuffer.revancedxposed.SkipTest
 import io.github.chsbuffer.revancedxposed.findClassDirect
 import io.github.chsbuffer.revancedxposed.fingerprint
 
+@get:SkipTest
 val oldNavigationBarAddItemFingerprint = fingerprint {
     strings("Bottom navigation tabs exceeds maximum of 5 tabs")
 }

app/src/main/java/io/github/chsbuffer/revancedxposed/spotify/misc/Fingerprints.kt

@@ -2,6 +2,7 @@ package io.github.chsbuffer.revancedxposed.spotify.misc
 
 import io.github.chsbuffer.revancedxposed.FindClassFunc
 import io.github.chsbuffer.revancedxposed.Opcode
+import io.github.chsbuffer.revancedxposed.SkipTest
 import io.github.chsbuffer.revancedxposed.findClassDirect
 import io.github.chsbuffer.revancedxposed.findFieldDirect
 import io.github.chsbuffer.revancedxposed.findMethodDirect
@@ -53,6 +54,7 @@ val oldContextMenuViewModelAddItemFingerprint = fingerprint {
     methodMatcher { addInvoke { name = "add" } }
 }
 
+@SkipTest
 fun structureGetSectionsFingerprint(className: String) = fingerprint {
     classMatcher { className(className, StringMatchType.EndsWith) }
     methodMatcher {

app/src/main/java/io/github/chsbuffer/revancedxposed/youtube/ad/general/Fingerprints.kt

@@ -8,7 +8,7 @@ import io.github.chsbuffer.revancedxposed.strings
 
 internal const val ANDROID_AUTOMOTIVE_STRING = "Android Automotive"
 
-internal val addCreateButtonViewFingerprint = fingerprint {
+val addCreateButtonViewFingerprint = fingerprint {
     strings("Android Wear", ANDROID_AUTOMOTIVE_STRING)
 }
 
@@ -19,7 +19,7 @@ val AutoMotiveFeatureMethod = findMethodDirect {
     }.single()
 }
 
-internal val createPivotBarFingerprint = fingerprint {
+val createPivotBarFingerprint = fingerprint {
     accessFlags(AccessFlags.PUBLIC, AccessFlags.CONSTRUCTOR)
     returns("V")
     parameters(