xref: /tools/tradefederation/core/src/com/android/tradefed/command/CommandOptions.java

/*
 * 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.command;

import com.android.tradefed.config.ConfigurationException;
import com.android.tradefed.config.Option;
import com.android.tradefed.config.Option.Importance;
import com.android.tradefed.config.OptionCopier;
import com.android.tradefed.device.metric.AutoLogCollector;
import com.android.tradefed.log.LogUtil.CLog;
import com.android.tradefed.util.UniqueMultiMap;

import java.io.File;
import java.time.Duration;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Implementation of {@link ICommandOptions}.
 */
public class CommandOptions implements ICommandOptions {

    @Option(name = "help", description =
        "display the help text for the most important/critical options.",
        importance = Importance.ALWAYS)
    private boolean mHelpMode = false;

    @Option(name = "help-all", description = "display the full help text for all options.",
            importance = Importance.ALWAYS)
    private boolean mFullHelpMode = false;

    public static final String DRY_RUN_OPTION = "dry-run";
    public static final String NOISY_DRY_RUN_OPTION = "noisy-dry-run";

    @Option(
        name = DRY_RUN_OPTION,
        description =
                "build but don't actually run the command.  Intended as a quick check "
                        + "to ensure that a command is runnable.",
        importance = Importance.ALWAYS
    )
    private boolean mDryRunMode = false;

    @Option(
        name = NOISY_DRY_RUN_OPTION,
        description =
                "build but don't actually run the command.  This version prints the "
                        + "command to the console.  Intended for cmdfile debugging.",
        importance = Importance.ALWAYS
    )
    private boolean mNoisyDryRunMode = false;

    @Option(name = "min-loop-time", description =
            "the minimum invocation time in ms when in loop mode.")
    private Long mMinLoopTime = 10L * 60L * 1000L;

    public static final String TEST_TAG_OPTION = "test-tag";

    @Option(name = TEST_TAG_OPTION, description = "Identifier for the invocation during reporting.")
    private String mTestTag = "stub";

    @Option(name = "test-tag-suffix", description = "suffix for test-tag. appended to test-tag to "
            + "represents some variants of one test.")
    private String mTestTagSuffix = null;

    @Option(name = "loop", description = "keep running continuously.",
            importance = Importance.ALWAYS)
    private boolean mLoopMode = false;

    @Option(name = "max-loops", description = "the maximum number of loops.")
    private long mMaxLoopCount = Long.MAX_VALUE;

    @Option(name = "all-devices", description =
            "fork this command to run on all connected devices.")
    private boolean mAllDevices = false;

    @Option(name = "bugreport-on-invocation-ended", description =
            "take a bugreport when the test invocation has ended")
    private boolean mTakeBugreportOnInvocationEnded = false;

    @Option(name = "bugreportz-on-invocation-ended", description = "Attempt to take a bugreportz "
            + "instead of bugreport during the test invocation final bugreport.")
    private boolean mTakeBugreportzOnInvocationEnded = false;

    @Option(
            name = "disable-conditional-bugreport",
            description =
                    "Disable the optimization to capture ANR instead of bugreport if no failure.")
    private boolean mDisableConditionalBugreport = false;

    @Option(name = "invocation-timeout", description =
            "the maximum time to wait for an invocation to terminate before attempting to force"
            + "stop it.", isTimeVal = true)
    private long mInvocationTimeout = 0;

    @Option(name = "shard-count", description =
            "the number of total shards to run. Without --shard-index option, this will cause " +
            "the command to spawn multiple shards in the current TF instance. With --shard-index " +
            "option, it will cause the command to run a single shard of tests only.")
    private Integer mShardCount;

    @Option(name = "shard-index", description =
            "the index of shard to run. Only set if shard-count > 1 and the value is in range " +
            "[0, shard-count)")
    private Integer mShardIndex;

    @Option(name = "optimize-mainline-test", description =
            "Whether or not to optimize the list of test modules for mainline.")
    private boolean mOptimizeMainlineTest;

    @Option(
        name = "enable-token-sharding",
        description = "Whether or not to allow sharding with the token support enabled."
    )
    private boolean mTokenSharding = false;

