xref: /tools/tradefederation/core/src/com/android/tradefed/command/ICommandOptions.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.device.metric.AutoLogCollector;
import com.android.tradefed.util.UniqueMultiMap;

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

/**
 *  Container for execution options for commands.
 */
public interface ICommandOptions {

    /**
     * Returns <code>true</code> if abbreviated help mode has been requested
     */
    public boolean isHelpMode();

    /**
     * Returns <code>true</code> if full detailed help mode has been requested
     */
    public boolean isFullHelpMode();

    /**
     * Return <code>true</code> if we should <emph>skip</emph> adding this command to the queue.
     */
    public boolean isDryRunMode();

    /**
     * Return <code>true</code> if we should print the command out to the console before we
     * <emph>skip</emph> adding it to the queue.
     */
    public boolean isNoisyDryRunMode();

    /**
     * Return the loop mode for the config.
     */
    public boolean isLoopMode();

    /**
     * Get the time to wait before re-scheduling this command.
     * @return time in ms
     */
    public long getLoopTime();

    /**
     * Sets the loop mode for the command
     *
     * @param loopMode
     */
    public void setLoopMode(boolean loopMode);

    /**
     * Return the test-tag for the invocation. Default is 'stub' if unspecified.
     */
    public String getTestTag();

    /**
     * Sets the test-tag for the invocation.
     *
     * @param testTag
     */
    public void setTestTag(String testTag);

    /**
     * Return the test-tag suffix, appended to test-tag to represents some variants of one test.
     */
    public String getTestTagSuffix();

    /**
     * Creates a copy of the {@link ICommandOptions} object.
     */
    public ICommandOptions clone();

    /**
     * Return true if command should run on all devices.
     */
    public boolean runOnAllDevices();

    /**
     * Return true if a bugreport should be taken when the test invocation has ended.
     */
    public boolean takeBugreportOnInvocationEnded();

    /** Sets whether or not to capture a bugreport at the end of the invocation. */
    public void setBugreportOnInvocationEnded(boolean takeBugreport);

    /**
     * Return true if a bugreportz should be taken instead of bugreport during the test invocation
     * final bugreport.
     */
    public boolean takeBugreportzOnInvocationEnded();

    /** Sets whether or not to capture a bugreportz at the end of the invocation. */
    public void setBugreportzOnInvocationEnded(boolean takeBugreportz);

    /** Returns whether or not conditional bugreport is disabled */
    public boolean isConditionalBugreportDisabled();

    /**
     * Return the invocation timeout specified. 0 if no timeout to be used.
     */
    public long getInvocationTimeout();

    /**
     * Set the invocation timeout. 0 if no timeout to be used.
     */
    public void setInvocationTimeout(Long mInvocationTimeout);


    /** Returns true if we should optimize the list of test modules for mainline test. */
    public boolean getOptimizeMainlineTest();

    /**
     * Return the total shard count for the command.
     */
    public Integer getShardCount();

    /**
     * Sets the shard count for the command.
     */
    public void setShardCount(Integer shardCount);

    /**
     * Return the shard index for the command.
     */
    public Integer getShardIndex();

    /**
     * Sets the shard index for the command.
     */
    public void setShardIndex(Integer shardIndex);

    /** Whether or not sharding should use the token support. */
    public boolean shouldUseTokenSharding();

    /** Returns if we should use dynamic sharding or not */
    public boolean shouldUseDynamicSharding();

    /** Returns the data passed to the invocation to describe it */
    public UniqueMultiMap<String, String> getInvocationData();

    /** Returns the list of remote files configured. */
    public Set<String> getRemoteFiles();

    /** Returns true if we should use Tf containers to run the invocation */
    public boolean shouldUseSandboxing();

    /** Sets whether or not we should use TF containers */
    public void setShouldUseSandboxing(boolean use);

    /** Returns true if we should use the Tf sandbox in a test mode. */
    public boolean shouldUseSandboxTestMode();

    /** Sets whether or not we should use the TF sandbox test mode. */
    public void setUseSandboxTestMode(boolean use);

    /** Whether or not to use sandbox mode in remote invocation. */
    public boolean shouldUseRemoteSandboxMode();

    /** Whether or not to trigger a deviceless remote invocation. */
    public boolean isRemoteInvocationDeviceless();

    /** Returns the set of auto log collectors to be added for an invocation */
    public Set<AutoLogCollector> getAutoLogCollectors();

    /** Sets the set of auto log collectors that should be added to an invocation. */
    public void setAutoLogCollectors(Set<AutoLogCollector> autoLogCollectors);

    /** Whether or not to enable experiments through experimental flags. */
    public boolean isExperimentEnabled();

