Move io.element.android.tests.uitests.ScreenshotTest to ui.T to generate much shorter name for screenshot files.

tests/uitests/src/test/kotlin/ui/BaseDeviceConfig.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * 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 ui
+
+import app.cash.paparazzi.DeviceConfig
+
+enum class BaseDeviceConfig(
+    val deviceConfig: DeviceConfig,
+) {
+    NEXUS_5(DeviceConfig.NEXUS_5),
+    // PIXEL_C(DeviceConfig.PIXEL_C),
+}

tests/uitests/src/test/kotlin/ui/ColorTestPreview.kt

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * 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 ui
+
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.height
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.unit.dp
+import com.airbnb.android.showkase.models.ShowkaseBrowserColor
+
+class ColorTestPreview(
+    private val showkaseBrowserColor: ShowkaseBrowserColor
+) : TestPreview {
+    @Composable
+    override fun Content() {
+        Box(
+            modifier = Modifier
+                .fillMaxWidth()
+                .height(250.dp)
+                .background(showkaseBrowserColor.color)
+        )
+    }
+
+    override val name: String = showkaseBrowserColor.colorName
+
+    override fun toString(): String = "Color_${showkaseBrowserColor.colorGroup}_${showkaseBrowserColor.colorName}"
+}

tests/uitests/src/test/kotlin/ui/ComponentTestPreview.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * 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 ui
+
+import androidx.compose.runtime.Composable
+import com.airbnb.android.showkase.models.ShowkaseBrowserComponent
+
+class ComponentTestPreview(
+    private val showkaseBrowserComponent: ShowkaseBrowserComponent
+) : TestPreview {
+    @Composable
+    override fun Content() = showkaseBrowserComponent.component()
+
+    override val name: String = showkaseBrowserComponent.componentName
+
+    override fun toString(): String = showkaseBrowserComponent.componentKey
+}

tests/uitests/src/test/kotlin/ui/S.kt