    @Option(
        name = "dynamic-sharding",
        description =
                "Allow to dynamically move IRemoteTest from one shard to another. Only for local "
                        + "sharding."
    )
    private boolean mDynamicSharding = true;

    @Option(
            name = "remote-dynamic-sharding",
            description =
                    "Enable use of the dynamic sharding service to load balance across multiple"
                            + " hosts.")
    private boolean mRemoteDynamicSharding = false;

    @Option(
            name = "use-even-module-sharding",
            description =
                    "Enable use of a strategy that attempts to distribute number of "
                            + "modules evenly across shards")
    private boolean mEvenModuleSharding = false;

    public static final String INVOCATION_DATA = "invocation-data";

    @Option(
            name = INVOCATION_DATA,
            description =
                    "A map of values that describe the invocation, these values will be added to"
                            + " the invocation context.")
    private UniqueMultiMap<String, String> mInvocationData = new UniqueMultiMap<>();

    public static final String USE_SANDBOX = "use-sandbox";
    public static final String ENABLE_SANDBOX_TEST_MODE = "sandbox-test-mode";
    public static final String USE_REMOTE_SANDBOX = "use-remote-sandbox";

    @Option(
            name = "remote-files",
            description = "A list of files references to store in build info")
    private Set<String> mRemoteFiles = new LinkedHashSet<>();

    @Option(
        name = USE_SANDBOX,
        description = "Set if the invocation should use a sandbox to run or not."
    )
    private boolean mUseSandbox = false;

    @Option(
            name = ENABLE_SANDBOX_TEST_MODE,
            description =
                    "Sandbox test mode where the sandbox will use itself to generate another layer "
                            + "of sandboxing. This is used for the sandbox to validate itself.")
    private boolean mSandboxTestMode = false;

    @Option(
        name = USE_REMOTE_SANDBOX,
        description = "Whether or not to trigger --use-sandbox in the remote invocation."
    )
    private boolean mUseRemoteSandbox = false;

    @Option(
            name = "deviceless-remote-exec",
            description = "Whether or not to trigger --null-deviec in the remote invocation.")
    private boolean mDevicelessRemoteExecution = false;

    @Deprecated
    @Option(
            name = "parallel-remote-setup",
            description =
                    "For remote sharded invocation, whether or not to attempt the setup in"
                            + " parallel.")
    private boolean mUseParallelRemoteSetup = false;

    @Option(
            name = "parallel-pre-invocation-setup",
            description = "Whether to execute pre-invocation setup in parallel.")
    private boolean mUseParallelPreInvocationSetup = false;

    @Option(
            name = "parallel-pre-invocation-setup-timeout",
            description = "Timeout for parallel pre-invocation setup.")
    private Duration mParallelPreInvocationSetupTimeout = Duration.ofMinutes(30L);

    @Option(name = "parallel-setup", description = "Whether to attempt the setup in parallel.")
    private boolean mUseParallelSetup = false;

    @Option(name = "parallel-setup-timeout", description = "Timeout to use during parallel setup.")
    private Duration mParallelSetupTimeout = Duration.ofMinutes(30L);

    @Option(
            name = "replicate-parent-setup",
            description =
                    "For remote sharded invocation, whether or not to replicate parent setup on "
                            + "all devices.")
    private boolean mReplicateParentSetup = false;

    @Option(
        name = "report-module-progression",
        description = "For remote invocation, whether or not to report progress at module level."
    )
    private boolean mReportModuleProgression = false;

    @Deprecated
    @Option(
            name = "extra-postsubmit-remote-instance",
            description =
                    "Option that allows to run more instances in the remote VM in postsubmit. "
                            + "Used for experimentation.")
    private int mExtraRemoteInstancePostsubmit = 0;

    @Option(
        name = "auto-collect",
        description =
                "Specify a set of collectors that will be automatically managed by the harness "
                        + "to collect logs."
    )
    private Set<AutoLogCollector> mAutoCollectors = new LinkedHashSet<>();

    @Option(
            name = "experiment-enabled",
            description = "A feature flag used to enable experimental flags.")
    private boolean mExperimentEnabled = false;

