Capture the layout of all screens - Android App

Question

I want to test android apps for accessibility violation. Is it possible to use uiautomator api and monkeyrunner api to capture the layout of all screens?

Answer 1

You can simply use AndroidViewClient's dump:

$ dump --help
usage: dump [OPTION]... [serialno]

Options:
  -H, --help                       prints this help                             
  -V, --verbose                    verbose comments                             
  -v, --version
  -I, --ignore-secure-device       ignore secure device                         
  -E, --ignore-version-check       ignores ADB version check                    
  -F, --force-view-server-use      force view server use (even if UiAutomator present)
  -S, --do-not-start-view-server   don't start ViewServer                       
  -k, --do-not-ignore-uiautomator-killed don't ignore UiAutomator killed              
  -w, --window=WINDOW              dump WINDOW content (default: -1, all windows)
  -i, --uniqueId                   dump View unique IDs                         
  -x, --position                   dump View positions                          
  -d, --content-description        dump View content descriptions               
  -c, --center                     dump View centers                            
  -f, --save-screenshot=FILE       save screenshot to file                      
  -W, --save-view-screenshots=DIR  save View screenshots to files in directory  
  -D, --do-not-dump-views          don't dump views, only useful if you specified -f or -W

In you case, probably

$ dump -d

is enough.

EDIT

If you want something more complex than just saving the logical content of the screen, you can use culebra (another tool in AndroidViewClient) that allows you to generate automated tests using a GUI:

$ culebra -UG -o mytest.py

You can interact with the mirror representation of the device screen in culebra's main window to generate the test. Save it. Run it on any device, even a completely different one.

Answer 2

import android.util.Log;

import com.android.uiautomator.testrunner.UiAutomatorTestCase;

import java.io.File;

public class TestUtils {

        private UiAutomatorTestCase mTestCase;

        public TestUtils(UiAutomatorTestCase testCase) {
            mTestCase = testCase;
        }
            public void sleepInSeconds(int timeInSeconds) {
                    mTestCase.sleep(timeInSeconds * 1000);
                }

            public String getFileName(String fileNameSuffix) {
                    String tempFileName = fileNameSuffix.toLowerCase().replace(" ", "_")
                            .replace("?", "_");
                    String fileName = String.format("%d_%s", System.currentTimeMillis(),
                            tempFileName);
                    return fileName;
                }

            // Note: You need to have file name as a single string.
            // This will get the UiHierarchy
            public String saveUiHierarchyToFile(String nameOfFile) {
                    String fileName = nameOfFile;
                    if (nameOfFile.contains(" ")) {
                        fileName = getFileName(nameOfFile);
                    }
                    sleepInSeconds(10);
                    try {
                        File hierarchyFile = new File(fileName + ".uix");
                        mTestCase.getUiDevice().dumpWindowHierarchy(hierarchyFile
                                .getAbsolutePath());
                        Log.d(mTestCase.getClass().getSimpleName(), String.format("\t ** UI hierarchy: " +
                                "/data/local/tmp%s", hierarchyFile.getAbsolutePath()));
                        return hierarchyFile.getAbsolutePath();
                    } catch (Exception e) {
                        Log.d(mTestCase.getName(), "\t ** Unable to save view hierarchy" +
                                " to a file", e);
                    }
                    return null;
                }

        // This will get the screen shot
        public String saveScreenshot(String nameOfFile) throws Exception {
                String fileName = nameOfFile;
                if (nameOfFile.contains(" ")) {
                    fileName = getFileName(nameOfFile);
                }
                sleepInSeconds(10);
                File screenshotFile = new File("/data/local/tmp",
                        fileName + ".png");
                mTestCase.getUiDevice().takeScreenshot(
                        new File(screenshotFile.getAbsolutePath()));
                Log.d(mTestCase.getClass().getSimpleName(), String.format("\t ** Screenshot: %s",
                        screenshotFile.getAbsolutePath()));
                return screenshotFile.getAbsolutePath();
            }

        // Store UiAutomator viewer
        public void storeUiAutomatorViewerFiles(String nameOfFile)
                    throws Exception {
                String fileName = getFileName(nameOfFile);
                saveScreenshot(fileName);
                saveUiHierarchyToFile(fileName);
            }
}