Add a way to skip over dep labels (#150)

Author: simontoens

README.md

@@ -85,17 +85,29 @@ pom_template_path=
 # Example value: tools/maven_install/*.json,another/path/to/mvn_install.json,
 maven_install_paths=
 
+
 [crawler]
-# A list of path prefixes that are not crawled by pomgen.  Any dependency
-# that starts with one of the strings returned by this method is skipped 
-# and not processed (and not included in the generated pom.xml).
+# A list of path prefixes that are not crawled by pomgen.  Any source dependency
+# that starts with one of the specified paths is skipped and not processed
+# (and not included in the generated pom.xml).
 # These dependencies are similar to Maven's "provided" scope: if they are
 # needed at runtime, it is expected that the final runtime assembly
 # contains them.
-# Default value: ""
+# Default value: []
 # Example value: projects/protos/,
 excluded_dependency_paths=
 
+# A list of labels that are skipped over by pomgen.  Any dependency
+# that matches one of the specified strings is skipped and not processed
+# (and not included in the generated pom.xml).
+# These dependencies are similar to Maven's "provided" scope: if they are
+# needed at runtime, it is expected that the final runtime assembly
+# contains them.
+# Default value: []
+# Example value: @maven//:com_google_guava_guava,
+excluded_dependency_labels=
+
+
 [artifact]
 # Global toggle for change detection (docs/change_detection.md)
 # Default value: True

config/config.py

@@ -5,56 +5,13 @@
 For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 
 
-Responsible for loading a config file of the following format:
-
-[general]
-# Path to the pom template, used when generating pom.xml files for jar artifacts
-pom_template_path=
-# A list of paths to pinned maven_install json files.
-# Globs are supported, for example: tools/maven_install/*.json
-maven_install_paths=maven_install.json,
-
-[crawler]
-# A list of path prefixes that are not crawled by pomgen.  Any dependency
-# that starts with one of the strings returned by this method is skipped 
-# and not processed (and not included in the generated pom.xml).
-# These dependencies are similar to Maven's "provided" scope: if they are
-# needed at runtime, it is expected that the final runtime assembly
-# contains them.
-excluded_dependency_paths=projects/protos/,
-
-[artifact]
-# Globally toggles change detection, the default value is on (True).
-# See /docs/change_detection.md
-change_detection_enabled=True
-
-# Paths not considered when determining whether an artifact has changed
-excluded_relative_paths=src/tests,
-
-# File names not considered when determining whether an artifact has changed
-excluded_filenames=.gitignore,
-
-# Ignored file extensions when determining whether an artifact has changed
-excluded_extensions=.md,
-
-# query versioning mode for proposed next versions
-transitives_versioning_mode=semver|counter
-
-# The classifier used for all jars artifacts assembled by pomgen
-# By default, no classifier is set
-# The same value can also be specified by setting the environment variable
-# POMGEN_JAR_CLASSIFIER - the environment variable takes precedence over the
-# value set in this cfg file
-jar_classifier=
+Responsible for loading a config file. For the config file format, see /README.md#configuration.
 """
 
-try:
-    import ConfigParser as configparser
-except ImportError:
-    import configparser
 
-from config import exclusions
 from common import logger
+from config import exclusions
+import configparser
 import os
 
 
@@ -92,6 +49,7 @@ def artifact(option, dflt, valid_values=None):
         pom_template_path_and_content=_read_files(repo_root, pom_template_p)[0],
         maven_install_paths=gen("maven_install_paths", ("maven_install.json",)),
         excluded_dependency_paths=crawl("excluded_dependency_paths", ()),
+        excluded_dependency_labels=crawl("excluded_dependency_labels", ()),
         excluded_src_relpaths=artifact("excluded_relative_paths", ("src/test",)),
         excluded_src_file_names=artifact("excluded_filenames", (".gitignore",)),
         excluded_src_file_extensions=artifact("excluded_extensions", (".md",)),
@@ -124,6 +82,7 @@ def __init__(self,
                  pom_template_path_and_content=("",""),
                  maven_install_paths=(),
                  excluded_dependency_paths=(),
+                 excluded_dependency_labels=(),
                  excluded_src_relpaths=(),
                  excluded_src_file_names=(),
                  excluded_src_file_extensions=(),
@@ -137,6 +96,7 @@ def __init__(self,
 
         # crawler
         self.excluded_dependency_paths = _add_pathsep(_to_tuple(excluded_dependency_paths))
+        self.excluded_dependency_labels = _to_tuple(excluded_dependency_labels)
 
         # artifact
         self.excluded_src_relpaths = _add_pathsep(_to_tuple(excluded_src_relpaths))
@@ -178,21 +138,25 @@ def __str__(self):
 
 [crawler]
 excluded_dependency_paths=%s
+excluded_dependency_labels=%s
 
 [artifact]
 excluded_relative_paths=%s
 excluded_filenames=%s
 excluded_extensions=%s
 transitives_versioning_mode=%s
 jar_artifact_classifier=%s
+change_detection_enabled=%s
 """ % (self.pom_template_path_and_content[0],
        self.maven_install_paths,
        self.excluded_dependency_paths,
+       self.excluded_dependency_labels,
        self.excluded_src_relpaths,
        self.excluded_src_file_names,
        self.excluded_src_file_extensions,
        self.transitives_versioning_mode,
-       self.jar_artifact_classifier)
+       self.jar_artifact_classifier,
+       self.change_detection_enabled)
 
 
 def _to_tuple(thing):

