#!/usr/bin/env python3
#
# Copyright 2023, 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.

"""Tests to check if atest commands were executed with success exit codes."""

import atest_integration_test


class CommandSuccessTests(atest_integration_test.AtestTestCase):
  """Test whether the atest commands run with success exit codes."""

  def test_example_instrumentation_tests(self):
    """Test if atest can run for the example instrumentation test path."""
    test_path = 'platform_testing/tests/example/instrumentation'
    self._verify_atest_command_success(
        test_path, is_device_required=True, snapshot_include_paths=[test_path]
    )

  def test_csuite_harness_tests(self):
    """Test if csuite-harness-tests command runs successfully."""
    self._verify_atest_command_success(
        'csuite-harness-tests --no-bazel-mode --host', is_device_required=False
    )

  def test_csuite_cli_test(self):
    """Test if csuite_cli_test command runs successfully."""
    self._verify_atest_command_success(
        'csuite_cli_test --no-bazel-mode --host', is_device_required=False
    )

  def _verify_atest_command_success(
      self,
      cmd: str,
      is_device_required: bool,
      snapshot_include_paths: list[str] = None,
  ) -> None:
    """Verifies whether an Atest command run completed with exit code 0.

    Args:
        cmd: The atest command to run. Note to leave 'atest' or 'atest-dev' out
          from the command.
        is_device_required: Whether the test requires a device.
        snapshot_include_paths: Any source paths needed to run the test in test
          environment.
    """
    script = self.create_atest_script()

    def build_step(
        step_in: atest_integration_test.StepInput,
    ) -> atest_integration_test.StepOutput:
      self.run_atest_command(
          cmd + ' -cb', step_in, include_device_serial=False
      ).check_returncode()
      step_out = self.create_step_output()
      if snapshot_include_paths:
        step_out.add_snapshot_include_paths(snapshot_include_paths)
      return step_out

    def test_step(step_in: atest_integration_test.StepInput) -> None:
      self.run_atest_command(
          cmd + ' -it', step_in, include_device_serial=is_device_required
      ).check_returncode()

    script.add_build_step(build_step)
    script.add_test_step(test_step)
    script.run()


if __name__ == '__main__':
  atest_integration_test.main()