add "generic" infra path config

It proved to be dangerous to introduce conditional logic into recipes
and recipe modules to alternate between buildbot and luci modes, namely
it touches buildbot code paths, which can be very dangerous.

Instead, introduce "generic" default path config that configures
existing base paths from the built-in ones.

Also remove swarmbucket path config because it is not used.

R=iannucci@chromium.org
BUG=660481

Change-Id: Ide0e1f64913fe35766b997ab5b55f01f4c63aa58
Reviewed-on: https://chromium-review.googlesource.com/459234
Commit-Queue: Nodir Turakulov <nodir@chromium.org>
Reviewed-by: Robbie Iannucci <iannucci@chromium.org>

recipes/recipe_modules/infra_paths/example.expected/paths_swarmbucket_linux.json → recipe_modules/infra_paths/example.expected/paths_generic_linux.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_swarmbucket_mac.json → recipe_modules/infra_paths/example.expected/paths_generic_mac.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_swarmbucket_win.json → recipe_modules/infra_paths/example.expected/paths_generic_win.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/gclient/example.expected/basic.json

@@ -89,7 +89,7 @@
       "RECIPE_PACKAGE_REPO[depot_tools]/gclient.py",
       "config",
       "--spec",
-      "cache_dir = '[CACHE]/git'\nsolutions = [{'deps_file': '.DEPS.git', 'managed': True, 'name': 'Angle', 'url': 'https://chromium.googlesource.com/angle/angle.git'}]"
+      "cache_dir = '[GIT_CACHE]'\nsolutions = [{'deps_file': '.DEPS.git', 'managed': True, 'name': 'Angle', 'url': 'https://chromium.googlesource.com/angle/angle.git'}]"
     ],
     "cwd": "[START_DIR]/src/third_party",
     "env": {

recipes/recipe_modules/gclient/example.expected/revision.json

@@ -91,7 +91,7 @@
       "RECIPE_PACKAGE_REPO[depot_tools]/gclient.py",
       "config",
       "--spec",
-      "cache_dir = '[CACHE]/git'\nsolutions = [{'deps_file': '.DEPS.git', 'managed': True, 'name': 'Angle', 'url': 'https://chromium.googlesource.com/angle/angle.git'}]"
+      "cache_dir = '[GIT_CACHE]'\nsolutions = [{'deps_file': '.DEPS.git', 'managed': True, 'name': 'Angle', 'url': 'https://chromium.googlesource.com/angle/angle.git'}]"
     ],
     "cwd": "[START_DIR]/src/third_party",
     "env": {

recipes/recipe_modules/gclient/example.expected/tryserver.json

@@ -91,7 +91,7 @@
       "RECIPE_PACKAGE_REPO[depot_tools]/gclient.py",
       "config",
       "--spec",
-      "cache_dir = '[CACHE]/git'\nsolutions = [{'deps_file': '.DEPS.git', 'managed': True, 'name': 'Angle', 'url': 'https://chromium.googlesource.com/angle/angle.git'}]"
+      "cache_dir = '[GIT_CACHE]'\nsolutions = [{'deps_file': '.DEPS.git', 'managed': True, 'name': 'Angle', 'url': 'https://chromium.googlesource.com/angle/angle.git'}]"
     ],
     "cwd": "[START_DIR]/src/third_party",
     "env": {

recipes/recipe_modules/git/example.expected/git-cache-checkout.json

@@ -18,7 +18,7 @@
       "cache",
       "populate",
       "-c",
-      "[CACHE]/git",
+      "[GIT_CACHE]",
       "https://chromium.googlesource.com/chromium/src.git"
     ],
     "cwd": "[START_DIR]/src",
@@ -35,7 +35,7 @@
       "exists",
       "--quiet",
       "--cache-dir",
-      "[CACHE]/git",
+      "[GIT_CACHE]",
       "https://chromium.googlesource.com/chromium/src.git"
     ],
     "cwd": "[START_DIR]/src",

recipes/recipe_modules/infra_paths/api.py

@@ -9,21 +9,10 @@ class InfraPathsApi(recipe_api.RecipeApi):
   """infra_paths module is glue for design mistakes. It will be removed."""
 
   def initialize(self):
-    path_config = self.m.properties.get('path_config')
-    if path_config:
-      # TODO(phajdan.jr): remove dupes from the engine and delete infra_ prefix.
-      self.m.path.set_config('infra_' + path_config)
+    path_config = self.m.properties.get('path_config', 'generic')
+    self.m.path.set_config('infra_' + path_config)
 
   @property
   def default_git_cache_dir(self):
-    """Returns the location of the default git cache directory.
-
-    This property should be used instead of using path['git_cache'] directly.
-
-    It returns git_cache path if it is defined (Buildbot world), otherwise
-    uses the more generic [CACHE]/git path (LUCI world).
-    """
-    try:
-      return self.m.path['git_cache']
-    except KeyError:
-      return self.m.path['cache'].join('git')
+    """Returns the location of the default git cache directory."""
+    return self.m.path['git_cache']

