Ability add or excluded additional dependencies. (#212)

Author: simontoens

BUILD

@@ -19,6 +19,7 @@ py_library(
                  "src/generate/impl/py/*.py"]),
     data = ["src/config/pom_template.xml"],
     visibility = ["//misc:__pkg__",],
+    imports = ["src"],
 )
 
 py_binary(

docs/mdfiles.md

@@ -91,6 +91,12 @@ Default value: `None`
 
 See the `java_import` [example](../examples/java-import).
 
+##### maven_artifact.emitted_dependencies
+
+Additional dependencies, as a list of strings to include/exclude in/from the generated manifest. Exclusions are specified by prefixing the dependency with a `-`. The dependencies are specified using their "target manifest" syntax, for example, for pom files, they use "gav" syntax for inclusion and `-group_id:artifact_id` for exclusion.
+
+Default value: `[]`
+
 
 ### LIBRARY.root (required)
 

examples/hello-world/juicer/MVN-INF/BUILD.pom

@@ -4,6 +4,7 @@ maven_artifact(
     version = "10.0.0-qual1-SNAPSHOT",
     pom_generation_mode = "dynamic",
     target_name = "juicer_lib",
+    emitted_dependencies = ["com.sales:foo:1.0.0"],
 )
 
 maven_artifact_update(

src/crawl/buildpom.py

@@ -64,6 +64,10 @@ class MavenArtifactDef(object):
     version_increment_strategy_name: specifies how this artifacts version should
         be incremented.
 
+    emitted_dependencies: specifies extra dependencies to include, or exclude,
+        in the generated manifest. Use manifest-native syntax, and prefix with
+        '-' to exclude.
+
 
     ==== Read out of the optional BUILD.pom.released file ====
 
@@ -126,7 +130,8 @@ def __init__(self,
                  bazel_target=None,
                  library_path=None,
                  requires_release=None,
-                 released_pom_content=None):
+                 released_pom_content=None,
+                 emitted_dependencies=[]):
         self._group_id = group_id
         self._artifact_id = artifact_id
         self._version = version
@@ -147,6 +152,7 @@ def __init__(self,
         self._requires_release = requires_release
         self._release_reason = None
         self._released_pom_content = released_pom_content
+        self._emitted_dependencies = emitted_dependencies
 
         # data cleanup/verification/sanitization
         # these are separate methods for better readability
@@ -251,6 +257,10 @@ def release_reason(self, value):
     def released_pom_content(self):
         return self._released_pom_content
 
+    @property
+    def emitted_dependencies(self):
+        return self._emitted_dependencies
+
     @property
     def version_increment_strategy_name(self):
         return self._version_increment_strategy_name
@@ -294,7 +304,8 @@ def parse_maven_artifact_def(root_path, package):
         gen_dependency_management_pom=ma_attrs.get("generate_dependency_management_pom", False),
         jar_path=ma_attrs.get("jar_path", None),
         bazel_target=ma_attrs.get("target_name", None),
-        deps=ma_attrs.get("deps", []))
+        deps=ma_attrs.get("deps", []),
+        emitted_dependencies=ma_attrs.get("emitted_dependencies", []))
 
     template_path = ma_attrs.get("pom_template_file", None)
     if template_path is not None:
@@ -368,4 +379,5 @@ def _augment_art_def_values(user_art_def, rel_art_def, bazel_package,
         released_artifact_hash=rel_art_def.artifact_hash if rel_art_def is not None else None,
         bazel_package=bazel_package,
         released_pom_content=released_pom_content,
-        version_increment_strategy_name=version_increment_strategy_name)
+        version_increment_strategy_name=version_increment_strategy_name,
+        emitted_dependencies=user_art_def.emitted_dependencies)

src/crawl/crawler.py

