chore: Lint code

2026-01-25 20:21:03 +00:00 · 2023-11-26 05:57:41 +01:00
parent 287841d806
commit 80407b6102
57 changed files with 1060 additions and 840 deletions
--- a/src/test/kotlin/app/revanced/patcher/extensions/InstructionExtensionsTest.kt
+++ b/src/test/kotlin/app/revanced/patcher/extensions/InstructionExtensionsTest.kt
@@ -27,180 +27,202 @@ private object InstructionExtensionsTest {
    private lateinit var testMethodImplementation: MutableMethodImplementation

    @BeforeEach
-    fun createTestMethod() = ImmutableMethod(
-        "TestClass;",
-        "testMethod",
-        null,
-        "V",
-        AccessFlags.PUBLIC.value,
-        null,
-        null,
-        MutableMethodImplementation(16).also { testMethodImplementation = it }.apply {
-            repeat(10) { i -> this.addInstruction(TestInstruction(i)) }
-        },
-    ).let { testMethod = it.toMutable() }
+    fun createTestMethod() =
+        ImmutableMethod(
+            "TestClass;",
+            "testMethod",
+            null,
+            "V",
+            AccessFlags.PUBLIC.value,
+            null,
+            null,
+            MutableMethodImplementation(16).also { testMethodImplementation = it }.apply {
+                repeat(10) { i -> this.addInstruction(TestInstruction(i)) }
+            },
+        ).let { testMethod = it.toMutable() }

    @Test
-    fun addInstructionsToImplementationIndexed() = applyToImplementation {
-        addInstructions(5, getTestInstructions(5..6)).also {
-            assertRegisterIs(5, 5)
-            assertRegisterIs(6, 6)
+    fun addInstructionsToImplementationIndexed() =
+        applyToImplementation {
+            addInstructions(5, getTestInstructions(5..6)).also {
+                assertRegisterIs(5, 5)
+                assertRegisterIs(6, 6)

-            assertRegisterIs(5, 7)
+                assertRegisterIs(5, 7)
+            }
        }
-    }

    @Test
-    fun addInstructionsToImplementation() = applyToImplementation {
-        addInstructions(getTestInstructions(10..11)).also {
-            assertRegisterIs(10, 10)
-            assertRegisterIs(11, 11)
+    fun addInstructionsToImplementation() =
+        applyToImplementation {
+            addInstructions(getTestInstructions(10..11)).also {
+                assertRegisterIs(10, 10)
+                assertRegisterIs(11, 11)
+            }
        }
-    }

    @Test
-    fun removeInstructionsFromImplementationIndexed() = applyToImplementation {
-        removeInstructions(5, 5).also { assertRegisterIs(4, 4) }
-    }
-
-    @Test
-    fun removeInstructionsFromImplementation() = applyToImplementation {
-        removeInstructions(0).also { assertRegisterIs(9, 9) }
-        removeInstructions(1).also { assertRegisterIs(1, 0) }
-        removeInstructions(2).also { assertRegisterIs(3, 0) }
-    }
-
-    @Test
-    fun replaceInstructionsInImplementationIndexed() = applyToImplementation {
-        replaceInstructions(5, getTestInstructions(0..1)).also {
-            assertRegisterIs(0, 5)
-            assertRegisterIs(1, 6)
-            assertRegisterIs(7, 7)
+    fun removeInstructionsFromImplementationIndexed() =
+        applyToImplementation {
+            removeInstructions(5, 5).also { assertRegisterIs(4, 4) }
        }
-    }

    @Test
-    fun addInstructionToMethodIndexed() = applyToMethod {
-        addInstruction(5, TestInstruction(0)).also { assertRegisterIs(0, 5) }
-    }
-
-    @Test
-    fun addInstructionToMethod() = applyToMethod {
-        addInstruction(TestInstruction(0)).also { assertRegisterIs(0, 10) }
-    }
-
-    @Test
-    fun addSmaliInstructionToMethodIndexed() = applyToMethod {
-        addInstruction(5, getTestSmaliInstruction(0)).also { assertRegisterIs(0, 5) }
-    }
-
-    @Test
-    fun addSmaliInstructionToMethod() = applyToMethod {
-        addInstruction(getTestSmaliInstruction(0)).also { assertRegisterIs(0, 10) }
-    }
-
-    @Test
-    fun addInstructionsToMethodIndexed() = applyToMethod {
-        addInstructions(5, getTestInstructions(0..1)).also {
-            assertRegisterIs(0, 5)
-            assertRegisterIs(1, 6)
-
-            assertRegisterIs(5, 7)
+    fun removeInstructionsFromImplementation() =
+        applyToImplementation {
+            removeInstructions(0).also { assertRegisterIs(9, 9) }
+            removeInstructions(1).also { assertRegisterIs(1, 0) }
+            removeInstructions(2).also { assertRegisterIs(3, 0) }
        }
-    }

    @Test
-    fun addInstructionsToMethod() = applyToMethod {
-        addInstructions(getTestInstructions(0..1)).also {
-            assertRegisterIs(0, 10)
-            assertRegisterIs(1, 11)
-
-            assertRegisterIs(9, 9)
+    fun replaceInstructionsInImplementationIndexed() =
+        applyToImplementation {
+            replaceInstructions(5, getTestInstructions(0..1)).also {
+                assertRegisterIs(0, 5)
+                assertRegisterIs(1, 6)
+                assertRegisterIs(7, 7)
+            }
        }
-    }

    @Test
-    fun addSmaliInstructionsToMethodIndexed() = applyToMethod {
-        addInstructionsWithLabels(5, getTestSmaliInstructions(0..1)).also {
-            assertRegisterIs(0, 5)
-            assertRegisterIs(1, 6)
-
-            assertRegisterIs(5, 7)
+    fun addInstructionToMethodIndexed() =
+        applyToMethod {
+            addInstruction(5, TestInstruction(0)).also { assertRegisterIs(0, 5) }
        }
-    }

    @Test
-    fun addSmaliInstructionsToMethod() = applyToMethod {
-        addInstructions(getTestSmaliInstructions(0..1)).also {
-            assertRegisterIs(0, 10)
-            assertRegisterIs(1, 11)
-
-            assertRegisterIs(9, 9)
+    fun addInstructionToMethod() =
+        applyToMethod {
+            addInstruction(TestInstruction(0)).also { assertRegisterIs(0, 10) }
        }
-    }

    @Test
-    fun addSmaliInstructionsWithExternalLabelToMethodIndexed() = applyToMethod {
-        val label = ExternalLabel("testLabel", getInstruction(5))
-
-        addInstructionsWithLabels(
-            5,
-            getTestSmaliInstructions(0..1).plus("\n").plus("goto :${label.name}"),
-            label
-        ).also {
-            assertRegisterIs(0, 5)
-            assertRegisterIs(1, 6)
-            assertRegisterIs(5, 8)
-
-            val gotoTarget = getInstruction<BuilderOffsetInstruction>(7)
-                .target.location.instruction as OneRegisterInstruction
-
-            assertEquals(5, gotoTarget.registerA)
+    fun addSmaliInstructionToMethodIndexed() =
+        applyToMethod {
+            addInstruction(5, getTestSmaliInstruction(0)).also { assertRegisterIs(0, 5) }
        }
-    }

    @Test
-    fun removeInstructionFromMethodIndexed() = applyToMethod {
-        removeInstruction(5).also {
-            assertRegisterIs(4, 4)
-            assertRegisterIs(6, 5)
+    fun addSmaliInstructionToMethod() =
+        applyToMethod {
+            addInstruction(getTestSmaliInstruction(0)).also { assertRegisterIs(0, 10) }
        }
-    }

    @Test
-    fun removeInstructionsFromMethodIndexed() = applyToMethod {
-        removeInstructions(5, 5).also { assertRegisterIs(4, 4) }
-    }
+    fun addInstructionsToMethodIndexed() =
+        applyToMethod {
+            addInstructions(5, getTestInstructions(0..1)).also {
+                assertRegisterIs(0, 5)
+                assertRegisterIs(1, 6)

-    @Test
-    fun removeInstructionsFromMethod() = applyToMethod {
-        removeInstructions(0).also { assertRegisterIs(9, 9) }
-        removeInstructions(1).also { assertRegisterIs(1, 0) }
-        removeInstructions(2).also { assertRegisterIs(3, 0) }
-    }
-
-    @Test
-    fun replaceInstructionInMethodIndexed() = applyToMethod {
-        replaceInstruction(5, TestInstruction(0)).also { assertRegisterIs(0, 5) }
-    }
-
-    @Test
-    fun replaceInstructionsInMethodIndexed() = applyToMethod {
-        replaceInstructions(5, getTestInstructions(0..1)).also {
-            assertRegisterIs(0, 5)
-            assertRegisterIs(1, 6)
-            assertRegisterIs(7, 7)
+                assertRegisterIs(5, 7)
+            }
        }
-    }

    @Test
-    fun replaceSmaliInstructionsInMethodIndexed() = applyToMethod {
-        replaceInstructions(5, getTestSmaliInstructions(0..1)).also {
-            assertRegisterIs(0, 5)
-            assertRegisterIs(1, 6)
-            assertRegisterIs(7, 7)
+    fun addInstructionsToMethod() =
+        applyToMethod {
+            addInstructions(getTestInstructions(0..1)).also {
+                assertRegisterIs(0, 10)
+                assertRegisterIs(1, 11)
+
+                assertRegisterIs(9, 9)
+            }
+        }
+
+    @Test
+    fun addSmaliInstructionsToMethodIndexed() =
+        applyToMethod {
+            addInstructionsWithLabels(5, getTestSmaliInstructions(0..1)).also {
+                assertRegisterIs(0, 5)
+                assertRegisterIs(1, 6)
+
+                assertRegisterIs(5, 7)
+            }
+        }
+
+    @Test
+    fun addSmaliInstructionsToMethod() =
+        applyToMethod {
+            addInstructions(getTestSmaliInstructions(0..1)).also {
+                assertRegisterIs(0, 10)
+                assertRegisterIs(1, 11)
+
+                assertRegisterIs(9, 9)
+            }
+        }
+
+    @Test
+    fun addSmaliInstructionsWithExternalLabelToMethodIndexed() =
+        applyToMethod {
+            val label = ExternalLabel("testLabel", getInstruction(5))
+
+            addInstructionsWithLabels(
+                5,
+                getTestSmaliInstructions(0..1).plus("\n").plus("goto :${label.name}"),
+                label,
+            ).also {
+                assertRegisterIs(0, 5)
+                assertRegisterIs(1, 6)
+                assertRegisterIs(5, 8)
+
+                val gotoTarget =
+                    getInstruction<BuilderOffsetInstruction>(7)
+                        .target.location.instruction as OneRegisterInstruction
+
+                assertEquals(5, gotoTarget.registerA)
+            }
+        }
+
+    @Test
+    fun removeInstructionFromMethodIndexed() =
+        applyToMethod {
+            removeInstruction(5).also {
+                assertRegisterIs(4, 4)
+                assertRegisterIs(6, 5)
+            }
+        }
+
+    @Test
+    fun removeInstructionsFromMethodIndexed() =
+        applyToMethod {
+            removeInstructions(5, 5).also { assertRegisterIs(4, 4) }
+        }
+
+    @Test
+    fun removeInstructionsFromMethod() =
+        applyToMethod {
+            removeInstructions(0).also { assertRegisterIs(9, 9) }
+            removeInstructions(1).also { assertRegisterIs(1, 0) }
+            removeInstructions(2).also { assertRegisterIs(3, 0) }
+        }
+
+    @Test
+    fun replaceInstructionInMethodIndexed() =
+        applyToMethod {
+            replaceInstruction(5, TestInstruction(0)).also { assertRegisterIs(0, 5) }
+        }
+
+    @Test
+    fun replaceInstructionsInMethodIndexed() =
+        applyToMethod {
+            replaceInstructions(5, getTestInstructions(0..1)).also {
+                assertRegisterIs(0, 5)
+                assertRegisterIs(1, 6)
+                assertRegisterIs(7, 7)
+            }
+        }
+
+    @Test
+    fun replaceSmaliInstructionsInMethodIndexed() =
+        applyToMethod {
+            replaceInstructions(5, getTestSmaliInstructions(0..1)).also {
+                assertRegisterIs(0, 5)
+                assertRegisterIs(1, 6)
+                assertRegisterIs(7, 7)
+            }
        }
-    }

    // region Helper methods

@@ -212,22 +234,29 @@ private object InstructionExtensionsTest {
        testMethod.apply(block)
    }

-    private fun MutableMethodImplementation.assertRegisterIs(register: Int, atIndex: Int) = assertEquals(
-        register, getInstruction<OneRegisterInstruction>(atIndex).registerA
+    private fun MutableMethodImplementation.assertRegisterIs(
+        register: Int,
+        atIndex: Int,
+    ) = assertEquals(
+        register,
+        getInstruction<OneRegisterInstruction>(atIndex).registerA,
    )

-    private fun MutableMethod.assertRegisterIs(register: Int, atIndex: Int) =
-        implementation!!.assertRegisterIs(register, atIndex)
+    private fun MutableMethod.assertRegisterIs(
+        register: Int,
+        atIndex: Int,
+    ) = implementation!!.assertRegisterIs(register, atIndex)

    private fun getTestInstructions(range: IntRange) = range.map { TestInstruction(it) }

    private fun getTestSmaliInstruction(register: Int) = "const/16 v$register, 0"

-    private fun getTestSmaliInstructions(range: IntRange) = range.joinToString("\n") {
-        getTestSmaliInstruction(it)
-    }
+    private fun getTestSmaliInstructions(range: IntRange) =
+        range.joinToString("\n") {
+            getTestSmaliInstruction(it)
+        }

    // endregion

    private class TestInstruction(register: Int) : BuilderInstruction21s(Opcode.CONST_16, register, 0)
-}
+}
--- a/src/test/kotlin/app/revanced/patcher/patch/options/PatchOptionsTest.kt
+++ b/src/test/kotlin/app/revanced/patcher/patch/options/PatchOptionsTest.kt
@@ -67,8 +67,7 @@ internal class PatchOptionsTest {
        }

    @Test
-    fun `should allow setting custom value`() =
-        assertDoesNotThrow { OptionsTestPatch.stringOptionWithChoices = "unknown" }
+    fun `should allow setting custom value`() = assertDoesNotThrow { OptionsTestPatch.stringOptionWithChoices = "unknown" }

    @Test
    fun `should allow resetting value`() = assertDoesNotThrow { OptionsTestPatch.stringOptionWithChoices = null }
@@ -86,42 +85,42 @@ internal class PatchOptionsTest {
    }

    @Test
-    fun `option types should be known`() =
-        assertTrue(OptionsTestPatch.options["array"].valueType == "StringArray")
+    fun `option types should be known`() = assertTrue(OptionsTestPatch.options["array"].valueType == "StringArray")

    @Test
-    fun `getting default value should work`() =
-        assertDoesNotThrow { assertNull(OptionsTestPatch.resettableOption.default) }
+    fun `getting default value should work`() = assertDoesNotThrow { assertNull(OptionsTestPatch.resettableOption.default) }

    private object OptionsTestPatch : BytecodePatch() {
        var booleanOption by booleanPatchOption(
            "bool",
-            true
+            true,
        )
        var requiredStringOption by stringPatchOption(
            "required",
            "default",
-            required = true
-        )
-        var stringArrayOption = stringArrayPatchOption(
-            "array",
-            arrayOf("1", "2")
+            required = true,
        )
+        var stringArrayOption =
+            stringArrayPatchOption(
+                "array",
+                arrayOf("1", "2"),
+            )
        var stringOptionWithChoices by stringPatchOption(
            "choices",
            "value",
-            values = mapOf("Valid option value" to "valid")
+            values = mapOf("Valid option value" to "valid"),
        )
        var validatedOption by stringPatchOption(
-
            "validated",
-            "default"
+            "default",
        ) { it == "valid" }
-        var resettableOption = stringPatchOption(
-            "resettable", null,
-            required = true
-        )
+        var resettableOption =
+            stringPatchOption(
+                "resettable",
+                null,
+                required = true,
+            )

        override fun execute(context: BytecodeContext) {}
    }
-}
+}
--- a/src/test/kotlin/app/revanced/patcher/patch/usage/ExampleBytecodePatch.kt
+++ b/src/test/kotlin/app/revanced/patcher/patch/usage/ExampleBytecodePatch.kt
@@ -32,7 +32,7 @@ import com.google.common.collect.ImmutableList
    name = "Example bytecode patch",
    description = "Example demonstration of a bytecode patch.",
    dependencies = [ExampleResourcePatch::class],
-    compatiblePackages = [CompatiblePackage("com.example.examplePackage", arrayOf("0.0.1", "0.0.2"))]
+    compatiblePackages = [CompatiblePackage("com.example.examplePackage", arrayOf("0.0.1", "0.0.2"))],
 )
 object ExampleBytecodePatch : BytecodePatch(setOf(ExampleFingerprint)) {
    // Entry point of a patch. Supplied fingerprints are resolved at this point.
@@ -60,7 +60,7 @@ object ExampleBytecodePatch : BytecodePatch(setOf(ExampleFingerprint)) {
                        invoke-static { }, LTestClass;->returnHello()Ljava/lang/String;
                        move-result-object v1
                        invoke-virtual { v0, v1 }, Ljava/io/PrintStream;->println(Ljava/lang/String;)V
-                    """
+                    """,
                )
            }

@@ -82,14 +82,14 @@ object ExampleBytecodePatch : BytecodePatch(setOf(ExampleFingerprint)) {
                                BuilderInstruction21c(
                                    Opcode.CONST_STRING,
                                    0,
-                                    ImmutableStringReference("Hello, ReVanced! Adding bytecode.")
+                                    ImmutableStringReference("Hello, ReVanced! Adding bytecode."),
                                ),
-                                BuilderInstruction11x(Opcode.RETURN_OBJECT, 0)
+                                BuilderInstruction11x(Opcode.RETURN_OBJECT, 0),
                            ),
                            null,
-                            null
-                        )
-                    ).toMutable()
+                            null,
+                        ),
+                    ).toMutable(),
                )

                // Add a field in the main class.
@@ -105,12 +105,12 @@ object ExampleBytecodePatch : BytecodePatch(setOf(ExampleFingerprint)) {
                            ImmutableFieldReference(
                                "Ljava/lang/System;",
                                "out",
-                                "Ljava/io/PrintStream;"
-                            )
+                                "Ljava/io/PrintStream;",
+                            ),
                        ),
                        null,
-                        null
-                    ).toMutable()
+                        null,
+                    ).toMutable(),
                )
            }
        } ?: throw PatchException("Fingerprint failed to resolve.")