    /** Returns the experimental flags map, that can be used to feature gate projects. */
    public Map<String, String> getExperimentalFlags();

    /** Whether to skip experiments for TRYBOT runs. */
    public boolean skipTrybotExperiment();

    /** Whether or not to capture a screenshot on test case failure */
    public boolean captureScreenshotOnFailure();

    /** Whether or not to capture a logcat on test case failure */
    public boolean captureLogcatOnFailure();

    /** Returns the suffix to append to the Tradefed host_log or null if no prefix. */
    public String getHostLogSuffix();

    /** Sets the suffix to append to Tradefed host_log. */
    public void setHostLogSuffix(String suffix);

    /** Whether or not to attempt parallel setup of the remote devices. */
    public boolean shouldUseParallelRemoteSetup();

    /** Return whether to execute pre-invocation setup in parallel. */
    public boolean shouldUseParallelPreInvocationSetup();

    /** Return the timeout for parallel pre-invocation setup. */
    public Duration getParallelPreInvocationSetupTimeout();

    /** Whether or not to attempt parallel setup. */
    public boolean shouldUseParallelSetup();

    /** Returns the timeout to use during parallel setups. */
    public Duration getParallelSetupTimeout();

    /** Whether or not to use replicated setup for all the remote devices. */
    public boolean shouldUseReplicateSetup();

    /** Set whether or not to use replicated setup. */
    public void setReplicateSetup(boolean replicate);

    /** Whether or not to report progression of remote invocation at module level. */
    public boolean shouldReportModuleProgression();

    /** Whether or not to start extra instances in the remote VM in postsubmit. */
    public int getExtraRemotePostsubmitInstance();

    /** Whether or not to release the device early when done with it. */
    public boolean earlyDeviceRelease();

    /** Whether or not to release the device early in delegated mode. */
    public boolean delegatedEarlyDeviceRelease();

    /** Set whether or not to release the device early in delegated mode. */
    public void setDelegatedEarlyDeviceRelease(boolean earlyRelease);

    /** Returns the map of args to pass to the dynamic download query. */
    public Map<String, String> getDynamicDownloadArgs();

    /** Whether or not to report the number of test cases per test types. */
    public boolean reportTestCaseCount();

    /** Set whether or not to report test cases count per test types. */
    public void setReportTestCaseCount(boolean report);

    /** Whether or not to report passed test cases. */
    public boolean reportPassedTests();

    /** Whether or not to filters previous passed test cases from previous attempt. */
    public boolean filterPreviousPassedTests();

    /** whether or not to report the logs until invocationComplete. */
    public boolean reportInvocationComplete();

    /** Set whether or not to report the logs until invocationComplete */
    public void setReportInvocationComplete(boolean reportInvocationCompleteLogs);

    /**
     * Returns the maximum number of times to scheduled the command. Has no effect if isLoopMode is
     * false.
     */
    public long getMaxLoopCount();

    /** List of tags used for reporting related to the invocation. */
    public List<String> reportingTags();

    /** Whether or not to disable pre-invocaiton setup and post-invocation teardown. */
    public boolean shouldDisableInvocationSetupAndTeardown();

    /** Return the number of devices for multi-device tests. */
    public Integer getMultiDeviceCount();

    /** Sets the number of expected devices for multi-device tests. */
    public void setMultiDeviceCount(int count);

    /** Returns whether or not invocation tracing is enabled. */
    public boolean isTracingEnabled();

    /** Returns the jdk folder to use when forking execution in a subprocess. */
    public File getJdkFolderForSubprocess();

    /** Returns whether to use remote dynamic sharding server or not */
    public boolean shouldRemoteDynamicShard();

    /** Sets whether to use remote dynamic sharding server or not */
    public void setShouldRemoteDynamicShard(boolean shouldRemoteDynamicShard);

    /** Returns whether to attempt to distribute number of modules evenly across shards */
    public boolean shouldUseEvenModuleSharding();

    /** Set whether to attempt to distribute number of modules evenly across shards */
    public void setShouldUseEvenModuleSharding(boolean useEvenModuleSharding);

    /** Returns the name of the instance used to handle remote caching. */
    public String getRemoteCacheInstanceName();

    /** Returns true if we should capture the results in the cache. */
    public boolean shouldUploadCacheResults();

    /** Returns true if we should report cache results when available. */
    public boolean reportCacheResults();

    /** Returns true if we should report cache results when available in presubmit. */
    public boolean reportCacheResultsInPresubmit();

    /** Returns true if we should capture the invocation results in the cache. */
    public boolean shouldUploadInvocationCacheResults();

    /** Returns true if we should report invocation cache results when available in presubmit. */
    public boolean reportInvocationCacheResultsInPresubmit();
}