Introduce itr option (#1820)

* rebase with minor fixes * add docs and have --itr be on top * do not update junit libs --------- Co-authored-by: Max Rydahl Andersen <[email protected]>
jbangdev · Nov 16, 2024 · 2e3f0db · 2e3f0db
1 parent 2c867b8
commit 2e3f0db
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 4 deletions.
diff --git a/docs/modules/ROOT/pages/dependencies.adoc b/docs/modules/ROOT/pages/dependencies.adoc
@@ -204,6 +204,12 @@ username/passwords.
 
 By default, `jbang` uses `~/.m2` as local repository, but this can be overwritten by the environment variable `JBANG_REPO`.
 
+=== Transitive repositories
+
+JBang honors by default the repositories found in transitive dependencies (similar to how Maven does).
+
+You can however disable this by using the `--ignore-transitive-repositories` (or `-itr`) option.
+
 == Using `@Grab`
 
 There is also support for using Groovy lang style `@Grab` syntax.

diff --git a/src/main/java/dev/jbang/cli/DependencyInfoMixin.java b/src/main/java/dev/jbang/cli/DependencyInfoMixin.java
@@ -4,6 +4,8 @@
 import java.util.List;
 import java.util.Map;
 
+import dev.jbang.util.Util;
+
 import picocli.CommandLine;
 
 public class DependencyInfoMixin {
@@ -18,6 +20,13 @@ public class DependencyInfoMixin {
 	@CommandLine.Option(names = { "--cp", "--class-path" }, description = "Add class path entries.")
 	List<String> classpaths;
 
+	@CommandLine.Option(names = {
+			"--ignore-transitive-repositories",
+			"--itr" }, description = "Ignore remote repositories found in transitive dependencies")
+	void setIgnoreTransitiveRepositories(boolean ignoreTransitiveRepositories) {
+		Util.setIgnoreTransitiveRepositories(ignoreTransitiveRepositories);
+	}
+
 	public List<String> getDependencies() {
 		return dependencies;
 	}

diff --git a/src/main/java/dev/jbang/dependencies/ArtifactResolver.java b/src/main/java/dev/jbang/dependencies/ArtifactResolver.java
@@ -48,6 +48,7 @@ public static class Builder {
 		private List<MavenRepo> repositories;
 		private int timeout;
 		private boolean offline;
+		private boolean ignoreTransitiveRepositories;
 		private boolean withUserSettings;
 		private Path localFolder;
 		private Path settingsXml;
@@ -98,6 +99,11 @@ public Builder offline(boolean offline) {
 			return this;
 		}
 
+		public Builder ignoreTransitiveRepositories(boolean ignoreTransitiveRepositories) {
+			this.ignoreTransitiveRepositories = ignoreTransitiveRepositories;
+			return this;
+		}
+
 		public Builder logging(boolean logging) {
 			this.loggingEnabled = logging;
 			return this;
@@ -132,6 +138,8 @@ private ArtifactResolver(Builder builder) {
 		ContextOverrides.Builder overridesBuilder = ContextOverrides.create()
 																	.userProperties(userProperties)
 																	.offline(builder.offline)
+																	.ignoreArtifactDescriptorRepositories(
+																			builder.ignoreTransitiveRepositories)
 																	.withUserSettings(builder.withUserSettings)
 																	.withUserSettingsXmlOverride(builder.settingsXml)
 																	.withLocalRepositoryOverride(builder.localFolder)

diff --git a/src/main/java/dev/jbang/dependencies/DependencyResolver.java b/src/main/java/dev/jbang/dependencies/DependencyResolver.java
@@ -65,7 +65,8 @@ public DependencyResolver addClassPaths(List<String> classPaths) {
 	public ModularClassPath resolve() {
 		ModularClassPath mcp = DependencyUtil.resolveDependencies(
 				new ArrayList<>(dependencies), new ArrayList<>(repositories),
-				Util.isOffline(), Util.isFresh(), !Util.isQuiet(), Util.downloadSources());
+				Util.isOffline(), Util.isIgnoreTransitiveRepositories(), Util.isFresh(), !Util.isQuiet(),
+				Util.downloadSources());
 		if (classPaths.isEmpty()) {
 			return mcp;
 		} else {

diff --git a/src/main/java/dev/jbang/dependencies/DependencyUtil.java b/src/main/java/dev/jbang/dependencies/DependencyUtil.java
@@ -53,7 +53,8 @@ private DependencyUtil() {
 	}
 
 	public static ModularClassPath resolveDependencies(List<String> deps, List<MavenRepo> repos,
-			boolean offline, boolean updateCache, boolean loggingEnabled, boolean downloadSources) {
+			boolean offline, boolean ignoreTransitiveRepositories, boolean updateCache, boolean loggingEnabled,
+			boolean downloadSources) {
 
 		// if no dependencies were provided we stop here
 		if (deps.isEmpty()) {
@@ -102,6 +103,8 @@ public static ModularClassPath resolveDependencies(List<String> deps, List<Maven
 																	.withUserSettings(true)
 																	.localFolder(getJBangLocalMavenRepoOverride())
 																	.offline(offline)
+																	.ignoreTransitiveRepositories(
+																			ignoreTransitiveRepositories)
 																	.forceCacheUpdate(updateCache)
 																	.logging(loggingEnabled)
 																	.downloadSources(downloadSources)

diff --git a/src/main/java/dev/jbang/util/Util.java b/src/main/java/dev/jbang/util/Util.java
@@ -92,6 +92,7 @@ public class Util {
 	private static boolean quiet;
 	private static boolean offline;
 	private static boolean fresh;
+	private static boolean ignoreTransitiveRepositories;
 	private static boolean preview;
 
 	private static Path cwd;
@@ -127,6 +128,10 @@ public static void setOffline(boolean offline) {
 		}
 	}
 
+	public static void setIgnoreTransitiveRepositories(boolean ignoreTransitiveRepositories) {
+		Util.ignoreTransitiveRepositories = ignoreTransitiveRepositories;
+	}
+
 	public static void setDownloadSources(boolean flag) {
 		downloadSources = flag;
 	}
@@ -142,6 +147,10 @@ public static boolean isOffline() {
 		return offline;
 	}
 
+	public static boolean isIgnoreTransitiveRepositories() {
+		return ignoreTransitiveRepositories;
+	}
+
 	public static void setFresh(boolean fresh) {
 		Util.fresh = fresh;
 		if (fresh) {

diff --git a/src/test/java/dev/jbang/dependencies/DependencyResolverTest.java b/src/test/java/dev/jbang/dependencies/DependencyResolverTest.java
@@ -139,6 +139,7 @@ void testResolveDependencies() {
 		List<String> deps = Arrays.asList("com.offbytwo:docopt:0.6.0.20150202", "log4j:log4j:1.2+");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		// if returns 5 its because optional deps are included which they shouldn't
@@ -151,6 +152,7 @@ void testResolveDependenciesNoDuplicates() {
 				"org.apache.commons:commons-text:1.8");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		// if returns with duplicates its because some dependencies are multiple times
@@ -172,6 +174,7 @@ void testResolveNativeDependencies() {
 		List<String> deps = Collections.singletonList("com.github.docker-java:docker-java:3.1.5");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		assertEquals(46, classpath.getClassPaths().size());
@@ -183,7 +186,7 @@ void testResolveJavaModules() throws IOException {
 		List<String> deps = Arrays.asList("org.openjfx:javafx-graphics:11.0.2:mac", "com.offbytwo:docopt:0.6+");
 
 		ModularClassPath cp = new ModularClassPath(
-				DependencyUtil	.resolveDependencies(deps, Collections.emptyList(), false, false, true, false)
+				DependencyUtil	.resolveDependencies(deps, Collections.emptyList(), false, false, false, true, false)
 								.getArtifacts()) {
 			@Override
 			protected boolean supportsModules(JdkProvider.Jdk jdk) {
@@ -205,6 +208,7 @@ void testImportPOM() {
 		List<String> deps = Arrays.asList("com.microsoft.azure:azure-bom:1.0.0.M1@pom", "com.microsoft.azure:azure");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		assertEquals(62, classpath.getArtifacts().size());
@@ -221,6 +225,7 @@ void testImportMultipleBoms() {
 				"org.slf4j:slf4j-simple:1.7.30");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		Optional<ArtifactInfo> coord = classpath.getArtifacts()
@@ -253,7 +258,7 @@ void testImportMultipleBoms() {
 				"org.apache.camel:camel-core",
 				"org.apache.camel:camel-vertx",
 				"org.slf4j:slf4j-simple:1.7.30");
-		classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false, true, false);
+		classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false, false, true, false);
 
 		coord = classpath	.getArtifacts()
 							.stream()
@@ -268,6 +273,7 @@ void testResolveTestJar() {
 		List<String> deps = Arrays.asList("org.infinispan:infinispan-commons:13.0.5.Final@test-jar");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		assertThat(classpath.getArtifacts(), hasSize(7));

diff --git a/src/test/java/dev/jbang/dependencies/TestArtifactInfo.java b/src/test/java/dev/jbang/dependencies/TestArtifactInfo.java
@@ -25,6 +25,7 @@ public void testDependencyCache() {
 				"org.apache.commons:commons-text:1.8");
 
 		ModularClassPath classpath = DependencyUtil.resolveDependencies(deps, Collections.emptyList(), false, false,
+				false,
 				true, false);
 
 		DependencyCache.cache("wonka", classpath.getArtifacts());