def test_template__deps_config_setion_is_removed(self):
"""
Verifies that the special dependency config section is removed
from the pom template when it is processed.
"""
pom_template = """
<project>
<dependencyManagement>
<dependencies>
__pomgen.start_dependency_customization__
__pomgen.end_dependency_customization__
</dependencies>
</dependencyManagement>
</project>
"""
expected_pom = """
<project>
<dependencyManagement>
<dependencies>
</dependencies>
</dependencyManagement>
</project>
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
maveninstallinfo.NOOP, pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = pom_template
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertEqual(expected_pom, generated_pom)
def test_template_genmode__goldfile(self):
"""
Verifies version omissions when genmode is GOLDFILE.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
self._mocked_mvn_install_info("maven"),
pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
srpc_artifact_def = buildpom.maven_artifact("com.grail.srpc",
"srpc-api", "5.6.7")
srpc_artifact_def = buildpom._augment_art_def_values(
srpc_artifact_def, None, "pack1", None, None, pomgenmode.DYNAMIC)
srpc_dep = dependency.MonorepoDependency(srpc_artifact_def,
bazel_target=None)
artifact_def.custom_pom_template_content = """
this artifact version #{version}
logback coord #{ch.qos.logback:logback-classic:version}
logback qualified #{@maven//:ch_qos_logback_logback_classic.version}
logback unqualified #{ch_qos_logback_logback_classic.version}
srpc #{com.grail.srpc:srpc-api:version}
"""
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
pomgen.register_dependencies_transitive_closure__library(
set([srpc_dep]))
generated_pom = pomgen.gen(pomcontenttype=pom.PomContentType.GOLDFILE)
self.assertIn("this artifact version ***", generated_pom)
self.assertIn("logback coord 1.2.3", generated_pom)
self.assertIn("logback qualified 1.2.3", generated_pom)
self.assertIn("logback unqualified 1.2.3", generated_pom)
self.assertIn("srpc ***", generated_pom)
def test_template_genmode__goldfile(self):
"""
Verifies version omissions when genmode is GOLDFILE.
"""
ws = workspace.Workspace(
"some/path", """
native.maven_jar(
name = "ch_qos_logback_logback_classic",
artifact = "ch.qos.logback:logback-classic:1.4.4",
)""", [], exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
srpc_artifact_def = buildpom.maven_artifact("com.grail.srpc",
"srpc-api", "5.6.7")
srpc_artifact_def = buildpom._augment_art_def_values(
srpc_artifact_def, None, "pack1", None, None, pomgenmode.DYNAMIC)
dep = dependency.new_dep_from_maven_artifact_def(srpc_artifact_def)
pomgen = pom.TemplatePomGen(ws,
artifact_def,
dep,
template_content="""
this artifact version #{version}
logback #{ch.qos.logback:logback-classic:version}
srpc #{com.grail.srpc:srpc-api:version}""")
pomgen.register_dependencies_globally(
set([
dependency.MonorepoDependency(srpc_artifact_def,
bazel_target=None)
]), set())
generated_pom = pomgen.gen(pomcontenttype=pom.PomContentType.GOLDFILE)
self.assertIn("this artifact version ***", generated_pom)
self.assertIn("logback 1.4.4", generated_pom)
self.assertIn("srpc ***", generated_pom)
def test_template_var_sub__monorepo_deps(self):
"""
Verifies references to monorepo versions in a pom template.
"""
ws = workspace.Workspace("some/path", "", [],
exclusions.src_exclusions())
artifact_def = buildpom.MavenArtifactDef("groupId", "artifactId",
"1.2.3")
srpc_artifact_def = buildpom.MavenArtifactDef("com.grail.srpc",
"srpc-api", "5.6.7")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws,
artifact_def,
dep,
template_content="""
srpc #{com.grail.srpc:srpc-api:version}""")
pomgen.register_dependencies_globally(
set([
dependency.MonorepoDependency(srpc_artifact_def,
bazel_target=None)
]), set())
generated_pom = pomgen.gen()
self.assertIn("srpc 5.6.7", generated_pom)
def test_template_var_sub__ext_deps_with_same_versions(self):
"""
Ensures that external dependencies (jars) that have the same gav, but
are defined multiple times in different maven_install rules, can
be referenced.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
self._mocked_mvn_install_info("maven"),
pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.4.4")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = """
1 v1 #{@maven//:org_apache_maven_same_version.version}
2 v2 #{@maven2//:org_apache_maven_same_version.version}
3 v #{org_apache_maven_same_version.version}
4 v #{org.apache.maven:same-version:version}
"""
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("1 v1 1.0.0", generated_pom)
self.assertIn("2 v2 1.0.0", generated_pom)
self.assertIn("3 v 1.0.0", generated_pom)
self.assertIn("4 v 1.0.0", generated_pom)
def test_template_var_sub__multiple_ext_deps_with_same_ga_diff_vers(self):
"""
Verifies that pomgen is NOT OK with multiple external deps with the same
groupId/artifactId but with a different version (as this would break
the #{<groupId>:<artifactId>:version} syntax).
"""
ws = workspace.Workspace(
"some/path", """
native.maven_jar(
name = "name1",
artifact = "g:a:20",
)
native.maven_jar(
name = "name2",
artifact = "g:a:21",
)
""", [], exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws,
artifact_def,
dep,
template_content="""
srpc #{g:a:version}""")
with self.assertRaises(Exception) as ctx:
pomgen.gen()
self.assertIn(
"Found multiple artifacts with the same groupId:artifactId",
str(ctx.exception))
self.assertIn("g:a", str(ctx.exception))
def test_template_var_sub__multiple_ext_deps_with_same_gav(self):
"""
Verifies that pomgen is ok with multiple external deps with the same
gav. This is an edge case, where the WORKSPACE file defines 2 (or more)
differnently named maven_jars, that all point back to the same artifact.
"""
ws = workspace.Workspace(
"some/path", """
native.maven_jar(
name = "name1",
artifact = "g:a:20",
)
native.maven_jar(
name = "name2",
artifact = "g:a:20",
)
""", [], exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws,
artifact_def,
dep,
template_content="""
srpc #{g:a:version}""")
pomgen.gen()
def test_template_var_sub__conflicting_gav__ext_and_BUILDpom(self):
"""
Verifies error handling when gavs are conflicting between external deps
and what is set in BUILD.pom files.
"""
ws = workspace.Workspace(
"some/path", """
native.maven_jar(
name = "name",
artifact = "g:a:20",
)""", [], exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws,
artifact_def,
dep,
template_content="""
srpc #{g:a:version}""")
art = buildpom.MavenArtifactDef("g", "a", "1", bazel_package="a/b/c")
d = dependency.MonorepoDependency(art, bazel_target=None)
pomgen.register_dependencies_globally(set([d]), set())
with self.assertRaises(Exception) as ctx:
pomgen.gen()
self.assertIn(
"Found multiple artifacts with the same groupId:artifactId",
str(ctx.exception))
self.assertIn("g:a", str(ctx.exception))
def test_template_var_sub__conflicting_gav__ext_and_BUILDpom(self):
"""
Verifies error handling when gavs are conflicting between external deps
and what is set in BUILD.pom files.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
self._mocked_mvn_install_info("maven"),
pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = "srpc #{g:a:version}"
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
art = buildpom.MavenArtifactDef("com.google.guava",
"guava",
"26.0",
bazel_package="a/b/c")
d = dependency.MonorepoDependency(art, bazel_target=None)
pomgen.register_dependencies_transitive_closure__library(set([d]))
with self.assertRaises(Exception) as ctx:
pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn(
"Found multiple artifacts with the same groupId:artifactId",
str(ctx.exception))
self.assertIn("com.google.guava:guava", str(ctx.exception))
def test_template_var_sub(self):
"""
Verifies variable substitution in a pom template.
"""
ws = workspace.Workspace(
"some/path", """
native.maven_jar(
name = "ch_qos_logback_logback_classic",
artifact = "ch.qos.logback:logback-classic:1.4.4",
)""", [], exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws,
artifact_def,
dep,
template_content="""
logback_old_syntax #{ch_qos_logback_logback_classic.version}
logback_new_syntax #{ch.qos.logback:logback-classic:version}
monorepo artifact version #{version}""")
generated_pom = pomgen.gen()
self.assertIn("logback_old_syntax 1.4.4", generated_pom)
self.assertIn("logback_new_syntax 1.4.4", generated_pom)
self.assertIn("monorepo artifact version 1.2.3", generated_pom)
def test_template__unencountered_deps(self):
"""
Verifies that declared deps that are not crawled can be referenced
using the pomgen.unencountered_deps property.
"""
pom_template = """
<project>
<dependencyManagement>
<dependencies>
__pomgen.start_dependency_customization__
<dependency>
<artifactId>art1</artifactId>
<groupId>group1</groupId>
<version>1.0.0</version>
<exclusions>
<exclusion>
<artifactId>ea1</artifactId>
<groupId>eg1</groupId>
</exclusion>
</exclusions>
</dependency>
__pomgen.end_dependency_customization__
#{pomgen.unencountered_dependencies}
</dependencies>
</dependencyManagement>
</project>
"""
expected_pom = """
<project>
<dependencyManagement>
<dependencies>
<dependency>
<artifactId>art1</artifactId>
<groupId>group1</groupId>
<version>1.0.0</version>
<exclusions>
<exclusion>
<artifactId>ea1</artifactId>
<groupId>eg1</groupId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</dependencyManagement>
</project>
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
maveninstallinfo.NOOP, pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = pom_template
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertEqual(expected_pom, generated_pom)
def test_template__library_transitives(self):
"""
Verifies that transitive dependencies can be referenced using the
property pomgen.transitive_closure_of_library_dependencies.
"""
pom_template = """
<project>
<dependencyManagement>
<dependencies>
#{pomgen.transitive_closure_of_library_dependencies}
</dependencies>
</dependencyManagement>
</project>
"""
expected_pom = """
<project>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.grail.srpc</groupId>
<artifactId>srpc-api</artifactId>
<version>5.6.7</version>
</dependency>
<dependency>
<groupId>cg</groupId>
<artifactId>ca</artifactId>
<version>0.0.1</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
maveninstallinfo.NOOP, pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = pom_template
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
srpc_artifact_def = buildpom.MavenArtifactDef("com.grail.srpc",
"srpc-api",
"5.6.7",
bazel_package="a/b/c")
internal_dep = dependency.MonorepoDependency(srpc_artifact_def,
bazel_target=None)
external_dep = dependency.ThirdPartyDependency("name", "cg", "ca",
"0.0.1")
pomgen.register_dependencies_transitive_closure__library(
set([external_dep, internal_dep]))
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertEqual(expected_pom, generated_pom)
def test_template__crawled_external_deps__configured_attributes(self):
"""
Verifies that "classifier" and "scope" are correcly set in the generated
pom.
"""
pom_template = """
<project>
<dependencyManagement>
<dependencies>
__pomgen.start_dependency_customization__
<dependency>
<artifactId>ca</artifactId>
<groupId>cg</groupId>
<version>0.0.1</version>
<scope>test</scope>
<classifier>sources</classifier>
</dependency>
__pomgen.end_dependency_customization__
#{pomgen.transitive_closure_of_library_dependencies}
</dependencies>
</dependencyManagement>
</project>
"""
expected_pom = """
<project>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>cg</groupId>
<artifactId>ca</artifactId>
<version>0.0.1</version>
<classifier>sources</classifier>
<scope>test</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
maveninstallinfo.NOOP, pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = pom_template
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
crawled_dep = dependency.ThirdPartyDependency("name", "cg", "ca",
"0.0.1")
pomgen.register_dependencies_transitive_closure__library(
set([crawled_dep]))
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertEqual(expected_pom, generated_pom)
def test_template_var_sub__ext_deps_with_diff_versions__no_unqual(self):
"""
Ensures that external dependencies (jars) that have the same ga, but
different versions, CANNOT be referenced using unqualified syntax
(without maven_install name prefix).
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
self._mocked_mvn_install_info("maven"),
pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.4.4")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = """
#{org_apache_maven_mult_versions.version}
"""
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
with self.assertRaises(Exception) as ctx:
pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("has unresolvable references", str(ctx.exception))
self.assertIn("['org_apache_maven_mult_versions.version']",
str(ctx.exception))
# now try with groupId:artifactId:version syntax
artifact_def.custom_pom_template_content = """
#{org.apache.maven:mult-versions:version}
"""
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
with self.assertRaises(Exception) as ctx:
pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("has unresolvable references", str(ctx.exception))
self.assertIn("['org.apache.maven:mult-versions:version']",
str(ctx.exception))
def test_template_unknown_variable(self):
"""
Verifies that an unknown variable in a pom template is handled and
results in an error during template processing.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
maveninstallinfo.NOOP, pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = "my pom template with a bad ref #{bad1} and also #{bad2}"
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
with self.assertRaises(Exception) as ctx:
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("bad1", str(ctx.exception))
self.assertIn("bad2", str(ctx.exception))
def test_template__crawled_external_deps(self):
"""
Verifies that crawled external deps can be referenced using the
property pomgen.crawled_external_dependencies.
"""
pom_template = """
<project>
<dependencyManagement>
<dependencies>
#{pomgen.crawled_external_dependencies}
</dependencies>
</dependencyManagement>
</project>
"""
expected_pom = """
<project>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>cg</groupId>
<artifactId>ca</artifactId>
<version>0.0.1</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
"""
ws = workspace.Workspace("some/path", "", [],
exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws, artifact_def, dep, pom_template)
crawled_dep = dependency.ThirdPartyDependency("name", "cg", "ca",
"0.0.1")
pomgen.register_dependencies_globally(set(), set([crawled_dep]))
generated_pom = pomgen.gen()
self.assertEqual(expected_pom, generated_pom)
def test_template_var_sub__ext_deps_with_diff_versions(self):
"""
Ensures that external dependencies (jars) that have the same ga, but
different versions, can be referenced using their "maven install" name.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
self._mocked_mvn_install_info("maven"),
pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.4.4")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = """
v1 #{@maven//:org_apache_maven_mult_versions.version}
v2 #{@maven2//:org_apache_maven_mult_versions.version}
"""
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("v1 1.0.0", generated_pom)
self.assertIn("v2 2.0.0", generated_pom)
def test_template_var_sub(self):
"""
Verifies variable substitution in a pom template.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
self._mocked_mvn_install_info("maven"),
pomcontent.NOOP)
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.4.4")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = """
unqualified #{ch_qos_logback_logback_classic.version}
qualified #{@maven//:ch_qos_logback_logback_classic.version}
coord #{ch.qos.logback:logback-classic:version}
monorepo artifact version #{version}
"""
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("unqualified 1.2.3", generated_pom)
self.assertIn("qualified 1.2.3", generated_pom)
self.assertIn("monorepo artifact version 1.4.4", generated_pom)
def test_template_var_sub__monorepo_deps(self):
"""
Verifies references to monorepo versions in a pom template.
"""
ws = workspace.Workspace("some/path", [], exclusions.src_exclusions(),
maveninstallinfo.NOOP, pomcontent.NOOP)
artifact_def = buildpom.MavenArtifactDef("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
artifact_def.custom_pom_template_content = "srpc #{com.grail.srpc:srpc-api:version}"
srpc_artifact_def = buildpom.MavenArtifactDef("com.grail.srpc",
"srpc-api",
"5.6.7",
bazel_package="a/b/c")
srpc_dep = dependency.MonorepoDependency(srpc_artifact_def,
bazel_target=None)
pomgen = pom.TemplatePomGen(ws, artifact_def, dep)
pomgen.register_dependencies_transitive_closure__library(
set([srpc_dep]))
generated_pom = pomgen.gen(pom.PomContentType.RELEASE)
self.assertIn("srpc 5.6.7", generated_pom)
def test_template__crawled_external_deps__configured_exclusions(self):
"""
Verifies that exclusions can be "attached" to crawled deps by
declaring them in a dependency config section.
"""
pom_template = """
<project>
<dependencyManagement>
<dependencies>
__pomgen.start_dependency_customization__
<dependency>
<artifactId>ca</artifactId>
<groupId>cg</groupId>
<version>0.0.1</version>
<classifier>c1</classifier>
<exclusions>
<exclusion>
<artifactId>ea1</artifactId>
<groupId>zzz</groupId>
</exclusion>
<exclusion>
<artifactId>ea2</artifactId>
<groupId>aaa</groupId>
</exclusion>
</exclusions>
</dependency>
__pomgen.end_dependency_customization__
#{pomgen.crawled_external_dependencies}
</dependencies>
</dependencyManagement>
</project>
"""
expected_pom = """
<project>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>cg</groupId>
<artifactId>ca</artifactId>
<version>0.0.1</version>
<classifier>c1</classifier>
<exclusions>
<exclusion>
<groupId>aaa</groupId>
<artifactId>ea2</artifactId>
</exclusion>
<exclusion>
<groupId>zzz</groupId>
<artifactId>ea1</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</dependencyManagement>
</project>
"""
ws = workspace.Workspace("some/path", "", [],
exclusions.src_exclusions())
artifact_def = buildpom.maven_artifact("groupId", "artifactId",
"1.2.3")
dep = dependency.new_dep_from_maven_artifact_def(artifact_def)
pomgen = pom.TemplatePomGen(ws, artifact_def, dep, pom_template)
crawled_dep = dependency.ThirdPartyDependency("name", "cg", "ca",
"0.0.1")
pomgen.register_dependencies_globally(set(), set([crawled_dep]))
generated_pom = pomgen.gen()
self.assertEqual(expected_pom, generated_pom)
