# Copyright 2018 The LUCI Authors. All rights reserved.
# Use of this source code is governed under the Apache License, Version 2.0
# that can be found in the LICENSE file.

from recipe_engine.config import List, Single, ConfigList, ConfigGroup
from recipe_engine.recipe_api import Property

DEPS = [
  'cipd',
  'json',
  'path',
  'platform',
  'properties',
  'service_account',
  'step',
]

PROPERTIES = {
  'use_pkg': Property(default=False, kind=bool),
  'pkg_files': Property(default=(), kind=List(str)),
  'pkg_dirs': Property(default=(), kind=ConfigList(lambda: ConfigGroup(
      path=Single(str),
      exclusions=List(str),
  ))),
  'pkg_vars': Property(default=None, kind=dict),
  'ver_files': Property(default=(), kind=List(str)),
  'install_mode': Property(default=None),
  'refs': Property(default=['fake-ref-1', 'fake-ref-2'], kind=List(str)),
  'tags': Property(kind=dict, default={'fake_tag_1': 'fake_value_1',
                                       'fake_tag_2': 'fake_value_2'}),
}


def RunSteps(api, use_pkg, pkg_files, pkg_dirs, pkg_vars, ver_files,
             install_mode, refs, tags):
  package_name = 'public/package/${platform}'
  package_instance_id = '7f751b2237df2fdf3c1405be00590fefffbaea2d'
  ensure_file = api.cipd.EnsureFile()
  ensure_file.add_package(package_name, package_instance_id)

  cipd_root = api.path['start_dir'].join('packages')
  # Some packages don't require credentials to be installed or queried.
  api.cipd.ensure(cipd_root, ensure_file)
  result = api.cipd.search(package_name, tag='git_revision:40-chars-long-hash')
  r = api.cipd.describe(package_name, version=result[0].instance_id)
  api.step('describe response', cmd=None).presentation.logs['parsed'] = (
      api.json.dumps(r.__dict__, indent=2).splitlines())


  # Others do, so provide creds first.
  private_package_name = 'private/package/${platform}'
  #packages[private_package_name] = 'latest'
  ensure_file.add_package(private_package_name, 'latest', subdir='private')
  api.cipd.ensure(cipd_root, ensure_file)
  result = api.cipd.search(private_package_name, tag='key:value')
  api.cipd.describe(private_package_name,
                    version=result[0].instance_id,
                    test_data_tags=['custom:tagged', 'key:value'],
                    test_data_refs=['latest'])
  api.cipd.describe('default/test/data',
                    version=result[0].instance_id)

  # examples of describe calls returning empty results
  for ver in ('ref', 'tag:1.2.3', 'hash'*10):
    try:
      api.cipd.describe('empty/pkg', version=ver, test_data_tags=(),
                        test_data_refs=())
      assert False, "Previous step should have failed" # pragma: no cover
    except api.step.StepFailure:
      pass

  # The rest of commands expect credentials to be set.
  service_account = api.service_account.from_credentials_json(
      '/path/to/cipd/creds.json')
  with api.cipd.set_service_account(service_account):
    # Check if we have READER, WRITER and OWNER roles for public/package path.
    api.cipd.acl_check('public/package', reader=True, writer=True, owner=True)

    # Build & register new package version.
    api.cipd.build('fake-input-dir', 'fake-package-path', 'infra/fake-package')
    api.cipd.build('fake-input-dir', 'fake-package-path', 'infra/fake-package',
                   compression_level=9, install_mode='copy',
                   preserve_mtime=True, preserve_writable=True)
    api.cipd.register('infra/fake-package', 'fake-package-path',
                      refs=refs, tags=tags)

  # Create (build & register).
    if use_pkg:
      root = api.path['start_dir'].join('some_subdir')
      pkg = api.cipd.PackageDefinition('infra/fake-package', root, install_mode)
      for fullpath in pkg_files:
        pkg.add_file(api.path.abs_to_path(fullpath))
      pkg.add_dir(root)
      for obj in pkg_dirs:
        pkg.add_dir(api.path.abs_to_path(obj.get('path', '')),
                    obj.get('exclusions'))
      for pth in ver_files:
        pkg.add_version_file(pth)

      api.cipd.build_from_pkg(pkg, 'fake-package-path')
      api.cipd.register('infra/fake-package', 'fake-package-path',
                        refs=refs, tags=tags)

      api.cipd.create_from_pkg(pkg, refs=refs, tags=tags)
    else:
      api.cipd.build_from_yaml(api.path['start_dir'].join('fake-package.yaml'),
                               'fake-package-path', pkg_vars=pkg_vars,
                               compression_level=9)
      api.cipd.register('infra/fake-package', 'fake-package-path',
                        refs=refs, tags=tags)

      api.cipd.create_from_yaml(api.path['start_dir'].join('fake-package.yaml'),
                                refs=refs, tags=tags, pkg_vars=pkg_vars,
                                compression_level=9)

    # Set tag or ref of an already existing package.
    api.cipd.set_tag('fake-package',
                     version='long/weird/ref/which/doesn/not/fit/into/40chars',
                     tags={'dead': 'beaf', 'more': 'value'})
    api.cipd.set_ref('fake-package', version='latest', refs=['any', 'some'])
    # Search by the new tag.
    api.cipd.search('fake-package/${platform}', tag='dead:beaf')

    # Fetch a raw package
    api.cipd.pkg_fetch(api.path['start_dir'].join('fetched_pkg'),
                       'fake-package/${platform}', 'some:tag')

    # Deploy a raw package
    api.cipd.pkg_deploy(
      api.path['start_dir'].join('raw_root'),
      api.path['start_dir'].join('fetched_pkg'))