    @Option(
            name = "experimental-flags",
            description = "Map of experimental flags that can be used for feature gating projects.")
    private Map<String, String> mExperimentalFlags = new LinkedHashMap<>();

    @Deprecated
    @Option(
        name = "logcat-on-failure",
        description = "take a logcat snapshot on every test failure."
    )
    private boolean mLogcatOnFailure = false;

    @Deprecated
    @Option(name = "screenshot-on-failure", description = "Take a screenshot on every test failure")
    private boolean mScreenshotOnFailure = false;

    @Option(
        name = "host-log-suffix",
        description = "Suffix to add to Tradefed host_log before logging it."
    )
    private String mHostLogSuffix = null;

    @Option(
            name = "early-device-release",
            description = "Feature flag to release the device as soon as done with it.")
    private boolean mEnableEarlyDeviceRelease = true;

    @Option(
            name = "delegated-early-device-release",
            description =
                    "Feature flag to enable early device release when running in delegated mode.")
    private boolean mEnableDelegatedEarlyDeviceRelease = true;

    @Option(
            name = "dynamic-download-args",
            description =
                    "Extra args passed to the IRemoteFileResolver interface for dynamic download "
                            + "in the queryArgs.")
    private Map<String, String> mDynamicDownloadArgs = new LinkedHashMap<>();

    @Option(
            name = "report-counted-test-cases",
            description = "Whether or not to report the number of test cases per test types.")
    private boolean mCountTestCases = true;

    @Option(
            name = "report-passed-tests",
            description = "Whether or not to report the passed tests in a file.")
    private boolean mReportPassedTests = true;

    @Option(
            name = "filter-previous-passed",
            description = "Feature flag to test filtering previously passed tests.")
    private boolean mTestFilterPassed = true;

    @Option(
            name = "report-invocation-complete-logs",
            description = "Whether or not to attempt to report the logs until invocationComplete.")
    private boolean mReportInvocationCompleteLogs = true;

    @Option(
            name = "disable-invocation-setup-and-teardown",
            description = "Disable the pre-invocation setup and post-invocation teardown phases.")
    private boolean mDisableInvocationSetupAndTeardown = false;

    @Option(
            name = "multi-device-count",
            description = "The number of devices for multi-device tests. For a new feature "
                                  + "under developing, not for other uses.")
    private Integer mMultiDeviceCount;

    @Option(name = "enable-tracing", description = "Enable test invocation tracing.")
    private boolean mTracingEnabled = true;

    public static final String JDK_FOLDER_OPTION_NAME = "jdk-folder-for-subprocess";

    @Option(
            name = "parallel-dynamic-download",
            description = "Enable parallel download of dynamic files when supported.")
    private boolean mEnableParallelDynamicDownload = false;

    @Option(
            name = JDK_FOLDER_OPTION_NAME,
            description =
                    "Whenever the java execution is forked to another subprocess, use this jdk"
                            + " folder instead of current one.")
    private File mJdkFolder;

