Benoit Marty
2 years ago
committed by
GitHub
108 changed files with 867 additions and 125 deletions
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
**/snapshots/**/*.png filter=lfs diff=lfs merge=lfs -text |
@ -0,0 +1,15 @@
@@ -0,0 +1,15 @@
|
||||
name: Validate Git LFS |
||||
|
||||
on: [pull_request] |
||||
|
||||
jobs: |
||||
build: |
||||
runs-on: ubuntu-latest |
||||
name: Validate |
||||
steps: |
||||
- uses: actions/checkout@v3 |
||||
with: |
||||
lfs: 'true' |
||||
|
||||
- run: | |
||||
./tools/git/validate_lfs.sh |
@ -0,0 +1,45 @@
@@ -0,0 +1,45 @@
|
||||
# Screenshot testing |
||||
|
||||
<!--- TOC --> |
||||
|
||||
* [Overview](#overview) |
||||
* [Setup](#setup) |
||||
* [Recording](#recording) |
||||
* [Verifying](#verifying) |
||||
* [Contributing](#contributing) |
||||
|
||||
<!--- END --> |
||||
|
||||
## Overview |
||||
|
||||
- Screenshot tests are tests which record the content of a rendered screen and verify subsequent runs to check if the screen renders differently. |
||||
- ElementX uses [Paparazzi](https://github.com/cashapp/paparazzi) to render, record and verify Composable. All Composable Preview will be use to make screenshot test, thanks to the usage of [Showkase](https://github.com/airbnb/Showkase). |
||||
- The screenshot verification occurs on every pull request as part of the `tests.yml` workflow. |
||||
|
||||
## Setup |
||||
|
||||
- Install Git LFS through your package manager of choice (`brew install git-lfs` | `yay -S git-lfs`). |
||||
- Install the Git LFS hooks into the project. |
||||
|
||||
```bash |
||||
# with element-android as the current working directory |
||||
git lfs install --local |
||||
``` |
||||
|
||||
- If installed correctly, `git push` and `git pull` will now include LFS content. |
||||
|
||||
## Recording |
||||
|
||||
- `./gradlew recordPaparazziDebug` |
||||
- Paparazzi will generate images in `:tests:uitests/src/test/snapshots`, which will need to be committed to the repository using Git LFS. |
||||
|
||||
## Verifying |
||||
|
||||
- `./gradlew verifyPaparazziDebug` |
||||
- In the case of failure, Paparazzi will generate images in `:tests:uitests/out/failure`. The images will show the expected and actual screenshots along with a delta of the two images. |
||||
|
||||
## Contributing |
||||
|
||||
- Creating Previewable Composable will automatically creates new screenshot tests. |
||||
- After creating the new test, record and commit the newly rendered screens. |
||||
- `./tools/git/validate_lfs.sh` can be run to ensure everything is working correctly with Git LFS, the CI also runs this check. |
@ -0,0 +1,44 @@
@@ -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. |
||||
*/ |
||||
|
||||
import extension.allFeatures |
||||
import extension.allLibraries |
||||
|
||||
// TODO: Remove once https://youtrack.jetbrains.com/issue/KTIJ-19369 is fixed |
||||
@Suppress("DSL_SCOPE_VIOLATION") |
||||
plugins { |
||||
id("io.element.android-compose-library") |
||||
alias(libs.plugins.ksp) |
||||
alias(libs.plugins.paparazzi) |
||||
} |
||||
|
||||
android { |
||||
namespace = "io.element.android.x.tests.uitests" |
||||
} |
||||
|
||||
dependencies { |
||||
testImplementation(libs.test.junit) |
||||
testImplementation(libs.test.parameter.injector) |
||||
androidTestImplementation(libs.test.junitext) |
||||
ksp(libs.showkase.processor) |
||||
kspTest(libs.showkase.processor) |
||||
|
||||
implementation(libs.showkase) |
||||
ksp(libs.showkase.processor) |
||||
|
||||
allLibraries() |
||||
allFeatures() |
||||
} |
@ -0,0 +1,21 @@
@@ -0,0 +1,21 @@
|
||||
# Add project specific ProGuard rules here. |
||||
# You can control the set of applied configuration files using the |
||||
# proguardFiles setting in build.gradle.kts. |
||||
# |
||||
# For more details, see |
||||
# http://developer.android.com/guide/developing/tools/proguard.html |
||||
|
||||
# If your project uses WebView with JS, uncomment the following |
||||
# and specify the fully qualified class name to the JavaScript interface |
||||
# class: |
||||
#-keepclassmembers class fqcn.of.javascript.interface.for.webview { |
||||
# public *; |
||||
#} |
||||
|
||||
# Uncomment this to preserve the line number information for |
||||
# debugging stack traces. |
||||
#-keepattributes SourceFile,LineNumberTable |
||||
|
||||
# If you keep the line number information, uncomment this to |
||||
# hide the original source file name. |
||||
#-renamesourcefileattribute SourceFile |
@ -0,0 +1,18 @@
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="utf-8"?> |
||||
<!-- |
||||
~ 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. |
||||
--> |
||||
|
||||
<manifest/> |
@ -0,0 +1,66 @@
@@ -0,0 +1,66 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
import androidx.compose.foundation.layout.padding |
||||
import androidx.compose.foundation.layout.size |
||||
import androidx.compose.material.icons.Icons |
||||
import androidx.compose.material.icons.filled.Close |
||||
import androidx.compose.material3.Button |
||||
import androidx.compose.material3.Icon |
||||
import androidx.compose.material3.IconButton |
||||
import androidx.compose.material3.Text |
||||
import androidx.compose.runtime.Composable |
||||
import androidx.compose.runtime.getValue |
||||
import androidx.compose.runtime.mutableStateOf |
||||
import androidx.compose.runtime.remember |
||||
import androidx.compose.runtime.setValue |
||||
import androidx.compose.ui.Modifier |
||||
import androidx.compose.ui.tooling.preview.Preview |
||||
import androidx.compose.ui.unit.dp |
||||
|
||||
@Composable |
||||
fun ShowkaseButton( |
||||
modifier: Modifier = Modifier, |
||||
onClick: () -> Unit = {}, |
||||
) { |
||||
var isShowkaseButtonVisible by remember { mutableStateOf(BuildConfig.DEBUG) } |
||||
|
||||
if (isShowkaseButtonVisible) { |
||||
Button( |
||||
modifier = modifier |
||||
.padding(top = 32.dp), |
||||
onClick = onClick |
||||
) { |
||||
Text(text = "Showkase Browser") |
||||
IconButton( |
||||
modifier = Modifier |
||||
.padding(start = 8.dp) |
||||
.size(16.dp), |
||||
onClick = { isShowkaseButtonVisible = false }, |
||||
) { |
||||
Icon(imageVector = Icons.Filled.Close, contentDescription = "") |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
@Preview(group = "Buttons", name = "Showkase button") |
||||
@Composable |
||||
fun ShowkaseButtonPreview() { |
||||
ShowkaseButton() |
||||
} |
@ -0,0 +1,24 @@
@@ -0,0 +1,24 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
import android.app.Activity |
||||
import com.airbnb.android.showkase.models.Showkase |
||||
|
||||
fun openShowkase(activity: Activity) { |
||||
activity.startActivity(Showkase.getBrowserIntent(activity)) |
||||
} |
@ -0,0 +1,26 @@
@@ -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 io.element.android.x.tests.uitests |
||||
|
||||
import app.cash.paparazzi.DeviceConfig |
||||
|
||||
enum class BaseDeviceConfig( |
||||
val deviceConfig: DeviceConfig, |
||||
) { |
||||
NEXUS_5(DeviceConfig.NEXUS_5), |
||||
// PIXEL_C(DeviceConfig.PIXEL_C), |
||||
} |
@ -0,0 +1,42 @@
@@ -0,0 +1,42 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
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 fun toString(): String = "Color_${showkaseBrowserColor.colorGroup}_${showkaseBrowserColor.colorName}" |
||||
} |
@ -0,0 +1,28 @@
@@ -0,0 +1,28 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
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 fun toString(): String = showkaseBrowserComponent.componentKey |
||||
} |
@ -0,0 +1,121 @@
@@ -0,0 +1,121 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
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 app.cash.paparazzi.Paparazzi |
||||
import com.airbnb.android.showkase.models.Showkase |
||||
import com.google.testing.junit.testparameterinjector.TestParameter |
||||
import com.google.testing.junit.testparameterinjector.TestParameterInjector |
||||
import io.element.android.x.designsystem.ElementXTheme |
||||
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. |
||||
*/ |
||||
@RunWith(TestParameterInjector::class) |
||||
class ScreenshotTest { |
||||
|
||||
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( |
||||
maxPercentDifference = 0.0, |
||||
) |
||||
|
||||
@Test |
||||
fun preview_tests( |
||||
@TestParameter(valuesProvider = PreviewProvider::class) componentTestPreview: TestPreview, |
||||
@TestParameter baseDeviceConfig: BaseDeviceConfig, |
||||
@TestParameter(value = ["1.0"/*, "1.5"*/]) fontScale: Float, |
||||
@TestParameter(value = ["light", "dark"]) theme: String, |
||||
@TestParameter(value = ["en" /*"fr", "de", "ru"*/]) localeStr: String, |
||||
) { |
||||
paparazzi.unsafeUpdateConfig( |
||||
deviceConfig = baseDeviceConfig.deviceConfig.copy( |
||||
softButtons = false, |
||||
) |
||||
) |
||||
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(localeStr.toLocale())) |
||||
}, |
||||
// Needed so that UI that uses it don't crash during screenshot tests |
||||
LocalOnBackPressedDispatcherOwner provides object : OnBackPressedDispatcherOwner { |
||||
override fun getLifecycle() = lifecycleOwner.lifecycle |
||||
|
||||
override fun getOnBackPressedDispatcher() = OnBackPressedDispatcher() |
||||
} |
||||
) { |
||||
ElementXTheme(darkTheme = (theme == "dark")) { |
||||
Box(modifier = Modifier.background(MaterialTheme.colorScheme.background)) { |
||||
componentTestPreview.Content() |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
private fun String.toLocale(): Locale { |
||||
return when (this) { |
||||
"en" -> Locale.ENGLISH |
||||
"fr" -> Locale.FRANCE |
||||
"de" -> Locale.GERMAN |
||||
else -> Locale.Builder().setLanguage(this).build() |
||||
} |
||||
} |
@ -0,0 +1,24 @@
@@ -0,0 +1,24 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
import androidx.compose.runtime.Composable |
||||
|
||||
interface TestPreview { |
||||
@Composable |
||||
fun Content() |
||||
} |
@ -0,0 +1,48 @@
@@ -0,0 +1,48 @@
|
||||
/* |
||||
* 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 io.element.android.x.tests.uitests |
||||
|
||||
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 fun toString(): String = "Typo_${showkaseBrowserTypography.typographyGroup}_${showkaseBrowserTypography.typographyName}" |
||||
} |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue