recipe_modules/path/examples/full.py

# Copyright 2014 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 __future__ import annotations

from recipe_engine import recipe_api

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

from builtins import range, zip


@recipe_api.ignore_warnings('recipe_engine/CHECKOUT_DIR_DEPRECATED')
def RunSteps(api):
  api.step('step1', ['/bin/echo', str(api.path.tmp_base_dir / 'foo')])

  # module.resource(...) demo.
  api.step('print resource',
           ['echo', api.path.resource('dir', 'file.py')])

  # module.repo_resource() demo.
  api.step('print package dir',
           ['echo', api.path.repo_resource('dir', 'file.py')])

  assert 'start_dir' in api.path
  assert api.path.start_dir / '.' == api.path.start_dir

  assert 'checkout' not in api.path
  api.path.checkout_dir = api.path.tmp_base_dir / 'checkout'
  assert 'checkout' in api.path

  # Global dynamic paths (see config.py example for declaration):
  dynamic_path = api.path.checkout_dir / 'jerky'
  api.step('checkout path', ['/bin/echo', dynamic_path])

  # Methods from python os.path are available via api.path. For testing, we
  # asserted that this file existed in the test description below.
  assert api.path.exists(api.path.tmp_base_dir)

  temp_dir = api.path.mkdtemp('kawaab')
  assert api.path.exists(temp_dir)

  temp_file = api.path.mkstemp('kawaac')
  assert api.path.exists(temp_file)

  file_path = api.path.tmp_base_dir / 'new_file'
  abspath = api.path.abspath(file_path)
  api.path.assert_absolute(abspath)
  try:
    api.path.assert_absolute("not/abs")
    assert False, "assert_absolute failed to catch relative path"
  except AssertionError:
    pass

  assert api.path.pardir == '..'
  if api.platform.is_win:
    assert api.path.sep == '\\'
    assert api.path.pathsep == ';'
  else:
    assert api.path.sep == '/'
    assert api.path.pathsep == ':'

  assert api.path.basename(file_path) == 'new_file'
  assert file_path.name == 'new_file'
  assert api.path.dirname(file_path) == api.path.tmp_base_dir
  assert file_path.parent == api.path.tmp_base_dir
  assert api.path.split(file_path) == (api.path.tmp_base_dir, 'new_file')

  thing_bat = api.path.tmp_base_dir / 'thing.bat'
  thing_bat_mkv = api.path.tmp_base_dir / 'thing.bat.mkv'
  assert api.path.splitext(thing_bat_mkv) == (thing_bat, '.mkv')

  assert api.path.abs_to_path(api.path.tmp_base_dir) == api.path.tmp_base_dir

  assert api.path.relpath(file_path, api.path.tmp_base_dir) == 'new_file'

  assert api.path.splitext('abc.xyz') == ('abc', '.xyz')
  assert api.path.split('abc/xyz') == ('abc', 'xyz')
  assert api.path.dirname('abc/xyz') == 'abc'

  abc_def_xyz = api.path.tmp_base_dir / 'abc.def.xyz'
  assert abc_def_xyz.stem == 'abc.def'
  assert abc_def_xyz.suffix == '.xyz'
  assert abc_def_xyz.suffixes == ['.def', '.xyz']

  abc = api.path.tmp_base_dir / 'abc'
  assert abc.stem == 'abc'
  assert abc.suffix == ''
  assert abc.suffixes == []

  api.step('touch me', ['touch', api.path.abspath(file_path)])
  # Assert for testing that a file exists.
  api.path.mock_add_paths(file_path)
  assert api.path.exists(file_path)

  # Assert that we can mock filesystem paths.
  root_path = ('C:\\Windows' if api.platform.is_win else '/bin')
  api.path.mock_add_paths(root_path)
  assert api.path.exists(root_path)

  realpath = api.path.realpath(file_path)
  assert api.path.exists(realpath)

  normpath = api.path.normpath(file_path)
  assert api.path.exists(normpath)

  directory = api.path.start_dir / 'directory'
  filepath = directory / 'filepath'
  api.step('rm directory (initial)', ['rm', '-rf', directory])
  assert not api.path.exists(directory)
  assert not api.path.isdir(directory)
  assert not api.path.exists(filepath)
  assert not api.path.isfile(filepath)

  api.path.mock_add_file(filepath)
  api.step('mkdir directory', ['mkdir', '-p', directory])
  api.step('touch filepath', ['touch', filepath])
  assert api.path.exists(directory)
  assert api.path.isdir(directory)
  assert not api.path.isfile(directory)
  assert api.path.exists(filepath)
  assert not api.path.isdir(filepath)
  assert api.path.isfile(filepath)

  api.path.mock_remove_paths(directory)
  api.step('rm directory', ['rm', '-rf', directory])
  assert not api.path.exists(directory)
  assert not api.path.isdir(directory)
  assert not api.path.exists(filepath)
  assert not api.path.isfile(filepath)

  api.path.mock_add_directory(directory)
  api.step('mkdir directory', ['mkdir', '-p', directory])
  assert api.path.exists(directory)
  assert api.path.isdir(directory)
  assert not api.path.isfile(directory)

  # We can mock copy paths. See the file module to do this for real.
  copy1 = api.path.start_dir / 'copy1'
  copy10 = api.path.start_dir / 'copy10'
  copy2 = api.path.start_dir / 'copy2'
  copy20 = api.path.start_dir / 'copy20'
  api.step('rm copy2 (initial)', ['rm', '-rf', copy2])
  api.step('rm copy20 (initial)', ['rm', '-rf', copy20])

  api.step('mkdirs', ['mkdir', '-p', copy1 / 'foo' / 'bar'])
  api.path.mock_add_paths(copy1.joinpath('foo', 'bar'))
  api.step('touch copy10', ['touch', copy10])
  api.path.mock_add_paths(copy10)
  api.step('cp copy1 copy2', ['cp', '-a', copy1, copy2])
  api.path.mock_copy_paths(copy1, copy2)
  assert api.path.exists(copy2 / 'foo' / 'bar')
  assert not api.path.exists(copy20)

  # We can mock remove paths. See the file module to do this for real.
  api.step('rm copy2/foo', ['rm', '-rf', copy2 / 'foo'])
  api.path.mock_remove_paths(str(copy2)+api.path.sep)
  assert not api.path.exists(copy2 / 'foo' / 'bar')
  assert not api.path.exists(copy2 / 'foo')
  assert api.path.exists(copy2)

  api.step('touch copy20', ['touch', copy20])
  api.path.mock_add_paths(copy20)
  api.step('rm copy2', ['rm', '-rf', copy2])
  api.path.mock_remove_paths(copy2)
  assert not api.path.exists(copy2)
  assert api.path.exists(copy20)

  # Convert strings to Paths.
  def _mk_paths():
    return [
        api.path.start_dir / 'some' / 'thing',
        api.path.start_dir,
        api.path.cache_dir / 'a file',
        api.path.home_dir / 'another file',
        api.path.resource("module_resource.py"),
        api.path.resource(),
        api.resource("recipe_resource.py"),
        api.resource(),
    ]
  static_paths = _mk_paths()
  for p in static_paths:
    after = api.path.abs_to_path(str(p))
    api.step('converted path %s' % p, ['echo', after])
    assert after == p, (after, p)

  # All paths are comparable and hashable.
  for i, (static_path, new_path) in enumerate(zip(static_paths, _mk_paths())):
    assert static_path == new_path
    assert hash(static_path) == hash(new_path)
    # Now ensure that our new_path doesn't accidentally match any of the
    # static_paths which it shouldn't.
    for j in range(len(static_paths)):
      if j == i:
        continue
      assert static_paths[j] != new_path
      assert hash(static_paths[j]) != hash(new_path)

  try:
    api.path.abs_to_path('non/../absolute')
    assert False, "this should have thrown"  # pragma: no cover
  except ValueError as ex:
    assert "is not absolute" in str(ex), ex

  try:
    if api.platform.is_win:
      api.path.abs_to_path(r'C:\some\other\root\non\absolute')
    else:
      api.path.abs_to_path('/some/other/root/non/absolute')
    assert False, "this should have thrown"  # pragma: no cover
  except ValueError as ex:
    assert "could not figure out" in str(ex), ex

  start_dir = api.path.start_dir
  a = start_dir / 'a'
  b = start_dir / 'b'
  assert a < b
  assert b > a
  assert not (b < a)

  # there is also a join method on the path module
  assert start_dir / 'a' == api.path.join(start_dir, 'a')

  slashy_path = api.path.start_dir / f'foo{api.path.sep}bar'
  separated_path = api.path.start_dir / 'foo' / 'bar'
  assert str(slashy_path) == str(separated_path)
  assert slashy_path == separated_path

  slashy_file = api.path.start_dir.joinpath(
      f'foo{api.path.sep}bar{api.path.sep}baz.txt')
  assert list(slashy_file.parents) == [
      separated_path,
      separated_path.parent,
      api.path.start_dir,
  ]


def GenTests(api):
  for platform in ('linux', 'win'):
    yield api.test(
        platform,
        api.platform.name(platform),
    )