text: # Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  #
  # Licensed under the Apache License, Version 2.0 (the "License"). You
  # may not use this file except in compliance with the License. A copy of
  # the License is located at
  #
  #     http://aws.amazon.com/apache2.0/
  #
  # or in the "license" file accompanying this file. This file 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.
  from __future__ import absolute_import
  
  import json
  import logging
  import os
  import platform
  import shutil
  import sys
  import tempfile
  
  import boto3
  import pytest
  
  from botocore.exceptions import ClientError
  from sagemaker import LocalSession, Session
  from sagemaker.pytorch import PyTorch
  
  from .utils import image_utils, get_ecr_registry, reupload_image_to_test_ecr
  
  logger = logging.getLogger(__name__)
  logging.getLogger('boto').setLevel(logging.INFO)
  logging.getLogger('boto3').setLevel(logging.INFO)
  logging.getLogger('botocore').setLevel(logging.INFO)
  logging.getLogger('factory.py').setLevel(logging.INFO)
  logging.getLogger('auth.py').setLevel(logging.INFO)
  logging.getLogger('connectionpool.py').setLevel(logging.INFO)
  
  
  dir_path = os.path.dirname(os.path.realpath(__file__))
  
  NO_P2_REGIONS = [
      "ap-east-1",
      "ap-northeast-3",
      "ap-southeast-2",
      "ca-central-1",
      "eu-central-1",
      "eu-north-1",
      "eu-west-2",
      "eu-west-3",
      "us-west-1",
      "sa-east-1",
      "me-south-1",
      "cn-northwest-1",
      "eu-south-1",
      "af-south-1",
  ]
  NO_P3_REGIONS = [
      "ap-east-1",
      "ap-northeast-3",
      "ap-southeast-1",
      "ap-southeast-2",
      "ap-south-1",
      "ca-central-1",
      "eu-central-1",
      "eu-north-1",
      "eu-west-2",
      "eu-west-3",
      "sa-east-1",
      "us-west-1",
      "me-south-1",
      "cn-northwest-1",
      "eu-south-1",
      "af-south-1",
  ]
  
  NO_P4_REGIONS = [
      "ap-east-1",
      "ap-northeast-3",
      "ap-southeast-1",
      "ap-southeast-2",
      "ap-south-1",
      "ca-central-1",
      "eu-central-1",
      "eu-north-1",
      "eu-west-2",
      "eu-west-3",
      "sa-east-1",
      "us-west-1",
      "me-south-1",
      "cn-northwest-1",
      "eu-south-1",
      "af-south-1",
  ]
  
  def pytest_addoption(parser):
      parser.addoption('--build-image', '-D', action='store_true')
      parser.addoption('--build-base-image', '-B', action='store_true')
      parser.addoption('--aws-id')
      parser.addoption('--instance-type')
      parser.addoption('--docker-base-name', default='pytorch')
      parser.addoption('--region', default='us-west-2')
      parser.addoption('--framework-version', default='')
      parser.addoption('--py-version', choices=['2', '3'], default=str(sys.version_info.major))
      parser.addoption('--processor', choices=['gpu', 'cpu'], default='cpu')
      # If not specified, will default to {framework-version}-{processor}-py{py-version}
      parser.addoption('--tag', default=None)
      parser.addoption('--generate-coverage-doc', default=False, action='store_true',
                       help='use this option to generate test coverage doc')
      parser.addoption(
          "--efa", action="store_true", default=False, help="Run only efa tests",
      )
  
  
  def pytest_configure(config):
      config.addinivalue_line("markers", "efa(): explicitly mark to run efa tests")
  
  
  def pytest_runtest_setup(item):
      if item.config.getoption("--efa"):
          efa_tests = [mark for mark in item.iter_markers(name="efa")]
          if not efa_tests:
              pytest.skip("Skipping non-efa tests")
  
  
  def pytest_collection_modifyitems(session, config, items):
      if config.getoption("--generate-coverage-doc"):
          from test.test_utils.test_reporting import TestReportGenerator
          report_generator = TestReportGenerator(items, is_sagemaker=True)
          report_generator.generate_coverage_doc(framework="pytorch", job_type="training")
  
  
  @pytest.fixture(scope='session', name='docker_base_name')
  def fixture_docker_base_name(request):
      return request.config.getoption('--docker-base-name')
  
  
  @pytest.fixture(scope='session', name='region')
  def fixture_region(request):
      return request.config.getoption('--region')
  
  
  @pytest.fixture(scope='session', name='framework_version')
  def fixture_framework_version(request):
      return request.config.getoption('--framework-version')
  
  
  @pytest.fixture(scope='session', name='py_version')
  def fixture_py_version(request):
      return 'py{}'.format(int(request.config.getoption('--py-version')))
  
  
  @pytest.fixture(scope='session', name='processor')
  def fixture_processor(request):
      return request.config.getoption('--processor')
  
  
  @pytest.fixture(scope='session', name='tag')
  def fixture_tag(request, framework_version, processor, py_version):
      provided_tag = request.config.getoption('--tag')
      default_tag = '{}-{}-{}'.format(framework_version, processor, py_version)
      return provided_tag if provided_tag else default_tag
  
  
  @pytest.fixture(scope='session', name='docker_image')
  def fixture_docker_image(docker_base_name, tag):
      return '{}:{}'.format(docker_base_name, tag)
  
  
  @pytest.fixture
  def opt_ml():
      tmp = tempfile.mkdtemp()
      os.mkdir(os.path.join(tmp, 'output'))
  
      # Docker cannot mount Mac OS /var folder properly see
      # https://forums.docker.com/t/var-folders-isnt-mounted-properly/9600
      opt_ml_dir = '/private{}'.format(tmp) if platform.system() == 'Darwin' else tmp
      yield opt_ml_dir
  
      shutil.rmtree(tmp, True)
  
  
  @pytest.fixture(scope='session', name='use_gpu')
  def fixture_use_gpu(processor):
      return processor == 'gpu'
  
  
  @pytest.fixture(scope='session', name='build_base_image', autouse=True)
  def fixture_build_base_image(request, framework_version, py_version, processor, tag, docker_base_name):
      build_base_image = request.config.getoption('--build-base-image')
      if build_base_image:
          return image_utils.build_base_image(framework_name=docker_base_name,
                                              framework_version=framework_version,
                                              py_version=py_version,
                                              base_image_tag=tag,
                                              processor=processor,
                                              cwd=os.path.join(dir_path, '..'))
  
      return tag
  
  
  @pytest.fixture(scope='session', name='sagemaker_session')
  def fixture_sagemaker_session(region):
      return Session(boto_session=boto3.Session(region_name=region))
  
  
  @pytest.fixture(scope='session', name='n_virginia_sagemaker_session')
  def fixture_n_virginia_sagemaker_session(n_virginia_region):
      return Session(boto_session=boto3.Session(region_name=n_virginia_region))
  
  
  @pytest.fixture(name='efa_instance_type')
  def fixture_efa_instance_type():
      default_instance_type = "ml.p3dn.24xlarge"
      return default_instance_type
  
  
  @pytest.fixture(scope='session', name='n_virginia_region')
  def fixture_n_virginia_region(request):
      return "us-east-1"
  
  
  @pytest.fixture(name='n_virginia_ecr_image')
  def fixture_n_virginia_ecr_image(ecr_image, n_virginia_region):
      """
      It uploads image to n_virginia region and return image uri
      """
      image_repo_uri, image_tag = ecr_image.split(":")
      _, image_repo_name = image_repo_uri.split("/")
      target_image_repo_name = f"{image_repo_name}"
      n_virginia_ecr_image = reupload_image_to_test_ecr(ecr_image, target_image_repo_name, n_virginia_region)
      return n_virginia_ecr_image
  
  
  @pytest.fixture(scope='session', name='sagemaker_local_session')
  def fixture_sagemaker_local_session(region):
      return LocalSession(boto_session=boto3.Session(region_name=region))
  
  
  @pytest.fixture(name='aws_id', scope='session')
  def fixture_aws_id(request):
      return request.config.getoption('--aws-id')
  
  
  @pytest.fixture(name='instance_type', scope='session')
  def fixture_instance_type(request, processor):
      provided_instance_type = request.config.getoption('--instance-type')
      default_instance_type = 'local' if processor == 'cpu' else 'local_gpu'
      return provided_instance_type or default_instance_type
  
  
  @pytest.fixture(name='docker_registry', scope='session')
  def fixture_docker_registry(aws_id, region):
      return get_ecr_registry(aws_id, region)
  
  
  @pytest.fixture(name='ecr_image', scope='session')
  def fixture_ecr_image(docker_registry, docker_base_name, tag):
      return '{}/{}:{}'.format(docker_registry, docker_base_name, tag)
  
  
  @pytest.fixture(scope='session', name='dist_cpu_backend', params=['gloo'])
  def fixture_dist_cpu_backend(request):
      return request.param
  
  
  @pytest.fixture(scope='session', name='dist_gpu_backend', params=['gloo', 'nccl'])
  def fixture_dist_gpu_backend(request):
      return request.param
  
  
  @pytest.fixture(autouse=True)
  def skip_by_device_type(request, use_gpu, instance_type):
      is_gpu = use_gpu or instance_type[3] in ['g', 'p']
      if (request.node.get_closest_marker('skip_gpu') and is_gpu) or \
              (request.node.get_closest_marker('skip_cpu') and not is_gpu):
          pytest.skip('Skipping because running on \'{}\' instance'.format(instance_type))
  
  
  @pytest.fixture(autouse=True)
  def skip_by_py_version(request, py_version):
      """
      This will cause tests to be skipped w/ py3 containers if "py-version" flag is not set
      and pytest is running from py2. We can rely on this when py2 is deprecated, but for now
      we must use "skip_py2_containers"
      """
      if request.node.get_closest_marker('skip_py2') and py_version != 'py3':
          pytest.skip('Skipping the test because Python 2 is not supported.')
  
  
  @pytest.fixture(autouse=True)
  def skip_test_in_region(request, region):
      if request.node.get_closest_marker('skip_test_in_region'):
          if region == 'me-south-1':
              pytest.skip('Skipping SageMaker test in region {}'.format(region))
  
  
  @pytest.fixture(autouse=True)
  def skip_gpu_instance_restricted_regions(region, instance_type):
      if ((region in NO_P2_REGIONS and instance_type.startswith('ml.p2'))
          or (region in NO_P3_REGIONS and instance_type.startswith('ml.p3'))
              or (region in NO_P4_REGIONS and instance_type.startswith('ml.p4'))):
                  pytest.skip('Skipping GPU test in region {}'.format(region))
  
  
  @pytest.fixture(autouse=True)
  def skip_py2_containers(request, tag):
      if request.node.get_closest_marker('skip_py2_containers'):
          if 'py2' in tag:
              pytest.skip('Skipping python2 container with tag {}'.format(tag))
  
  
  def _get_remote_override_flags():
      try:
          s3_client = boto3.client('s3')
          sts_client = boto3.client('sts')
          account_id = sts_client.get_caller_identity().get('Account')
          result = s3_client.get_object(Bucket=f"dlc-cicd-helper-{account_id}", Key="override_tests_flags.json")
          json_content = json.loads(result["Body"].read().decode('utf-8'))
      except ClientError as e:
          logger.error("ClientError when performing S3/STS operation. Exception: {}".format(e))
          json_content = {}
      return json_content
  
  
  def _is_test_disabled(test_name, build_name, version):
      """
      Expected format of remote_override_flags:
      {
          "CB Project Name for Test Type A": {
              "CodeBuild Resolved Source Version": ["test_type_A_test_function_1", "test_type_A_test_function_2"]
          },
          "CB Project Name for Test Type B": {
              "CodeBuild Resolved Source Version": ["test_type_B_test_function_1", "test_type_B_test_function_2"]
          }
      }
  
      :param test_name: str Test Function node name (includes parametrized values in string)
      :param build_name: str Build Project name of current execution
      :param version: str Source Version of current execution
      :return: bool True if test is disabled as per remote override, False otherwise
      """
      remote_override_flags = _get_remote_override_flags()
      remote_override_build = remote_override_flags.get(build_name, {})
      if version in remote_override_build:
          return (
              not remote_override_build[version]
              or any([test_keyword in test_name for test_keyword in remote_override_build[version]])
          )
      return False
  
  
  @pytest.fixture(autouse=True)
  def disable_test(request):
      test_name = request.node.name
      # We do not have a regex pattern to find CB name, which means we must resort to string splitting
      build_arn = os.getenv("CODEBUILD_BUILD_ARN")
      build_name = build_arn.split("/")[-1].split(":")[0] if build_arn else None
      version = os.getenv("CODEBUILD_RESOLVED_SOURCE_VERSION")
  
      if build_name and version and _is_test_disabled(test_name, build_name, version):
          pytest.skip(f"Skipping {test_name} test because it has been disabled.")
  