| /* |
| * Copyright (C) 2011 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.build.IDeviceBuildInfo; |
| import com.android.tradefed.command.remote.DeviceDescriptor; |
| import com.android.tradefed.config.Option; |
| import com.android.tradefed.config.Option.Importance; |
| 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.testtype.IAbi; |
| import com.android.tradefed.testtype.IAbiReceiver; |
| import com.android.tradefed.util.AaptParser; |
| import com.android.tradefed.util.AbiFormatter; |
| import com.android.tradefed.util.BuildTestsZipUtils; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.List; |
| |
| /** |
| * A {@link ITargetPreparer} that installs one or more apps from a {@link |
| * IDeviceBuildInfo#getTestsDir()} folder onto device. |
| * |
| * <p>This preparer will look in alternate directories if the tests zip does not exist or does not |
| * contain the required apk. The search will go in order from the last alternative dir specified to |
| * the first. |
| */ |
| @OptionClass(alias = "tests-zip-app") |
| public class TestAppInstallSetup extends BaseTargetPreparer |
| implements ITargetCleaner, IAbiReceiver { |
| |
| /** The mode the apk should be install in. */ |
| private enum InstallMode { |
| FULL, |
| INSTANT, |
| } |
| |
| // An error message that occurs when a test APK is already present on the DUT, |
| // but cannot be updated. When this occurs, the package is removed from the |
| // device so that installation can continue like normal. |
| private static final String INSTALL_FAILED_UPDATE_INCOMPATIBLE = |
| "INSTALL_FAILED_UPDATE_INCOMPATIBLE"; |
| |
| @Option(name = "test-file-name", |
| description = "the name of a test zip file to install on device. Can be repeated.", |
| importance = Importance.IF_UNSET) |
| private Collection<String> mTestFileNames = new ArrayList<String>(); |
| |
| @Option( |
| name = "throw-if-not-found", |
| description = "Throw exception if the specified file is not found." |
| ) |
| private boolean mThrowIfNoFile = true; |
| |
| @Option(name = AbiFormatter.FORCE_ABI_STRING, |
| description = AbiFormatter.FORCE_ABI_DESCRIPTION, |
| importance = Importance.IF_UNSET) |
| private String mForceAbi = null; |
| |
| @Option(name = "install-arg", |
| description = "Additional arguments to be passed to install command, " |
| + "including leading dash, e.g. \"-d\"") |
| private Collection<String> mInstallArgs = new ArrayList<>(); |
| |
| @Option(name = "cleanup-apks", |
| description = "Whether apks installed should be uninstalled after test. Note that the " |
| + "preparer does not verify if the apks are successfully removed.") |
| private boolean mCleanup = false; |
| |
| @Option(name = "alt-dir", |
| description = "Alternate directory to look for the apk if the apk is not in the tests " |
| + "zip file. For each alternate dir, will look in //, //data/app, //DATA/app, " |
| + "//DATA/app/apk_name/ and //DATA/priv-app/apk_name/. Can be repeated. " |
| + "Look for apks in last alt-dir first.") |
| private List<File> mAltDirs = new ArrayList<>(); |
| |
| @Option(name = "alt-dir-behavior", description = "The order of alternate directory to be used " |
| + "when searching for apks to install") |
| private AltDirBehavior mAltDirBehavior = AltDirBehavior.FALLBACK; |
| |
| @Option(name = "instant-mode", description = "Whether or not to install apk in instant mode.") |
| private boolean mInstantMode = false; |
| |
| @Option( |
| name = "force-install-mode", |
| description = |
| "Force the preparer to ignore instant-mode option, and install in the requested mode." |
| ) |
| private InstallMode mInstallMode = null; |
| |
| private IAbi mAbi = null; |
| private Integer mUserId = null; |
| private Boolean mGrantPermission = null; |
| |
| private List<String> mPackagesInstalled = null; |
| |
| /** |
| * Adds a file to the list of apks to install |
| * |
| * @param fileName |
| */ |
| public void addTestFileName(String fileName) { |
| mTestFileNames.add(fileName); |
| } |
| |
| /** Returns a copy of the list of specified test apk names. */ |
| public List<String> getTestsFileName() { |
| return new ArrayList<String>(mTestFileNames); |
| } |
| |
| /** Sets whether or not the installed apk should be cleaned on tearDown */ |
| public void setCleanApk(boolean shouldClean) { |
| mCleanup = shouldClean; |
| } |
| |
| /** |
| * If the apk should be installed for a particular user, sets the id of the user to install for. |
| */ |
| public void setUserId(int userId) { |
| mUserId = userId; |
| } |
| |
| /** If a userId is provided, grantPermission can be set for the apk installation. */ |
| public void setShouldGrantPermission(boolean shouldGrant) { |
| mGrantPermission = shouldGrant; |
| } |
| |
| /** Adds one apk installation arg to be used. */ |
| public void addInstallArg(String arg) { |
| mInstallArgs.add(arg); |
| } |
| |
| /** |
| * Resolve the actual apk path based on testing artifact information inside build info. |
| * |
| * @param buildInfo build artifact information |
| * @param apkFileName filename of the apk to install |
| * @param device the {@link ITestDevice} being prepared |
| * @return a {@link File} representing the physical apk file on host or {@code null} if the file |
| * does not exist. |
| */ |
| protected File getLocalPathForFilename( |
| IBuildInfo buildInfo, String apkFileName, ITestDevice device) throws TargetSetupError { |
| try { |
| return BuildTestsZipUtils.getApkFile(buildInfo, apkFileName, mAltDirs, mAltDirBehavior, |
| false /* use resource as fallback */, |
| null /* device signing key */); |
| } catch (IOException ioe) { |
| throw new TargetSetupError("failed to resolve apk path", ioe, |
| device.getDeviceDescriptor()); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void setUp(ITestDevice device, IBuildInfo buildInfo) |
| throws TargetSetupError, DeviceNotAvailableException { |
| if (mTestFileNames == null || mTestFileNames.size() == 0) { |
| CLog.i("No test apps to install, skipping"); |
| return; |
| } |
| if (mCleanup) { |
| mPackagesInstalled = new ArrayList<>(); |
| } |
| |
| for (String testAppName : mTestFileNames) { |
| if (testAppName == null || testAppName.trim().isEmpty()) { |
| continue; |
| } |
| File testAppFile = getLocalPathForFilename(buildInfo, testAppName, device); |
| if (testAppFile == null) { |
| if (mThrowIfNoFile) { |
| throw new TargetSetupError( |
| String.format("Test app %s was not found.", testAppName), |
| device.getDeviceDescriptor()); |
| } else { |
| CLog.d("Test app %s was not found.", testAppName); |
| continue; |
| } |
| } |
| if (!testAppFile.canRead()) { |
| if (mThrowIfNoFile) { |
| throw new TargetSetupError( |
| String.format("Could not read file %s.", testAppName), |
| device.getDeviceDescriptor()); |
| } else { |
| CLog.d("Could not read file %s.", testAppName); |
| continue; |
| } |
| } |
| // resolve abi flags |
| if (mAbi != null && mForceAbi != null) { |
| throw new IllegalStateException("cannot specify both abi flags"); |
| } |
| String abiName = null; |
| if (mAbi != null) { |
| abiName = mAbi.getName(); |
| } else if (mForceAbi != null) { |
| abiName = AbiFormatter.getDefaultAbi(device, mForceAbi); |
| } |
| if (abiName != null) { |
| mInstallArgs.add(String.format("--abi %s", abiName)); |
| } |
| // Handle instant mode: if we are forced in one installation mode or not. |
| if (mInstallMode != null) { |
| if (InstallMode.INSTANT.equals(mInstallMode)) { |
| mInstallArgs.add("--instant"); |
| } |
| } else { |
| if (mInstantMode) { |
| mInstallArgs.add("--instant"); |
| } |
| } |
| |
| String packageName = parsePackageName(testAppFile, device.getDeviceDescriptor()); |
| CLog.d("Installing apk from %s ...", testAppFile.getAbsolutePath()); |
| String result = installPackage(device, testAppFile); |
| if (result != null) { |
| if (result.startsWith(INSTALL_FAILED_UPDATE_INCOMPATIBLE)) { |
| // Try to uninstall package and reinstall. |
| uninstallPackage(device, packageName); |
| result = installPackage(device, testAppFile); |
| } |
| } |
| if (result != null) { |
| throw new TargetSetupError( |
| String.format("Failed to install %s on %s. Reason: '%s'", testAppName, |
| device.getSerialNumber(), result), device.getDeviceDescriptor()); |
| } |
| if (mCleanup) { |
| mPackagesInstalled.add(packageName); |
| } |
| } |
| } |
| |
| @Override |
| public void setAbi(IAbi abi) { |
| mAbi = abi; |
| } |
| |
| @Override |
| public IAbi getAbi() { |
| return mAbi; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public void tearDown(ITestDevice device, IBuildInfo buildInfo, Throwable e) |
| throws DeviceNotAvailableException { |
| if (mCleanup && mPackagesInstalled != null && !(e instanceof DeviceNotAvailableException)) { |
| for (String packageName : mPackagesInstalled) { |
| uninstallPackage(device, packageName); |
| } |
| } |
| } |
| |
| /** |
| * Set an alternate directory. |
| */ |
| public void setAltDir(File altDir) { |
| mAltDirs.add(altDir); |
| } |
| |
| /** |
| * Set an alternate directory behaviors. |
| */ |
| public void setAltDirBehavior(AltDirBehavior altDirBehavior) { |
| mAltDirBehavior = altDirBehavior; |
| } |
| |
| /** Attempt to install a package on the device. */ |
| private String installPackage(ITestDevice device, File testAppFile) |
| throws DeviceNotAvailableException { |
| // Handle the different install use cases (with or without a user) |
| if (mUserId == null) { |
| return device.installPackage(testAppFile, true, mInstallArgs.toArray(new String[] {})); |
| } else if (mGrantPermission != null) { |
| return device.installPackageForUser( |
| testAppFile, |
| true, |
| mGrantPermission, |
| mUserId, |
| mInstallArgs.toArray(new String[] {})); |
| } else { |
| return device.installPackageForUser( |
| testAppFile, true, mUserId, mInstallArgs.toArray(new String[] {})); |
| } |
| } |
| |
| /** Attempt to remove the package from the device. */ |
| private void uninstallPackage(ITestDevice device, String packageName) |
| throws DeviceNotAvailableException { |
| String msg = device.uninstallPackage(packageName); |
| if (msg != null) { |
| CLog.w(String.format("error uninstalling package '%s': %s", packageName, msg)); |
| } |
| } |
| |
| /** Get the package name from the test app. */ |
| protected String parsePackageName(File testAppFile, DeviceDescriptor deviceDescriptor) |
| throws TargetSetupError { |
| AaptParser parser = AaptParser.parse(testAppFile); |
| if (parser == null) { |
| throw new TargetSetupError("apk installed but AaptParser failed", deviceDescriptor); |
| } |
| return parser.getPackageName(); |
| } |
| } |
