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.

Sign up for GitHub

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

[APITools] Handle multiple version correct when obtaining prerequisites #1339

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+56 −60
Open

[APITools] Handle multiple version correct when obtaining prerequisites #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions .../org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiBaselineManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
Expand Down Expand Up @@ -381,14 +380,14 @@ private Document getProfileXML(IApiBaseline baseline) throws CoreException {
Element celement = null;
IApiComponent[] components = baseline.getApiComponents();
for (IApiComponent component : components) {
Set<IApiComponent> allComponentSet = new HashSet<>();
Set<IApiComponent> allComponentSet;
// if the baseline has multiple versions, persist all versions
Set<IApiComponent> multipleComponents = baseline.getAllApiComponents(component.getSymbolicName());
if (multipleComponents.isEmpty()) {
// no multiple version - add the current component
allComponentSet.add(component);
allComponentSet = Set.of(component);
} else {
allComponentSet.addAll(multipleComponents);
allComponentSet = multipleComponents;
}
for (IApiComponent iApiComponent : allComponentSet) {
if (!iApiComponent.isSystemComponent()) {
Expand All @@ -399,8 +398,6 @@ private Document getProfileXML(IApiBaseline baseline) throws CoreException {
root.appendChild(celement);
}
}
// clear the temporary hashset
allComponentSet.clear();
}
return document;
}
Expand Down
17 changes: 2 additions & 15 deletions ...ipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ApiAnalysisBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
* @since 1.0.3
*/
public static final Set<String> IMPORTANT_HEADERS = Set.of(Constants.SYSTEM_BUNDLE_SYMBOLICNAME,
Constants.BUNDLE_VERSION, Constants.REQUIRE_BUNDLE, Constants.BUNDLE_REQUIREDEXECUTIONENVIRONMENT,

Check warning on line 124 in apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ApiAnalysisBuilder.java

View check run for this annotation

Jenkins - eclipse-pde / Compiler and API Tools

Deprecation 

NORMAL:
The field Constants.BUNDLE_REQUIREDEXECUTIONENVIRONMENT is deprecated
Constants.EXPORT_PACKAGE, Constants.IMPORT_PACKAGE, Constants.BUNDLE_CLASSPATH);

/**
Expand Down Expand Up @@ -894,22 +894,9 @@
localMonitor.subTask(NLS.bind(BuilderMessages.building_workspace_profile, currentproject.getName()));
localMonitor.split(1);
String id = currentModel.getBundleDescription().getSymbolicName();
Version version = currentModel.getBundleDescription().getVersion();
// Compatibility checks
IApiComponent apiComponent = wbaseline.getApiComponent(id);
Set<IApiComponent> apiComponentMultiple = wbaseline.getAllApiComponents(id);
if (!apiComponentMultiple.isEmpty()) {
// add the exact match
for (IApiComponent iApiComponent : apiComponentMultiple) {
Version workspaceBaselineVersion = new Version(iApiComponent.getVersion());// removes
// qualifier
Version currentProjectVersion = currentModel.getBundleDescription().getVersion();
if (new Version(currentProjectVersion.getMajor(), currentProjectVersion.getMinor(),
currentProjectVersion.getMicro()).compareTo(workspaceBaselineVersion) == 0) {
apiComponent = iApiComponent;
break;
}
}
}
IApiComponent apiComponent = wbaseline.getApiComponent(id, version);
if (apiComponent != null) {
if (getAnalyzer() instanceof BaseApiAnalyzer) {
((BaseApiAnalyzer) getAnalyzer()).checkBaselineMismatch(baseline, wbaseline);
Expand Down
16 changes: 2 additions & 14 deletions ...e.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IncrementalApiBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,20 +263,8 @@ void build(final IProject project, final IApiBaseline baseline, final IApiBaseli
IPluginModelBase currentModel = this.builder.getCurrentModel();
if (currentModel != null) {
String id = currentModel.getBundleDescription().getSymbolicName();
IApiComponent comp = wbaseline.getApiComponent(id);
Set<IApiComponent> apiComponentMultiple = wbaseline.getAllApiComponents(id);
if (!apiComponentMultiple.isEmpty()) {
// add the exact match
for (IApiComponent iApiComponent : apiComponentMultiple) {
Version workspaceBaselineVersion = new Version(iApiComponent.getVersion());// removes
// qualifier
Version currentProjectVersion = currentModel.getBundleDescription().getVersion();
if (new Version(currentProjectVersion.getMajor(), currentProjectVersion.getMinor(), currentProjectVersion.getMicro()).compareTo(workspaceBaselineVersion) == 0) {
comp = iApiComponent;
break;
}
}
}
Version version = currentModel.getBundleDescription().getVersion();
IApiComponent comp = wbaseline.getApiComponent(id, version);
if (comp == null) {
return;
}
Expand Down
64 changes: 39 additions & 25 deletions ...s/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiBaseline.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,34 +323,27 @@ protected void addComponent(IApiComponent component) {
return;
}

IApiComponent comp = fComponentsById.get(component.getSymbolicName());

IApiComponent comp = fComponentsById.put(component.getSymbolicName(), component);
// if more than 1 components, store all of them
if (comp != null) {
if (fAllComponentsById.containsKey(component.getSymbolicName())) {
Set<IApiComponent> allComponents = fAllComponentsById.get(component.getSymbolicName());
if (!allComponents.contains(component)) {
allComponents.add(component);
}
} else {
TreeSet<IApiComponent> allComponents = new TreeSet<>(
(comp1, comp2) -> {
if (comp2.getVersion().equals(comp1.getVersion())) {
if (comp2.getVersion().contains("JavaSE")) { //$NON-NLS-1$
ApiPlugin.logInfoMessage("Multiple locations for the same Java = " //$NON-NLS-1$
+ comp1.getLocation() + comp2.getLocation());
Set<IApiComponent> allComponents = fAllComponentsById.computeIfAbsent(component.getSymbolicName(),
name -> new TreeSet<>((comp1, comp2) -> {
String version2 = comp2.getVersion();
String version1 = comp1.getVersion();
if (version2.equals(version1)) {
if (version2.contains("JavaSE")) { //$NON-NLS-1$
ApiPlugin.logInfoMessage("Multiple locations for the same Java = " + comp1.getLocation() //$NON-NLS-1$
+ comp2.getLocation());
}
return 0;
}
return 0;
}
return new Version(comp2.getVersion()).compareTo(new Version(comp1.getVersion()));
});
return new Version(version2).compareTo(new Version(version1));
}));
if (allComponents.isEmpty()) {
allComponents.add(comp);
allComponents.add(component);
fAllComponentsById.put(component.getSymbolicName(), allComponents);
}
allComponents.add(component);
}

fComponentsById.put(component.getSymbolicName(), component);
if (component instanceof ProjectComponent projectApiComponent) {
fComponentsByProjectNames.put(projectApiComponent.getJavaProject().getProject().getName(), component);
}
Expand Down Expand Up @@ -670,6 +663,25 @@ public IApiComponent getApiComponent(String id) {
return fComponentsById.get(id);
}

@Override
public IApiComponent getApiComponent(String id, Version version) {
loadBaselineInfos();
if (disposed) {
return null;
}
IApiComponent component = fComponentsById.get(id);
if (hasSameMMMVersion(version, component)) {
return component;
}
Set<IApiComponent> allComponents = fAllComponentsById.get(id);
return allComponents.stream().filter(c -> hasSameMMMVersion(version, c)).findFirst().orElse(null);
}

private static boolean hasSameMMMVersion(Version ref, IApiComponent component) {
Version v = new Version(component.getVersion());
return ref.getMajor() == v.getMajor() && ref.getMinor() == v.getMinor() && ref.getMicro() == v.getMicro();
}

@Override
public Set<IApiComponent> getAllApiComponents(String id) {
loadBaselineInfos();
Expand Down Expand Up @@ -859,9 +871,11 @@ public IApiComponent[] getPrerequisiteComponents(IApiComponent[] components) thr
}
}
Collection<BundleDescription> dependencies = BuildDependencyCollector.collectBuildRelevantDependencies(bundles);
return dependencies.stream().map(BundleDescription::getSymbolicName) //
.map(id -> getApiComponent(id)).filter(Objects::nonNull) //
.toArray(IApiComponent[]::new);
return dependencies.stream().map(bundle -> {
String id = bundle.getSymbolicName();
Version version = bundle.getVersion();
return getApiComponent(id, version);
}).filter(Objects::nonNull).toArray(IApiComponent[]::new);
}

/**
Expand Down
10 changes: 10 additions & 0 deletions ....pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiBaseline.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.osgi.framework.Version;

/**
* A collection of related API components that together make up an
Expand Down Expand Up @@ -78,6 +79,15 @@ public interface IApiBaseline extends IApiElement {
*/
public IApiComponent getApiComponent(String id);

/**
* Returns the API component in this baseline with the given symbolic name and
* version or <code>null</code> if none.
*
* @param id component symbolic name
* @return API component or <code>null</code>
*/
public IApiComponent getApiComponent(String id, Version version);

/**
* Returns all the API components in this baseline (sorted from higher to
* lower version) with the given symbolic name or empty set if multiple
Expand Down
Loading