148: Refactor output path into Destination

CHANGELOG.md

@@ -27,9 +27,16 @@
 
 ### Library
 
+#### Changed
+
+- Internal file management is now abstracted through the new `Destination` interface.
+    This interface allows for extensibility and customization of the file handling. It is backwards compatible with
+    the existing SDCard and app data/data directory options.
+
 #### Bug fixes
 
 - Fix https://github.com/ndtp/android-testify/issues/81: `reportShow` and `reportPull` now support Gradle 7+.
+- Exceptions now correctly report the gradle module name of the source of the error.
 
 #### Added
 

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

@@ -32,8 +32,8 @@ import dev.testify.internal.DeviceStringFormatter
 import dev.testify.internal.formatDeviceString
 import dev.testify.internal.getDeviceDescription
 import dev.testify.internal.helpers.loadAsset
-import dev.testify.internal.output.getFileRelativeToRoot
-import dev.testify.internal.output.getOutputFilePath
+import dev.testify.output.getDestination
+import dev.testify.output.getFileRelativeToRoot
 import dev.testify.testDescription
 import java.io.File
 import java.io.InputStreamReader
@@ -74,8 +74,12 @@ private fun getOutputFile(context: Context, description: TestDescription): File
         ),
         DEFAULT_NAME_FORMAT
     )
-    val outputPath = getOutputFilePath(context, fileName, JSON_EXTENSION)
-    return File(outputPath)
+    val destination = getDestination(
+        context = context,
+        fileName = fileName,
+        extension = JSON_EXTENSION
+    )
+    return destination.file
 }
 
 private const val JSON_EXTENSION = ".a11y.json"

Ext/Fullscreen/src/main/java/dev/testify/capture/fullscreen/FullscreenCaptureMethod.kt

@@ -27,24 +27,19 @@ import android.app.Activity
 import android.content.Context
 import android.graphics.Bitmap
 import android.view.View
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
 import androidx.test.uiautomator.UiDevice
 import dev.testify.ScreenshotRule
 import dev.testify.exception.FailedToCaptureFullscreenBitmapException
 import dev.testify.exception.FailedToLoadCapturedBitmapException
 import dev.testify.internal.DEFAULT_NAME_FORMAT
 import dev.testify.internal.DeviceStringFormatter
-import dev.testify.internal.exception.ScreenshotDirectoryNotFoundException
 import dev.testify.internal.formatDeviceString
-import dev.testify.internal.output.getOutputDirectoryPath
-import dev.testify.internal.output.getOutputFilePath
-import dev.testify.internal.output.useSdCard
-import dev.testify.testDescription
-import java.io.File
-import dev.testify.assureScreenshotDirectory
 import dev.testify.loadBitmapFromFile
+import dev.testify.output.Destination
+import dev.testify.output.getDestination
 import dev.testify.preferredBitmapOptions
