diff --git a/.github/ci-gradle.properties b/.github/ci-gradle.properties new file mode 100644 index 000000000..e69de29bb diff --git a/.github/workflows/composescreenshot.yml b/.github/workflows/composescreenshot.yml new file mode 100644 index 000000000..c717f8305 --- /dev/null +++ b/.github/workflows/composescreenshot.yml @@ -0,0 +1,24 @@ +# Workflow name +name: Compose Preview Screenshot +on: + # When it will be triggered + # And in which branch + pull_request: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Set Up JDK + uses: actions/setup-java@v3 + with: + distribution: 'zulu' # See 'Supported distributions' for available options + java-version: '17' + cache: 'gradle' + + - name: Build project and run screenshot tests + working-directory: ./ui/PreviewScreenshot + run: ./gradlew validateDebugScreenshotTest diff --git a/ui/PreviewScreenshot/.gitignore b/ui/PreviewScreenshot/.gitignore new file mode 100644 index 000000000..aa724b770 --- /dev/null +++ b/ui/PreviewScreenshot/.gitignore @@ -0,0 +1,15 @@ +*.iml +.gradle +/local.properties +/.idea/caches +/.idea/libraries +/.idea/modules.xml +/.idea/workspace.xml +/.idea/navEditor.xml +/.idea/assetWizardSettings.xml +.DS_Store +/build +/captures +.externalNativeBuild +.cxx +local.properties diff --git a/ui/PreviewScreenshot/README.md b/ui/PreviewScreenshot/README.md new file mode 100644 index 000000000..97c4c951f --- /dev/null +++ b/ui/PreviewScreenshot/README.md @@ -0,0 +1,7 @@ +# Compose Preview Screenshot Testing tool + +Experimental: Compose Preview Screenshot Testing is still in development. Its +features and APIs are subject to change substantially during the alpha phase. +Report any feedback and issues through the [issue tracker](https://d.android.com/studio/report-bugs). + +See [Compose Preview Screenshot Testing](https://d.android.com/studio/preview/compose-screenshot-testing). diff --git a/ui/PreviewScreenshot/app/.gitignore b/ui/PreviewScreenshot/app/.gitignore new file mode 100644 index 000000000..42afabfd2 --- /dev/null +++ b/ui/PreviewScreenshot/app/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/ui/PreviewScreenshot/app/build.gradle.kts b/ui/PreviewScreenshot/app/build.gradle.kts new file mode 100644 index 000000000..32497ca2b --- /dev/null +++ b/ui/PreviewScreenshot/app/build.gradle.kts @@ -0,0 +1,89 @@ +/* + * Copyright (C) 2024 The Android Open Source Project + * + * 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. + */ + +plugins { + alias(libs.plugins.android.application) + alias(libs.plugins.jetbrains.kotlin.android) + alias(libs.plugins.screenshot) +} + +android { + namespace = "com.example.compose.previewscreenshot" + compileSdk = 34 + + defaultConfig { + applicationId = "com.example.compose.previewscreenshot" + minSdk = 24 + targetSdk = 34 + versionCode = 1 + versionName = "1.0" + + testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" + vectorDrawables { + useSupportLibrary = true + } + } + + buildTypes { + release { + isMinifyEnabled = false + proguardFiles( + getDefaultProguardFile("proguard-android-optimize.txt"), + "proguard-rules.pro" + ) + } + } + compileOptions { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 + } + kotlinOptions { + jvmTarget = "1.8" + } + buildFeatures { + compose = true + } + composeOptions { + kotlinCompilerExtensionVersion = "1.5.13" + } + + experimentalProperties["android.experimental.enableScreenshotTest"] = true + + packaging { + resources { + excludes += "/META-INF/{AL2.0,LGPL2.1}" + } + } +} + +dependencies { + + implementation(libs.androidx.core.ktx) + implementation(libs.androidx.lifecycle.runtime.ktx) + implementation(libs.androidx.activity.compose) + implementation(platform(libs.androidx.compose.bom)) + implementation(libs.androidx.ui) + implementation(libs.androidx.ui.graphics) + implementation(libs.androidx.ui.tooling.preview) + implementation(libs.androidx.material3) + testImplementation(libs.junit) + androidTestImplementation(libs.androidx.junit) + androidTestImplementation(libs.androidx.espresso.core) + androidTestImplementation(platform(libs.androidx.compose.bom)) + androidTestImplementation(libs.androidx.ui.test.junit4) + debugImplementation(libs.androidx.ui.tooling) + debugImplementation(libs.androidx.ui.test.manifest) +} diff --git a/ui/PreviewScreenshot/app/proguard-rules.pro b/ui/PreviewScreenshot/app/proguard-rules.pro new file mode 100644 index 000000000..481bb4348 --- /dev/null +++ b/ui/PreviewScreenshot/app/proguard-rules.pro @@ -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. +# +# 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 \ No newline at end of file diff --git a/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_1300b7bc_da39a3ee_0.png b/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_1300b7bc_da39a3ee_0.png new file mode 100644 index 000000000..8f6d965c0 Binary files /dev/null and b/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_1300b7bc_da39a3ee_0.png differ diff --git a/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_3d8b4969_da39a3ee_0.png b/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_3d8b4969_da39a3ee_0.png new file mode 100644 index 000000000..edc97a23f Binary files /dev/null and b/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_3d8b4969_da39a3ee_0.png differ diff --git a/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_faf0477b_da39a3ee_0.png b/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_faf0477b_da39a3ee_0.png new file mode 100644 index 000000000..31a110493 Binary files /dev/null and b/ui/PreviewScreenshot/app/src/debug/screenshotTest/reference/com.example.compose.previewscreenshot.MainScreen.GreetingPreview_faf0477b_da39a3ee_0.png differ diff --git a/ui/PreviewScreenshot/app/src/main/AndroidManifest.xml b/ui/PreviewScreenshot/app/src/main/AndroidManifest.xml new file mode 100644 index 000000000..8d8f8269d --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/AndroidManifest.xml @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + diff --git a/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/MainActivity.kt b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/MainActivity.kt new file mode 100644 index 000000000..3b1342f15 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/MainActivity.kt @@ -0,0 +1,69 @@ +/* + * Copyright (C) 2024 The Android Open Source Project + * + * 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 com.example.compose.previewscreenshot + +import android.content.res.Configuration +import android.os.Bundle +import androidx.activity.ComponentActivity +import androidx.activity.compose.setContent +import androidx.activity.enableEdgeToEdge +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.padding +import androidx.compose.material3.Scaffold +import androidx.compose.material3.Surface +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.ui.Modifier +import androidx.compose.ui.res.stringResource +import androidx.compose.ui.tooling.preview.Preview +import com.example.compose.previewscreenshot.ui.theme.SampleTheme + +class MainActivity : ComponentActivity() { + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + enableEdgeToEdge() + setContent { + SampleTheme { + Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding -> + Greeting( + modifier = Modifier.padding(innerPadding) + ) + } + } + } + } +} + +@Composable +fun Greeting(modifier: Modifier = Modifier) { + Surface { + Text( + text = stringResource(id = R.string.greeting), + modifier = modifier + ) + } +} + +@Preview(showBackground = true) +@Preview(showBackground = true, locale = "es") +@Preview(showBackground = true, name = "Dark" , uiMode = Configuration.UI_MODE_NIGHT_YES) +@Composable +fun GreetingPreview() { + SampleTheme { + Greeting() + } +} diff --git a/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Color.kt b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Color.kt new file mode 100644 index 000000000..dff55084f --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Color.kt @@ -0,0 +1,27 @@ +/* + * Copyright (C) 2024 The Android Open Source Project + * + * 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 com.example.compose.previewscreenshot.ui.theme + +import androidx.compose.ui.graphics.Color + +val Purple80 = Color(0xFFD0BCFF) +val PurpleGrey80 = Color(0xFFCCC2DC) +val Pink80 = Color(0xFFEFB8C8) + +val Purple40 = Color(0xFF6650a4) +val PurpleGrey40 = Color(0xFF625b71) +val Pink40 = Color(0xFF7D5260) diff --git a/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Theme.kt b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Theme.kt new file mode 100644 index 000000000..d4354fc56 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Theme.kt @@ -0,0 +1,73 @@ +/* + * Copyright (C) 2024 The Android Open Source Project + * + * 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 com.example.compose.previewscreenshot.ui.theme + +import android.os.Build +import androidx.compose.foundation.isSystemInDarkTheme +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.darkColorScheme +import androidx.compose.material3.dynamicDarkColorScheme +import androidx.compose.material3.dynamicLightColorScheme +import androidx.compose.material3.lightColorScheme +import androidx.compose.runtime.Composable +import androidx.compose.ui.platform.LocalContext + +private val DarkColorScheme = darkColorScheme( + primary = Purple80, + secondary = PurpleGrey80, + tertiary = Pink80 +) + +private val LightColorScheme = lightColorScheme( + primary = Purple40, + secondary = PurpleGrey40, + tertiary = Pink40 + + /* Other default colors to override + background = Color(0xFFFFFBFE), + surface = Color(0xFFFFFBFE), + onPrimary = Color.White, + onSecondary = Color.White, + onTertiary = Color.White, + onBackground = Color(0xFF1C1B1F), + onSurface = Color(0xFF1C1B1F), + */ +) + +@Composable +fun SampleTheme( + darkTheme: Boolean = isSystemInDarkTheme(), + // Dynamic color is available on Android 12+ + dynamicColor: Boolean = true, + content: @Composable () -> Unit +) { + val colorScheme = when { + dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { + val context = LocalContext.current + if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) + } + + darkTheme -> DarkColorScheme + else -> LightColorScheme + } + + MaterialTheme( + colorScheme = colorScheme, + typography = Typography, + content = content + ) +} diff --git a/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Type.kt b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Type.kt new file mode 100644 index 000000000..579c325cd --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/java/com/example/compose/previewscreenshot/ui/theme/Type.kt @@ -0,0 +1,50 @@ +/* + * Copyright (C) 2024 The Android Open Source Project + * + * 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 com.example.compose.previewscreenshot.ui.theme + +import androidx.compose.material3.Typography +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.font.FontFamily +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.unit.sp + +// Set of Material typography styles to start with +val Typography = Typography( + bodyLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 16.sp, + lineHeight = 24.sp, + letterSpacing = 0.5.sp + ) + /* Other default text styles to override + titleLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 22.sp, + lineHeight = 28.sp, + letterSpacing = 0.sp + ), + labelSmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 11.sp, + lineHeight = 16.sp, + letterSpacing = 0.5.sp + ) + */ +) diff --git a/ui/PreviewScreenshot/app/src/main/res/drawable/ic_launcher_background.xml b/ui/PreviewScreenshot/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 000000000..867736413 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ui/PreviewScreenshot/app/src/main/res/drawable/ic_launcher_foreground.xml b/ui/PreviewScreenshot/app/src/main/res/drawable/ic_launcher_foreground.xml new file mode 100644 index 000000000..0a3876957 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/drawable/ic_launcher_foreground.xml @@ -0,0 +1,46 @@ + + + + + + + + + + + + + diff --git a/ui/PreviewScreenshot/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/ui/PreviewScreenshot/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 000000000..12d3be99a --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,22 @@ + + + + + + + + diff --git a/ui/PreviewScreenshot/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/ui/PreviewScreenshot/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 000000000..12d3be99a --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,22 @@ + + + + + + + + diff --git a/ui/PreviewScreenshot/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp b/ui/PreviewScreenshot/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp new file mode 100644 index 000000000..aa7d6427e Binary files /dev/null and b/ui/PreviewScreenshot/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp differ diff --git a/ui/PreviewScreenshot/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp b/ui/PreviewScreenshot/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp new file mode 100644 index 000000000..9126ae37c Binary files /dev/null and b/ui/PreviewScreenshot/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp differ diff --git a/ui/PreviewScreenshot/app/src/main/res/values-es/strings.xml b/ui/PreviewScreenshot/app/src/main/res/values-es/strings.xml new file mode 100644 index 000000000..5aadb9113 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/values-es/strings.xml @@ -0,0 +1,19 @@ + + + + ¡Hola! + diff --git a/ui/PreviewScreenshot/app/src/main/res/values/colors.xml b/ui/PreviewScreenshot/app/src/main/res/values/colors.xml new file mode 100644 index 000000000..9621b7e9f --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/values/colors.xml @@ -0,0 +1,26 @@ + + + + + #FFBB86FC + #FF6200EE + #FF3700B3 + #FF03DAC5 + #FF018786 + #FF000000 + #FFFFFFFF + diff --git a/ui/PreviewScreenshot/app/src/main/res/values/strings.xml b/ui/PreviewScreenshot/app/src/main/res/values/strings.xml new file mode 100644 index 000000000..dd91e0d64 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/values/strings.xml @@ -0,0 +1,20 @@ + + + + Compose Preview Screenshot Testing sample + Hello! + diff --git a/ui/PreviewScreenshot/app/src/main/res/values/themes.xml b/ui/PreviewScreenshot/app/src/main/res/values/themes.xml new file mode 100644 index 000000000..29d3a0e34 --- /dev/null +++ b/ui/PreviewScreenshot/app/src/main/res/values/themes.xml @@ -0,0 +1,20 @@ + + + + +