@@ -121,7 +121,10 @@ object ExampleBytecodePatch : BytecodePatch(setOf(ExampleFingerprint)) {
     * @param index The index of the instruction to replace.
     * @param string The replacement string.
     */
-    private fun MutableMethod.replaceStringAt(index: Int, string: String) {
+    private fun MutableMethod.replaceStringAt(
+        index: Int,
+        string: String,
+    ) {
        val instruction = getInstruction(index)

        // Utility method of dexlib2.
@@ -139,8 +142,7 @@ object ExampleBytecodePatch : BytecodePatch(setOf(ExampleFingerprint)) {
        // At last, use the method replaceInstruction to replace it at the given index startIndex.
        replaceInstruction(
            index,
-            "const-string ${strInstruction.registerA}, ${ImmutableStringReference(string)}"
+            "const-string ${strInstruction.registerA}, ${ImmutableStringReference(string)}",
        )
    }
 }
-
--- a/src/test/kotlin/app/revanced/patcher/patch/usage/ExampleFingerprint.kt
+++ b/src/test/kotlin/app/revanced/patcher/patch/usage/ExampleFingerprint.kt
@@ -1,7 +1,7 @@
 package app.revanced.patcher.patch.usage
 import app.revanced.patcher.extensions.or
-import app.revanced.patcher.fingerprint.annotation.FuzzyPatternScanMethod
 import app.revanced.patcher.fingerprint.MethodFingerprint
+import app.revanced.patcher.fingerprint.annotation.FuzzyPatternScanMethod
 import com.android.tools.smali.dexlib2.AccessFlags
 import com.android.tools.smali.dexlib2.Opcode

@@ -12,9 +12,9 @@ object ExampleFingerprint : MethodFingerprint(
    listOf("[L"),
    listOf(
        Opcode.SGET_OBJECT,
-        null,                 // Matching unknown opcodes.
+        null, // Matching unknown opcodes.
        Opcode.INVOKE_STATIC, // This is intentionally wrong to test fuzzy matching.
-        Opcode.RETURN_VOID
+        Opcode.RETURN_VOID,
    ),
-    null
-)
+    null,
+)
--- a/src/test/kotlin/app/revanced/patcher/patch/usage/ExampleResourcePatch.kt
+++ b/src/test/kotlin/app/revanced/patcher/patch/usage/ExampleResourcePatch.kt
@@ -4,19 +4,19 @@ import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.patch.ResourcePatch
 import org.w3c.dom.Element

-
 class ExampleResourcePatch : ResourcePatch() {
    override fun execute(context: ResourceContext) {
        context.xmlEditor["AndroidManifest.xml"].use { editor ->
-            val element = editor // regular DomFileEditor
-                .file
-                .getElementsByTagName("application")
-                .item(0) as Element
+            val element =
+                editor // regular DomFileEditor
+                    .file
+                    .getElementsByTagName("application")
+                    .item(0) as Element
            element
                .setAttribute(
                    "exampleAttribute",
-                    "exampleValue"
+                    "exampleValue",
                )
        }
    }
-}
+}
--- a/src/test/kotlin/app/revanced/patcher/util/smali/InlineSmaliCompilerTest.kt
+++ b/src/test/kotlin/app/revanced/patcher/util/smali/InlineSmaliCompilerTest.kt
@@ -33,16 +33,18 @@ internal class InlineSmaliCompilerTest {
        val insnIndex = insnAmount - 2
        val targetIndex = insnIndex - 1

-        method.addInstructions(arrayOfNulls<String>(insnAmount).also {
-            Arrays.fill(it, "const/4 v0, 0x0")
-        }.joinToString("\n"))
+        method.addInstructions(
+            arrayOfNulls<String>(insnAmount).also {
+                Arrays.fill(it, "const/4 v0, 0x0")
+            }.joinToString("\n"),
+        )
        method.addInstructionsWithLabels(
            targetIndex,
            """
                :test
                const/4 v0, 0x1
                if-eqz v0, :test
-            """
+            """,
        )

        val insn = method.getInstruction<BuilderInstruction21t>(insnIndex)
@@ -59,7 +61,7 @@ internal class InlineSmaliCompilerTest {
            """
                const/4 v0, 0x1
                const/4 v0, 0x0
-            """
+            """,
        )

        assertEquals(labelIndex, method.newLabel(labelIndex).location.index)
@@ -71,7 +73,7 @@ internal class InlineSmaliCompilerTest {
                if-eqz v0, :test
                return-void
            """,
-            ExternalLabel("test", method.getInstruction(1))
+            ExternalLabel("test", method.getInstruction(1)),
        )

        val insn = method.getInstruction<BuilderInstruction21t>(insnIndex)
@@ -93,13 +95,16 @@ internal class InlineSmaliCompilerTest {
            accessFlags,
            emptySet(),
            emptySet(),
-            MutableMethodImplementation(registerCount)
+            MutableMethodImplementation(registerCount),
        ).toMutable()

-        private fun instructionEquals(want: BuilderInstruction, have: BuilderInstruction) {
+        private fun instructionEquals(
+            want: BuilderInstruction,
+            have: BuilderInstruction,
+        ) {
            assertEquals(want.opcode, have.opcode)
            assertEquals(want.format, have.format)
            assertEquals(want.codeUnits, have.codeUnits)
        }
    }
-}
+}