Migrate helper classes and extensions to Ktx library

Author: DanielJette

CHANGELOG.md

@@ -1,3 +1,13 @@
+## 5.0.0
+
+- https://github.com/ndtp/android-testify/pull/XXX
+    - `dev.testify.internal.extensions.cyan` moved to `dev.testify.extensions.cyan`
+    - Java interop for `findAnnotation` method is now available from `AnnotationExtensionsKtx`
+    - Java interop for `instrumentationPrintln` method is now available from `InstrumentationRegistryExtensionsKt`
+    - Java interop for `getModuleName` method is now available from `InstrumentationRegistryExtensionsKt`
+    - `fun Context.updateLocale(locale: Locale?): Context` is now public
+    - `fun getMetaDataBundle(context: Context): Bundle?` is now public
+
 ## 4.0.0
 
 - https://github.com/ndtp/android-testify/pull/266 Updated to Kotlin 2.2

Ext/Accessibility/src/main/java/dev/testify/accessibility/internal/AccessibilityScreenshotLifecycleObserver.kt

@@ -35,10 +35,10 @@ import com.google.android.apps.common.testing.accessibility.framework.Accessibil
 import com.google.android.apps.common.testing.accessibility.framework.uielement.AccessibilityHierarchyAndroid
 import dev.testify.ScreenshotLifecycle
 import dev.testify.accessibility.exception.AccessibilityErrorsException
+import dev.testify.extensions.cyan
 import dev.testify.internal.extensions.TestInstrumentationRegistry
 import dev.testify.internal.extensions.TestInstrumentationRegistry.instrumentationPrintln
 import dev.testify.internal.extensions.TestInstrumentationRegistry.isRecordMode
-import dev.testify.internal.extensions.cyan
 import dev.testify.testDescription
 import java.util.Locale
 

Ext/Ktx/README.md

@@ -1,20 +1,18 @@
-# Testify — Android Screenshot Testing — Fullscreen capture method
+# Testify — Android Screenshot Testing — Kotlin Extensions
 
-<a href="https://search.maven.org/artifact/dev.testify/testify-fullscreen"><img alt="Maven Central" src="https://img.shields.io/maven-central/v/dev.testify/testify-fullscreen?color=%236e40ed&label=dev.testify%3Atestify-fullscreen"/></a>
+<a href="https://search.maven.org/artifact/dev.testify/testify-kts"><img alt="Maven Central" src="https://img.shields.io/maven-central/v/dev.testify/testify-ktx?color=%236e40ed&label=dev.testify%3Atestify-ktx"/></a>
 
-**Capture the entire device screen, including system UI, dialogs and menus.**
+**Kotlin extensions for Android Testify, providing more idiomatic and helper APIs to work with screenshot testing in Android.**
 
