ScreenshotTestSuite

Added in 9.5.0-alpha04

@Incubating
interface ScreenshotTestSuite : TestSuite

Model for screenshot test suites in the Variant API.

This object is accessible on subtypes of Variant that implement HasTestSuites, via HasTestSuites.suites.

Summary

Public properties
`Provider<String>`	`engineVersion` The version of the `com.android.tools.screenshot:screenshot-validation-junit-engine` artifact to use for layout rendering and screenshot validation.
`Provider<Float>`	`imageDifferenceThreshold` The maximum allowed percentage difference between the reference image and the rendered image for a screenshot test to pass.

Inherited functions

From org.gradle.api.Named

String

getName()

From com.android.build.api.variant.TestSuite

`Unit`	`configureTestTasks(action: Test.(context: TestTaskContext) -> Unit)` Configures the test tasks for this test target.
`Provider<String>`	`@Incubating instrumentationRunner(source: TestSuiteSourceSet.TestApk)` The instrumentationRunner to use to run the tests.
`Unit`	`@Incubating withTestTaskProviders(action: TaskProvider<Test>.(context: TestTaskContext) -> Unit)` Runs some action on the `TestSuite` test task's `TaskProvider`.

Inherited properties

From com.android.build.api.variant.TestSuite

`Boolean`	`codeCoverageEnabled` Whether test coverage is enabled for this test suite.
`JUnitEngineSpec`	`junitEngineSpec` Return the `JUnitEngineSpec` for this test suite.
`Provider<Boolean>`	`requiresUpdateTask` Whether this test suite requires an extra update task.
`Collection<TestSuiteSourceSet>`	`sources` Return the list of sourcesets associated with this test suite.
`Map<String, TestSuiteTarget>`	`targets` Return the list of `TestSuiteTarget` for this test suite in this variant.

Public properties

engineVersion

Added in 9.5.0-alpha04

val engineVersion: Provider<String>

The version of the com.android.tools.screenshot:screenshot-validation-junit-engine artifact to use for layout rendering and screenshot validation.

imageDifferenceThreshold

Added in 9.5.0-alpha04

val imageDifferenceThreshold: Provider<Float>

The maximum allowed percentage difference between the reference image and the rendered image for a screenshot test to pass.

Specified as a floating-point value between 0.0f (exact match required) and 1.0f (100% difference allowed). For example, a value of 0.0001f represents a 0.01% difference threshold.

Default value is 0.0f (exact match required).