improve tag matching

- keep backwards compatibility so that Repos without tags return an empty set and empty set means "matches" - renamed Tags.matchesTags to Tags.isIncluded - move tags to own package aQute.bnd.service.tags Signed-off-by: Christoph Rueger <[email protected]>
chrisrueger · May 21, 2024 · 53cb0dc · 53cb0dc
1 parent 7857d51
commit 53cb0dc
Show file tree

Hide file tree

Showing 14 changed files with 70 additions and 59 deletions.
diff --git a/biz.aQute.bndlib/src/aQute/bnd/osgi/repository/BaseRepository.java b/biz.aQute.bndlib/src/aQute/bnd/osgi/repository/BaseRepository.java
@@ -26,8 +26,8 @@
 import aQute.bnd.exceptions.Exceptions;
 import aQute.bnd.osgi.resource.ResourceUtils;
 import aQute.bnd.service.RepositoryPlugin;
-import aQute.bnd.service.Tagged;
-import aQute.bnd.service.Tags;
+import aQute.bnd.service.tags.Tagged;
+import aQute.bnd.service.tags.Tags;
 
 /**
  * WARNING ! Not tested

diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/Registry.java b/biz.aQute.bndlib/src/aQute/bnd/service/Registry.java
@@ -1,10 +1,10 @@
 package aQute.bnd.service;
 
-import static aQute.bnd.service.Tagged.matchesTags;
-
 import java.util.List;
 import java.util.stream.Collectors;
 
+import aQute.bnd.service.tags.Tagged;
+
 /**
  * A registry for objects.
  */
