Improve screenshot testing with ComposablePreviewScanner (#3125)
* Use ComposablePreviewScanner to rework how screenshot testing works * Add test sharding * Update screenshots * Fixes for Element Gallery --------- Co-authored-by: ElementBot <benoitm+elementbot@element.io> Co-authored-by: Benoit Marty <benoit@matrix.org>
This commit is contained in:
Jorge Martin Espinosa
GitHub
parent
41e3568a5a
commit
950e502ca6
2063 changed files with 1607 additions and 1768 deletions
|
|
@ -1,26 +0,0 @@
|
|||
/*
|
||||
* 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),
|
||||
}
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
/*
|
||||
* 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}"
|
||||
}
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
* 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.unit.Dp
|
||||
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 customHeightDp(): Dp? {
|
||||
return showkaseBrowserComponent.heightDp?.let { Dp(it.toFloat()) }
|
||||
}
|
||||
|
||||
override fun toString(): String = showkaseBrowserComponent.componentKey
|
||||
// Strip common package beginning
|
||||
.replace("io.element.android.features.", "f.")
|
||||
.replace("io.element.android.libraries.", "l.")
|
||||
.replace("io.element.android.", "")
|
||||
// Reduce default group (if present)
|
||||
.replace("_DefaultGroup_", "_")
|
||||
// No need to include `Preview` suffix of function name
|
||||
.replace("Preview_", "_")
|
||||
// Also for preview annotated with @ElementPreview
|
||||
.replace("Preview-", "-")
|
||||
}
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 com.airbnb.android.showkase.models.Showkase
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterValuesProvider
|
||||
|
||||
object PreviewProvider : TestParameterValuesProvider() {
|
||||
override fun provideValues(context: Context): 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).filter { !it.toString().contains("compound") }
|
||||
}
|
||||
}
|
||||
46
tests/uitests/src/test/kotlin/ui/PreviewShard1Test.kt
Normal file
46
tests/uitests/src/test/kotlin/ui/PreviewShard1Test.kt
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 base.PaparazziPreviewRule
|
||||
import base.ScreenshotTest
|
||||
import base.Shard1ComposablePreviewProvider
|
||||
import com.google.testing.junit.testparameterinjector.TestParameter
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector
|
||||
import org.junit.Rule
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
|
||||
import sergio.sastre.composable.preview.scanner.core.preview.ComposablePreview
|
||||
|
||||
/**
|
||||
* Test that takes a preview and runs a screenshot test on it.
|
||||
* It uses a sharded preview provider so multiple 'shards' can run in parallel, optimizing CPU and time usage.
|
||||
*/
|
||||
@RunWith(TestParameterInjector::class)
|
||||
class PreviewShard1Test(
|
||||
@TestParameter(valuesProvider = Shard1ComposablePreviewProvider::class)
|
||||
val preview: ComposablePreview<AndroidPreviewInfo>,
|
||||
) {
|
||||
@get:Rule
|
||||
val paparazziRule = PaparazziPreviewRule.createFor(preview, locale = "en")
|
||||
|
||||
@Test
|
||||
fun snapshot() {
|
||||
ScreenshotTest.runTest(paparazzi = paparazziRule, preview = preview, localeStr = "en")
|
||||
}
|
||||
}
|
||||
46
tests/uitests/src/test/kotlin/ui/PreviewShard2Test.kt
Normal file
46
tests/uitests/src/test/kotlin/ui/PreviewShard2Test.kt
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 base.PaparazziPreviewRule
|
||||
import base.ScreenshotTest
|
||||
import base.Shard2ComposablePreviewProvider
|
||||
import com.google.testing.junit.testparameterinjector.TestParameter
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector
|
||||
import org.junit.Rule
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
|
||||
import sergio.sastre.composable.preview.scanner.core.preview.ComposablePreview
|
||||
|
||||
/**
|
||||
* Test that takes a preview and runs a screenshot test on it.
|
||||
* It uses a sharded preview provider so multiple 'shards' can run in parallel, optimizing CPU and time usage.
|
||||
*/
|
||||
@RunWith(TestParameterInjector::class)
|
||||
class PreviewShard2Test(
|
||||
@TestParameter(valuesProvider = Shard2ComposablePreviewProvider::class)
|
||||
val preview: ComposablePreview<AndroidPreviewInfo>,
|
||||
) {
|
||||
@get:Rule
|
||||
val paparazziRule = PaparazziPreviewRule.createFor(preview, locale = "en")
|
||||
|
||||
@Test
|
||||
fun snapshot() {
|
||||
ScreenshotTest.runTest(paparazzi = paparazziRule, preview = preview, localeStr = "en")
|
||||
}
|
||||
}
|
||||
46
tests/uitests/src/test/kotlin/ui/PreviewShard3Test.kt
Normal file
46
tests/uitests/src/test/kotlin/ui/PreviewShard3Test.kt
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 base.PaparazziPreviewRule
|
||||
import base.ScreenshotTest
|
||||
import base.Shard3ComposablePreviewProvider
|
||||
import com.google.testing.junit.testparameterinjector.TestParameter
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector
|
||||
import org.junit.Rule
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
|
||||
import sergio.sastre.composable.preview.scanner.core.preview.ComposablePreview
|
||||
|
||||
/**
|
||||
* Test that takes a preview and runs a screenshot test on it.
|
||||
* It uses a sharded preview provider so multiple 'shards' can run in parallel, optimizing CPU and time usage.
|
||||
*/
|
||||
@RunWith(TestParameterInjector::class)
|
||||
class PreviewShard3Test(
|
||||
@TestParameter(valuesProvider = Shard3ComposablePreviewProvider::class)
|
||||
val preview: ComposablePreview<AndroidPreviewInfo>,
|
||||
) {
|
||||
@get:Rule
|
||||
val paparazziRule = PaparazziPreviewRule.createFor(preview, locale = "en")
|
||||
|
||||
@Test
|
||||
fun snapshot() {
|
||||
ScreenshotTest.runTest(paparazzi = paparazziRule, preview = preview, localeStr = "en")
|
||||
}
|
||||
}
|
||||
46
tests/uitests/src/test/kotlin/ui/PreviewShard4Test.kt
Normal file
46
tests/uitests/src/test/kotlin/ui/PreviewShard4Test.kt
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 base.PaparazziPreviewRule
|
||||
import base.ScreenshotTest
|
||||
import base.Shard4ComposablePreviewProvider
|
||||
import com.google.testing.junit.testparameterinjector.TestParameter
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector
|
||||
import org.junit.Rule
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
|
||||
import sergio.sastre.composable.preview.scanner.core.preview.ComposablePreview
|
||||
|
||||
/**
|
||||
* Test that takes a preview and runs a screenshot test on it.
|
||||
* It uses a sharded preview provider so multiple 'shards' can run in parallel, optimizing CPU and time usage.
|
||||
*/
|
||||
@RunWith(TestParameterInjector::class)
|
||||
class PreviewShard4Test(
|
||||
@TestParameter(valuesProvider = Shard4ComposablePreviewProvider::class)
|
||||
val preview: ComposablePreview<AndroidPreviewInfo>,
|
||||
) {
|
||||
@get:Rule
|
||||
val paparazziRule = PaparazziPreviewRule.createFor(preview, locale = "en")
|
||||
|
||||
@Test
|
||||
fun snapshot() {
|
||||
ScreenshotTest.runTest(paparazzi = paparazziRule, preview = preview, localeStr = "en")
|
||||
}
|
||||
}
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
/*
|
||||
* 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 com.google.testing.junit.testparameterinjector.TestParameter
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
|
||||
/**
|
||||
* Screenshot test for the English version only.
|
||||
*/
|
||||
@RunWith(TestParameterInjector::class)
|
||||
class S : ScreenshotTest() {
|
||||
/**
|
||||
* *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"]) fontScale: Float,
|
||||
// Need to keep the TestParameter to have filename including the language.
|
||||
@TestParameter(value = ["en"]) localeStr: String,
|
||||
) {
|
||||
doTest(
|
||||
componentTestPreview = componentTestPreview,
|
||||
baseDeviceConfig = baseDeviceConfig,
|
||||
fontScale = fontScale,
|
||||
localeStr = localeStr,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,125 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 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.android.ide.common.rendering.api.SessionParams
|
||||
import com.android.resources.NightMode
|
||||
import io.element.android.compound.theme.ElementTheme
|
||||
import org.junit.Rule
|
||||
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.
|
||||
*/
|
||||
open class ScreenshotTest {
|
||||
@get:Rule
|
||||
val paparazzi = Paparazzi(
|
||||
environment = detectEnvironment(),
|
||||
maxPercentDifference = 0.01,
|
||||
renderingMode = SessionParams.RenderingMode.NORMAL,
|
||||
)
|
||||
|
||||
protected fun doTest(
|
||||
componentTestPreview: TestPreview,
|
||||
baseDeviceConfig: BaseDeviceConfig,
|
||||
fontScale: Float,
|
||||
localeStr: String,
|
||||
) {
|
||||
val locale = localeStr.toLocale()
|
||||
Locale.setDefault(locale) // Needed for regional settings, as first day of week
|
||||
val densityScale = baseDeviceConfig.deviceConfig.density.dpiValue / 160f
|
||||
val customScreenHeight = componentTestPreview.customHeightDp()?.value?.let { it * densityScale }?.toInt()
|
||||
paparazzi.unsafeUpdateConfig(
|
||||
deviceConfig = baseDeviceConfig.deviceConfig.copy(
|
||||
softButtons = false,
|
||||
locale = localeStr,
|
||||
nightMode = componentTestPreview.isNightMode().let {
|
||||
when (it) {
|
||||
true -> NightMode.NIGHT
|
||||
false -> NightMode.NOTNIGHT
|
||||
}
|
||||
},
|
||||
screenHeight = customScreenHeight ?: baseDeviceConfig.deviceConfig.screenHeight,
|
||||
),
|
||||
)
|
||||
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()
|
||||
}
|
||||
}
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2024 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 com.google.testing.junit.testparameterinjector.TestParameter
|
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
|
||||
/**
|
||||
* Screenshot test for the Locale other then English.
|
||||
*/
|
||||
@RunWith(TestParameterInjector::class)
|
||||
class T : ScreenshotTest() {
|
||||
/**
|
||||
* *Note*: keep the method name as short as possible to get shorter filename for generated screenshot.
|
||||
* Long name was preview_test.
|
||||
*/
|
||||
@SuppressWarnings("MemberNameEqualsClassName")
|
||||
@Test
|
||||
fun t(
|
||||
@TestParameter(valuesProvider = PreviewProvider::class) componentTestPreview: TestPreview,
|
||||
@TestParameter baseDeviceConfig: BaseDeviceConfig,
|
||||
@TestParameter(value = ["1.0"]) fontScale: Float,
|
||||
@TestParameter(value = ["de"]) localeStr: String,
|
||||
) {
|
||||
// Only test ComponentTestPreview, and only with the light theme
|
||||
if (componentTestPreview.isNightMode() || componentTestPreview !is ComponentTestPreview) {
|
||||
return
|
||||
}
|
||||
doTest(
|
||||
componentTestPreview = componentTestPreview,
|
||||
baseDeviceConfig = baseDeviceConfig,
|
||||
fontScale = fontScale,
|
||||
localeStr = localeStr,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
/*
|
||||
* 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 androidx.compose.ui.unit.Dp
|
||||
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
|
||||
|
||||
fun customHeightDp(): Dp? = null
|
||||
}
|
||||
|
||||
/**
|
||||
* 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")
|
||||
}
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
/*
|
||||
* 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}"
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue