change_detection setting needs to be bool (#147)

Author: simontoens

config/config.py

@@ -97,7 +97,7 @@ def artifact(option, dflt, valid_values=None):
         excluded_src_file_extensions=artifact("excluded_extensions", (".md",)),
         transitives_versioning_mode=artifact("transitives_versioning_mode", "semver", valid_values=("semver", "counter")),
         jar_artifact_classifier=artifact("jar_classifier", None),
-        change_detection=artifact("change_detection", True),
+        change_detection_enabled=artifact("change_detection_enabled", True),
     )
 
     if verbose:
@@ -129,7 +129,7 @@ def __init__(self,
                  excluded_src_file_extensions=(),
                  transitives_versioning_mode="semver",
                  jar_artifact_classifier=None,
-                 change_detection=True):
+                 change_detection_enabled=True):
 
         # general
         self.pom_template_path_and_content=pom_template_path_and_content
@@ -144,7 +144,7 @@ def __init__(self,
         self.excluded_src_file_extensions = _to_tuple(excluded_src_file_extensions)
         self.transitives_versioning_mode = transitives_versioning_mode
         self._jar_artifact_classifier = jar_artifact_classifier
-        self._change_detection = change_detection
+        self._change_detection_enabled = _to_bool(change_detection_enabled)
 
     @property
     def pom_template(self):
@@ -160,7 +160,7 @@ def jar_artifact_classifier(self):
 
     @property
     def change_detection_enabled(self):
-        return self._change_detection
+        return self._change_detection_enabled
 
     @property
     def all_src_exclusions(self):
@@ -204,9 +204,18 @@ def _to_tuple(thing):
         tokens = thing.split(",")
         filtered_tokens = [t.strip() for t in tokens if len(t.strip()) > 0]
         return tuple(filtered_tokens)
-    raise Exception("Cannot convert to tuple")
+    raise Exception("Cannot convert to tuple [%s] % thing")
 
 
+def _to_bool(thing):
+    if isinstance(thing, bool):
+        return thing
+    if isinstance(thing, int):
+        return False if thing == 0 else True
+    if isinstance(thing, str):
+        return True if thing.lower() in ("true", "on", "1") else False
+    raise Exception("Cannot convert to bool [%s]" % thing)
+
 def _read_files(repo_root, paths):
     """
     Returns a list of tuples: (<path>, <file content>).

tests/configtest.py

@@ -10,6 +10,7 @@
 import tempfile
 import unittest
 
+
 class ConfigTest(unittest.TestCase):
 
     def test_pom_template(self):
@@ -126,6 +127,45 @@ def test_classifier__set_in_config__env_var_takes_precedence(self):
         finally:
             del os.environ["POMGEN_JAR_CLASSIFIER"]
 
+    def test_change_detection__default(self):
+        repo_root = tempfile.mkdtemp("root")
+        os.mkdir(os.path.join(repo_root, "config"))
+        pom_template_path = self._write_file(repo_root, "WORKSPACE", "foo")
+        pom_template_path = self._write_file(repo_root, "config/pom_template.xml", "foo")
+        self._write_file(repo_root, ".pomgenrc", "")
+
+        cfg = config.load(repo_root)
+
+        self.assertTrue(cfg.change_detection_enabled)
+
+    def test_change_detection__enabled(self):
+        repo_root = tempfile.mkdtemp("root")
+        os.mkdir(os.path.join(repo_root, "config"))
+        pom_template_path = self._write_file(repo_root, "WORKSPACE", "foo")
+        pom_template_path = self._write_file(repo_root, "config/pom_template.xml", "foo")
+        self._write_file(repo_root, ".pomgenrc", """
+[artifact]
+change_detection_enabled=True
+""")
+
+        cfg = config.load(repo_root)
+
+        self.assertTrue(cfg.change_detection_enabled)
+
+    def test_change_detection__disabled(self):
+        repo_root = tempfile.mkdtemp("root")
+        os.mkdir(os.path.join(repo_root, "config"))
+        pom_template_path = self._write_file(repo_root, "WORKSPACE", "foo")
+        pom_template_path = self._write_file(repo_root, "config/pom_template.xml", "foo")
+        self._write_file(repo_root, ".pomgenrc", """
+[artifact]
+change_detection_enabled=False
+""")
+
+        cfg = config.load(repo_root)
+
+        self.assertFalse(cfg.change_detection_enabled)
+
     def test_str(self):
         repo_root = tempfile.mkdtemp("root")
         pom_template_path = self._write_file(repo_root, "pom_template", "foo")
@@ -136,24 +176,6 @@ def test_str(self):
         self.assertIn("pom_template_path=%s" % pom_template_path, str(cfg))
         self.assertIn("maven_install_paths=('maven', 'misc')" , str(cfg))
 
-    def _write_pomgenrc(self, repo_root, pom_template_path, maven_install_paths):
-        content = """[general]
-pom_template_path=%s
-""" % pom_template_path
-
-        if maven_install_paths is not None:
-            content = content + """
-maven_install_paths=%s
-""" % maven_install_paths
-
-        self._write_file(repo_root, ".pomgenrc", content)
-
-    def _write_file(self, repo_root, relative_path, content):
-        path = os.path.join(repo_root, relative_path)
-        with open(path, "w") as f:
-            f.write(content)
-        return path
-
     def test_pathsep__excluded_dependency_paths(self):
         cfg = config.Config(excluded_dependency_paths="abc")
         self.assertEqual("abc/", cfg.excluded_dependency_paths[0])
@@ -189,6 +211,25 @@ def test_tuple__excluded_src_file_extensions(self):
         self.assertTrue(isinstance(cfg.excluded_src_file_extensions, tuple))
         self.assertEqual(0, len(cfg.excluded_src_file_extensions))
 
+    def _write_pomgenrc(self, repo_root, pom_template_path, maven_install_paths):
+        content = """[general]
+pom_template_path=%s
+""" % pom_template_path
+
+        if maven_install_paths is not None:
+            content = content + """
+maven_install_paths=%s
+""" % maven_install_paths
+
+        self._write_file(repo_root, ".pomgenrc", content)
+
+    def _write_file(self, repo_root, relative_path, content):
+        path = os.path.join(repo_root, relative_path)
+        with open(path, "w") as f:
+            f.write(content)
+        return path
+
+
 if __name__ == '__main__':
     unittest.main()