-Use the [UiAutomator's](https://developer.android.com/training/testing/other-components/ui-automator) built-in [screenshotting](https://developer.android.com/reference/androidx/test/uiautomator/UiDevice#takescreenshot) capability to capture a [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap) of the entire device.
+The new KTX library packages up a set of foundational utilities that originally lived deep inside Testify’s screenshot testing engine. These components are broadly useful for any instrumentation test suite. By extracting and stabilizing these internals, the library provides a standalone toolkit that improves the reliability, predictability, and ergonomics of your androidTest environment, even if you never call a screenshot API.
 
-The bitmap will be generated from a PNG at 1:1 scale and 100% quality. The bitmap's size will match the full device resolution and include all system UI such as the status bar and navigation bar.
+Why Use Testify KTX?
 
-As the system UI content is highly variable, you can use [ScreenshotRule.excludeStatusBar](./src/main/java/dev/testify/capture/fullscreen/provider/StatusBarExclusionRectProvider.kt) and/or [ScreenshotRule.excludeNavigationBar](./src/main/java/dev/testify/capture/fullscreen/provider/NavigationBarExclusionRectProvider.kt) to ignore the status bar and navigation bar, respectively.
+- Adds idiomatic Kotlin helpers around core Testify APIs, reducing boilerplate.
+- Provides a simplified set of file I/O utilities for files on the emulator SD card, `data/data` directory, or Test Storage.
+- Includes utilities for working with annotations, device identification, and test instrumentation.
 
-Though the PNG is intended to be lossless, some compression artifacts or GPU-related variance can occur. As such, it is recommended to use a small tolerance when capturing fullscreen images.
-
-You can set a comparison tolerance using [ScreenshotRule.setExactness](../../Library/src/main/java/dev/testify/ScreenshotRule.kt).
-
-# Set up testify-fullscreen
+# Set up testify-ktx
 
 **Root build.gradle**
 
@@ -31,43 +29,20 @@ Ensure that `mavenCentral()` is available to both `pluginManagement` and `depend
 **Application build.gradle**
 ```groovy
 dependencies {
-    androidTestImplementation "dev.testify:testify-fullscreen:3.2.3"
+    androidTestImplementation "dev.testify:testify-ktx:3.2.3"
 }
 ```
 
-# Write a test
-
-In order to capture the full device screen, you must set the capture method on `ScreenshotRule` to `fullscreenCapture()`.
-You can do this with either `setCaptureMethod(::fullscreenCapture)` or the helper extension method `captureFullscreen()`.
-
-Additonal examples can be found in [FullscreenCaptureExampleTest.kt](../../Samples/Legacy/src/androidTest/java/dev/testify/sample/FullscreenCaptureExampleTests.kt).
-
-```kotlin
-class FullscreenCaptureTest {
+# Included API
 
-    @get:Rule
-    var rule = ScreenshotRule(MainActivity::class.java)
-
-    @ScreenshotInstrumentation
-    @Test
-    fun fullscreen() {
-        rule
-            .captureFullscreen()    // Set the fullscreen capture method
-            .excludeSystemUi()      // Exclude the navigation bar and status bar areas from the comparison
-            .setExactness(0.95f)    // Allow a 5% variation in color
-            .assertSame()
-    }
-}
-
-```
 
 ---
 
 # License
 
     MIT License
 
-    Copyright (c) 2022 ndtp
+    Copyright (c) 2025 ndtp
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

Ext/Ktx/build.gradle

@@ -2,6 +2,8 @@ plugins {
     id 'com.android.library'
     id 'kotlin-android'
     id 'org.jetbrains.dokka'
+    id 'maven-publish'
+    id 'signing'
 }
 
 ext {
@@ -74,6 +76,7 @@ android {
         implementation libs.androidx.rules
         implementation libs.androidx.uiautomator
         implementation libs.core.ktx
+        implementation libs.androidx.test.storage
     }
 
     publishing {
@@ -88,5 +91,3 @@ android {
 afterEvaluate {
     apply from: "../../publish.build.gradle"
 }
-
-apply from: '../../ktlint.gradle'

Library/src/main/java/dev/testify/CaptureMethod.kt renamed to Ext/Ktx/src/main/java/dev/testify/CaptureMethod.kt

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2022 ndtp
+ * Copyright (c) 2022-2025 ndtp
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

Library/src/main/java/dev/testify/ScreenshotUtility.kt renamed to Ext/Ktx/src/main/java/dev/testify/ScreenshotUtility.kt

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2025 ndtp
  * Original work copyright (c) 2019 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -60,7 +60,7 @@ val preferredBitmapOptions: BitmapFactory.Options
  *
  * @param context The [Context] to use when writing the bitmap to disk.
  * @param bitmap The [Bitmap] to write to disk. If null, this function will return false.
- * @param destination The [Destination] to write the bitmap to.
+ * @param destination The [dev.testify.output.Destination] to write the bitmap to.
  *
  * @throws Exception if the destination cannot be found.
  *
@@ -130,7 +130,7 @@ fun loadBaselineBitmapForComparison(
  *
  * @param activity The [Activity] instance to capture.
  * @param fileName The name to use when writing the captured image to disk.
- * @param captureMethod a [CaptureMethod] that will return a [Bitmap] from the provided [Activity] and [View]
+ * @param captureMethod a [dev.testify.CaptureMethod] that will return a [Bitmap] from the provided [Activity] and [View]
  * @param screenshotView A [View] found in the [activity]'s view hierarchy.
  *          If screenshotView is null, defaults to activity.window.decorView.
  *
@@ -182,7 +182,7 @@ fun loadBitmapFromFile(outputPath: String, preferredBitmapOptions: BitmapFactory
 /**
  * Delete the Bitmap [File] specified by [destination].
  *
- * @param destination The [Destination] to delete.
+ * @param destination The [dev.testify.output.Destination] to delete.
  *
  * @return true if the file was successfully deleted, false otherwise.
  */

Ext/Ktx/src/main/java/dev/testify/annotation/AnnotationExtensions.kt

@@ -0,0 +1,61 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2025 ndtp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+@file:JvmName("AnnotationExtensionsKtx")
+package dev.testify.annotation
+
+/**
+ * Find the first [Annotation] in the given [Collection] which is of type [T]
+ *
+ * @return Annotation of type T
+ */
+inline fun <reified T : Annotation> Collection<Annotation>.findAnnotation(): T? =
+    this.find { it is T } as? T
+
+/**
+ * Find the first [Annotation] in the given [Collection] which is of type [T]
+ *
+ * @return Annotation of type T
+ */
+fun <T : Annotation> Collection<Annotation>.findAnnotation(clazz: Class<T>): T? =
+    this.find { clazz.isInstance(it) }?.let { clazz.cast(it) }
+
+/**
+ * Find the first [Annotation] in the given [Collection] which has the given [name]
+ *
+ * @param name - The qualified class name of the requested annotation
+ *
+ * @return Annotation of type T
+ */
+inline fun <reified T : Annotation> Collection<Annotation>.findAnnotation(name: String): T? =
+    this.find { it.annotationClass.qualifiedName == name } as? T
+
+/**
+ * Find the first [Annotation] in the given [Collection] which has the given [name]
+ *
+ * @param name - The qualified class name of the requested annotation
+ *
+ * @return Annotation of type T
+ */
+fun <T : Annotation> Collection<Annotation>.findAnnotation(name: String, clazz: Class<T>): T? =
+    this.find { it.annotationClass.qualifiedName == name && clazz.isInstance(it) }?.let { clazz.cast(it) }

Library/src/main/java/dev/testify/core/DeviceIdentifier.kt renamed to Ext/Ktx/src/main/java/dev/testify/core/DeviceIdentifier.kt

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2025 ndtp
  * Original work copyright (c) 2019 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -31,6 +31,7 @@ import android.view.WindowManager
 import dev.testify.internal.extensions.languageTag
 import dev.testify.internal.helpers.buildVersionSdkInt
 import java.util.Locale
+import kotlin.text.iterator
 
 /**
  * A typealias for the test class and test name.

Library/src/main/java/dev/testify/core/exception/RootViewNotFoundException.kt renamed to Ext/Ktx/src/main/java/dev/testify/core/exception/RootViewNotFoundException.kt

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2025 ndtp
  * Original work copyright (c) 2019 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy

Library/src/main/java/dev/testify/core/exception/TestifyException.kt renamed to Ext/Ktx/src/main/java/dev/testify/core/exception/TestifyException.kt

@@ -1,7 +1,8 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Modified work copyright (c) 2022-2025 ndtp
+ * Original work copyright (c) 2019 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal