Merge pull request #158 from IBM/add_regex_for_version

Kind specific VCS checkout

Author: HonakerM

oper8/config/config.yaml

@@ -140,6 +140,9 @@ pod_name: ""
 # Version Control System Config
 vcs:
   enabled: false
+  # If kind_regex is provided then only Kind's that match that regex will be checked out.
+  # The default regex ignores temporary patches since they are unversioned
+  kind_regex: "^((?!TemporaryPatch).*)$"
 
   # Source and destination directories
   repo: null

oper8/reconcile.py

@@ -168,6 +168,8 @@ def __init__(
                 "Must provide vcs.field with strict_versioning=True",
             )
 
+        self.vcs_kind_regex = re.compile(config.vcs.kind_regex or ".*")
+
         self.deploy_manager = deploy_manager
         self.reimport_controller = reimport_controller
 
@@ -407,6 +409,10 @@ def setup_vcs(self, cr_manifest: aconfig.Config):
             cr_manifest: aconfig.Config
                 The cr manifest to pull the requested version from.
         """
+        if not self.vcs_kind_regex.match(cr_manifest.get("kind", "")):
+            log.debug("Skipping vcs checkout due to kind regex")
+            return
+
         version = get_manifest_version(cr_manifest)
         if not version:
             raise ValueError("CR Manifest has no version")

tests/test_reconcile.py

@@ -389,6 +389,31 @@ def test_setup_vcs_invalid_module_dir():
             rm.setup_vcs(cr)
 
 
+def test_setup_vcs_default_skip_path(cleanup_vcs):
+    """Test that setup_vcs correctly skips kind regex matches"""
+
+    # Setup required variables
+    with tempfile.TemporaryDirectory() as vcs_directory:
+        rm = ReconcileManager()
+
+        # Capture current path/cwd for checks
+        current_cwd = os.getcwd()
+        current_path = copy.deepcopy(sys.path)
+
+        # Create a TemporaryPatch CR which should be skipped
+        cr = setup_cr("TemporaryPatch")
+
+        # Patch setup_directory as that's tested separately and manually create
+        # the module directory
+        with library_config():
+            create_module_dir(vcs_directory)
+            rm.setup_vcs(cr)
+
+        # Assert that the cwd is unaffected
+        assert os.getcwd() == current_cwd
+        assert sys.path == current_path
+
+
 ######################
 ## setup_controller ##
 ######################