Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6e4f63a7 authored by Jordan Demeulenaere's avatar Jordan Demeulenaere
Browse files

Do pixel-perfect mapping on x86_64 devices only 

This CL changes the matcher used for unit screenshot tests so that we do
pixel-perfect matching only on x86_64 devices, and use the MSSIM matcher
otheriwse. See comment in the code and b/237511747 for more information.

Bug: 237511747
Test: atest SystemUIGoogleScreenshotTests
Change-Id: Ia8915de33521035d46f1854580db830b11f94e5c
parent 61d27419

packages/SystemUI/screenshot/src/com/android/systemui/testing/screenshot/ScreenshotTestRule.kt

+19 −2
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ import android.app.UiModeManager 
import android.content.Context

import android.graphics.Bitmap

import android.graphics.Canvas

import android.os.Build

import android.os.UserHandle

import android.view.Display

import android.view.View
@@ -32,6 +33,7 @@ import platform.test.screenshot.GoldenImagePathManager 
import platform.test.screenshot.PathConfig

import platform.test.screenshot.PathElementNoContext

import platform.test.screenshot.ScreenshotTestRule

import platform.test.screenshot.matchers.MSSIMMatcher

import platform.test.screenshot.matchers.PixelPerfectMatcher



/**
@@ -55,7 +57,11 @@ class ScreenshotTestRule(private val testSpec: ScreenshotTestSpec) : TestRule { 
                currentDisplay?.name ?: error("currentDisplay is null")

            },

        )

    private val defaultMatcher = PixelPerfectMatcher()

    private val matcher = if (shouldUsePerfectMatching()) {

        PixelPerfectMatcher()

    } else {

        MSSIMMatcher()

    }



    private val screenshotRule =

        ScreenshotTestRule(
@@ -67,6 +73,17 @@ class ScreenshotTestRule(private val testSpec: ScreenshotTestSpec) : TestRule { 
            )

        )



    private fun shouldUsePerfectMatching(): Boolean {

        // Different CPU architectures can sometimes end up rendering differently, so we can't do

        // pixel-perfect matching on different architectures using the same golden. Given that our

        // presubmits are run on cf_x86_64_phone, our goldens should be perfectly matched on the

        // x86_64 architecture and use the Structural Similarity Index on others.

        // TODO(b/237511747): Run our screenshot presubmit tests on arm64 instead so that we can

        // do pixel perfect matching both at presubmit time and at development time with actual

        // devices.

        return Build.CPU_ABI == "x86_64"

    }



    override fun apply(base: Statement, description: Description): Statement {

        // The statement which call beforeTest() before running the test and afterTest() afterwards.

        val statement =
@@ -147,7 +164,7 @@ class ScreenshotTestRule(private val testSpec: ScreenshotTestSpec) : TestRule { 
        // device to assertBitmapAgainstGolden instead?

        currentDisplay = testSpec.display

        currentGoldenIdentifier = goldenIdentifier

        screenshotRule.assertBitmapAgainstGolden(bitmap, identifierWithSpec, defaultMatcher)

        screenshotRule.assertBitmapAgainstGolden(bitmap, identifierWithSpec, matcher)

        currentDisplay = null

        currentGoldenIdentifier = goldenIdentifier

    }