#
# Copyright (C) 2016 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.
#
"""This module has the global key values that are used across framework
modules.
"""


class ConfigKeys(object):
    """Enum values for test config related lookups.
    """
    # Keys used to look up values from test config files.
    # These keys define the wording of test configs and their internal
    # references.
    KEY_LOG_PATH = "log_path"
    KEY_LOG_SEVERITY = "log_severity"
    KEY_TESTBED = "test_bed"
    KEY_TESTBED_NAME = "name"
    KEY_TEST_PATHS = "test_paths"
    KEY_TEST_SUITE = "test_suite"
    KEY_TEST_TIMEOUT = "test_timeout"

    # Keys in test suite
    KEY_INCLUDE_FILTER = "include_filter"
    KEY_EXCLUDE_FILTER = "exclude_filter"
    KEY_EXCLUDE_OVER_INCLUDE = "exclude_over_include"

    # Keys for base test.
    IKEY_MAX_RETRY_COUNT = "max_retry_count"

    # Keys for binary tests
    IKEY_BINARY_TEST_SOURCE = "binary_test_source"
    IKEY_BINARY_TEST_WORKING_DIRECTORY = "binary_test_working_directory"
    IKEY_BINARY_TEST_ENVP = "binary_test_envp"
    IKEY_BINARY_TEST_ARGS = "binary_test_args"
    IKEY_BINARY_TEST_LD_LIBRARY_PATH = "binary_test_ld_library_path"
    IKEY_NATIVE_SERVER_PROCESS_NAME = "native_server_process_name"
    IKEY_GTEST_BATCH_MODE = "gtest_batch_mode"

    # @Deprecated use IKEY_DISABLE_FRAMEWORK
    IKEY_BINARY_TEST_DISABLE_FRAMEWORK = "binary_test_disable_framework"
    IKEY_DISABLE_FRAMEWORK = "DISABLE_FRAMEWORK"
    # @Deprecated use IKEY_STOP_NATIVE_SERVERS
    IKEY_BINARY_TEST_STOP_NATIVE_SERVERS = "binary_test_stop_native_servers"
    IKEY_STOP_NATIVE_SERVERS = "STOP_NATIVE_SERVERS"

    # Internal keys, used internally, not exposed to user's config files.
    IKEY_USER_PARAM = "user_params"
    IKEY_TESTBED_NAME = "testbed_name"
    IKEY_LOG_PATH = "log_path"
    IKEY_ABI_NAME = "abi_name"
    IKEY_ABI_BITNESS = "abi_bitness"
    IKEY_RUN_32BIT_ON_64BIT_ABI = "run_32bit_on_64bit_abi"
    IKEY_SKIP_ON_32BIT_ABI = "skip_on_32bit_abi"
    IKEY_SKIP_ON_64BIT_ABI = "skip_on_64bit_abi"
    IKEY_SKIP_IF_THERMAL_THROTTLING = "skip_if_thermal_throttling"
    IKEY_DISABLE_CPU_FREQUENCY_SCALING = "disable_cpu_frequency_scaling"

    IKEY_BUILD = "build"
    IKEY_DATA_FILE_PATH = "data_file_path"

    IKEY_BUG_REPORT_ON_FAILURE = "BUG_REPORT_ON_FAILURE"
    IKEY_LOGCAT_ON_FAILURE = "LOGCAT_ON_FAILURE"

    # sub fields of test_bed
    IKEY_ANDROID_DEVICE = "AndroidDevice"
    IKEY_PRODUCT_TYPE = "product_type"
    IKEY_PRODUCT_VARIANT = "product_variant"
    IKEY_BUILD_FLAVOR = "build_flavor"
    IKEY_BUILD_ID = "build_id"
    IKEY_BRANCH = "branch"
    IKEY_BUILD_ALIAS = "build_alias"
    IKEY_API_LEVEL = "api_level"
    IKEY_SERIAL = "serial"

    # Keys for web
    IKEY_ENABLE_WEB = "enable_web"

    # Keys for profiling
    IKEY_ENABLE_PROFILING = "enable_profiling"
    IKEY_BINARY_TEST_PROFILING_LIBRARY_PATH = "binary_test_profiling_library_path"
    IKEY_PROFILING_TRACING_PATH = "profiling_trace_path"
    IKEY_TRACE_FILE_TOOL_NAME = "trace_file_tool_name"
    IKEY_SAVE_TRACE_FILE_REMOTE = "save_trace_file_remote"
    IKEY_PROFILING_ARG_VALUE = "profiling_arg_value"

    # Keys for systrace (for hal tests)
    IKEY_ENABLE_SYSTRACE = "enable_systrace"
    IKEY_SYSTRACE_PROCESS_NAME = "systrace_process_name"
    IKEY_SYSTRACE_REPORT_PATH = "systrace_report_path"
    IKEY_SYSTRACE_REPORT_URL_PREFIX = "systrace_report_url_prefix"
    IKEY_SYSTRACE_REPORT_USE_DATE_DIRECTORY = "systrace_report_path_use_date_directory"
    IKEY_SYSTRACE_UPLAD_TO_DASHBOARD = "systrace_upload_to_dashboard"

    # Keys for coverage
    IKEY_ENABLE_COVERAGE = "enable_coverage"
    IKEY_ENABLE_SANCOV = "enable_sancov"
    IKEY_MODULES = "modules"
    IKEY_SERVICE_JSON_PATH = "service_key_json_path"
    IKEY_DASHBOARD_POST_COMMAND = "dashboard_post_command"
    IKEY_OUTPUT_COVERAGE_REPORT = "output_coverage_report"
    IKEY_GLOBAL_COVERAGE = "global_coverage"
    IKEY_SANCOV_RESOURCES_PATH = "sancov_resources_path"
    IKEY_GCOV_RESOURCES_PATH = "gcov_resources_path"
    IKEY_COVERAGE_REPORT_PATH = "coverage_report_path"
    IKEY_EXCLUDE_COVERAGE_PATH = "exclude_coverage_path"
    IKEY_FUZZING_GCS_BUCKET_NAME = "fuzzing_gcs_bucket_name"

    # Keys for the HAL HIDL GTest type (see VtsMultiDeviceTest.java).
    IKEY_PRECONDITION_HWBINDER_SERVICE = "precondition_hwbinder_service"
    IKEY_PRECONDITION_FEATURE = "precondition_feature"
    IKEY_PRECONDITION_FILE_PATH_PREFIX = "precondition_file_path_prefix"
    IKEY_PRECONDITION_FIRST_API_LEVEL = "precondition_first_api_level"
    IKEY_PRECONDITION_LSHAL = "precondition_lshal"
    IKEY_PRECONDITION_SYSPROP = "precondition_sysprop"
    IKEY_PRECONDITION_VINTF = "precondition_vintf"

    # Keys for toggle passthrough mode
    IKEY_PASSTHROUGH_MODE = "passthrough_mode"

    # Keys for the HAL HIDL Replay Test type.
    IKEY_HAL_HIDL_REPLAY_TEST_TRACE_PATHS = "hal_hidl_replay_test_trace_paths"
    IKEY_HAL_HIDL_PACKAGE_NAME = "hal_hidl_package_name"

    # Keys for special test cases
    IKEY_FFMPEG_BINARY_PATH = "ffmpeg_binary_path"
    IKEY_SYZKALLER_PACKAGES_PATH = "syzkaller_packages_path"
    IKEY_SYZKALLER_TEMPLATE_PATH = "syzkaller_template_path"

    # Keys for log uploading
    IKEY_ENABLE_LOG_UPLOADING = "enable_log_uploading"
    IKEY_LOG_UPLOADING_PATH = "log_uploading_path"
    IKEY_LOG_UPLOADING_USE_DATE_DIRECTORY = "log_uploading_use_date_directory"
    IKEY_LOG_UPLOADING_URL_PREFIX = "log_uploading_url_prefix"
    IKEY_LOG_UPLOADING_GCS_BUCKET_NAME = "log_uploading_gcs_bucket_name"

    # Keys for general user config types
    IKEY_USER_CONFIG_STR = 'CONFIG_STR'
    IKEY_USER_CONFIG_INT = 'CONFIG_INT'
    IKEY_USER_CONFIG_BOOL = 'CONFIG_BOOL'

    # A list of keys whose values in configs should not be passed to test
    # classes without unpacking first.
    RESERVED_KEYS = (KEY_TESTBED, KEY_LOG_PATH, KEY_TEST_PATHS)

    # Keys for special run modes
    IKEY_COLLECT_TESTS_ONLY = "collect_tests_only"
    RUN_AS_VTS_SELFTEST = "run_as_vts_self_test"

    # Vts compliance test related keys
    RUN_AS_COMPLIANCE_TEST = "run_as_compliance_test"

    # Mobly test related keys
    MOBLY_TEST_MODULE = "MOBLY_TEST_MODULE"

    # Controller option keys
    SHELL_DEFAULT_NOHUP = "shell_default_nohup"