@@ -0,0 +1,148 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * 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
+ *
+ *     https://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 ui
+
+import android.content.res.Configuration
+import android.os.LocaleList
+import androidx.activity.OnBackPressedDispatcher
+import androidx.activity.OnBackPressedDispatcherOwner
+import androidx.activity.compose.LocalOnBackPressedDispatcherOwner
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Box
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.runtime.CompositionLocalProvider
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalConfiguration
+import androidx.compose.ui.platform.LocalDensity
+import androidx.compose.ui.platform.LocalInspectionMode
+import androidx.compose.ui.platform.LocalLifecycleOwner
+import androidx.compose.ui.unit.Density
+import androidx.lifecycle.Lifecycle
+import app.cash.paparazzi.Paparazzi
+import app.cash.paparazzi.detectEnvironment
+import com.airbnb.android.showkase.models.Showkase
+import com.android.ide.common.rendering.api.SessionParams
+import com.android.resources.NightMode
+import com.google.testing.junit.testparameterinjector.TestParameter
+import com.google.testing.junit.testparameterinjector.TestParameterInjector
+import io.element.android.libraries.theme.ElementTheme
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+import java.util.Locale
+
+/**
+ * BMA: Inspired from https://github.com/airbnb/Showkase/blob/master/showkase-screenshot-testing-paparazzi-sample/src/test/java/com/airbnb/android/showkase/screenshot/testing/paparazzi/sample/PaparazziSampleScreenshotTest.kt
+ *
+ * Credit to Alex Vanyo for creating this sample in the Now In Android app by Google.
+ * PR here - https://github.com/android/nowinandroid/pull/101. Modified the test from that PR to
+ * my own needs for this sample.
+ *
+ * *Note*: keep the class name as short as possible to get shorter filename for generated screenshot.
+ * Long name was ScreenshotTest.
+ */
+@RunWith(TestParameterInjector::class)
+class S {
+
+    object PreviewProvider : TestParameter.TestParameterValuesProvider {
+        override fun provideValues(): List<TestPreview> {
+            val metadata = Showkase.getMetadata()
+            val components = metadata.componentList.map(::ComponentTestPreview)
+            val colors = metadata.colorList.map(::ColorTestPreview)
+            val typography = metadata.typographyList.map(::TypographyTestPreview)
+
+            return components + colors + typography
+        }
+    }
+
+    @get:Rule
+    val paparazzi = Paparazzi(
+        environment = detectEnvironment().run {
+            // Workaround to work with API 34 (https://github.com/cashapp/paparazzi/issues/1025)
+            copy(compileSdkVersion = 33, platformDir = platformDir.replace("34", "33"))
+        },
+        maxPercentDifference = 0.01,
+        renderingMode = SessionParams.RenderingMode.NORMAL,
+    )
+
+    /**
+     * *Note*: keep the method name as short as possible to get shorter filename for generated screenshot.
+     * Long name was preview_test.
+     */
+    @Test
+    fun t(
+        @TestParameter(valuesProvider = PreviewProvider::class) componentTestPreview: TestPreview,
+        @TestParameter baseDeviceConfig: BaseDeviceConfig,
+        @TestParameter(value = ["1.0"/*, "1.5"*/]) fontScale: Float,
+        @TestParameter(value = ["en" /*"fr", "de", "ru"*/]) localeStr: String,
+    ) {
+        val locale = localeStr.toLocale()
+        Locale.setDefault(locale) // Needed for regional settings, as first day of week
+        paparazzi.unsafeUpdateConfig(
+            deviceConfig = baseDeviceConfig.deviceConfig.copy(
+                softButtons = false,
+                nightMode = componentTestPreview.isNightMode().let {
+                    when (it) {
+                        true -> NightMode.NIGHT
+                        false -> NightMode.NOTNIGHT
+                    }
+                },
+            ),
+        )
+        paparazzi.snapshot {
+            val lifecycleOwner = LocalLifecycleOwner.current
+            CompositionLocalProvider(
+                LocalInspectionMode provides true,
+                LocalDensity provides Density(
+                    density = LocalDensity.current.density,
+                    fontScale = fontScale
+                ),
+                LocalConfiguration provides Configuration().apply {
+                    setLocales(LocaleList(locale))
+                    uiMode = when (componentTestPreview.isNightMode()) {
+                        true -> Configuration.UI_MODE_NIGHT_YES
+                        false -> Configuration.UI_MODE_NIGHT_NO
+                    }
+                },
+                // Needed so that UI that uses it don't crash during screenshot tests
+                LocalOnBackPressedDispatcherOwner provides object : OnBackPressedDispatcherOwner {
+                    override val lifecycle: Lifecycle get() = lifecycleOwner.lifecycle
+                    override val onBackPressedDispatcher: OnBackPressedDispatcher get() = OnBackPressedDispatcher()
+                }
+            ) {
+                ElementTheme {
+                    Box(
+                        modifier = Modifier
+                            .background(MaterialTheme.colorScheme.background)
+                    ) {
+                        componentTestPreview.Content()
+                    }
+                }
+            }
+        }
+    }
+}
+
+private fun String.toLocale(): Locale {
+    return when (this) {
+        "en" -> Locale.US
+        "fr" -> Locale.FRANCE
+        "de" -> Locale.GERMAN
+        else -> Locale.Builder().setLanguage(this).build()
+    }
+}

tests/uitests/src/test/kotlin/ui/TestPreview.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * 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 ui
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.tooling.preview.Preview
+import com.airbnb.android.showkase.models.ShowkaseElementsMetadata
+import io.element.android.libraries.designsystem.preview.NIGHT_MODE_NAME
+
+interface TestPreview {
+    @Composable
+    fun Content()
+
+    val name: String
+}
+
+/**
+ * Showkase doesn't put the [Preview.uiMode] parameter in its [ShowkaseElementsMetadata]
+ * so we have to encode the night mode bit in a preview's name.
+ */
+fun TestPreview.isNightMode(): Boolean {
+    // Dark mode previews have name "N" so their component name contains "- N"
+    return this.name.contains("- $NIGHT_MODE_NAME")
+}

tests/uitests/src/test/kotlin/ui/TypographyTestPreview.kt

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * 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 ui
+
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.text.BasicText
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import com.airbnb.android.showkase.models.ShowkaseBrowserTypography
+import com.airbnb.android.showkase.ui.padding4x
+import java.util.Locale
+
+class TypographyTestPreview(
+    private val showkaseBrowserTypography: ShowkaseBrowserTypography
+) : TestPreview {
+    @Composable
+    override fun Content() {
+        BasicText(
+            text = showkaseBrowserTypography.typographyName.replaceFirstChar {
+                it.titlecase(Locale.getDefault())
+            },
+            modifier = Modifier
+                .fillMaxWidth()
+                .padding(padding4x),
+            style = showkaseBrowserTypography.textStyle.copy(
+                color = MaterialTheme.colorScheme.onBackground
+            )
+        )
+    }
+
+    override val name: String = showkaseBrowserTypography.typographyName
+
+    override fun toString(): String = "Typo_${showkaseBrowserTypography.typographyGroup}_${showkaseBrowserTypography.typographyName}"
+}