@@ -183,16 +183,34 @@ def _register_dependencies(self, target_to_transitive_closure_deps):
         - the transitive closure of the library's dependencies
         """
         for ctx in self.genctxs:
-            directs = self.target_to_dependencies[ctx.label]
+            additional_deps, excluded_deps = self._load_custom_output_dependencies(ctx.artifact_def)
+            directs = [dep for dep in self.target_to_dependencies[ctx.label] if dep not in excluded_deps] + additional_deps
             ctx.register_artifact_directs(directs)
-            transitive_closure = target_to_transitive_closure_deps[ctx.label]
+
+            transitive_closure = [dep for dep in target_to_transitive_closure_deps[ctx.label] if dep not in excluded_deps]
             ctx.register_artifact_transitive_closure(transitive_closure)
-            lib_transitive_closure = self\
+
+            lib_transitive_closure = [dep for dep in self\
                 ._get_deps_transitive_closure_for_library(
                     ctx.artifact_def.library_path,
-                    target_to_transitive_closure_deps)
+                    target_to_transitive_closure_deps) if dep not in excluded_deps]
             ctx.register_library_transitive_closure(lib_transitive_closure)
 
+    def _load_custom_output_dependencies(self, artifact_def):
+        additional_deps = []
+        excluded_deps = []
+        for str_repr in artifact_def.emitted_dependencies:
+            exclude = False
+            if str_repr.startswith("-"):
+                str_repr = str_repr[1:]
+                exclude = True
+            dep = self.generation_strategy.load_dependency_by_native_repr(str_repr)
+            if exclude:
+                excluded_deps.append(dep)
+            else:
+                additional_deps.append(dep)
+        return additional_deps, excluded_deps
+
     def _get_deps_transitive_closure_for_library(
             self, library_path, target_to_transitive_closure_deps):
         all_deps = set()

src/crawl/pom.py

@@ -637,7 +637,6 @@ def _sort(s):
     """
     Converts the specified set to a list, and returns the list, sorted.
     """
-    assert isinstance(s, set), "Expected a set"
-    the_list = list(s)
+    the_list = list(s) if isinstance(s, set) else s
     the_list.sort()
     return the_list

src/generate/__init__.py

@@ -29,6 +29,10 @@ def load_dependency(self, label, artifact_def):
         """
         pass
 
+    @abstractmethod
+    def load_dependency_by_native_repr(self, str_repr):
+        pass
+
     @abstractmethod
     def load_transitive_closure(self, dependency):
         """

src/generate/impl/pomgenerationstrategy.py

@@ -20,6 +20,11 @@ def load_dependency(self, label, artifact_def):
                 raise Exception("Unknown external dependency - please make sure all maven install json files have been registered with pomgen (by setting maven_install_paths in the pomgen config file): [%s]" % label.canonical_form)
             return self.workspace._label_to_ext_dep[label.canonical_form]
 
+    def load_dependency_by_native_repr(self, str_repr):
+        if str_repr.count(":") == 1:
+            str_repr += ":-1"
+        return dependency.new_dep_from_maven_art_str(str_repr, None)
+
     def load_transitive_closure(self, dependency):
         depmd = self.workspace.dependency_metadata
         return depmd.get_transitive_closure(dependency)

src/generate/impl/pygenerationstrategy.py

@@ -55,5 +55,8 @@ def load_dependency(self, label, artifact_def):
         """
         pass
 
+    def load_dependency_by_native_repr(self, str_repr):
+        pass
+
     def load_transitive_closure(self, dependency):
         pass

tests/crawlerunittest.py

@@ -10,6 +10,7 @@
 from common import maveninstallinfo
 from common import pomgenmode
 from config import config
+from crawl import artifactgenctx as artifactgenctx
 from crawl import buildpom
 from crawl import crawler as crawlerm
 from crawl import dependency
@@ -562,6 +563,72 @@ def test_remove_package_private_labels__skip_mode_allows_them(self):
 
         self.assertEqual([l1, l2, l3, l4], labels)
 
