Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show blacklisted req/caps on resolve failure #5906

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ public abstract class AbstractResolveContext extends ResolveContext {
private Resource systemResource;
private Resource inputResource;
private Set<Resource> blacklistedResources = new HashSet<>();
private final Set<Capability> blacklistedCapabilities = new HashSet<>();
private int level = 0;
private Resource framework;
private final AtomicBoolean reported = new AtomicBoolean();
Expand Down Expand Up @@ -285,10 +286,20 @@ protected ArrayList<Capability> findProvidersFromRepositories(Requirement requir
protected Collection<Capability> findProviders(Repository repo, Requirement requirement) {
Map<Requirement, Collection<Capability>> map = repo.findProviders(Collections.singleton(requirement));
Collection<Capability> caps = map.get(requirement);
caps.removeIf(capability -> blacklistedResources.contains(capability.getResource()));
caps.removeIf(capability -> isBlacklisted(capability));
return caps;
}

private boolean isBlacklisted(Capability capability) {

boolean contains = blacklistedResources.contains(capability.getResource());
if (contains) {
blacklistedCapabilities.add(capability);
}

return contains;
}

private void setResourcePriority(int priority, Resource resource) {
resourcePriorities.putIfAbsent(resource, priority);
}
Expand Down Expand Up @@ -695,6 +706,10 @@ public Set<Resource> getBlackList() {
return blacklistedResources;
}

public Set<Capability> getBlacklistedCapabilities() {
return blacklistedCapabilities;
}

public void setLevel(int n) {
this.level = n;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package biz.aQute.resolve;

import java.util.Collection;
import java.util.Set;

import org.osgi.resource.Capability;
import org.osgi.resource.Requirement;
import org.osgi.resource.Resource;
import org.osgi.service.resolver.ResolutionException;

/**
* A {@link ResolutionException} providing more details about why resolution has
* failed.
*/
public class BndResolutionException extends ResolutionException {

private static final long serialVersionUID = 1L;

private Set<Resource> blackList;
private Set<Capability> blacklistedCapabilities;

public BndResolutionException(String message, Throwable cause,
Collection<Requirement> unresolvedRequirements, Set<Resource> blackList,
Set<Capability> blacklistedCapabilities) {
super(message, cause, unresolvedRequirements);
this.blackList = blackList;
this.blacklistedCapabilities = blacklistedCapabilities;

}

public Set<Resource> getBlackList() {
return blackList;
}

public Set<Capability> getBlacklistedCapabilities() {
return blacklistedCapabilities;
}
}
86 changes: 86 additions & 0 deletions biz.aQute.resolve/src/biz/aQute/resolve/ResolveProcess.java
Original file line number Diff line number Diff line change
Expand Up @@ -287,10 +287,82 @@ public static String format(ResolutionException re, boolean reportOptional) {
.forEach(formatGroup(f));
}

// 4. Check Blacklist

if (re instanceof BndResolutionException detailedExc) {
printBlacklistDebugLog(chain, f, detailedExc);
}

return f.toString();
}
}

/**
* Print -runblacklist related debug output if exists.
*
* @param unresolvedRequirements
* @param f
* @param detailedExc
*/
private static void printBlacklistDebugLog(List<Requirement> unresolvedRequirements, Formatter f,
BndResolutionException detailedExc) {
Set<Resource> blackList = detailedExc.getBlackList();
Set<Capability> blacklistedCapabilities = detailedExc.getBlacklistedCapabilities();

if (blacklistedCapabilities != null && !blacklistedCapabilities.isEmpty()) {

f.format(
"%n%nBlacklisted Capabilities: Some requirements could not be satisfied because of blacklisted capabilities in -runblacklist:%n");

printBlacklistSummary(unresolvedRequirements, f, blackList);

f.format("%n%nAll blacklisted Capabilities:%n");

for (Capability cap : blacklistedCapabilities) {
f.format("'%s' providing capability '%s: %s' ignored%n", cap.getResource(), cap.getNamespace(),
cap.getAttributes()
.get(cap.getNamespace()));
}

f.format("%n%nAll blacklisted Resources:%n");

for (Resource res : blackList) {
f.format("%s%n", res);
}
}
}

/**
* Tries to determine which of the blacklisted capability (resource) is
* responsible for an unresolved requirement.
*
* @param unresolvedRequirements
* @param f
* @param blackList
*/
private static void printBlacklistSummary(List<Requirement> unresolvedRequirements, Formatter f,
Set<Resource> blackList) {
for (Requirement req : unresolvedRequirements) {

String namespace = req.getNamespace();
String filter = req.getDirectives()
.get("filter");

for (Resource blacklistedRes : blackList) {

List<Capability> findCapability = ResourceUtils.findCapability(blacklistedRes, namespace,
filter);
if (!findCapability.isEmpty()) {
f.format(
"'%s' is ignored because it is blacklisted although providing required capability '%s: %s'%n",
blacklistedRes, namespace, filter);
}

}

}
}

/**
* Prints a summary by transforming the requirements chain using
* FilterParser which removes visual noise from the output and tries to make
Expand Down Expand Up @@ -435,6 +507,20 @@ private static ResolutionException augment(Collection<Requirement> unresolved, R
}
}
} catch (TimeoutException toe) {}

if (context instanceof AbstractResolveContext arctx) {
Set<Resource> blackList = arctx.getBlackList();
Set<Capability> blacklistedCapabilities = arctx.getBlacklistedCapabilities();

if (!blacklistedCapabilities.isEmpty()) {
return new BndResolutionException(re.getMessage(), re, list, blackList,
blacklistedCapabilities);
} else {
return new ResolutionException(re.getMessage(), re, list);
}

}

return new ResolutionException(re.getMessage(), re, list);
}

Expand Down