hostsidetests/theme/src/android/theme/cts/ThemeHostTest.java - platform/cts - Git at Google

 /*
  * Copyright (C) 2014 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 android.theme.cts;

 import com.android.ddmlib.Log;
 import com.android.ddmlib.Log.LogLevel;
 import com.android.tradefed.device.CollectingOutputReceiver;
 import com.android.tradefed.device.DeviceNotAvailableException;
 import com.android.tradefed.device.ITestDevice;
 import com.android.tradefed.result.FileInputStreamSource;
 import com.android.tradefed.result.InputStreamSource;
 import com.android.tradefed.result.LogDataType;
 import com.android.tradefed.testtype.DeviceTestCase;
 import com.android.tradefed.util.Pair;
 import com.android.tradefed.util.StreamUtil;

 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.ExecutorCompletionService;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;

 /**
  * Test to check non-modifiable themes have not been changed.
  */
 public class ThemeHostTest extends DeviceTestCase {

     private static final String LOG_TAG = "ThemeHostTest";
     private static final String APP_PACKAGE_NAME = "android.theme.app";

     private static final String GENERATED_ASSETS_ZIP = "/sdcard/cts-theme-assets.zip";

     /** The class name of the main activity in the APK. */
     private static final String TEST_CLASS = "androidx.test.runner.AndroidJUnitRunner";

     /** The command to launch the main instrumentation test. */
     private static final String START_CMD = String.format(
             "am instrument -w --no-isolated-storage --no-window-animation %s/%s",
             APP_PACKAGE_NAME, TEST_CLASS);

     private static final String CLEAR_GENERATED_CMD = "rm -rf %s/*.png";
     private static final String STOP_CMD = String.format("am force-stop %s", APP_PACKAGE_NAME);
     private static final String HARDWARE_TYPE_CMD = "dumpsys | grep android.hardware.type";
     private static final String DENSITY_PROP_DEVICE = "ro.sf.lcd_density";
     private static final String DENSITY_PROP_EMULATOR = "qemu.sf.lcd_density";

     /** Shell command used to obtain current device density. */
     private static final String WM_DENSITY = "wm density";

     /** Overall test timeout is 30 minutes. Should only take about 5. */
     private static final int TEST_RESULT_TIMEOUT = 30 * 60 * 1000;

     /** Map of reference image names and files. */
     private Map<String, File> mReferences;

     /** A reference to the device under test. */
     private ITestDevice mDevice;

     private ExecutorService mExecutionService;

     private ExecutorCompletionService<Pair<String, File>> mCompletionService;

     // Density to which the device should be restored, or -1 if unnecessary.
     private int mRestoreDensity;


     @Override
     protected void setUp() throws Exception {
         super.setUp();

         mDevice = getDevice();
         mRestoreDensity = resetDensityIfNeeded(mDevice);
         final String density = getDensityBucketForDevice(mDevice);
         final String referenceZipAssetPath = String.format("/%s.zip", density);
         mReferences = extractReferenceImages(referenceZipAssetPath);

         final int numCores = Runtime.getRuntime().availableProcessors();
         mExecutionService = Executors.newFixedThreadPool(numCores * 2);
         mCompletionService = new ExecutorCompletionService<>(mExecutionService);
     }

     private Map<String, File> extractReferenceImages(String zipFile) throws Exception {
         final Map<String, File> references = new HashMap<>();
         final InputStream zipStream = ThemeHostTest.class.getResourceAsStream(zipFile);
         if (zipStream != null) {
             try (ZipInputStream in = new ZipInputStream(zipStream)) {
                 final byte[] buffer = new byte[1024];
                 for (ZipEntry ze; (ze = in.getNextEntry()) != null; ) {
                     final String name = ze.getName();
                     final File tmp = File.createTempFile("ref_" + name, ".png");
                     tmp.deleteOnExit();
                     try (FileOutputStream out = new FileOutputStream(tmp)) {
                         for (int count; (count = in.read(buffer)) != -1; ) {
                             out.write(buffer, 0, count);
                         }
                     }

                     references.put(name, tmp);
                 }
             } catch (IOException e) {
                 fail("Failed to unzip assets: " + zipFile);
             }
         } else {
             if (checkHardwareTypeSkipTest(mDevice.executeShellCommand(HARDWARE_TYPE_CMD).trim())) {
                 Log.logAndDisplay(LogLevel.WARN, LOG_TAG,
                         "Could not obtain resources for skipped themes test: " + zipFile);
             } else {
                 fail("Failed to get resource: " + zipFile);
             }
         }

         return references;
     }

     @Override
     protected void tearDown() throws Exception {
         mExecutionService.shutdown();

         // Remove generated images.
         mDevice.executeShellCommand(CLEAR_GENERATED_CMD);

         restoreDensityIfNeeded(mDevice, mRestoreDensity);

         super.tearDown();
     }

     public void testThemes() throws Exception {
         if (checkHardwareTypeSkipTest(mDevice.executeShellCommand(HARDWARE_TYPE_CMD).trim())) {
             Log.logAndDisplay(LogLevel.INFO, LOG_TAG, "Skipped themes test for watch / TV / automotive");
             return;
         }

         if (mReferences.isEmpty()) {
             Log.logAndDisplay(LogLevel.INFO, LOG_TAG,
                     "Skipped themes test due to missing reference images");
             return;
         }

         assertTrue("Aborted image generation, see device log for details", generateDeviceImages());

         // Pull ZIP file from remote device.
         final File localZip = File.createTempFile("generated", ".zip");
         assertTrue("Failed to pull generated assets from device",
                 mDevice.pullFile(GENERATED_ASSETS_ZIP, localZip));

         final int numTasks = extractGeneratedImages(localZip, mReferences);

         int failureCount = 0;
         for (int i = numTasks; i > 0; i--) {
             final Pair<String, File> comparison = mCompletionService.take().get();
             if (comparison != null) {
                 InputStreamSource inputStream = new FileInputStreamSource(comparison.second);
                 try{
                     // Log the diff file
                     addTestLog(comparison.first, LogDataType.PNG, inputStream);
                 } finally {
                     StreamUtil.cancel(inputStream);
                 }
                 failureCount++;
             }
         }

         assertTrue(failureCount + " failures in theme test", failureCount == 0);
     }

     private int extractGeneratedImages(File localZip, Map<String, File> references)
             throws IOException {
         int numTasks = 0;

         // Extract generated images to temporary files.
         final byte[] data = new byte[8192];
         try (ZipInputStream zipInput = new ZipInputStream(new FileInputStream(localZip))) {
             for (ZipEntry entry; (entry = zipInput.getNextEntry()) != null; ) {
                 final String name = entry.getName();
                 final File expected = references.get(name);
                 if (expected != null && expected.exists()) {
                     final File actual = File.createTempFile("actual_" + name, ".png");
                     actual.deleteOnExit();

                     try (FileOutputStream pngOutput = new FileOutputStream(actual)) {
                         for (int count; (count = zipInput.read(data, 0, data.length)) != -1; ) {
                             pngOutput.write(data, 0, count);
                         }
                     }

                     final String shortName = name.substring(0, name.indexOf('.'));
                     mCompletionService.submit(new ComparisonTask(shortName, expected, actual));
                     numTasks++;
                 } else {
                     Log.logAndDisplay(LogLevel.INFO, LOG_TAG,
                             "Missing reference image for " + name);
                 }

                 zipInput.closeEntry();
             }
         }

         return numTasks;
     }

     private boolean generateDeviceImages() throws Exception {
         // Stop any existing instances.
         mDevice.executeShellCommand(STOP_CMD);

         // Start instrumentation test.
         final CollectingOutputReceiver receiver = new CollectingOutputReceiver();
         mDevice.executeShellCommand(START_CMD, receiver, TEST_RESULT_TIMEOUT,
                 TimeUnit.MILLISECONDS, 0);

         return receiver.getOutput().contains("OK ");
     }

     private static String getDensityBucketForDevice(ITestDevice device) {
         final int density;
         try {
             density = getDensityForDevice(device);
         } catch (DeviceNotAvailableException e) {
             throw new RuntimeException("Failed to detect device density", e);
         }
         final String bucket;
         switch (density) {
             case 120:
                 bucket = "ldpi";
                 break;
             case 160:
                 bucket = "mdpi";
                 break;
             case 213:
                 bucket = "tvdpi";
                 break;
             case 240:
                 bucket = "hdpi";
                 break;
             case 320:
                 bucket = "xhdpi";
                 break;
             case 480:
                 bucket = "xxhdpi";
                 break;
             case 640:
                 bucket = "xxxhdpi";
                 break;
             default:
                 bucket = density + "dpi";
                 break;
         }

         Log.logAndDisplay(LogLevel.INFO, LOG_TAG,
                 "Device density detected as " + density + " (" + bucket + ")");
         return bucket;
     }

     private static int resetDensityIfNeeded(ITestDevice device) throws DeviceNotAvailableException {
         final String output = device.executeShellCommand(WM_DENSITY);
          final Pattern p = Pattern.compile("Override density: (\\d+)");
          final Matcher m = p.matcher(output);
          if (m.find()) {
              device.executeShellCommand(WM_DENSITY + " reset");
              int restoreDensity = Integer.parseInt(m.group(1));
              return restoreDensity;
          }
          return -1;
     }

     private static void restoreDensityIfNeeded(ITestDevice device, int restoreDensity)
             throws DeviceNotAvailableException {
         if (restoreDensity > 0) {
             device.executeShellCommand(WM_DENSITY + " " + restoreDensity);
         }
     }

     private static int getDensityForDevice(ITestDevice device) throws DeviceNotAvailableException {
         final String densityProp;
         if (device.getSerialNumber().startsWith("emulator-")) {
             densityProp = DENSITY_PROP_EMULATOR;
         } else {
             densityProp = DENSITY_PROP_DEVICE;
         }
         return Integer.parseInt(device.getProperty(densityProp));
     }

     private static boolean checkHardwareTypeSkipTest(String hardwareTypeString) {
         return hardwareTypeString.contains("android.hardware.type.watch")
                 || hardwareTypeString.contains("android.hardware.type.television")
                 || hardwareTypeString.contains("android.hardware.type.automotive");
     }
 }
	/*
	* Copyright (C) 2014 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 android.theme.cts;

	import com.android.ddmlib.Log;
	import com.android.ddmlib.Log.LogLevel;
	import com.android.tradefed.device.CollectingOutputReceiver;
	import com.android.tradefed.device.DeviceNotAvailableException;
	import com.android.tradefed.device.ITestDevice;
	import com.android.tradefed.result.FileInputStreamSource;
	import com.android.tradefed.result.InputStreamSource;
	import com.android.tradefed.result.LogDataType;
	import com.android.tradefed.testtype.DeviceTestCase;
	import com.android.tradefed.util.Pair;
	import com.android.tradefed.util.StreamUtil;

	import java.io.File;
	import java.io.FileInputStream;
	import java.io.FileOutputStream;
	import java.io.IOException;
	import java.io.InputStream;
	import java.util.HashMap;
	import java.util.Map;
	import java.util.concurrent.ExecutorCompletionService;
	import java.util.concurrent.ExecutorService;
	import java.util.concurrent.Executors;
	import java.util.concurrent.TimeUnit;
	import java.util.regex.Matcher;
	import java.util.regex.Pattern;
	import java.util.zip.ZipEntry;
	import java.util.zip.ZipInputStream;

	/**
	* Test to check non-modifiable themes have not been changed.
	*/
	public class ThemeHostTest extends DeviceTestCase {

	private static final String LOG_TAG = "ThemeHostTest";
	private static final String APP_PACKAGE_NAME = "android.theme.app";

	private static final String GENERATED_ASSETS_ZIP = "/sdcard/cts-theme-assets.zip";

	/** The class name of the main activity in the APK. */
	private static final String TEST_CLASS = "androidx.test.runner.AndroidJUnitRunner";

	/** The command to launch the main instrumentation test. */
	private static final String START_CMD = String.format(
	"am instrument -w --no-isolated-storage --no-window-animation %s/%s",
	APP_PACKAGE_NAME, TEST_CLASS);

	private static final String CLEAR_GENERATED_CMD = "rm -rf %s/*.png";
	private static final String STOP_CMD = String.format("am force-stop %s", APP_PACKAGE_NAME);
	private static final String HARDWARE_TYPE_CMD = "dumpsys \| grep android.hardware.type";
	private static final String DENSITY_PROP_DEVICE = "ro.sf.lcd_density";
	private static final String DENSITY_PROP_EMULATOR = "qemu.sf.lcd_density";

	/** Shell command used to obtain current device density. */
	private static final String WM_DENSITY = "wm density";

	/** Overall test timeout is 30 minutes. Should only take about 5. */
	private static final int TEST_RESULT_TIMEOUT = 30 * 60 * 1000;

	/** Map of reference image names and files. */
	private Map<String, File> mReferences;

	/** A reference to the device under test. */
	private ITestDevice mDevice;

	private ExecutorService mExecutionService;

	private ExecutorCompletionService<Pair<String, File>> mCompletionService;

	// Density to which the device should be restored, or -1 if unnecessary.
	private int mRestoreDensity;


	@Override
	protected void setUp() throws Exception {
	super.setUp();

	mDevice = getDevice();
	mRestoreDensity = resetDensityIfNeeded(mDevice);
	final String density = getDensityBucketForDevice(mDevice);
	final String referenceZipAssetPath = String.format("/%s.zip", density);
	mReferences = extractReferenceImages(referenceZipAssetPath);

	final int numCores = Runtime.getRuntime().availableProcessors();
	mExecutionService = Executors.newFixedThreadPool(numCores * 2);
	mCompletionService = new ExecutorCompletionService<>(mExecutionService);
	}

	private Map<String, File> extractReferenceImages(String zipFile) throws Exception {
	final Map<String, File> references = new HashMap<>();
	final InputStream zipStream = ThemeHostTest.class.getResourceAsStream(zipFile);
	if (zipStream != null) {
	try (ZipInputStream in = new ZipInputStream(zipStream)) {
	final byte[] buffer = new byte[1024];
	for (ZipEntry ze; (ze = in.getNextEntry()) != null; ) {
	final String name = ze.getName();
	final File tmp = File.createTempFile("ref_" + name, ".png");
	tmp.deleteOnExit();
	try (FileOutputStream out = new FileOutputStream(tmp)) {
	for (int count; (count = in.read(buffer)) != -1; ) {
	out.write(buffer, 0, count);
	}
	}

	references.put(name, tmp);
	}
	} catch (IOException e) {
	fail("Failed to unzip assets: " + zipFile);
	}
	} else {
	if (checkHardwareTypeSkipTest(mDevice.executeShellCommand(HARDWARE_TYPE_CMD).trim())) {
	Log.logAndDisplay(LogLevel.WARN, LOG_TAG,
	"Could not obtain resources for skipped themes test: " + zipFile);
	} else {
	fail("Failed to get resource: " + zipFile);
	}
	}

	return references;
	}

	@Override
	protected void tearDown() throws Exception {
	mExecutionService.shutdown();

	// Remove generated images.
	mDevice.executeShellCommand(CLEAR_GENERATED_CMD);

	restoreDensityIfNeeded(mDevice, mRestoreDensity);

	super.tearDown();
	}

	public void testThemes() throws Exception {
	if (checkHardwareTypeSkipTest(mDevice.executeShellCommand(HARDWARE_TYPE_CMD).trim())) {
	Log.logAndDisplay(LogLevel.INFO, LOG_TAG, "Skipped themes test for watch / TV / automotive");
	return;
	}

	if (mReferences.isEmpty()) {
	Log.logAndDisplay(LogLevel.INFO, LOG_TAG,
	"Skipped themes test due to missing reference images");
	return;
	}

	assertTrue("Aborted image generation, see device log for details", generateDeviceImages());

	// Pull ZIP file from remote device.
	final File localZip = File.createTempFile("generated", ".zip");
	assertTrue("Failed to pull generated assets from device",
	mDevice.pullFile(GENERATED_ASSETS_ZIP, localZip));

	final int numTasks = extractGeneratedImages(localZip, mReferences);

	int failureCount = 0;
	for (int i = numTasks; i > 0; i--) {
	final Pair<String, File> comparison = mCompletionService.take().get();
	if (comparison != null) {
	InputStreamSource inputStream = new FileInputStreamSource(comparison.second);
	try{
	// Log the diff file
	addTestLog(comparison.first, LogDataType.PNG, inputStream);
	} finally {
	StreamUtil.cancel(inputStream);
	}
	failureCount++;
	}
	}

	assertTrue(failureCount + " failures in theme test", failureCount == 0);
	}

	private int extractGeneratedImages(File localZip, Map<String, File> references)
	throws IOException {
	int numTasks = 0;

	// Extract generated images to temporary files.
	final byte[] data = new byte[8192];
	try (ZipInputStream zipInput = new ZipInputStream(new FileInputStream(localZip))) {
	for (ZipEntry entry; (entry = zipInput.getNextEntry()) != null; ) {
	final String name = entry.getName();
	final File expected = references.get(name);
	if (expected != null && expected.exists()) {
	final File actual = File.createTempFile("actual_" + name, ".png");
	actual.deleteOnExit();

	try (FileOutputStream pngOutput = new FileOutputStream(actual)) {
	for (int count; (count = zipInput.read(data, 0, data.length)) != -1; ) {
	pngOutput.write(data, 0, count);
	}
	}

	final String shortName = name.substring(0, name.indexOf('.'));
	mCompletionService.submit(new ComparisonTask(shortName, expected, actual));
	numTasks++;
	} else {
	Log.logAndDisplay(LogLevel.INFO, LOG_TAG,
	"Missing reference image for " + name);
	}

	zipInput.closeEntry();
	}
	}

	return numTasks;
	}

	private boolean generateDeviceImages() throws Exception {
	// Stop any existing instances.
	mDevice.executeShellCommand(STOP_CMD);

	// Start instrumentation test.
	final CollectingOutputReceiver receiver = new CollectingOutputReceiver();
	mDevice.executeShellCommand(START_CMD, receiver, TEST_RESULT_TIMEOUT,
	TimeUnit.MILLISECONDS, 0);

	return receiver.getOutput().contains("OK ");
	}

	private static String getDensityBucketForDevice(ITestDevice device) {
	final int density;
	try {
	density = getDensityForDevice(device);
	} catch (DeviceNotAvailableException e) {
	throw new RuntimeException("Failed to detect device density", e);
	}
	final String bucket;
	switch (density) {
	case 120:
	bucket = "ldpi";
	break;
	case 160:
	bucket = "mdpi";
	break;
	case 213:
	bucket = "tvdpi";
	break;
	case 240:
	bucket = "hdpi";
	break;
	case 320:
	bucket = "xhdpi";
	break;
	case 480:
	bucket = "xxhdpi";
	break;
	case 640:
	bucket = "xxxhdpi";
	break;
	default:
	bucket = density + "dpi";
	break;
	}

	Log.logAndDisplay(LogLevel.INFO, LOG_TAG,
	"Device density detected as " + density + " (" + bucket + ")");
	return bucket;
	}

	private static int resetDensityIfNeeded(ITestDevice device) throws DeviceNotAvailableException {
	final String output = device.executeShellCommand(WM_DENSITY);
	final Pattern p = Pattern.compile("Override density: (\\d+)");
	final Matcher m = p.matcher(output);
	if (m.find()) {
	device.executeShellCommand(WM_DENSITY + " reset");
	int restoreDensity = Integer.parseInt(m.group(1));
	return restoreDensity;
	}
	return -1;
	}

	private static void restoreDensityIfNeeded(ITestDevice device, int restoreDensity)
	throws DeviceNotAvailableException {
	if (restoreDensity > 0) {
	device.executeShellCommand(WM_DENSITY + " " + restoreDensity);
	}
	}

	private static int getDensityForDevice(ITestDevice device) throws DeviceNotAvailableException {
	final String densityProp;
	if (device.getSerialNumber().startsWith("emulator-")) {
	densityProp = DENSITY_PROP_EMULATOR;
	} else {
	densityProp = DENSITY_PROP_DEVICE;
	}
	return Integer.parseInt(device.getProperty(densityProp));
	}

	private static boolean checkHardwareTypeSkipTest(String hardwareTypeString) {
	return hardwareTypeString.contains("android.hardware.type.watch")
	\|\| hardwareTypeString.contains("android.hardware.type.television")
	\|\| hardwareTypeString.contains("android.hardware.type.automotive");
	}
	}