recipes/recipe_modules/infra_paths/example.expected/basic.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[CACHE]/git@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_buildbot_linux.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'depot_tools': ('depot_tools',), 'build_internal': ('build_internal',), 'cache': ('build', 'slave', 'cache'), 'goma_cache': ('build', 'slave', 'goma_cache'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'build': ('build',), 'git_cache': ('build', 'slave', 'cache_dir'), 'root': (), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_buildbot_mac.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'depot_tools': ('depot_tools',), 'build_internal': ('build_internal',), 'cache': ('build', 'slave', 'cache'), 'goma_cache': ('build', 'slave', 'goma_cache'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'build': ('build',), 'git_cache': ('build', 'slave', 'cache_dir'), 'root': (), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_buildbot_win.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'depot_tools': ('depot_tools',), 'build_internal': ('build_internal',), 'cache': ('build', 'slave', 'cache'), 'goma_cache': ('build', 'slave', 'goma_cache'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'build': ('build',), 'git_cache': ('build', 'slave', 'cache_dir'), 'root': (), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_generic_linux.json

+[
+  {
+    "cmd": [],
+    "name": "show cache path",
+    "~followup_annotations": [
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
+      "@@@STEP_LOG_END@result@@@"
+    ]
+  },
+  {
+    "name": "$result",
+    "recipe_result": null,
+    "status_code": 0
+  }
+]
\ No newline at end of file

recipes/recipe_modules/infra_paths/example.expected/paths_generic_mac.json

+[
+  {
+    "cmd": [],
+    "name": "show cache path",
+    "~followup_annotations": [
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
+      "@@@STEP_LOG_END@result@@@"
+    ]
+  },
+  {
+    "name": "$result",
+    "recipe_result": null,
+    "status_code": 0
+  }
+]
\ No newline at end of file

recipes/recipe_modules/infra_paths/example.expected/paths_generic_win.json

+[
+  {
+    "cmd": [],
+    "name": "show cache path",
+    "~followup_annotations": [
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'builder'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git'), 'tmp_base': ('/',)}@@@",
+      "@@@STEP_LOG_END@result@@@"
+    ]
+  },
+  {
+    "name": "$result",
+    "recipe_result": null,
+    "status_code": 0
+  }
+]
\ No newline at end of file

recipes/recipe_modules/infra_paths/example.expected/paths_kitchen_linux.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'b'), 'goma_deps_cache': ('/', 'b', 'c', 'goma_deps_cache'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma_cache'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git_cache'), 'root': ('/', 'b', 'FakeTestingCWD'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_kitchen_mac.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'b'), 'goma_deps_cache': ('/', 'b', 'c', 'goma_deps_cache'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma_cache'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git_cache'), 'root': ('/', 'b', 'FakeTestingCWD'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.expected/paths_kitchen_win.json

@@ -3,8 +3,7 @@
     "cmd": [],
     "name": "show cache path",
     "~followup_annotations": [
-      "@@@STEP_LOG_LINE@result@[CACHE]@@@",
-      "@@@STEP_LOG_LINE@result@[GIT_CACHE]@@@",
+      "@@@STEP_LOG_LINE@result@base_paths: {'builder_cache': ('/', 'b', 'c', 'b'), 'goma_deps_cache': ('/', 'b', 'c', 'goma_deps_cache'), 'cache': ('/', 'b', 'c'), 'goma_cache': ('/', 'b', 'c', 'goma_cache'), 'start_dir': ('/', 'b', 'FakeTestingCWD'), 'git_cache': ('/', 'b', 'c', 'git_cache'), 'root': ('/', 'b', 'FakeTestingCWD'), 'tmp_base': ('/',)}@@@",
       "@@@STEP_LOG_END@result@@@"
     ]
   },

recipes/recipe_modules/infra_paths/example.py

@@ -16,8 +16,7 @@ DEPS = [
 def RunSteps(api):
   api.step('show cache path', [])
   api.step.active_result.presentation.logs['result'] = [
-    str(api.path['cache']),
-    str(api.infra_paths.default_git_cache_dir),
+    'base_paths: %r' % (api.path.c.base_paths,),
   ]
 
 
@@ -25,7 +24,7 @@ def GenTests(api):
   yield api.test('basic')
 
   for platform in ('linux', 'mac', 'win'):
-    for path_config in ('buildbot', 'kitchen', 'swarmbucket'):
+    for path_config in ('buildbot', 'kitchen', 'generic'):
       yield (
           api.test('paths_%s_%s' % (path_config, platform)) +
           api.platform.name(platform) +

recipes/recipe_modules/infra_paths/path_config.py

@@ -51,6 +51,8 @@ def infra_kitchen(c):
       c.base_paths[path] = c.base_paths['cache'] + (path,)
 
 
-@CONFIG_CTX(includes=['infra_buildbot'])
-def infra_swarmbucket(c):
-  c.base_paths['git_cache'] = c.START_DIR + ('git_cache',)
+@CONFIG_CTX()
+def infra_generic(c):
+  c.base_paths['builder_cache'] = c.base_paths['cache'] + ('builder',)
+  c.base_paths['git_cache'] = c.base_paths['cache'] + ('git',)
+  c.base_paths['goma_cache'] = c.base_paths['cache'] + ('goma',)