Increase screenshot test coverage to include landscape orientation an…

…d an action bar
saket · Oct 7, 2023 · 696c69b · 696c69b
1 parent 9c726c2
commit 696c69b
Show file tree

Hide file tree

Showing 56 changed files with 77 additions and 25 deletions.
diff --git a/cascade-compose/src/androidTest/kotlin/me/saket/cascade/CascadePopupAlignmentTest.kt b/cascade-compose/src/androidTest/kotlin/me/saket/cascade/CascadePopupAlignmentTest.kt
@@ -2,8 +2,11 @@
 
 package me.saket.cascade
 
+import android.content.pm.ActivityInfo
 import android.graphics.Bitmap
+import android.view.WindowInsets
 import android.view.WindowManager
+import androidx.appcompat.app.AppCompatActivity
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.fillMaxSize
@@ -48,13 +51,16 @@ import com.dropbox.dropshots.Dropshots
 import com.dropbox.dropshots.ThresholdValidator
 import com.google.testing.junit.testparameterinjector.TestParameter
 import com.google.testing.junit.testparameterinjector.TestParameterInjector
+import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.TestName
 import org.junit.runner.RunWith
 
 @RunWith(TestParameterInjector::class)
-internal class CascadePopupAlignmentTest {
+internal class CascadePopupAlignmentTest(
+  @TestParameter private val showActionBar: ShowActionBarParam,
+) {
   @get:Rule val composeTestRule = createAndroidComposeRule<TestActivity>()
   @get:Rule val testName = TestName()
   @get:Rule val dropshots = Dropshots(
@@ -67,7 +73,21 @@ internal class CascadePopupAlignmentTest {
   // FWIW shadows are already tested by CascadeDropdownMenuTest.
   private val shadowElevation = 0.dp
 
-  @Test fun canary() {
+  @Before
+  fun setUp() {
+    composeTestRule.activityRule.scenario.onActivity {
+      showActionBar.apply(it)
+    }
+  }
+
+  @Test fun canary(
+    @TestParameter orientation: OrientationParam
+  ) {
+    composeTestRule.activity.requestedOrientation = orientation.orientation
+    composeTestRule.runOnUiThread {
+      showActionBar.apply(composeTestRule.activity)
+    }
+
     composeTestRule.setContent {
       CascadeMaterialTheme {
         PopupScaffold {
@@ -84,7 +104,9 @@ internal class CascadePopupAlignmentTest {
         }
       }
     }
-    dropshots.assertDeviceSnapshot()
+
+    composeTestRule.waitForIdle()
+    dropshots.assertSnapshot(takeScreenshotWithoutSystemBars())
   }
 
   @Test fun size_given_to_cascade_should_be_correctly_applied_to_its_content() {
@@ -110,14 +132,14 @@ internal class CascadePopupAlignmentTest {
         }
       }
     }
-    dropshots.assertDeviceSnapshot()
+    dropshots.assertSnapshot(takeScreenshotWithoutSystemBars())
   }
 
   @Test fun alignment_of_popup_should_match_with_material3(
-    @TestParameter alignment: PopupAlignment,
-    @TestParameter useNoLimitsFlag: Boolean,
+    @TestParameter alignment: PopupAlignmentParam,
+    @TestParameter useNoLimits: UseNoLimitsLayoutFlag,
   ) {
-    if (useNoLimitsFlag) {
+    if (useNoLimits.useNoLimits) {
       composeTestRule.runOnUiThread {
         composeTestRule.activity.window.addFlags(WindowManager.LayoutParams.FLAG_LAYOUT_NO_LIMITS)
       }
@@ -157,7 +179,7 @@ internal class CascadePopupAlignmentTest {
         }
       }
     }
-    dropshots.assertDeviceSnapshot()
+    dropshots.assertSnapshot(takeScreenshotWithoutSystemBars())
   }
 
   @Test fun content_inside_popup_can_be_updated() {
@@ -184,7 +206,10 @@ internal class CascadePopupAlignmentTest {
 
     listOf(Red, Magenta, Blue, Cyan).forEachIndexed { num, nextColor ->
       color = nextColor
-      dropshots.assertDeviceSnapshot(nameSuffix = "[$num]")
+      dropshots.assertSnapshot(
+        bitmap = takeScreenshotWithoutSystemBars(),
+        name = testName.methodName + "_[$num]"
+      )
       composeTestRule.mainClock.advanceTimeByFrame()
     }
   }
@@ -219,7 +244,7 @@ internal class CascadePopupAlignmentTest {
         }
       }
     }
-    dropshots.assertDeviceSnapshot()
+    dropshots.assertSnapshot(takeScreenshotWithoutSystemBars())
   }
 
   @Test fun clicking_on_a_menu_item_opens_its_sub_menu() {
@@ -251,7 +276,7 @@ internal class CascadePopupAlignmentTest {
 
     composeTestRule.onNodeWithText("I just called").performClick()
     composeTestRule.waitForIdle()
-    dropshots.assertDeviceSnapshot()
+    dropshots.assertSnapshot(takeScreenshotWithoutSystemBars())
   }
 
   @Composable
@@ -276,32 +301,31 @@ internal class CascadePopupAlignmentTest {
   }
 
   /** Screenshots the entire device instead of just the active Activity's content. */
-  private fun Dropshots.assertDeviceSnapshot(nameSuffix: String? = null) {
+  private fun takeScreenshotWithoutSystemBars(): Bitmap {
     val screenshot: Bitmap = takeScreenshot()
 
+    val insets = composeTestRule.activity.window
+      .decorView.rootWindowInsets
+      .getInsets(WindowInsets.Type.systemBars())
+
     // The navigation bar's handle cross-fades its color smoothly and can
     // appear slightly different each time. Crop it out to affect screenshots.
     val navigationBarHeightInPx = composeTestRule.activity.resources.run {
       getDimensionPixelSize(getIdentifier("navigation_bar_height", "dimen", "android"))
     }
-    val screenshotWithoutNavBar: Bitmap = Bitmap.createBitmap(
-      /* source = */ screenshot,
-      /* x = */ 0,
-      /* y = */ 0,
-      /* width = */ screenshot.width,
-      /* height = */ screenshot.height - navigationBarHeightInPx
-    )
-
-    assertSnapshot(
-      bitmap = screenshotWithoutNavBar,
-      name = testName.methodName + (if (nameSuffix != null) "_$nameSuffix" else "")
+    return Bitmap.createBitmap(
+      screenshot,
+      insets.left,
+      insets.top,
+      screenshot.width - insets.left - insets.right,
+      screenshot.height - insets.top - insets.bottom
     )
   }
 }
 
 // These enums produce better test names than Alignment#toString().
 @Suppress("unused")
-enum class PopupAlignment(val alignment: Alignment) {
+enum class PopupAlignmentParam(val alignment: Alignment) {
   TopStart(Alignment.TopStart),
   TopCenter(Alignment.TopCenter),
   TopEnd(Alignment.TopEnd),
@@ -313,6 +337,34 @@ enum class PopupAlignment(val alignment: Alignment) {
   BottomEnd(Alignment.BottomEnd),
 }
 
+@Suppress("unused")
+enum class ShowActionBarParam(val show: Boolean) {
+  ShowActionBar(true),
+  HideActionBar(false),
+  ;
+
+  fun apply(activity: AppCompatActivity) {
+    activity.title = "cascade"
+    if (show) {
+      activity.supportActionBar!!.show()
+    } else {
+      activity.supportActionBar!!.hide()
+    }
+  }
+}
+
+@Suppress("unused")
+enum class UseNoLimitsLayoutFlag(val useNoLimits: Boolean) {
+  NoLimitsEnabled(true),
+  NoLimitsDisabled(false)
+}
+
+@Suppress("unused")
+enum class OrientationParam(val orientation: Int) {
+  Portrait(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT),
+  Landscape(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE)
+}
+
 @Composable
 fun CascadeMaterialTheme(content: @Composable () -> Unit) {
   val colors = lightColorScheme(

diff --git a/...ch_with_material3[BottomCenter,false].png → ...ionBar,BottomCenter,NoLimitsDisabled].png b/...ch_with_material3[BottomCenter,false].png → ...ionBar,BottomCenter,NoLimitsDisabled].png
diff --git a/...tch_with_material3[BottomCenter,true].png → ...tionBar,BottomCenter,NoLimitsEnabled].png b/...tch_with_material3[BottomCenter,true].png → ...tionBar,BottomCenter,NoLimitsEnabled].png
diff --git a/...match_with_material3[BottomEnd,false].png → ...ActionBar,BottomEnd,NoLimitsDisabled].png b/...match_with_material3[BottomEnd,false].png → ...ActionBar,BottomEnd,NoLimitsDisabled].png
diff --git a/..._match_with_material3[BottomEnd,true].png → ...eActionBar,BottomEnd,NoLimitsEnabled].png b/..._match_with_material3[BottomEnd,true].png → ...eActionBar,BottomEnd,NoLimitsEnabled].png
diff --git a/...tch_with_material3[BottomStart,false].png → ...tionBar,BottomStart,NoLimitsDisabled].png b/...tch_with_material3[BottomStart,false].png → ...tionBar,BottomStart,NoLimitsDisabled].png
diff --git a/...atch_with_material3[BottomStart,true].png → ...ctionBar,BottomStart,NoLimitsEnabled].png b/...atch_with_material3[BottomStart,true].png → ...ctionBar,BottomStart,NoLimitsEnabled].png
diff --git a/...ld_match_with_material3[Center,false].png → ...ideActionBar,Center,NoLimitsDisabled].png b/...ld_match_with_material3[Center,false].png → ...ideActionBar,Center,NoLimitsDisabled].png
diff --git a/...uld_match_with_material3[Center,true].png → ...HideActionBar,Center,NoLimitsEnabled].png b/...uld_match_with_material3[Center,true].png → ...HideActionBar,Center,NoLimitsEnabled].png
diff --git a/...match_with_material3[CenterEnd,false].png → ...ActionBar,CenterEnd,NoLimitsDisabled].png b/...match_with_material3[CenterEnd,false].png → ...ActionBar,CenterEnd,NoLimitsDisabled].png
diff --git a/..._match_with_material3[CenterEnd,true].png → ...eActionBar,CenterEnd,NoLimitsEnabled].png b/..._match_with_material3[CenterEnd,true].png → ...eActionBar,CenterEnd,NoLimitsEnabled].png
diff --git a/...tch_with_material3[CenterStart,false].png → ...tionBar,CenterStart,NoLimitsDisabled].png b/...tch_with_material3[CenterStart,false].png → ...tionBar,CenterStart,NoLimitsDisabled].png
diff --git a/...atch_with_material3[CenterStart,true].png → ...ctionBar,CenterStart,NoLimitsEnabled].png b/...atch_with_material3[CenterStart,true].png → ...ctionBar,CenterStart,NoLimitsEnabled].png
diff --git a/...match_with_material3[TopCenter,false].png → ...ActionBar,TopCenter,NoLimitsDisabled].png b/...match_with_material3[TopCenter,false].png → ...ActionBar,TopCenter,NoLimitsDisabled].png
diff --git a/..._match_with_material3[TopCenter,true].png → ...eActionBar,TopCenter,NoLimitsEnabled].png b/..._match_with_material3[TopCenter,true].png → ...eActionBar,TopCenter,NoLimitsEnabled].png
diff --git a/...ld_match_with_material3[TopEnd,false].png → ...ideActionBar,TopEnd,NoLimitsDisabled].png b/...ld_match_with_material3[TopEnd,false].png → ...ideActionBar,TopEnd,NoLimitsDisabled].png
diff --git a/...uld_match_with_material3[TopEnd,true].png → ...HideActionBar,TopEnd,NoLimitsEnabled].png b/...uld_match_with_material3[TopEnd,true].png → ...HideActionBar,TopEnd,NoLimitsEnabled].png
diff --git a/..._match_with_material3[TopStart,false].png → ...eActionBar,TopStart,NoLimitsDisabled].png b/..._match_with_material3[TopStart,false].png → ...eActionBar,TopStart,NoLimitsDisabled].png
diff --git a/...d_match_with_material3[TopStart,true].png → ...deActionBar,TopStart,NoLimitsEnabled].png b/...d_match_with_material3[TopStart,true].png → ...deActionBar,TopStart,NoLimitsEnabled].png
diff --git a/...up_should_match_with_material3[ShowActionBar,BottomCenter,NoLimitsDisabled].png b/...up_should_match_with_material3[ShowActionBar,BottomCenter,NoLimitsDisabled].png
diff --git a/...pup_should_match_with_material3[ShowActionBar,BottomCenter,NoLimitsEnabled].png b/...pup_should_match_with_material3[ShowActionBar,BottomCenter,NoLimitsEnabled].png
diff --git a/...popup_should_match_with_material3[ShowActionBar,BottomEnd,NoLimitsDisabled].png b/...popup_should_match_with_material3[ShowActionBar,BottomEnd,NoLimitsDisabled].png
diff --git a/..._popup_should_match_with_material3[ShowActionBar,BottomEnd,NoLimitsEnabled].png b/..._popup_should_match_with_material3[ShowActionBar,BottomEnd,NoLimitsEnabled].png
diff --git a/...pup_should_match_with_material3[ShowActionBar,BottomStart,NoLimitsDisabled].png b/...pup_should_match_with_material3[ShowActionBar,BottomStart,NoLimitsDisabled].png
diff --git a/...opup_should_match_with_material3[ShowActionBar,BottomStart,NoLimitsEnabled].png b/...opup_should_match_with_material3[ShowActionBar,BottomStart,NoLimitsEnabled].png
diff --git a/...of_popup_should_match_with_material3[ShowActionBar,Center,NoLimitsDisabled].png b/...of_popup_should_match_with_material3[ShowActionBar,Center,NoLimitsDisabled].png
diff --git a/..._of_popup_should_match_with_material3[ShowActionBar,Center,NoLimitsEnabled].png b/..._of_popup_should_match_with_material3[ShowActionBar,Center,NoLimitsEnabled].png
diff --git a/...popup_should_match_with_material3[ShowActionBar,CenterEnd,NoLimitsDisabled].png b/...popup_should_match_with_material3[ShowActionBar,CenterEnd,NoLimitsDisabled].png
diff --git a/..._popup_should_match_with_material3[ShowActionBar,CenterEnd,NoLimitsEnabled].png b/..._popup_should_match_with_material3[ShowActionBar,CenterEnd,NoLimitsEnabled].png
diff --git a/...pup_should_match_with_material3[ShowActionBar,CenterStart,NoLimitsDisabled].png b/...pup_should_match_with_material3[ShowActionBar,CenterStart,NoLimitsDisabled].png
diff --git a/...opup_should_match_with_material3[ShowActionBar,CenterStart,NoLimitsEnabled].png b/...opup_should_match_with_material3[ShowActionBar,CenterStart,NoLimitsEnabled].png
diff --git a/...popup_should_match_with_material3[ShowActionBar,TopCenter,NoLimitsDisabled].png b/...popup_should_match_with_material3[ShowActionBar,TopCenter,NoLimitsDisabled].png
diff --git a/..._popup_should_match_with_material3[ShowActionBar,TopCenter,NoLimitsEnabled].png b/..._popup_should_match_with_material3[ShowActionBar,TopCenter,NoLimitsEnabled].png
diff --git a/...of_popup_should_match_with_material3[ShowActionBar,TopEnd,NoLimitsDisabled].png b/...of_popup_should_match_with_material3[ShowActionBar,TopEnd,NoLimitsDisabled].png
diff --git a/..._of_popup_should_match_with_material3[ShowActionBar,TopEnd,NoLimitsEnabled].png b/..._of_popup_should_match_with_material3[ShowActionBar,TopEnd,NoLimitsEnabled].png
diff --git a/..._popup_should_match_with_material3[ShowActionBar,TopStart,NoLimitsDisabled].png b/..._popup_should_match_with_material3[ShowActionBar,TopStart,NoLimitsDisabled].png
diff --git a/...f_popup_should_match_with_material3[ShowActionBar,TopStart,NoLimitsEnabled].png b/...f_popup_should_match_with_material3[ShowActionBar,TopStart,NoLimitsEnabled].png
diff --git a/cascade-compose/src/androidTest/screenshots/canary[HideActionBar,Landscape].png b/cascade-compose/src/androidTest/screenshots/canary[HideActionBar,Landscape].png
diff --git a/...se/src/androidTest/screenshots/canary.png → ...nshots/canary[HideActionBar,Portrait].png b/...se/src/androidTest/screenshots/canary.png → ...nshots/canary[HideActionBar,Portrait].png
diff --git a/cascade-compose/src/androidTest/screenshots/canary[ShowActionBar,Landscape].png b/cascade-compose/src/androidTest/screenshots/canary[ShowActionBar,Landscape].png
diff --git a/cascade-compose/src/androidTest/screenshots/canary[ShowActionBar,Portrait].png b/cascade-compose/src/androidTest/screenshots/canary[ShowActionBar,Portrait].png
diff --git a/...ing_on_a_menu_item_opens_its_sub_menu.png → ...tem_opens_its_sub_menu[HideActionBar].png b/...ing_on_a_menu_item_opens_its_sub_menu.png → ...tem_opens_its_sub_menu[HideActionBar].png
diff --git a/...dTest/screenshots/clicking_on_a_menu_item_opens_its_sub_menu[ShowActionBar].png b/...dTest/screenshots/clicking_on_a_menu_item_opens_its_sub_menu[ShowActionBar].png
diff --git a/...ntent_inside_popup_can_be_updated_[0].png → ...pup_can_be_updated[HideActionBar]_[0].png b/...ntent_inside_popup_can_be_updated_[0].png → ...pup_can_be_updated[HideActionBar]_[0].png
diff --git a/...ntent_inside_popup_can_be_updated_[1].png → ...pup_can_be_updated[HideActionBar]_[1].png b/...ntent_inside_popup_can_be_updated_[1].png → ...pup_can_be_updated[HideActionBar]_[1].png
diff --git a/...ntent_inside_popup_can_be_updated_[2].png → ...pup_can_be_updated[HideActionBar]_[2].png b/...ntent_inside_popup_can_be_updated_[2].png → ...pup_can_be_updated[HideActionBar]_[2].png
diff --git a/...ntent_inside_popup_can_be_updated_[3].png → ...pup_can_be_updated[HideActionBar]_[3].png b/...ntent_inside_popup_can_be_updated_[3].png → ...pup_can_be_updated[HideActionBar]_[3].png
diff --git a/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[0].png b/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[0].png
diff --git a/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[1].png b/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[1].png
diff --git a/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[2].png b/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[2].png
diff --git a/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[3].png b/...roidTest/screenshots/content_inside_popup_can_be_updated[ShowActionBar]_[3].png
diff --git a/...d_be_correctly_applied_to_its_content.png → ...applied_to_its_content[HideActionBar].png b/...d_be_correctly_applied_to_its_content.png → ...applied_to_its_content[HideActionBar].png
diff --git a/..._given_to_cascade_should_be_correctly_applied_to_its_content[ShowActionBar].png b/..._given_to_cascade_should_be_correctly_applied_to_its_content[ShowActionBar].png
diff --git a/...oidTest/screenshots/zero_sized_anchor.png → ...hots/zero_sized_anchor[HideActionBar].png b/...oidTest/screenshots/zero_sized_anchor.png → ...hots/zero_sized_anchor[HideActionBar].png
diff --git a/cascade-compose/src/androidTest/screenshots/zero_sized_anchor[ShowActionBar].png b/cascade-compose/src/androidTest/screenshots/zero_sized_anchor[ShowActionBar].png
diff --git a/cascade-compose/src/debug/AndroidManifest.xml b/cascade-compose/src/debug/AndroidManifest.xml
@@ -4,6 +4,6 @@
   <application>
     <activity
       android:name=".TestActivity"
-      android:theme="@style/Theme.AppCompat.NoActionBar" />
+      android:theme="@style/Theme.AppCompat" />
   </application>
 </manifest>