@@ -13,12 +13,13 @@ public interface Registry {
 
 	default <T> List<T> getPlugins(Class<T> c, String... tags) {
 
-		if (tags == null || tags.length == 0) {
+		if (tags.length == 0) {
 			return getPlugins(c);
 		}
 
 		return getPlugins(c).stream()
-			.filter(repo -> matchesTags(repo, tags))
+			.filter(repo -> repo instanceof Tagged taggedRepo && taggedRepo.getTags()
+				.isIncluded(tags))
 			.collect(Collectors.toList());
 	}
 

diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/RepositoryPlugin.java b/biz.aQute.bndlib/src/aQute/bnd/service/RepositoryPlugin.java
@@ -11,6 +11,8 @@
 
 import aQute.bnd.osgi.Constants;
 import aQute.bnd.osgi.Processor;
+import aQute.bnd.service.tags.Tagged;
+import aQute.bnd.service.tags.Tags;
 import aQute.bnd.version.Version;
 
 /**
@@ -288,8 +290,5 @@ default Promise<Void> sync() throws Exception {
 			});
 	}
 
-	@Override
-	default Tags getTags() {
-		return DEFAULT_REPO_TAGS;
-	}
+
 }
diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/Tagged.java b/biz.aQute.bndlib/src/aQute/bnd/service/Tagged.java
diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/tags/Tagged.java b/biz.aQute.bndlib/src/aQute/bnd/service/tags/Tagged.java
@@ -0,0 +1,21 @@
+package aQute.bnd.service.tags;
+
+/**
+ * Allows to add tags to implementing classes. Originally intended for tagging
+ * repositories.
+ */
+public interface Tagged {
+
+	/**
+	 * Dummy placeholder for "empty tags".
+	 */
+	String EMPTY_TAGS = "<<EMPTY>>"; 
+
+	/**
+	 * @return a non-null list of tags. Default is empty (meaning 'no tags').
+	 */
+	default Tags getTags() {
+		return Tags.NO_TAGS;
+	}
+
+}
diff --git a/...te.bndlib/src/aQute/bnd/service/Tags.java → ...dlib/src/aQute/bnd/service/tags/Tags.java b/...te.bndlib/src/aQute/bnd/service/Tags.java → ...dlib/src/aQute/bnd/service/tags/Tags.java
@@ -1,4 +1,4 @@
-package aQute.bnd.service;
+package aQute.bnd.service.tags;
 
 import static java.util.Collections.unmodifiableSortedSet;
 
@@ -16,7 +16,7 @@
  * categorization and filtering. Typically these entities then implement the
  * {@link Tagged} interface.
  */
-public final class Tags implements Set<String> {
+public class Tags implements Set<String> {
 	private final SortedSet<String>	internalSet;
 
 	public final static Tags	NO_TAGS				= of();
@@ -29,7 +29,7 @@ private Tags(Collection<? extends String> c) {
 		this.internalSet = unmodifiableSortedSet(new TreeSet<>(c));
 	}
 
-	static Tags of(String... name) {
+	public static Tags of(String... name) {
 		return new Tags(Set.of(name));
 	}
 
@@ -130,6 +130,26 @@ public String toString() {
 		return internalSet.toString();
 	}
 
+	/**
+	 * @param <T>
+	 * @param tags
+	 * @return <code>true</code> if the passed object matches any of the given
+	 *         tags, otherwise returns <code>false</code>
+	 */
+	public <T> boolean isIncluded(String... tags) {
+
+		if (isEmpty()) {
+			return true;
+		}
+
+		for (String tag : tags) {
+			if (contains(tag)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
 
 
 }
diff --git a/biz.aQute.bndlib/src/aQute/bnd/service/tags/package-info.java b/biz.aQute.bndlib/src/aQute/bnd/service/tags/package-info.java
@@ -0,0 +1,4 @@
+@Version("1.0.0")
+package aQute.bnd.service.tags;
+
+import org.osgi.annotation.versioning.Version;
diff --git a/biz.aQute.bndlib/src/aQute/lib/deployer/FileRepo.java b/biz.aQute.bndlib/src/aQute/lib/deployer/FileRepo.java
@@ -1,6 +1,6 @@
 package aQute.lib.deployer;
 
-import static aQute.bnd.service.Tags.parse;
+import static aQute.bnd.service.tags.Tags.parse;
 
 import java.io.Closeable;
 import java.io.File;
@@ -36,9 +36,9 @@
 import aQute.bnd.service.RegistryPlugin;
 import aQute.bnd.service.RepositoryListenerPlugin;
 import aQute.bnd.service.RepositoryPlugin;
-import aQute.bnd.service.Tagged;
-import aQute.bnd.service.Tags;
 import aQute.bnd.service.repository.SearchableRepository.ResourceDescriptor;
+import aQute.bnd.service.tags.Tagged;
+import aQute.bnd.service.tags.Tags;
 import aQute.bnd.version.Version;
 import aQute.lib.collections.SortedList;
 import aQute.lib.hex.Hex;

diff --git a/biz.aQute.repository/src/aQute/bnd/deployer/repository/LocalIndexedRepo.java b/biz.aQute.repository/src/aQute/bnd/deployer/repository/LocalIndexedRepo.java
@@ -1,7 +1,6 @@
 package aQute.bnd.deployer.repository;
 
 import static aQute.bnd.deployer.repository.RepoConstants.DEFAULT_CACHE_DIR;
-import static aQute.bnd.service.Tags.parse;
 
 import java.io.ByteArrayOutputStream;
 import java.io.File;
@@ -41,6 +40,7 @@
 import aQute.bnd.service.RepositoryListenerPlugin;
 import aQute.bnd.service.ResourceHandle;
 import aQute.bnd.service.ResourceHandle.Location;
+import aQute.bnd.service.tags.Tags;
 import aQute.bnd.version.Version;
 import aQute.bnd.version.VersionRange;
 import aQute.lib.hex.Hex;
@@ -135,7 +135,7 @@ public synchronized void setProperties(Map<String, String> map) {
 				String.format("Cannot create repository cache: '%s' already exists but is not directory.",
 					cacheDir.getAbsolutePath()));
 
-		super.setTags(parse(map.get(PROP_TAGS), DEFAULT_REPO_TAGS));
+		super.setTags(Tags.parse(map.get(PROP_TAGS), DEFAULT_REPO_TAGS));
 	}
 
 	@Override

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
@@ -1,7 +1,7 @@
 package aQute.bnd.repository.maven.pom.provider;
 
 import static aQute.bnd.osgi.Constants.BSN_SOURCE_SUFFIX;
-import static aQute.bnd.service.Tags.parse;
+import static aQute.bnd.service.tags.Tags.parse;
 import static java.util.stream.Collectors.joining;
 import static java.util.stream.Collectors.toList;
 

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
@@ -1,7 +1,7 @@
 package aQute.bnd.repository.maven.provider;
 
 import static aQute.bnd.osgi.Constants.BSN_SOURCE_SUFFIX;
-import static aQute.bnd.service.Tags.parse;
+import static aQute.bnd.service.tags.Tags.parse;
 
 import java.io.Closeable;
 import java.io.File;

diff --git a/biz.aQute.repository/src/aQute/bnd/repository/osgi/OSGiRepository.java b/biz.aQute.repository/src/aQute/bnd/repository/osgi/OSGiRepository.java
@@ -1,6 +1,6 @@
 package aQute.bnd.repository.osgi;
 
-import static aQute.bnd.service.Tags.parse;
+import static aQute.bnd.service.tags.Tags.parse;
 
 import java.io.Closeable;
 import java.io.File;

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
@@ -1,6 +1,6 @@
 package aQute.bnd.repository.p2.provider;
 
-import static aQute.bnd.service.Tags.parse;
+import static aQute.bnd.service.tags.Tags.parse;
 
 import java.io.Closeable;
 import java.io.File;

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
@@ -18,7 +18,7 @@
 
 import aQute.bnd.build.Workspace;
 import aQute.bnd.osgi.Constants;
-import aQute.bnd.service.Tagged;
+import aQute.bnd.service.tags.Tagged;
 import aQute.bnd.test.jupiter.InjectTemporaryDirectory;
 import aQute.http.testservers.HttpTestServer.Config;
 import aQute.lib.io.IO;
@@ -66,7 +66,8 @@ public void testEnv() throws Exception {
 		System.out.println(workspace.getBase());
 
 		// check repo tags
-		// repos should have the 'resolve' tag by default if no tag is specified
+		// we expect all repos to be returned for the 'resolve' tag by default
+		// if a repo has no tag specified
 		List<Repository> repos = workspace.getPlugins(Repository.class);
 		List<Repository> resolveRepos = workspace.getPlugins(Repository.class, Constants.REPOTAGS_RESOLVE);
 		assertEquals(repos, resolveRepos);