ISSUE-88: Update documentation

ndtp · Mar 25, 2024 · ec7f4ce · ec7f4ce
1 parent 3e1a8d0
commit ec7f4ce
Show file tree

Hide file tree

Showing 68 changed files with 1,518 additions and 333 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@
 
 ### Legacy Sample
 
+#### Added
+
 - Added tests demonstrating the usage of ScreenshotScenarioRule.
 
 ### Flix Sample

diff --git a/Ext/Compose/src/main/java/dev/testify/compose/exception/ComposeContainerNotFoundException.kt b/Ext/Compose/src/main/java/dev/testify/compose/exception/ComposeContainerNotFoundException.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Ext/Compose/src/main/java/dev/testify/compose/scenario/LaunchComposableTestActivity.kt b/Ext/Compose/src/main/java/dev/testify/compose/scenario/LaunchComposableTestActivity.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Ext/Fullscreen/src/main/java/dev/testify/capture/fullscreen/FullscreenCaptureMethod.kt b/Ext/Fullscreen/src/main/java/dev/testify/capture/fullscreen/FullscreenCaptureMethod.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2022 ndtp
+ * Copyright (c) 2022-2024 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

diff --git a/Library/build.gradle b/Library/build.gradle
@@ -36,6 +36,7 @@ android {
         multiDexEnabled = true
         kotlinOptions {
             allWarningsAsErrors = true
+            freeCompilerArgs = [ "-Xcontext-receivers" ]
         }
     }
 

diff --git a/Library/src/androidTest/java/dev/testify/ScreenshotRuleLifecycleTest.kt b/Library/src/androidTest/java/dev/testify/ScreenshotRuleLifecycleTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2024 ndtp
  * Original work copyright (c) 2021 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/Library/src/androidTest/java/dev/testify/scenario/ScenarioRuleAnnotationTest.kt b/Library/src/androidTest/java/dev/testify/scenario/ScenarioRuleAnnotationTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/androidTest/java/dev/testify/scenario/ScenarioRuleAssertExpectedDeviceTest.kt b/Library/src/androidTest/java/dev/testify/scenario/ScenarioRuleAssertExpectedDeviceTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/androidTest/java/dev/testify/scenario/ScenarioRuleExceptionTest.kt b/Library/src/androidTest/java/dev/testify/scenario/ScenarioRuleExceptionTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/androidTest/java/dev/testify/scenario/ScenarioTestRuleLifecycleTest.kt b/Library/src/androidTest/java/dev/testify/scenario/ScenarioTestRuleLifecycleTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/androidTest/java/dev/testify/scenario/ScreenshotScenarioLifecycleTest.kt b/Library/src/androidTest/java/dev/testify/scenario/ScreenshotScenarioLifecycleTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2022 ndtp
+ * Copyright (c) 2024 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
@@ -70,8 +70,8 @@ class ScreenshotScenarioLifecycleTest {
             }
 
             assertEquals(6, observer.log.size)
-            assertEquals("applyConfiguration", observer.log[0])
-            assertEquals("beforeAssertSame", observer.log[1])
+            assertEquals("beforeAssertSame", observer.log[0])
+            assertEquals("applyConfiguration", observer.log[1])
             assertEquals("beforeInitializeView", observer.log[2])
             assertEquals("afterInitializeView", observer.log[3])
             assertEquals("beforeScreenshot", observer.log[4])