crawl/workspace.py

@@ -24,6 +24,7 @@ def __init__(self, repo_root_path, config, maven_install_info,
                  pom_content, dependency_metadata, verbose=False):
         self.repo_root_path = repo_root_path
         self.excluded_dependency_paths = config.excluded_dependency_paths
+        self.excluded_dependency_labels = config.excluded_dependency_labels
         self.source_exclusions = config.all_src_exclusions
         self.pom_content = pom_content
         self.verbose = verbose
@@ -116,6 +117,9 @@ def filter_artifact_producing_packages(self, packages):
         return [art_def.bazel_package for art_def in art_defs if art_def.pom_generation_mode.produces_artifact]
 
     def _parse_dep_label(self, dep_label):
+        if dep_label in self.excluded_dependency_labels:
+            return None
+
         if dep_label.startswith("@"):
             if dep_label not in self._name_to_ext_deps:
                 print(self._name_to_ext_deps.values())

tests/configtest.py

@@ -166,6 +166,20 @@ def test_change_detection__disabled(self):
 
         self.assertFalse(cfg.change_detection_enabled)
 
+    def test_excluded_labels(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", """
+[crawler]
+excluded_dependency_labels=  123    ,   444
+""")
+
+        cfg = config.load(repo_root)
+
+        self.assertEquals(("123", "444"), cfg.excluded_dependency_labels)
+
     def test_str(self):
         repo_root = tempfile.mkdtemp("root")
         pom_template_path = self._write_file(repo_root, "pom_template", "foo")

tests/workspacetest.py

@@ -17,7 +17,6 @@
 from crawl import git
 from crawl import pomcontent
 from crawl import workspace
-
 import os
 import tempfile
 import unittest
@@ -138,6 +137,22 @@ def test_excluded_dependency_paths(self):
         self.assertEqual("logback-classic", deps[0].artifact_id)
         self.assertEqual("1.2.3", deps[0].version)
         self.assertIsNone(deps[0].bazel_package)
+
+    def test_excluded_dependency_labels(self):
+        """
+        Verifies that excluded dependency labels are not added to the list of 
+        dependencies.
+        """
+        depmd = dependencym.DependencyMetadata(None)
+        ws = workspace.Workspace("some/path",
+            config=self._get_config(excluded_dependency_labels=["@maven//:ch_qos_logback_logback_classic",]),
+            maven_install_info=self._mocked_mvn_install_info("maven"),
+            pom_content=pomcontent.NOOP,
+            dependency_metadata=depmd)
+
+        deps = ws.parse_dep_labels(["@maven//:ch_qos_logback_logback_classic"])
+
+        self.assertEqual(0, len(deps))
 
     def test_parse_ext_dep_with_reserved_words(self):
         """
@@ -486,9 +501,8 @@ def _write_basic_workspace_file(self, repo_root_path):
         with open(workspace_file_path, "w") as f:
            f.write(workspace_file)
 
-    def _get_config(self, excluded_dependency_paths=[]):
-        return config.Config(
-            excluded_dependency_paths=excluded_dependency_paths)
+    def _get_config(self, **kwargs):
+        return config.Config(**kwargs)
 
 
 if __name__ == '__main__':