+    def test_register_dependencies(self):
+        pom_template = ""
+        library_path = "projects/libs/lib"
+        d1 = self._get_3rdparty_dep("com:d1:1.0.0", "d1")
+        d2 = self._get_3rdparty_dep("com:d2:1.0.0", "d2")
+        d3 = self._get_3rdparty_dep("com:d3:1.0.0", "d3")
+        d4 = self._get_3rdparty_dep("com:d4:1.0.0", "d4")
+        node1 = self._build_node("art1", "projects/libs/lib/p1",
+                                 library_path=library_path)
+        node2 = self._build_node("art2", "projects/libs/lib/p2",
+                                 library_path=library_path)
+        ws = self._get_workspace()
+        ctx = artifactgenctx.ArtifactGenerationContext(
+            ws, pom_template, node1.artifact_def, node1.label)
+        strategy = pomgenerationstrategy.PomGenerationStrategy(ws, pom_template)
+        crawler = crawlerm.Crawler(ws, strategy, pom_template)
+        crawler.library_to_nodes[library_path].append(node1)
+        crawler.library_to_nodes[library_path].append(node2)
+        crawler.genctxs = [ctx]
+        crawler.target_to_dependencies = {node1.label: [d1,d2]}
+        target_to_transitive_closure_deps = {
+            node1.label: [d1, d2, d3],
+            node2.label: [d4],
+        }
+
+        crawler._register_dependencies(target_to_transitive_closure_deps)
+
+        self.assertEqual(set([d1, d2]), set(ctx.direct_dependencies))
+        self.assertEqual(set([d1, d2, d3]), set(ctx.artifact_transitive_closure))
+        self.assertEqual(set([d1, d2, d3, d4]), set(ctx.library_transitive_closure))
+
+    def test_register_dependencies_with_exclusions(self):
+        pom_template = ""
+        library_path = "projects/libs/lib"
+        d1 = self._get_3rdparty_dep("com:d1:1.0.0", "d1")
+        d2 = self._get_3rdparty_dep("com:d2:1.0.0", "d2")
+        d3 = self._get_3rdparty_dep("com:d3:1.0.0", "d3")
+        d4 = self._get_3rdparty_dep("com:d4:1.0.0", "d4")
+        d5 = self._get_3rdparty_dep("com:d5:1.0.0", "d5")
+        node1 = self._build_node("art1", "projects/libs/lib/p1",
+                                 library_path=library_path)
+        node2 = self._build_node("art2", "projects/libs/lib/p2",
+                                 library_path=library_path)
+        ws = self._get_workspace()
+        ctx = artifactgenctx.ArtifactGenerationContext(
+            ws, pom_template, node1.artifact_def, node1.label)
+        strategy = pomgenerationstrategy.PomGenerationStrategy(ws, pom_template)
+        crawler = crawlerm.Crawler(ws, strategy, pom_template)
+        crawler.library_to_nodes[library_path].append(node1)
+        crawler.library_to_nodes[library_path].append(node2)
+        crawler.genctxs = [ctx]
+        crawler.target_to_dependencies = {node1.label: [d1,d2]}
+        target_to_transitive_closure_deps = {
+            node1.label: [d1, d2, d3],
+            node2.label: [d4],
+        }
+        # add one additional dependency and exclude d2
+        node1.artifact_def._emitted_dependencies = ["com:d5:1.0.0", "-com:d2",]
+
+        crawler._register_dependencies(target_to_transitive_closure_deps)
+
+        self.assertEqual(set([d1, d5]), set(ctx.direct_dependencies))
+        self.assertEqual(set([d1, d3]), set(ctx.artifact_transitive_closure))
+        self.assertEqual(set([d1, d3, d4]), set(ctx.library_transitive_closure))
+
+
     def _build_node(self, artifact_id, bazel_package,
                     pom_generation_mode=pomgenmode.DYNAMIC,
                     parent_node=None, library_path=None):