rework - repos now have 'resolve' tag by default

chrisrueger · chrisrueger · commit b9a574f0e919 · 2024-05-10T21:54:35.000+02:00
- this commit partly reverts previous commit
- repos now get the 'resolve' tag by default if not specified
- .bndrun: empty -runrepos will be populated with all repos having the 'resolve' tag
- .bndrun: resolution consider all repos having the 'resolve' tag. that means you can exclude a repo from resolution by manually assigning it a different tag (e.g. to exclude the baseline repo from resolution, you should give the baseline-repo e.g. the tag 'baseline' and make sure it does NOT have the 'resolve' tag

Signed-off-by: Christoph Rueger &lt;chrisrueger@gmail.com&gt;
diff --git a/biz.aQute.bndlib/src/aQute/bnd/osgi/repository/BaseRepository.java b/biz.aQute.bndlib/src/aQute/bnd/osgi/repository/BaseRepository.java
@@ -36,8 +36,6 @@ public abstract class BaseRepository implements Repository, Tagged {
 	private final PromiseFactory					promiseFactory	= new PromiseFactory(
 		PromiseFactory.inlineExecutor());
 
-	private static final String						DEFAULT_TAG		= "all";
-	private static final Set<String>				DEFAULT_TAGS	= Set.of(DEFAULT_TAG);
 
 	static {
 		Requirement requireAll = ResourceUtils.createWildcardRequirement();
@@ -250,6 +248,6 @@ public RequirementBuilder addAttribute(String name, Object value) {
 
 	@Override
 	public Set<String> getTags() {
-		return DEFAULT_TAGS;
+		return Tagged.DEFAULT_REPO_TAGS;
 	}
 }
diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/Registry.java b/biz.aQute.bndlib/src/aQute/bnd/service/Registry.java
@@ -1,12 +1,26 @@
 package aQute.bnd.service;
 
+import static aQute.bnd.service.Tagged.matchesTags;
+
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * A registry for objects.
  */
 public interface Registry {
 	<T> List<T> getPlugins(Class<T> c);
 
+	default <T> List<T> getPlugins(Class<T> c, String... tags) {
+
+		if (tags == null || tags.length == 0) {
+			return getPlugins(c);
+		}
+
+		return getPlugins(c).stream()
+			.filter(repo -> matchesTags(repo, tags))
+			.collect(Collectors.toList());
+	}
+
 	<T> T getPlugin(Class<T> c);
 }
diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/Tagged.java b/biz.aQute.bndlib/src/aQute/bnd/service/Tagged.java
@@ -1,29 +1,60 @@
 package aQute.bnd.service;
 
+import static aQute.bnd.service.Tagged.RepoTags.resolve;
+import static java.util.stream.Collectors.toCollection;
+
 import java.util.Arrays;
 import java.util.LinkedHashSet;
 import java.util.Set;
-import java.util.stream.Collectors;
 
 /**
  * Allows to add tags to implementing classes. Originally intended for tagging
  * repositories.
  */
 public interface Tagged {
 
+
+	enum RepoTags {
+		/**
+		 * tag for repos which should be used for Resolving bundles. This is
+		 * also the default tag for all repos which not have specified tags
+		 * (also for bc reasons) Also see {@link Tagged#DEFAULT_REPO_TAGS}
+		 */
+		resolve
+		// add more if neded e.g. relase, baseline
+	}
+
+	/**
+	 * Each repo has by default the tag {@link RepoTags#resolve} if not tags are
+	 * set at the repo definition in build.bnd That means it is consider
+	 */
+	Set<String> DEFAULT_REPO_TAGS = Set.of(resolve.name());
+
 	/**
 	 * @return a non-null list of tags.
 	 */
 	Set<String> getTags();
 
-	static Set<String> toTags(String csvTags) {
+	static Set<String> toTags(String csvTags, Set<String> defaultTags) {
 		if (csvTags == null || csvTags.isBlank()) {
-			return Set.of("all"); // default
+			return defaultTags; // default
 		}
 
 		return Arrays.stream(csvTags.split(","))
 			.map(String::trim)
-			.collect(Collectors.toCollection(LinkedHashSet::new));
+			.collect(toCollection(LinkedHashSet::new));
+	}
+
+	static <T> boolean matchesTags(T obj, String... tags) {
+		if (obj instanceof Tagged tagged) {
+			Set<String> taggedTags = tagged.getTags();
+			for (String tag : tags) {
+				if (taggedTags.contains(tag)) {
+					return true;
+				}
+			}
+		}
+		return false;
 	}
 
 }
diff --git a/biz.aQute.bndlib/src/aQute/lib/deployer/FileRepo.java b/biz.aQute.bndlib/src/aQute/lib/deployer/FileRepo.java
@@ -1060,6 +1060,6 @@ public void setIndex(boolean b) {
 
 	@Override
 	public Set<String> getTags() {
-		return Tagged.toTags(tags);
+		return Tagged.toTags(tags, Tagged.DEFAULT_REPO_TAGS);
 	}
 }
diff --git a/biz.aQute.repository/src/aQute/bnd/deployer/repository/LocalIndexedRepo.java b/biz.aQute.repository/src/aQute/bnd/deployer/repository/LocalIndexedRepo.java
@@ -621,7 +621,7 @@ public void close() {}
 
 	@Override
 	public Set<String> getTags() {
-		return Tagged.toTags(tags);
+		return Tagged.toTags(tags, Tagged.DEFAULT_REPO_TAGS);
 	}
 
 }
diff --git a/biz.aQute.repository/src/aQute/bnd/repository/maven/pom/provider/BndPomRepository.java b/biz.aQute.repository/src/aQute/bnd/repository/maven/pom/provider/BndPomRepository.java
@@ -511,6 +511,6 @@ private Archive trySources(String bsn, Version version) throws Exception {
 
 	@Override
 	public Set<String> getTags() {
-		return Tagged.toTags(configuration.tags());
+		return Tagged.toTags(configuration.tags(), Tagged.DEFAULT_REPO_TAGS);
 	}
 }
diff --git a/biz.aQute.repository/src/aQute/bnd/repository/maven/provider/MavenBndRepository.java b/biz.aQute.repository/src/aQute/bnd/repository/maven/provider/MavenBndRepository.java
@@ -1078,6 +1078,6 @@ public boolean isRemote() {
 
 	@Override
 	public Set<String> getTags() {
-		return Tagged.toTags(configuration.tags());
+		return Tagged.toTags(configuration.tags(), Tagged.DEFAULT_REPO_TAGS);
 	}
 }
diff --git a/biz.aQute.repository/src/aQute/bnd/repository/osgi/OSGiRepository.java b/biz.aQute.repository/src/aQute/bnd/repository/osgi/OSGiRepository.java
@@ -417,6 +417,6 @@ private void status(String s) {
 
 	@Override
 	public Set<String> getTags() {
-		return Tagged.toTags(config.tags());
+		return Tagged.toTags(config.tags(), Tagged.DEFAULT_REPO_TAGS);
 	}
 }
diff --git a/biz.aQute.repository/src/aQute/bnd/repository/p2/provider/P2Repository.java b/biz.aQute.repository/src/aQute/bnd/repository/p2/provider/P2Repository.java
@@ -197,7 +197,7 @@ public String title(Object... target) throws Exception {
 
 	@Override
 	public Set<String> getTags() {
-		return Tagged.toTags(config.tags());
+		return Tagged.toTags(config.tags(), Tagged.DEFAULT_REPO_TAGS);
 	}
 
 }
diff --git a/biz.aQute.repository/test/aQute/bnd/repository/maven/provider/WorkspaceTest.java b/biz.aQute.repository/test/aQute/bnd/repository/maven/provider/WorkspaceTest.java
@@ -1,17 +1,24 @@
 package aQute.bnd.repository.maven.provider;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Formatter;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.osgi.service.repository.Repository;
 
 import aQute.bnd.build.Workspace;
+import aQute.bnd.service.Tagged;
+import aQute.bnd.service.Tagged.RepoTags;
 import aQute.bnd.test.jupiter.InjectTemporaryDirectory;
 import aQute.http.testservers.HttpTestServer.Config;
 import aQute.lib.io.IO;
@@ -57,6 +64,37 @@ public void testEnv() throws Exception {
 		assertNotNull(workspace);
 		assertNotNull(repo);
 		System.out.println(workspace.getBase());
+
+		// check repo tags
+		// repos should have the 'resolve' tag by default if no tag is specified
+		List<Repository> repos = workspace.getPlugins(Repository.class);
+		List<Repository> resolveRepos = workspace.getPlugins(Repository.class, RepoTags.resolve.name());
+		assertEquals(repos, resolveRepos);
+
+		Repository repo = repos.get(0);
+		assertTrue(repo instanceof Tagged);
+		assertEquals(1, ((Tagged) repo).getTags()
+			.size());
+		assertEquals(RepoTags.resolve.name(), new ArrayList<>(((Tagged) repo).getTags()).get(0));
+
+	}
+
+	@Test
+	public void testRepoWithDifferentTag() throws Exception {
+		// similar as testEnv()
+		// but override the tag with a different one and repeat the tests
+		config(Map.of("tags", "foo"));
+
+		List<Repository> resolveRepos = workspace.getPlugins(Repository.class, RepoTags.resolve.name());
+		assertTrue(resolveRepos.isEmpty());
+
+		List<Repository> repos = workspace.getPlugins(Repository.class);
+		Repository repo = repos.get(0);
+		assertTrue(repo instanceof Tagged);
+		assertEquals(1, ((Tagged) repo).getTags()
+			.size());
+		assertEquals("foo", new ArrayList<>(((Tagged) repo).getTags()).get(0));
+
 	}
 
 	void config(Map<String, String> override) throws Exception {
@@ -74,7 +112,12 @@ void config(Map<String, String> override) throws Exception {
 			sb.format("  name=test; \\\n", MavenBndRepository.class.getName());
 			sb.format("  local=%s; \\\n", config.get("local"));
 			sb.format("  releaseUrl=%s; \\\n", config.get("releaseUrl"));
-			sb.format("  index=%s\n", config.get("index"));
+			sb.format("  index=%s; \\\n", config.get("index"));
+
+			String tags = config.get("tags");
+			if (tags != null && !tags.isBlank()) {
+				sb.format("  tags=%s\n", tags);
+			}
 
 			build.getParentFile()
 				.mkdirs();
diff --git a/biz.aQute.resolve/src/biz/aQute/resolve/BndrunResolveContext.java b/biz.aQute.resolve/src/biz/aQute/resolve/BndrunResolveContext.java
@@ -1,5 +1,7 @@
 package biz.aQute.resolve;
 
+import static aQute.bnd.service.Tagged.RepoTags.resolve;
+
 import java.io.File;
 import java.io.InputStream;
 import java.net.URI;
@@ -54,9 +56,7 @@
 import aQute.bnd.service.Registry;
 import aQute.bnd.service.RepositoryPlugin;
 import aQute.bnd.service.Strategy;
-import aQute.bnd.service.Tagged;
 import aQute.bnd.service.resolve.hook.ResolverHook;
-import aQute.lib.collections.MultiMap;
 import aQute.lib.converter.Converter;
 import aQute.lib.strings.Strings;
 import aQute.lib.utf8properties.UTF8Properties;
@@ -362,7 +362,6 @@ private Processor loadRepositories() throws Exception {
 
 			// Map the repository names...
 
-			MultiMap<String, Repository> reposTagMap = new MultiMap<>();
 			Map<String, Repository> repoNameMap = new HashMap<>(allRepos.size());
 			for (Repository repo : allRepos) {
 				String name;
@@ -373,28 +372,14 @@ private Processor loadRepositories() throws Exception {
 				}
 				repoNameMap.put(name, repo);
 
-				// tags
-				if (repo instanceof Tagged taggedRepo) {
-					Set<String> tags = taggedRepo.getTags();
-					for (String tag : tags) {
-						reposTagMap.add(tag, repo);
-					}
-				}
 			}
 
 			// Create the result list
 			orderedRepositories = new ArrayList<>();
 			for (String repoName : repoNames.keySet()) {
-				// tags prefixed with '@' e.g. '@baseline'
-				if (repoName.startsWith("@")) {
-					List<Repository> repos = reposTagMap.get(repoName.substring(1));
-					if (repos != null)
-						orderedRepositories.addAll(repos);
-				} else {
-					Repository repo = repoNameMap.get(repoName);
-					if (repo != null)
-						orderedRepositories.add(repo);
-				}
+				Repository repo = repoNameMap.get(repoName);
+				if (repo != null)
+					orderedRepositories.add(repo);
 			}
 		}
 
@@ -420,12 +405,12 @@ private List<Repository> getAllRepos() {
 		List<Repository> allRepos;
 		if (project != null && !project.isStandalone()) {
 			allRepos = project.getWorkspace()
-				.getPlugins(Repository.class);
+				.getPlugins(Repository.class, resolve.name());
 			allRepos.removeIf(WorkspaceRepositoryMarker.class::isInstance);
 			WorkspaceResourcesRepository wr = new WorkspaceResourcesRepository(project.getWorkspace());
 			allRepos.add(wr);
 		} else {
-			allRepos = registry.getPlugins(Repository.class);
+			allRepos = registry.getPlugins(Repository.class, resolve.name());
 		}
 		return allRepos;
 	}
diff --git a/bndtools.core/_plugin.xml b/bndtools.core/_plugin.xml
@@ -839,7 +839,7 @@
 			helpUrl="https://bnd.bndtools.org/plugins/filerepo.html">
 			<property name="name" type="string"
 				description="Name of the repository" />
-			<property name="tags" type="string" description="Comma separated list of tags. (e.g. baseline,release,resolve)" />
+			<property name="tags" type="string" description="Comma separated list of tags. (e.g. resolve, baseline, release)" default="resolve" />
 			<property name="location" type="string"
 				description="Local directory path" />
 			<property name="readonly" type="boolean" default="false" />
@@ -850,7 +850,7 @@
 			helpUrl="https://bnd.bndtools.org/plugins/osgirepo.html">
 			<property name="name" type="string"
 				description="Name of the repository" />
-			<property name="tags" type="string" description="Comma separated list of tags. (e.g. baseline,release,resolve)" />	
+			<property name="tags" type="string" description="Comma separated list of tags. (e.g. resolve, baseline, release)" default="resolve" />	
 			<property name="locations" type="string"
 				description="Index locations (comma-separated list of URLs)" />
 			<property name="cache" type="string"
@@ -863,7 +863,7 @@
 			helpUrl="https://bnd.bndtools.org/plugins/localindexrepo.html">
 			<property name="name" type="string"
 				description="Name of the repository" />
-			<property name="tags" type="string" description="Comma separated list of tags. (e.g. baseline,release,resolve)" />
+			<property name="tags" type="string" description="Comma separated list of tags. (e.g. resolve, baseline, release)" default="resolve" />
 			<property name="local" type="string"
 				description="Local directory path" />
 			<property name="phase" type="string"
@@ -902,7 +902,7 @@
 			helpUrl="https://bnd.bndtools.org/plugins/maven.html"
 			rank="10">
 		    <property name="name" type="string" description="The name of this repository" default="Maven Repository" />
-			<property name="tags" type="string" description="Comma separated list of tags. (e.g. baseline,release)" />
+			<property name="tags" type="string" description="Comma separated list of tags. (e.g. resolve, baseline, release)" default="resolve" />
 			<property name="releaseUrl" type="string" description="The urls to the remote release repository." default="https://repo.maven.apache.org/maven2/" />
 		    <property name="stagingUrl" type="string" description="The url of the staging release repository." />
 		    <property name="snapshotUrl" type="string" description="The urls to the remote snapshot repository." default="https://repository.apache.org/snapshots/" />
@@ -922,7 +922,7 @@
 			name="P2Repository"
 			helpUrl="https://bnd.bndtools.org/plugins/p2repo.html">
 		    <property name="name" type="string" description="The name of this repository" default="P2Repository" />
-		    <property name="tags" type="string" description="Comma separated list of tags. (e.g. baseline,release,resolve)" />
+		    <property name="tags" type="string" description="Comma separated list of tags. (e.g. resolve, baseline, release)" default="resolve" />
 			<property name="url" type="string" description="The URL to either the P2 repository (a directory) or an Eclipse target platform. Required." />
 		    <property name="location" type="string" description="The location to store the index file. Default: 'cnf/cache/p2-index-reponame/index.xml.gz'" />
 		</plugin>
@@ -932,7 +932,7 @@
 			name="Maven POM Repository"
 			helpUrl="https://bnd.bndtools.org/plugins/pomrepo.html">
 		    <property name="name" type="string" description="The name of the repo. Required." default="Maven POM Repository" />
-		    <property name="tags" type="string" description="Comma separated list of tags. (e.g. baseline,release,resolve)" />
+		    <property name="tags" type="string" description="Comma separated list of tags. (e.g. resolve, baseline, release)" default="resolve" />
 		    <property name="releaseUrl" type="string" description="The url to the remote release repository. Can be a comma separated list of urls." default="https://repo.maven.apache.org/maven2/" />
 		    <property name="snapshotUrl" type="string" description="The url to the remote snapshot repository. If this is not specified, it falls back to the release repository or just local if this is also not specified. Can be a comma separated list of urls." default="https://repository.apache.org/snapshots/" />
 		    <property name="local" type="string" description="The path to the local repository" default="~/.m2/repository" />
diff --git a/bndtools.core/src/bndtools/editor/project/RepositoriesEditModel.java b/bndtools.core/src/bndtools/editor/project/RepositoriesEditModel.java
@@ -1,5 +1,7 @@
 package bndtools.editor.project;
 
+import static aQute.bnd.service.Tagged.RepoTags.resolve;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
@@ -30,7 +32,7 @@ class RepositoriesEditModel {
 	RepositoriesEditModel(BndEditModel model) {
 		this.model = model;
 		this.pluginOrder = model.getWorkspace()
-			.getPlugins(Repository.class);
+			.getPlugins(Repository.class, resolve.name());
 		this.standalone = model.getStandaloneLinks();
 		this.runrepos = model.getRunRepos();
 		this.ignoreStandalone = model.getIgnoreStandalone();
@@ -44,6 +46,7 @@ class RepositoriesEditModel {
 			List<Repository> remains = new ArrayList<>(pluginOrder);
 
 			for (String name : runrepos) {
+
 				Repository r = find(name);
 				if (r != null) {
 					actualOrder.add(r);
@@ -55,6 +58,7 @@ class RepositoriesEditModel {
 		}
 	}
 
+
 	private Repository find(String sought) {
 		for (Repository r : pluginOrder) {
 			String name = toName(r);

Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,6 @@ public abstract class BaseRepository implements Repository, Tagged {`
`36`	`36`	`private final PromiseFactory promiseFactory = new PromiseFactory(`
`37`	`37`	`PromiseFactory.inlineExecutor());`
`38`	`38`
`39`		`- private static final String DEFAULT_TAG = "all";`
`40`		`- private static final Set<String> DEFAULT_TAGS = Set.of(DEFAULT_TAG);`
`41`	`39`
`42`	`40`	`static {`
`43`	`41`	`Requirement requireAll = ResourceUtils.createWildcardRequirement();`
`@@ -250,6 +248,6 @@ public RequirementBuilder addAttribute(String name, Object value) {`
`250`	`248`
`251`	`249`	`@Override`
`252`	`250`	`public Set<String> getTags() {`
`253`		`- return DEFAULT_TAGS;`
	`251`	`+ return Tagged.DEFAULT_REPO_TAGS;`
`254`	`252`	`}`
`255`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1060,6 +1060,6 @@ public void setIndex(boolean b) {`
`1060`	`1060`
`1061`	`1061`	`@Override`
`1062`	`1062`	`public Set<String> getTags() {`
`1063`		`- return Tagged.toTags(tags);`
	`1063`	`+ return Tagged.toTags(tags, Tagged.DEFAULT_REPO_TAGS);`
`1064`	`1064`	`}`
`1065`	`1065`	`}`
Original file line number	Diff line number	Diff line change
`@@ -621,7 +621,7 @@ public void close() {}`
`621`	`621`
`622`	`622`	`@Override`
`623`	`623`	`public Set<String> getTags() {`
`624`		`- return Tagged.toTags(tags);`
	`624`	`+ return Tagged.toTags(tags, Tagged.DEFAULT_REPO_TAGS);`
`625`	`625`	`}`
`626`	`626`
`627`	`627`	`}`
Original file line number	Diff line number	Diff line change
`@@ -511,6 +511,6 @@ private Archive trySources(String bsn, Version version) throws Exception {`
`511`	`511`
`512`	`512`	`@Override`
`513`	`513`	`public Set<String> getTags() {`
`514`		`- return Tagged.toTags(configuration.tags());`
	`514`	`+ return Tagged.toTags(configuration.tags(), Tagged.DEFAULT_REPO_TAGS);`
`515`	`515`	`}`
`516`	`516`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1078,6 +1078,6 @@ public boolean isRemote() {`
`1078`	`1078`
`1079`	`1079`	`@Override`
`1080`	`1080`	`public Set<String> getTags() {`
`1081`		`- return Tagged.toTags(configuration.tags());`
	`1081`	`+ return Tagged.toTags(configuration.tags(), Tagged.DEFAULT_REPO_TAGS);`
`1082`	`1082`	`}`
`1083`	`1083`	`}`
Original file line number	Diff line number	Diff line change
`@@ -417,6 +417,6 @@ private void status(String s) {`
`417`	`417`
`418`	`418`	`@Override`
`419`	`419`	`public Set<String> getTags() {`
`420`		`- return Tagged.toTags(config.tags());`
	`420`	`+ return Tagged.toTags(config.tags(), Tagged.DEFAULT_REPO_TAGS);`
`421`	`421`	`}`
`422`	`422`	`}`
Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,7 @@ public String title(Object... target) throws Exception {`
`197`	`197`
`198`	`198`	`@Override`
`199`	`199`	`public Set<String> getTags() {`
`200`		`- return Tagged.toTags(config.tags());`
	`200`	`+ return Tagged.toTags(config.tags(), Tagged.DEFAULT_REPO_TAGS);`
`201`	`201`	`}`
`202`	`202`
`203`	`203`	`}`