+import dev.testify.testDescription
 
 /**
  * Use the UiAutomator's built-in screenshotting capability to capture a [Bitmap] of the entire device.
@@ -69,12 +64,14 @@ import dev.testify.preferredBitmapOptions
  */
 @Suppress("UNUSED_PARAMETER")
 fun fullscreenCapture(activity: Activity, targetView: View?): Bitmap {
-    activity.assureScreenshotDirectory()
 
-    val instrumentation = InstrumentationRegistry.getInstrumentation()
+    val instrumentation = getInstrumentation()
     val fileName = getFileName(instrumentation.context)
-    val outputPath = getOutputFilePath(activity, fileName)
-    val file = File(outputPath)
+    val destination = getDestination(activity, fileName)
+
+    destination.assureScreenshotDirectory(activity)
+
+    val file = destination.file
 
     // Use UiAutomator to take a screenshot
     val device = UiDevice.getInstance(instrumentation)
@@ -85,22 +82,19 @@ fun fullscreenCapture(activity: Activity, targetView: View?): Bitmap {
      * The screenshot is written as a PNG to [file] on the emulator. We can use [loadBitmapFromFile]
      * to load it from a file into memory as a [Bitmap].
      */
-    return loadBitmapFromFile(outputPath, preferredBitmapOptions)
+
+    return destination.loadBitmap(preferredBitmapOptions)
         ?: throw FailedToLoadCapturedBitmapException()
 }
 
 /**
  * Make sure the directory used to save Bitmaps on the device is valid and available.
  *
- * @throws ScreenshotDirectoryNotFoundException
+ * @throws Exception
  */
-private fun Context.assureScreenshotDirectory() {
-    if (assureScreenshotDirectory(this)) return
-
-    throw ScreenshotDirectoryNotFoundException(
-        useSdCard = useSdCard(InstrumentationRegistry.getArguments()),
-        path = getOutputDirectoryPath(this).absolutePath
-    )
+private fun Destination.assureScreenshotDirectory(context: Context) {
+    if (this.assureDestination(context)) return
+    throw this.getScreenshotDestinationNotFoundException()
 }
 
 /**

Library/src/androidTest/java/dev/testify/ScreenshotUtilityTest.kt

@@ -29,15 +29,14 @@ package dev.testify
 import android.view.View
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.rule.ActivityTestRule
-import dev.testify.internal.output.getOutputFilePath
 import dev.testify.internal.processor.capture.createBitmapFromDrawingCache
+import dev.testify.output.getDestination
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertTrue
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
-import java.io.File
 
 @RunWith(AndroidJUnit4::class)
 class ScreenshotUtilityTest {
@@ -57,8 +56,8 @@ class ScreenshotUtilityTest {
     fun createBitmapFromActivity() {
         val activity = testActivityRule.activity
         val rootView = activity.findViewById<View>(R.id.test_root_view)
-        val outputFilePath = getOutputFilePath(activity, "testing")
-        val bitmapFile = File(outputFilePath)
+        val destination = getDestination(context = activity, fileName = "testing")
+        val bitmapFile = destination.file
 
         val capturedBitmap = createBitmapFromActivity(
             activity = activity,
@@ -77,10 +76,10 @@ class ScreenshotUtilityTest {
         createBitmapFromActivity()
 
         val fileName = "testing"
-        val outputFilePath = getOutputFilePath(activity, fileName)
+        val destination = getDestination(context = activity, fileName = fileName)
 
-        deleteBitmap(activity, fileName)
-        val fileThatShouldBeDeleted = File(outputFilePath)
+        deleteBitmap(destination)
+        val fileThatShouldBeDeleted = destination.file
         assertFalse(fileThatShouldBeDeleted.exists())
     }
 }

Library/src/main/AndroidManifest.xml

@@ -4,6 +4,14 @@
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 
-    <application />
+    <application>
+        <meta-data
+            android:name="dev.testify.destination"
+            android:value="@string/testifyDestination" />
+
+        <meta-data
+            android:name="dev.testify.module"
+            android:value="@string/testifyModule" />
+    </application>
 
 </manifest>

Library/src/main/java/dev/testify/ScreenshotRule.kt

@@ -26,6 +26,7 @@
 
 package dev.testify
 
+import android.annotation.SuppressLint
 import android.app.Activity
 import android.content.Context
 import android.content.Intent
@@ -73,13 +74,13 @@ import dev.testify.internal.helpers.EspressoActions
 import dev.testify.internal.helpers.EspressoHelper
 import dev.testify.internal.helpers.ResourceWrapper
 import dev.testify.internal.helpers.registerActivityProvider
-import dev.testify.internal.output.doesOutputFileExist
 import dev.testify.internal.processor.capture.canvasCapture
 import dev.testify.internal.processor.capture.createBitmapFromDrawingCache
 import dev.testify.internal.processor.capture.pixelCopyCapture
 import dev.testify.internal.processor.compare.FuzzyCompare
 import dev.testify.internal.processor.compare.sameAsCompare
 import dev.testify.internal.processor.diff.HighContrastDiff
+import dev.testify.output.getDestination
 import dev.testify.report.ReportSession
 import dev.testify.report.Reporter
 import org.junit.Assert.assertTrue
@@ -154,9 +155,6 @@ open class ScreenshotRule<T : Activity> @JvmOverloads constructor(
         }
     }
 
-    val outputFileExists: Boolean
-        get() = doesOutputFileExist(activity, outputFileName)
-
     private fun isRunningOnUiThread(): Boolean {
         return Looper.getMainLooper().thread == Thread.currentThread()
     }
@@ -298,6 +296,7 @@ open class ScreenshotRule<T : Activity> @JvmOverloads constructor(
 
     @get:LayoutRes
     private val TestifyLayout.resolvedLayoutId: Int
+        @SuppressLint("DiscouragedApi")
         get() {
             if (this.layoutResName.isNotEmpty()) {
                 return getInstrumentation().targetContext.resources?.getIdentifier(layoutResName, null, null)
@@ -562,7 +561,7 @@ open class ScreenshotRule<T : Activity> @JvmOverloads constructor(
                 if (compareBitmaps(baselineBitmap, currentBitmap)) {
                     assertTrue(
                         "Could not delete cached bitmap ${description.name}",
-                        deleteBitmap(activity, outputFileName)
+                        deleteBitmap(getDestination(activity, outputFileName))
                     )
                 } else {
                     if (TestifyFeatures.GenerateDiffs.isEnabled(activity)) {