Merge pull request #156 from solrudev/develop

0.19.2

Author: solrudev

.github/workflows/ci.yml

@@ -15,6 +15,9 @@ jobs:
     runs-on: ubuntu-latest
     name: Build Ackpine
 
+    permissions:
+      checks: write
+
     steps:
       - name: Checkout
         uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0
@@ -34,6 +37,16 @@ jobs:
         run: |
           ./gradlew :buildAckpine --stacktrace
 
+      - name: Run tests
+        run: |
+          ./gradlew test
+
+      - name: Publish test report
+        uses: mikepenz/action-junit-report@a294a61c909bd8a4b563024a2faa28897fd53ebc # 6.1.0
+        if: success() || failure()
+        with:
+          report_paths: '**/build/test-results/*/TEST-*.xml'
+
   status-check:
     runs-on: ubuntu-latest
     if: always()

README.md

@@ -37,7 +37,7 @@ Ackpine depends on Jetpack libraries, so it's also necessary to add the `google(
 
 ```toml
 [versions]
-ackpine = "0.19.1"
+ackpine = "0.19.2"
 
 [libraries]
 ackpine-core = { module = "ru.solrudev.ackpine:ackpine-core", version.ref = "ackpine" }
@@ -60,6 +60,9 @@ ackpine-shizuku = { module = "ru.solrudev.ackpine:ackpine-shizuku", version.ref
 # optional - Kotlin extensions for Shizuku plugin
 ackpine-shizuku-ktx = { module = "ru.solrudev.ackpine:ackpine-shizuku-ktx", version.ref = "ackpine" }
 
+# optional - testing utilities
+ackpine-test = { module = "ru.solrudev.ackpine:ackpine-test", version.ref = "ackpine" }
+
 [bundles]
 ackpine = [
     "ackpine-core",
@@ -78,7 +81,7 @@ ackpine = [
 
 ```kotlin
 dependencies {
-    val ackpineVersion = "0.19.1"
+    val ackpineVersion = "0.19.2"
     implementation("ru.solrudev.ackpine:ackpine-core:$ackpineVersion")
 
     // optional - Kotlin extensions and Coroutines support
@@ -98,6 +101,9 @@ dependencies {
 
     // optional - Kotlin extensions for Shizuku plugin
     implementation("ru.solrudev.ackpine:ackpine-shizuku-ktx:$ackpineVersion")
+
+	// optional - testing utilities
+	testImplementation("ru.solrudev.ackpine:ackpine-test:$ackpineVersion")
 }
 ```
 </details>

ackpine-resources/api/ackpine-resources.api

@@ -17,8 +17,8 @@ public final class ru/solrudev/ackpine/resources/ResolvableString$Companion {
 
 public abstract class ru/solrudev/ackpine/resources/ResolvableString$Resource : ru/solrudev/ackpine/resources/ResolvableString {
 	public fun <init> ([Ljava/io/Serializable;)V
-	public final fun equals (Ljava/lang/Object;)Z
-	public final fun hashCode ()I
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
 	public final fun resolve (Landroid/content/Context;)Ljava/lang/String;
 	protected abstract fun stringId ()I
 }

ackpine-resources/src/main/kotlin/ru/solrudev/ackpine/resources/ResolvableString.kt

@@ -20,6 +20,7 @@ package ru.solrudev.ackpine.resources
 
 import android.content.Context
 import androidx.annotation.StringRes
+import ru.solrudev.ackpine.resources.ResolvableString.Resource
 import java.io.Serializable
 
 /**
@@ -73,12 +74,12 @@ public sealed interface ResolvableString : Serializable {
 		}
 
 		/**
-		 * Creates an anonymous instance of [ResolvableString.Resource], which is a [ResolvableString] backed by
+		 * Creates a transient instance of [ResolvableString.Resource], which is a [ResolvableString] backed by
 		 * Android resource string with optional [arguments][args]. Arguments can be
 		 * [ResolvableStrings][ResolvableString] as well.
 		 *
-		 * This factory is meant to create only **transient** strings, i.e. not persisted in storage. For persisted
-		 * strings [ResolvableString.Resource] should be explicitly subclassed. Example:
+		 * This factory is meant to create only **transient** strings, i.e. not persisted in storage, because string IDs
+		 * are not stable. For persisted strings [ResolvableString.Resource] should be explicitly subclassed. Example:
 		 * ```
 		 * object InstallMessageTitle : ResolvableString.Resource() {
 		 *     override fun stringId() = R.string.install_message_title
@@ -97,12 +98,9 @@ public sealed interface ResolvableString : Serializable {
 		 * @param stringId Android string resource ID
 		 * @param args string format arguments
 		 */
-		@Suppress("serial")
 		@JvmStatic
 		public fun transientResource(@StringRes stringId: Int, vararg args: Serializable): ResolvableString {
-			return object : Resource(*args) {
-				override fun stringId() = stringId
-			}
+			return TransientResource(stringId, args)
 		}
 	}
 
@@ -147,14 +145,14 @@ public sealed interface ResolvableString : Serializable {
 			}
 		}.toTypedArray()
 
-		final override fun equals(other: Any?): Boolean {
+		override fun equals(other: Any?): Boolean {
 			if (this === other) return true
 			if (javaClass != other?.javaClass) return false
 			other as Resource
 			return args.contentEquals(other.args)
 		}
 
-		final override fun hashCode(): Int {
+		override fun hashCode(): Int {
 			return args.contentHashCode()
 		}
 
@@ -164,6 +162,34 @@ public sealed interface ResolvableString : Serializable {
 	}
 }
 
+private class TransientResource(
+	@param:StringRes private val stringId: Int,
+	private val args: Array<out Serializable>
+) : Resource(stringId, args) {
+
+	override fun stringId() = stringId
+
+	override fun equals(other: Any?): Boolean {
+		if (this === other) return true
+		if (javaClass != other?.javaClass) return false
+		other as TransientResource
+		if (stringId != other.stringId) return false
+		if (!args.contentDeepEquals(other.args)) return false
+		return true
+	}
+
+	override fun hashCode(): Int {
+		var result = super.hashCode()
+		result = 31 * result + stringId
+		result = 31 * result + args.contentDeepHashCode()
+		return result
+	}
+
+	private companion object {
+		private const val serialVersionUID: Long = 2599070109225891907L
+	}
+}
+
 private data object Empty : ResolvableString {
 	private const val serialVersionUID = 5194188194930148316L
 	override fun resolve(context: Context): String = ""

ackpine-test/api/ackpine-test.api

@@ -0,0 +1,143 @@
+public abstract interface class ru/solrudev/ackpine/test/TestInstallSessionFactory {
+	public static final field Companion Lru/solrudev/ackpine/test/TestInstallSessionFactory$Companion;
+	public abstract fun create (Ljava/util/UUID;Lru/solrudev/ackpine/installer/parameters/InstallParameters;)Lru/solrudev/ackpine/test/TestProgressSession;
+}
+
+public final class ru/solrudev/ackpine/test/TestInstallSessionFactory$Companion {
+}
+
+public final class ru/solrudev/ackpine/test/TestPackageInstaller : ru/solrudev/ackpine/installer/PackageInstaller {
+	public fun <init> ()V
+	public fun <init> (Lru/solrudev/ackpine/test/TestInstallSessionFactory;)V
+	public synthetic fun <init> (Lru/solrudev/ackpine/test/TestInstallSessionFactory;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;)V
+	public final fun clearSessions ()V
+	public synthetic fun createSession (Lru/solrudev/ackpine/installer/parameters/InstallParameters;)Lru/solrudev/ackpine/session/ProgressSession;
+	public fun createSession (Lru/solrudev/ackpine/installer/parameters/InstallParameters;)Lru/solrudev/ackpine/test/TestProgressSession;
+	public fun getActiveSessionsAsync ()Lcom/google/common/util/concurrent/ListenableFuture;
+	public fun getSessionAsync (Ljava/util/UUID;)Lcom/google/common/util/concurrent/ListenableFuture;
+	public final fun getSessions ()Ljava/util/List;
+	public fun getSessionsAsync ()Lcom/google/common/util/concurrent/ListenableFuture;
+	public final fun seedSession (Lru/solrudev/ackpine/test/TestProgressSession;)V
+}
+
+public final class ru/solrudev/ackpine/test/TestPackageUninstaller : ru/solrudev/ackpine/uninstaller/PackageUninstaller {
+	public fun <init> ()V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestUninstallSessionFactory;)V
+	public synthetic fun <init> (Lru/solrudev/ackpine/test/TestUninstallSessionFactory;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun clearSessions ()V
+	public synthetic fun createSession (Lru/solrudev/ackpine/uninstaller/parameters/UninstallParameters;)Lru/solrudev/ackpine/session/Session;
+	public fun createSession (Lru/solrudev/ackpine/uninstaller/parameters/UninstallParameters;)Lru/solrudev/ackpine/test/TestSession;
+	public fun getActiveSessionsAsync ()Lcom/google/common/util/concurrent/ListenableFuture;
+	public fun getSessionAsync (Ljava/util/UUID;)Lcom/google/common/util/concurrent/ListenableFuture;
+	public final fun getSessions ()Ljava/util/List;
+	public fun getSessionsAsync ()Lcom/google/common/util/concurrent/ListenableFuture;
+	public final fun seedSession (Lru/solrudev/ackpine/test/TestSession;)V
+}
+
+public final class ru/solrudev/ackpine/test/TestProgressSession : ru/solrudev/ackpine/test/TestSession, ru/solrudev/ackpine/session/ProgressSession {
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;Lru/solrudev/ackpine/session/Session$State;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;Lru/solrudev/ackpine/session/Session$State;Lru/solrudev/ackpine/session/Progress;)V
+	public synthetic fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;Lru/solrudev/ackpine/session/Session$State;Lru/solrudev/ackpine/session/Progress;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun addProgressListener (Lru/solrudev/ackpine/DisposableSubscriptionContainer;Lru/solrudev/ackpine/session/ProgressSession$ProgressListener;)Lru/solrudev/ackpine/DisposableSubscription;
+	public final fun getProgress ()Lru/solrudev/ackpine/session/Progress;
+	public final fun getProgressHistory ()Ljava/util/List;
+	public fun removeProgressListener (Lru/solrudev/ackpine/session/ProgressSession$ProgressListener;)V
+	public fun reset (Lru/solrudev/ackpine/session/Session$State;Z)V
+	public final fun resetProgress ()V
+	public final fun resetProgress (Lru/solrudev/ackpine/session/Progress;)V
+	public final fun resetProgress (Lru/solrudev/ackpine/session/Progress;Z)V
+	public static synthetic fun resetProgress$default (Lru/solrudev/ackpine/test/TestProgressSession;Lru/solrudev/ackpine/session/Progress;ZILjava/lang/Object;)V
+}
+
+public final class ru/solrudev/ackpine/test/TestSdkInt {
+	public static final field INSTANCE Lru/solrudev/ackpine/test/TestSdkInt;
+	public static final fun get ()I
+	public static final fun reset ()V
+	public static final fun set (I)V
+}
+
+public class ru/solrudev/ackpine/test/TestSession : ru/solrudev/ackpine/session/Session {
+	public fun <init> ()V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;)V
+	public fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;Lru/solrudev/ackpine/session/Session$State;)V
+	public synthetic fun <init> (Lru/solrudev/ackpine/test/TestSessionScript;Ljava/util/UUID;Lru/solrudev/ackpine/session/Session$State;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun addStateListener (Lru/solrudev/ackpine/DisposableSubscriptionContainer;Lru/solrudev/ackpine/session/Session$StateListener;)Lru/solrudev/ackpine/DisposableSubscription;
+	public fun cancel ()V
+	public fun commit ()Z
+	public final fun getController ()Lru/solrudev/ackpine/test/TestSessionController;
+	public fun getId ()Ljava/util/UUID;
+	public final fun getState ()Lru/solrudev/ackpine/session/Session$State;
+	public final fun getStateHistory ()Ljava/util/List;
+	public fun isActive ()Z
+	public fun isCancelled ()Z
+	public fun isCompleted ()Z
+	public fun launch ()Z
+	public fun removeStateListener (Lru/solrudev/ackpine/session/Session$StateListener;)V
+	public final fun reset ()V
+	public final fun reset (Lru/solrudev/ackpine/session/Session$State;)V
+	public fun reset (Lru/solrudev/ackpine/session/Session$State;Z)V
+	public static synthetic fun reset$default (Lru/solrudev/ackpine/test/TestSession;Lru/solrudev/ackpine/session/Session$State;ZILjava/lang/Object;)V
+}
+
+public final class ru/solrudev/ackpine/test/TestSessionController {
+	public synthetic fun <init> (Lru/solrudev/ackpine/test/TestSession;Lru/solrudev/ackpine/test/TestSessionScript;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun cancel ()Lru/solrudev/ackpine/test/TestSessionController;
+	public final fun fail (Lru/solrudev/ackpine/session/Failure;)Lru/solrudev/ackpine/test/TestSessionController;
+	public final fun getCancelCalls ()I
+	public final fun getCommitCalls ()I
+	public final fun getLaunchCalls ()I
+	public final fun resetCalls ()Lru/solrudev/ackpine/test/TestSessionController;
+	public final fun setProgress (Lru/solrudev/ackpine/session/Progress;)Lru/solrudev/ackpine/test/TestSessionController;
+	public final fun setState (Lru/solrudev/ackpine/session/Session$State;)Lru/solrudev/ackpine/test/TestSessionController;
+	public final fun succeed ()Lru/solrudev/ackpine/test/TestSessionController;
+}
+
+public final class ru/solrudev/ackpine/test/TestSessionScript {
+	public static final field Companion Lru/solrudev/ackpine/test/TestSessionScript$Companion;
+	public static final fun auto (Lru/solrudev/ackpine/session/Session$State$Terminal;)Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun clear ()Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun clearCancel ()Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun clearCommit ()Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun clearLaunch ()Lru/solrudev/ackpine/test/TestSessionScript;
+	public static final fun empty ()Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun onCancel (Lru/solrudev/ackpine/session/Session$State;)Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun onCommit ([Lru/solrudev/ackpine/session/Session$State;)Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun onLaunch ([Lru/solrudev/ackpine/session/Session$State;)Lru/solrudev/ackpine/test/TestSessionScript;
+}
+
+public final class ru/solrudev/ackpine/test/TestSessionScript$Companion {
+	public final fun auto (Lru/solrudev/ackpine/session/Session$State$Terminal;)Lru/solrudev/ackpine/test/TestSessionScript;
+	public final fun empty ()Lru/solrudev/ackpine/test/TestSessionScript;
+}
+
+public abstract interface class ru/solrudev/ackpine/test/TestUninstallSessionFactory {
+	public static final field Companion Lru/solrudev/ackpine/test/TestUninstallSessionFactory$Companion;
+	public abstract fun create (Ljava/util/UUID;Lru/solrudev/ackpine/uninstaller/parameters/UninstallParameters;)Lru/solrudev/ackpine/test/TestSession;
+}
+
+public final class ru/solrudev/ackpine/test/TestUninstallSessionFactory$Companion {
+}
+
+public final class ru/solrudev/ackpine/test/futures/ImmediateFuture : com/google/common/util/concurrent/ListenableFuture {
+	public static final field Companion Lru/solrudev/ackpine/test/futures/ImmediateFuture$Companion;
+	public synthetic fun <init> (Ljava/lang/Object;Ljava/lang/Throwable;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun addListener (Ljava/lang/Runnable;Ljava/util/concurrent/Executor;)V
+	public fun cancel (Z)Z
+	public static final fun failure (Ljava/lang/Throwable;)Lru/solrudev/ackpine/test/futures/ImmediateFuture;
+	public fun get ()Ljava/lang/Object;
+	public fun get (JLjava/util/concurrent/TimeUnit;)Ljava/lang/Object;
+	public fun isCancelled ()Z
+	public fun isDone ()Z
+	public static final fun success (Ljava/lang/Object;)Lru/solrudev/ackpine/test/futures/ImmediateFuture;
+}
+
+public final class ru/solrudev/ackpine/test/futures/ImmediateFuture$Companion {
+	public final fun failure (Ljava/lang/Throwable;)Lru/solrudev/ackpine/test/futures/ImmediateFuture;
+	public final fun success (Ljava/lang/Object;)Lru/solrudev/ackpine/test/futures/ImmediateFuture;
+}
+

ackpine-test/build.gradle.kts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2026 Ilya Fomichev
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+description = "Testing utilities for Ackpine"
+
+plugins {
+	id("ru.solrudev.ackpine.library")
+	id("ru.solrudev.ackpine.library-publish")
+	id("ru.solrudev.ackpine.dokka")
+}
+
+ackpine {
+	id = "test"
+	artifact {
+		name = "Ackpine Test"
+		inceptionYear = "2026"
+	}
+}
+
+dependencies {
+	api(projects.ackpineApi.apiMain)
+}

ackpine-test/src/main/kotlin/ru/solrudev/ackpine/SdkInt.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2026 Ilya Fomichev
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ru.solrudev.ackpine
+
+import ru.solrudev.ackpine.test.TestSdkInt
+
+@Suppress("Unused")
+internal object SdkInt {
+	@JvmSynthetic
+	@JvmName("get")
+	fun get() = TestSdkInt.get()
+}