def GenTests(api):
  yield (
    # This is very common dev workstation, but not all devs are on it.
    api.test('basic')
    + api.platform('linux', 64)
  )

  yield (
    api.test('mac64')
    + api.platform('mac', 64)
  )

  yield (
    api.test('win64')
    + api.platform('win', 64)
  )

  yield (
    api.test('describe-failed')
    + api.platform('linux', 64)
    + api.override_step_data(
      'cipd describe public/package/${platform}',
      api.cipd.example_error(
        'package "public/package/linux-amd64-ubuntu14_04" not registered',
      ))
  )

  yield (
    api.test('describe-many-instances')
    + api.platform('linux', 64)
    + api.override_step_data(
      'cipd search fake-package/${platform} dead:beaf',
      api.cipd.example_search(
        'public/package/linux-amd64-ubuntu14_04',
        instances=3
      ))
  )

  yield (
    api.test('search-empty-result')
    + api.platform('linux', 64)
    + api.override_step_data(
      'cipd search fake-package/${platform} dead:beaf',
      api.json.output({'result': None})
    )
  )

  yield (
    api.test('basic_pkg')
    + api.properties(
      use_pkg=True,
      pkg_files=[
        '[START_DIR]/some_subdir/a/path/to/file.py',
        '[START_DIR]/some_subdir/some_config.cfg',
      ],
      pkg_dirs=[
        {
          'path': '[START_DIR]/some_subdir/directory',
        },
        {
          'path': '[START_DIR]/some_subdir/other_dir',
          'exclusions': [
            r'.*\.pyc',
          ]
        },
      ],
      ver_file=['.versions/file.cipd_version'],
    )
  )

  yield (
    api.test('pkg_bad_verfile')
    + api.properties(
      use_pkg=True,
      ver_files=['a', 'b'],
    )
    + api.expect_exception('ValueError')
  )

  yield (
    api.test('pkg_bad_mode')
    + api.properties(
      use_pkg=True,
      install_mode='',
    )
    + api.expect_exception('ValueError')
  )

  yield (
    api.test('pkg_bad_file')
    + api.properties(
      use_pkg=True,
      pkg_files=[
        '[START_DIR]/a/path/to/file.py',
      ],
    )
    + api.expect_exception('ValueError')
  )

  yield (
    api.test('basic_with_pkg_vars')
    + api.properties(
      pkg_vars = {
        'pkg_var_1': 'pkg_val_1',
        'pkg_var_2': 'pkg_val_2',
      }
    )
  )

  yield (
    api.test('basic_with_no_refs_or_tags')
    + api.properties(
      refs=[],
      tags={},
    )
  )