Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2885)

Unified Diff: scripts/slave/recipe_modules/path/api.py

Issue 1347263002: Revert of Cross-repo recipe package system. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/tools/build
Patch Set: Created 5 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « scripts/slave/recipe_modules/path/__init__.py ('k') | scripts/slave/recipe_modules/path/config.py » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: scripts/slave/recipe_modules/path/api.py
diff --git a/scripts/slave/recipe_modules/path/api.py b/scripts/slave/recipe_modules/path/api.py
new file mode 100644
index 0000000000000000000000000000000000000000..a647b98548cec463b9103f24873dd4a4e8935687
--- /dev/null
+++ b/scripts/slave/recipe_modules/path/api.py
@@ -0,0 +1,238 @@
+# Copyright 2013 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import functools
+import os
+import sys
+import tempfile
+
+from recipe_engine import recipe_api
+from recipe_engine import config_types
+
+
+def PathToString(api, test):
+ def PathToString_inner(path):
+ assert isinstance(path, config_types.Path)
+ base_path = None
+ suffix = path.platform_ext.get(api.m.platform.name, '')
+ if isinstance(path.base, config_types.NamedBasePath):
+ name = path.base.name
+ if name in api.c.dynamic_paths:
+ base_path = api.c.dynamic_paths[name]
+ elif name in api.c.base_paths:
+ if test.enabled:
+ base_path = repr(path.base)
+ else: # pragma: no cover
+ base_path = api.join(*api.c.base_paths[name])
+ elif isinstance(path.base, config_types.ModuleBasePath):
+ if test.enabled:
+ base_path = repr(path.base)
+ else: # pragma: no cover
+ base_path = os.path.dirname(path.base.module.__file__)
+ else: # pragma: no cover
+ raise NotImplementedError('PathToString not implemented for %s' %
+ path.base.__class__.__name__)
+ assert base_path, 'Could not get base %r for path' % path.base
+ return api.join(base_path, *path.pieces) + suffix
+ return PathToString_inner
+
+
+def string_filter(func):
+ @functools.wraps(func)
+ def inner(*args, **kwargs):
+ return func(*map(str, args), **kwargs)
+ return inner
+
+
+class path_set(object):
+ """ implements a set which contains all the parents folders of added folders.
+ """
+ def __init__(self, path_mod, initial_paths):
+ self._path_mod = path_mod
+ self._initial_paths = set(initial_paths)
+ self._paths = set()
+
+ def _initialize(self):
+ self._initialize = lambda: None
+ for path in self._initial_paths:
+ self.add(path)
+ self._initial_paths = None
+ self.contains = lambda path: path in self._paths
+
+ def add(self, path):
+ path = str(path)
+ self._initialize()
+ while path:
+ self._paths.add(path)
+ path = self._path_mod.dirname(path)
+
+ def contains(self, path):
+ self._initialize()
+ return self.contains(path)
+
+
+class fake_path(object):
+ """Standin for os.path when we're in test mode.
+
+ This class simulates the os.path interface exposed by PathApi, respecting the
+ current platform according to the `platform` module. This allows us to
+ simulate path functions according to the platform being tested, rather than
+ the platform which is currently running.
+ """
+
+ def __init__(self, api, _mock_path_exists):
+ self._api = api
+ self._mock_path_exists = path_set(self, _mock_path_exists)
+ self._pth = None
+
+ def __getattr__(self, name):
+ if not self._pth:
+ if self._api.m.platform.is_win:
+ import ntpath as pth
+ elif self._api.m.platform.is_mac or self._api.m.platform.is_linux:
+ import posixpath as pth
+ self._pth = pth
+ return getattr(self._pth, name)
+
+ def mock_add_paths(self, path):
+ """
+ Adds a path and all of its parents to the set of existing paths.
+ """
+ self._mock_path_exists.add(path)
+
+ def exists(self, path): # pylint: disable=E0202
+ """Return True if path refers to an existing path."""
+ return self._mock_path_exists.contains(path)
+
+ def abspath(self, path):
+ """Returns the absolute version of path."""
+ path = self.normpath(path)
+ if path[0] != '[': # pragma: no cover
+ # We should never really hit this, but simulate the effect.
+ return self.api.slave_build(path)
+ else:
+ return path
+
+
+def _split_path(path): # pragma: no cover
+ """Relative or absolute path -> tuple of components."""
+ abs_path = os.path.abspath(path).split(os.path.sep)
+ # Guarantee that the first element is an absolute drive or the posix root.
+ if abs_path[0].endswith(':'):
+ abs_path[0] += '\\'
+ elif abs_path[0] == '':
+ abs_path[0] = '/'
+ else:
+ assert False, 'Got unexpected path format: %r' % abs_path
+ return abs_path
+
+
+class PathApi(recipe_api.RecipeApi):
+ """
+ PathApi provides common os.path functions as well as convenience functions
+ for generating absolute paths to things in a testable way.
+
+ Mocks:
+ exists (list): Paths which should exist in the test case. Thes must be paths
+ using the [*_ROOT] placeholders. ex. '[BUILD_ROOT]/scripts'.
+ """
+
+ OK_ATTRS = ('pardir', 'sep', 'pathsep')
+
+ # Because the native 'path' type in python is a str, we filter the *args
+ # of these methods to stringify them first (otherwise they would be getting
+ # recipe_util_types.Path instances).
+ FILTER_METHODS = ('abspath', 'basename', 'exists', 'join', 'split',
+ 'splitext')
+
+ def get_config_defaults(self):
+ return {
+ 'CURRENT_WORKING_DIR': self._startup_cwd,
+ 'TEMP_DIR': self._temp_dir,
+ }
+
+ def __init__(self, **kwargs):
+ super(PathApi, self).__init__(**kwargs)
+ config_types.Path.set_tostring_fn(
+ PathToString(self, self._test_data))
+
+ # Used in mkdtemp when generating and checking expectations.
+ self._test_counter = 0
+
+ if not self._test_data.enabled: # pragma: no cover
+ self._path_mod = os.path
+ # Capture the cwd on process start to avoid shenanigans.
+ self._startup_cwd = _split_path(os.getcwd())
+ # Use default system wide temp dir as a root temp dir.
+ self._temp_dir = _split_path(tempfile.gettempdir())
+ else:
+ self._path_mod = fake_path(self, self._test_data.get('exists', []))
+ self._startup_cwd = ['/', 'FakeTestingCWD']
+ # Appended to placeholder '[TMP]' to get fake path in test.
+ self._temp_dir = ['/']
+
+ # We can't depend on another module in the ctor.
+ if self._engine.properties.get('path_config') == 'swarming':
+ self.set_config('swarming')
+ else:
+ self.set_config('buildbot')
+
+ def mock_add_paths(self, path):
+ """For testing purposes, assert that |path| exists."""
+ if self._test_data.enabled:
+ self._path_mod.mock_add_paths(path)
+
+ def assert_absolute(self, path):
+ assert self.abspath(path) == str(path), '%s is not absolute' % path
+
+ def mkdtemp(self, prefix):
+ """Makes a new temp directory, returns path to it."""
+ if not self._test_data.enabled: # pragma: no cover
+ # New path as str.
+ new_path = tempfile.mkdtemp(prefix=prefix, dir=str(self['tmp_base']))
+ # Ensure it's under self._temp_dir, convert to Path.
+ new_path = _split_path(new_path)
+ assert new_path[:len(self._temp_dir)] == self._temp_dir
+ temp_dir = self['tmp_base'].join(*new_path[len(self._temp_dir):])
+ else:
+ self._test_counter += 1
+ assert isinstance(prefix, basestring)
+ temp_dir = self['tmp_base'].join(
+ '%s_tmp_%d' % (prefix, self._test_counter))
+ self.mock_add_paths(temp_dir)
+ return temp_dir
+
+ def __contains__(self, pathname):
+ return bool(self.c.dynamic_paths.get(pathname))
+
+ def __setitem__(self, pathname, path):
+ assert isinstance(path, config_types.Path), (
+ 'Setting dynamic path to something other than a Path: %r' % path)
+ assert pathname in self.c.dynamic_paths, (
+ 'Must declare dynamic path (%r) in config before setting it.' % path)
+ assert isinstance(path.base, config_types.BasePath), (
+ 'Dynamic path values must be based on a base_path' % path.base)
+ self.c.dynamic_paths[pathname] = path
+
+ def __getitem__(self, name):
+ if name in self.c.dynamic_paths:
+ r = self.c.dynamic_paths[name]
+ assert r is not None, ('Tried to get dynamic path %s but it has not been '
+ 'set yet.' % name)
+ return r
+ if name in self.c.base_paths:
+ return config_types.Path(config_types.NamedBasePath(name))
+
+ def __getattr__(self, name):
+ # retrieve os.path attributes
+ if name in self.OK_ATTRS:
+ return getattr(self._path_mod, name)
+ if name in self.FILTER_METHODS:
+ return string_filter(getattr(self._path_mod, name))
+ raise AttributeError("'%s' object has no attribute '%s'" %
+ (self._path_mod, name)) # pragma: no cover
+
+ def __dir__(self): # pragma: no cover
+ # Used for helping out show_me_the_modules.py
+ return self.__dict__.keys() + list(self.OK_ATTRS + self.FILTER_METHODS)
« no previous file with comments | « scripts/slave/recipe_modules/path/__init__.py ('k') | scripts/slave/recipe_modules/path/config.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698