diff --git a/Library/src/androidTest/java/dev/testify/scenario/ScreenshotScenarioRuleDefaultTest.kt b/Library/src/androidTest/java/dev/testify/scenario/ScreenshotScenarioRuleDefaultTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/main/java/dev/testify/ScreenshotRule.kt b/Library/src/main/java/dev/testify/ScreenshotRule.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2024 ndtp
  * Original work copyright (c) 2019 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -398,7 +398,6 @@ open class ScreenshotRule<T : Activity> @JvmOverloads constructor(
     /**
      * The [Statement] to be executed by the [ScreenshotStatement].
      */
-    @VisibleForTesting
     internal var statement: Statement? = null
 
     /**

diff --git a/Library/src/main/java/dev/testify/core/TestifyConfiguration.kt b/Library/src/main/java/dev/testify/core/TestifyConfiguration.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2022 ndtp
+ * Copyright (c) 2022-2024 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

diff --git a/Library/src/main/java/dev/testify/core/exception/IllegalScenarioException.kt b/Library/src/main/java/dev/testify/core/exception/IllegalScenarioException.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/main/java/dev/testify/core/exception/MissingAssertSameException.kt b/Library/src/main/java/dev/testify/core/exception/MissingAssertSameException.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2024 ndtp
  * Original work copyright (c) 2020 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/...ry/src/main/java/dev/testify/core/exception/NoResourceConfigurationOnScenarioException.kt b/...ry/src/main/java/dev/testify/core/exception/NoResourceConfigurationOnScenarioException.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/main/java/dev/testify/core/exception/ScenarioRequiredException.kt b/Library/src/main/java/dev/testify/core/exception/ScenarioRequiredException.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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

diff --git a/Library/src/main/java/dev/testify/core/logic/AssertSame.kt b/Library/src/main/java/dev/testify/core/logic/AssertSame.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2023-2024 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
@@ -173,15 +173,15 @@ internal fun <TActivity : Activity> assertSame(
 
             if (TestifyFeatures.GenerateDiffs.isEnabled(activity)) {
                 HighContrastDiff
-                    .create(configuration.exclusionRects) // TODO: Test me
+                    .create(configuration.exclusionRects)
                     .name(outputFileName)
                     .baseline(baselineBitmap)
                     .current(currentBitmap)
                     .exactness(configuration.exactness)
                     .generate(context = activity)
             }
             if (isRecordMode) {
-                TestInstrumentationRegistry.instrumentationPrintln( // TODO: Test me
+                TestInstrumentationRegistry.instrumentationPrintln(
                     "\n\t✓ " + "Recording baseline for ${description.name}".cyan()
                 )
             } else {

diff --git a/Library/src/main/java/dev/testify/internal/helpers/EspressoHelper.kt b/Library/src/main/java/dev/testify/internal/helpers/EspressoHelper.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2022 ndtp
+ * Copyright (c) 2022-2024 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

diff --git a/Library/src/main/java/dev/testify/internal/helpers/ResourceWrapper.kt b/Library/src/main/java/dev/testify/internal/helpers/ResourceWrapper.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2024 ndtp
  * Original work copyright (c) 2020 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/Library/src/main/java/dev/testify/scenario/ScreenshotScenarioRule.kt b/Library/src/main/java/dev/testify/scenario/ScreenshotScenarioRule.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2024 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
@@ -56,7 +56,6 @@ import dev.testify.core.exception.ScreenshotIsDifferentException
 import dev.testify.core.logic.AssertionState
 import dev.testify.core.logic.ScreenshotLifecycleHost
 import dev.testify.core.logic.ScreenshotLifecycleObserver
-import dev.testify.internal.extensions.TestInstrumentationRegistry.instrumentationPrintln
 import dev.testify.internal.extensions.isInvokedFromPlugin
 import dev.testify.internal.helpers.ActivityProvider
 import dev.testify.internal.helpers.closeSoftKeyboard
@@ -68,6 +67,9 @@ import org.junit.rules.TestRule
 import org.junit.rules.TestWatcher
 import org.junit.runner.Description
 import org.junit.runners.model.Statement
+import kotlin.contracts.ExperimentalContracts
+import kotlin.contracts.InvocationKind
+import kotlin.contracts.contract
 
 /**
  * ScreenshotScenarioRule is one of the main entry point for Testify.
@@ -189,7 +191,7 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      *    @ScreenshotInstrumentation
      *    @Test
      *    fun default() {
-     *        launchActivity<TestLocaleHarnessActivity>().use { scenario ->
+     *        launchActivity<TestHarnessActivity>().use { scenario ->
      *            rule
      *                .withScenario(scenario)
      *                .assertSame()
@@ -217,7 +219,7 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      *     @ScreenshotInstrumentation
      *     @Test
      *     fun default() {
-     *         launchActivity<TestLocaleHarnessActivity>().use { scenario ->
+     *         launchActivity<TestHarnessActivity>().use { scenario ->
      *             rule
      *                 .withScenario(scenario)
      *                 .setViewModifications { harnessRoot ->
@@ -247,7 +249,7 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      *     @ScreenshotInstrumentation
      *     @Test
      *     fun setScreenshotViewProvider() {
-     *         launchActivity<TestLocaleHarnessActivity>().use { scenario ->
+     *         launchActivity<TestHarnessActivity>().use { scenario ->
      *             rule
      *                 .withScenario(scenario)
      *                 .setScreenshotViewProvider {
@@ -273,7 +275,7 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      *     @ScreenshotInstrumentation
      *     @Test
      *     fun testConfigure() {
-     *         launchActivity<TestLocaleHarnessActivity>().use { scenario ->
+     *         launchActivity<TestHarnessActivity>().use { scenario ->
      *             rule
      *                 .withScenario(scenario)
      *                 .configure {
@@ -344,7 +346,6 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
         testClass: Class<*>,
         methodAnnotations: Collection<Annotation>?
     ) {
-        instrumentationPrintln("apply")
         val classAnnotations = testClass.annotations.asList()
         assertForScreenshotInstrumentationAnnotation(
             methodName,
@@ -454,7 +455,6 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      */
     @CallSuper
     override fun beforeAssertSame() {
-        instrumentationPrintln("beforeAssertSame")
         getInstrumentation().registerActivityProvider(this)
 
         // Called after configuration has been set
@@ -477,7 +477,7 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      *     @ScreenshotInstrumentation
      *     @Test
      *     fun default() {
-     *         launchActivity<TestLocaleHarnessActivity>().use { scenario ->
+     *         launchActivity<TestHarnessActivity>().use { scenario ->
      *             rule
      *                 .configure {
      *                     exactness = 0.95f
@@ -494,6 +494,20 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
             throw ScenarioRequiredException()
         }
 
+        scenario?.let {
+            assertSame(it)
+        } ?: throw ScenarioRequiredException()
+    }
+
+    context (ActivityScenario<*>)
+    @JvmName("assertSameContext")
+    fun assertSame() {
+        assertSame(this@ActivityScenario)
+    }
+
+    private fun assertSame(scenario: ActivityScenario<*>) {
+        this.scenario = scenario
+
         addScreenshotObserver(this)
 
         try {
@@ -533,9 +547,6 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      * Called by the [ScreenshotStatement] before each test method is executed.
      */
     protected fun evaluateBeforeEach() {
-
-        instrumentationPrintln("evaluateBeforeEach")
-
         getInstrumentation()?.run {
             reporter?.identifySession(this)
         }
@@ -555,8 +566,6 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
      * Called by the [ScreenshotStatement] after each test method is executed.
      */
     protected fun evaluateAfterEach() {
-        instrumentationPrintln("evaluateAfterEach")
-
         /**
          * Only throw the MissingAssertSameException if the test is a screenshot test.
          * This allows the user to run the test as a normal JUnit test without having to call assertSame.
@@ -610,3 +619,11 @@ open class ScreenshotScenarioRule @JvmOverloads constructor(
         notifyObservers { it.applyConfiguration(getActivity(), configuration) }
     }
 }
+
+@OptIn(ExperimentalContracts::class)
+inline fun <T : ActivityScenario<A>, A : Activity> T.test(block: T.(T) -> Unit) {
+    contract {
+        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
+    }
+    this.block(this)
+}
diff --git a/Library/src/test/java/dev/testify/ScreenshotRuleTest.kt b/Library/src/test/java/dev/testify/ScreenshotRuleTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2023-2024 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

diff --git a/Library/src/test/java/dev/testify/core/exception/ErrorCauseTest.kt b/Library/src/test/java/dev/testify/core/exception/ErrorCauseTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Modified work copyright (c) 2022 ndtp
+ * Modified work copyright (c) 2022-2024 ndtp
  * Original work copyright (c) 2021 Shopify Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/Library/src/test/java/dev/testify/internal/helpers/ResourceWrapperTest.kt b/Library/src/test/java/dev/testify/internal/helpers/ResourceWrapperTest.kt
@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2023 ndtp
+ * Copyright (c) 2023-2024 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