aboutsummaryrefslogtreecommitdiff
path: root/src/com/android/tradefed/targetprep/PreloadedClassesPreparer.java
blob: c9636447d657fd73b5725d77dc4dcc6954c688c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * Copyright (C) 2017 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 com.android.tradefed.targetprep;

import com.android.tradefed.build.IBuildInfo;
import com.android.tradefed.config.Option;
import com.android.tradefed.config.OptionClass;
import com.android.tradefed.device.DeviceNotAvailableException;
import com.android.tradefed.device.ITestDevice;
import com.android.tradefed.log.LogUtil.CLog;
import com.android.tradefed.util.CommandResult;
import com.android.tradefed.util.CommandStatus;
import com.android.tradefed.util.IRunUtil;
import com.android.tradefed.util.RunUtil;

import com.google.common.annotations.VisibleForTesting;

import java.io.File;

/**
 * A {@link ITargetPreparer} that replaces the preloaded classes file on a device.
 *
 * <p>Note that this preparer requires a rooted, debug build to work.
 */
@OptionClass(alias = "preloaded-classes-preparer")
public class PreloadedClassesPreparer implements ITargetPreparer {
    // Preload tool commands
    private static final String TOOL_CMD = "java -cp %s com.android.preload.Main --seq %s %s";
    private static final String WRITE_CMD = "write %s";
    // Defaults
    public static final long DEFAULT_TIMEOUT_MS = 5 * 60 * 1000;

    @Option(
        name = "preload-file",
        description = "The new preloaded classes file to put on the device."
    )
    private File mNewClassesFile = null;

    @Option(name = "preload-tool", description = "Overridden location of the preload tool JAR.")
    private String mPreloadToolJarPath = "";

    @Option(name = "skip", description = "Skip this preparer entirely.")
    private boolean mSkip = false;

    @Option(
        name = "write-timeout",
        isTimeVal = true,
        description = "Maximum timeout for overwriting the file in milliseconds."
    )
    private long mWriteTimeout = DEFAULT_TIMEOUT_MS;

    /** {@inheritDoc} */
    @Override
    public void setUp(ITestDevice device, IBuildInfo buildInfo)
            throws TargetSetupError, BuildError, DeviceNotAvailableException {
        if (mSkip) {
            return;
        } else if (getPreloadedClassesPath().isEmpty()) {
            CLog.w("No preloaded classes file specified. Skipping preparer.");
            return;
        }

        // Download preload tool, if not supplied
        if (getPreloadToolPath().isEmpty()) {
            File preload = buildInfo.getFile("preload2.jar");
            if (preload != null && preload.exists()) {
                setPreloadToolPath(preload.getAbsolutePath());
            } else {
                throw new TargetSetupError(
                        "Unable to find the preload tool.", device.getDeviceDescriptor());
            }
        }

        // Root, disable verity, and remount
        device.enableAdbRoot();
        device.remountSystemWritable();
        // Root again after rebooting
        device.enableAdbRoot();
        // Construct the command
        String exportCmd = String.format(WRITE_CMD, getPreloadedClassesPath());
        String[] fullCmd =
                String.format(TOOL_CMD, getPreloadToolPath(), device.getSerialNumber(), exportCmd)
                        .split(" ");
        CommandResult result = getRunUtil().runTimedCmd(mWriteTimeout, fullCmd);
        if (!CommandStatus.SUCCESS.equals(result.getStatus())) {
            throw new TargetSetupError(
                    String.format("Error writing: %s", result.getStderr()),
                    device.getDeviceDescriptor());
        }
        // Wait for the device to be reconnected
        device.waitForDeviceAvailable();
    }

    /**
     * Get the {@link IRunUtil} instance to use.
     *
     * <p>Exposed so unit tests can mock.
     */
    @VisibleForTesting
    protected IRunUtil getRunUtil() {
        return RunUtil.getDefault();
    }

    /**
     * Get the preloaded classes file.
     *
     * <p>Exposed so unit tests can mock.
     */
    @VisibleForTesting
    protected String getPreloadedClassesPath() {
        return (mNewClassesFile != null) ? mNewClassesFile.getAbsolutePath() : "";
    }

    /** Get the preload tool path. */
    protected String getPreloadToolPath() {
        return mPreloadToolJarPath;
    }

    /** Set the preload tool path. */
    protected void setPreloadToolPath(String path) {
        mPreloadToolJarPath = path;
    }
}