    /**
     * Set the help mode for the config.
     * <p/>
     * Exposed for testing.
     */
    void setHelpMode(boolean helpMode) {
        mHelpMode = helpMode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isHelpMode() {
        return mHelpMode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isFullHelpMode() {
        return mFullHelpMode;
    }

    /**
     * Set the dry run mode for the config.
     * <p/>
     * Exposed for testing.
     */
    void setDryRunMode(boolean dryRunMode) {
        mDryRunMode = dryRunMode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isDryRunMode() {
        return mDryRunMode || mNoisyDryRunMode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isNoisyDryRunMode() {
        return mNoisyDryRunMode;
    }

    /**
     * Set the loop mode for the config.
     */
    @Override
    public void setLoopMode(boolean loopMode) {
        mLoopMode = loopMode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isLoopMode() {
        return mLoopMode;
    }

    /**
     * Set the min loop time for the config.
     * <p/>
     * Exposed for testing.
     */
    void setMinLoopTime(long loopTime) {
        mMinLoopTime = loopTime;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public long getLoopTime() {
        return mMinLoopTime;
    }

    @Override
    public long getMaxLoopCount() {
        return mMaxLoopCount;
    }

    @Override
    public ICommandOptions clone() {
        CommandOptions clone = new CommandOptions();
        try {
            OptionCopier.copyOptions(this, clone);
        } catch (ConfigurationException e) {
            CLog.e("failed to clone command options: %s", e.getMessage());
        }
        return clone;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean runOnAllDevices() {
        return mAllDevices;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean takeBugreportOnInvocationEnded() {
        return mTakeBugreportOnInvocationEnded;
    }

    /** {@inheritDoc} */
    @Override
    public void setBugreportOnInvocationEnded(boolean takeBugreport) {
        mTakeBugreportOnInvocationEnded = takeBugreport;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean takeBugreportzOnInvocationEnded() {
        return mTakeBugreportzOnInvocationEnded;
    }

    /** {@inheritDoc} */
    @Override
    public void setBugreportzOnInvocationEnded(boolean takeBugreportz) {
        mTakeBugreportzOnInvocationEnded = takeBugreportz;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isConditionalBugreportDisabled() {
        return mDisableConditionalBugreport;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public long getInvocationTimeout() {
        return mInvocationTimeout;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setInvocationTimeout(Long invocationTimeout) {
        mInvocationTimeout = invocationTimeout;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean getOptimizeMainlineTest() {
        return mOptimizeMainlineTest;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Integer getShardCount() {
        return mShardCount;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setShardCount(Integer shardCount) {
        mShardCount = shardCount;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Integer getShardIndex() {
        return mShardIndex;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setShardIndex(Integer shardIndex) {
        mShardIndex = shardIndex;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseTokenSharding() {
        return mTokenSharding;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setTestTag(String testTag) {
       mTestTag = testTag;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getTestTag() {
        return mTestTag;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getTestTagSuffix() {
        return mTestTagSuffix;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseDynamicSharding() {
        return mDynamicSharding;
    }

    /** {@inheritDoc} */
    @Override
    public UniqueMultiMap<String, String> getInvocationData() {
        return mInvocationData;
    }

    /** {@inheritDoc} */
    @Override
    public Set<String> getRemoteFiles() {
        return mRemoteFiles;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseSandboxing() {
        return mUseSandbox;
    }

    /** {@inheritDoc} */
    @Override
    public void setShouldUseSandboxing(boolean use) {
        mUseSandbox = use;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseSandboxTestMode() {
        return mSandboxTestMode;
    }

    /** {@inheritDoc} */
    @Override
    public void setUseSandboxTestMode(boolean use) {
        mSandboxTestMode = use;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseRemoteSandboxMode() {
        return mUseRemoteSandbox;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isRemoteInvocationDeviceless() {
        return mDevicelessRemoteExecution;
    }

    /** {@inheritDoc} */
    @Override
    public Set<AutoLogCollector> getAutoLogCollectors() {
        return mAutoCollectors;
    }

    /** {@inheritDoc} */
    @Override
    public void setAutoLogCollectors(Set<AutoLogCollector> autoLogCollectors) {
        mAutoCollectors = autoLogCollectors;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isExperimentEnabled() {
        return mExperimentEnabled;
    }

    /** {@inheritDoc} */
    @Override
    public Map<String, String> getExperimentalFlags() {
        return mExperimentalFlags;
    }

    /** {@inheritDoc} */
    @Override
    public boolean captureScreenshotOnFailure() {
        return mScreenshotOnFailure;
    }

    /** {@inheritDoc} */
    @Override
    public boolean captureLogcatOnFailure() {
        return mLogcatOnFailure;
    }

    /** {@inheritDoc} */
    @Override
    public String getHostLogSuffix() {
        return mHostLogSuffix;
    }

    /** {@inheritDoc} */
    @Override
    public void setHostLogSuffix(String suffix) {
        mHostLogSuffix = suffix;
    }
    /** {@inheritDoc} */
    @Override
    public boolean shouldUseParallelRemoteSetup() {
        return mUseParallelRemoteSetup;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseParallelPreInvocationSetup() {
        return mUseParallelPreInvocationSetup;
    }

    /** {@inheritDoc} */
    @Override
    public Duration getParallelPreInvocationSetupTimeout() {
        return mParallelPreInvocationSetupTimeout;
    }
    /** {@inheritDoc} */
    @Override
    public boolean shouldUseParallelSetup() {
        return mUseParallelSetup;
    }

    /** {@inheritDoc} */
    @Override
    public Duration getParallelSetupTimeout() {
        return mParallelSetupTimeout;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseReplicateSetup() {
        return mReplicateParentSetup;
    }

    /** {@inheritDoc} */
    @Override
    public void setReplicateSetup(boolean replicate) {
        mReplicateParentSetup = replicate;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldReportModuleProgression() {
        return mReportModuleProgression;
    }

    /** {@inheritDoc} */
    @Override
    public int getExtraRemotePostsubmitInstance() {
        return mExtraRemoteInstancePostsubmit;
    }

    /** {@inheritDoc} */
    @Override
    public boolean earlyDeviceRelease() {
        return mEnableEarlyDeviceRelease;
    }

    /** {@inheritDoc} */
    @Override
    public boolean delegatedEarlyDeviceRelease() {
        return mEnableDelegatedEarlyDeviceRelease;
    }

    /** {@inheritDoc} */
    @Override
    public void setDelegatedEarlyDeviceRelease(boolean earlyRelease) {
        mEnableDelegatedEarlyDeviceRelease = earlyRelease;
    }

    /** {@inheritDoc} */
    @Override
    public Map<String, String> getDynamicDownloadArgs() {
        return mDynamicDownloadArgs;
    }

    /** {@inheritDoc} */
    @Override
    public boolean reportTestCaseCount() {
        return mCountTestCases;
    }

    /** {@inheritDoc} */
    @Override
    public void setReportTestCaseCount(boolean report) {
        mCountTestCases = report;
    }

    /** {@inheritDoc} */
    @Override
    public boolean reportPassedTests() {
        return mReportPassedTests;
    }

    /** {@inheritDoc} */
    @Override
    public boolean filterPreviousPassedTests() {
        return mTestFilterPassed;
    }

    /** {@inheritDoc} */
    @Override
    public boolean reportInvocationComplete() {
        return mReportInvocationCompleteLogs;
    }

    /** {@inheritDoc} */
    @Override
    public void setReportInvocationComplete(boolean reportInvocationCompleteLogs) {
        mReportInvocationCompleteLogs = reportInvocationCompleteLogs;
    }

    /** {@inheritDoc} */
    @Override
    public List<String> reportingTags() {
        List<String> tags = new ArrayList<>();
        // Convert a few of the enabled features into easily consumable tag that can be displayed
        // to see if a feature is enabled.
        if (mAutoCollectors.contains(AutoLogCollector.DEVICE_TRACE)) {
            tags.add("device_tracing_enable");
        }
        return tags;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldDisableInvocationSetupAndTeardown() {
        return mDisableInvocationSetupAndTeardown;
    }

    /** {@inheritDoc} */
    @Override
    public Integer getMultiDeviceCount() {
        return mMultiDeviceCount;
    }

    /** {@inheritDoc} */
    @Override
    public void setMultiDeviceCount(int count) {
        mMultiDeviceCount = count;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isTracingEnabled() {
        return mTracingEnabled;
    }

    /** {@inheritDoc} */
    @Override
    public File getJdkFolderForSubprocess() {
        return mJdkFolder;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldRemoteDynamicShard() {
        return mRemoteDynamicSharding;
    }

    /** {@inheritDoc} */
    @Override
    public void setShouldRemoteDynamicShard(boolean shouldRemoteDynamicShard) {
        mRemoteDynamicSharding = shouldRemoteDynamicShard;
    }

    /** {@inheritDoc} */
    @Override
    public boolean shouldUseEvenModuleSharding() {
        return mEvenModuleSharding;
    }

    /** {@inheritDoc} */
    @Override
    public void setShouldUseEvenModuleSharding(boolean useEvenModuleSharding) {
        mEvenModuleSharding = useEvenModuleSharding;
    }
}