tests/accessibility/common/src/android/accessibility/cts/common/ShellCommandBuilder.java

/*
 * Copyright (C) 2015 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.accessibility.cts.common;

import android.app.Instrumentation;
import android.app.UiAutomation;
import android.os.ParcelFileDescriptor;
import android.util.Log;

import com.android.compatibility.common.util.SystemUtil;

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.LinkedList;

/**
 * A helper class to execute batch of shell commands.
 */
public class ShellCommandBuilder {
    private static final String LOG_TAG = "ShellCommandBuilder";

    private final LinkedList<Runnable> mCommands = new LinkedList<>();
    private final UiAutomation mUiAutomation;

    /**
     * Returns a {@link ShellCommandBuilder} with an {@link UiAutomation} which doesn't suppress
     * accessibility service.
     */
    public static ShellCommandBuilder create(Instrumentation instrumentation) {
        return new ShellCommandBuilder(instrumentation.getUiAutomation(
                UiAutomation.FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES));
    }

    /**
     * Returns a {@link ShellCommandBuilder} with {@code uiAutomation}.
     */
    public static ShellCommandBuilder create(UiAutomation uiAutomation) {
        return new ShellCommandBuilder(uiAutomation);
    }

    private ShellCommandBuilder(UiAutomation uiAutomation) {
        mUiAutomation = uiAutomation;
    }

    public void run() {
        for (Runnable command : mCommands) {
            command.run();
        }
    }

    public ShellCommandBuilder deleteSecureSetting(String name) {
        addCommand("settings delete secure " + name);
        return this;
    }

    public ShellCommandBuilder putSecureSetting(String name, String value) {
        addCommand("settings put secure " + name + " " + value);
        return this;
    }

    public ShellCommandBuilder grantPermission(String packageName, String permission) {
        mCommands.add(() -> {
            mUiAutomation.grantRuntimePermission(packageName, permission);
        });
        return this;
    }

    public ShellCommandBuilder addCommand(String command) {
        mCommands.add(() -> {
            execShellCommand(mUiAutomation, command);
        });
        return this;
    }

    public ShellCommandBuilder addCommandPrintOnLogCat(String command) {
        mCommands.add(() -> {
            execShellCommandAndPrintOnLogcat(mUiAutomation, command);
        });
        return this;
    }

    public static void execShellCommandAndPrintOnLogcat(UiAutomation automation, String command) {
        Log.i(LOG_TAG, "command [" + command + "]");
        try {
            final String output = SystemUtil.runShellCommand(automation, command);
            for (String line : output.split("\\n", -1)) {
                Log.i(LOG_TAG, line);
            }
        } catch (IOException e) {
            throw new RuntimeException("Failed to exec shell command [" + command + "]", e);
        }
    }

    public static void execShellCommand(UiAutomation automation, String command) {
        Log.i(LOG_TAG, "command [" + command + "]");
        try (ParcelFileDescriptor fd = automation.executeShellCommand(command)) {
            try (InputStream inputStream = new FileInputStream(fd.getFileDescriptor())) {
                try (BufferedReader reader = new BufferedReader(
                        new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
                    while (reader.readLine() != null) {
                        // Keep reading.
                    }
                }
            }
        } catch (IOException e) {
            throw new RuntimeException("Failed to exec shell command [" + command + "]", e);
        }
    }
}