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

Jump to bottom

Versionless Repo Resolver additions and Error handling #29058

Merged
merged 8 commits into from
Jul 17, 2024
Merged

Versionless Repo Resolver additions and Error handling #29058

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d036e52
Resolver passing platforms
cbridgha Jul 10, 2024
f6dc278
Install now passing platforms
cbridgha Jul 10, 2024
54d7361
Implmenting ESA feature apis
cbridgha Jul 11, 2024
190620c
Gather and pass error states from Result
cbridgha Jul 12, 2024
b25aec3
Forwarding Result data
cbridgha Jul 13, 2024
eb96f63
Add fixes from suggestions, and cleanup comments
cbridgha Jul 15, 2024
c8e60d8
restructure,check for null
cbridgha Jul 16, 2024
9576b50
Fixup syntax and javadoc based on comments
cbridgha Jul 16, 2024
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
5 changes: 2 additions & 3 deletions dev/com.ibm.ws.install/src/com/ibm/ws/install/internal/InstallKernelMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,9 +963,8 @@ public Collection<String> singleFileResolve() {
if (!isInstallServerFeature) {
resolveResult = resolver.resolve((Collection<String>) data.get(InstallConstants.FEATURES_TO_RESOLVE));
} else {
resolveResult = resolver.resolveAsSet((Collection<String>) data.get(InstallConstants.FEATURES_TO_RESOLVE));
// TODO - After Resolver changes, also start passing platforms
// (Collection<String>) data.get(InstallConstants.PLATFORMS));
resolveResult = resolver.resolveAsSet((Collection<String>) data.get(InstallConstants.FEATURES_TO_RESOLVE),
(Collection<String>) data.get(InstallConstants.PLATFORMS));
}

if (!resolveResult.isEmpty()) {
Expand Down
84 changes: 74 additions & 10 deletions ...repository.resolver/src/com/ibm/ws/repository/resolver/RepositoryResolutionException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-2.0/
*
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
Expand All @@ -15,8 +15,10 @@

import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import org.osgi.service.resolver.ResolutionException;

Expand All @@ -40,14 +42,18 @@ public class RepositoryResolutionException extends RepositoryException {
private final Collection<ProductRequirementInformation> missingProductInformation;
private final Collection<MissingRequirement> allRequirementsResourcesNotFound;
private final Map<String, Collection<Chain>> featureConflicts;
private Set<String> resolvedPlatforms;
private Set<String> missingPlatforms;
private boolean hasVersionlessIssue;
Azquelt marked this conversation as resolved.
Show resolved Hide resolved
private List<String> missingBasePlatforms;

/**
* @param cause
* @param topLevelFeaturesNotResolved
* @param allRequirementsNotFound
* @param missingProductInformation all the product information requirements that could not be found. Can be empty but must not be <code>null</code>
* @param missingProductInformation all the product information requirements that could not be found. Can be empty but must not be <code>null</code>
* @param allRequirementsResourcesNotFound The {@link MissingRequirement} objects that were not found. Must not be <code>null</code>.
* @param featureConflicts the details of any feature conflicts which occurred during feature resolution, as returned from {@link Result#getConflicts()}
* @param featureConflicts the details of any feature conflicts which occurred during feature resolution, as returned from {@link Result#getConflicts()}
*/
public RepositoryResolutionException(ResolutionException cause, Collection<String> topLevelFeaturesNotResolved, Collection<String> allRequirementsNotFound,
Collection<ProductRequirementInformation> missingProductInformation, Collection<MissingRequirement> allRequirementsResourcesNotFound,
Expand All @@ -60,6 +66,33 @@ public RepositoryResolutionException(ResolutionException cause, Collection<Strin
this.featureConflicts = featureConflicts;
}

/**
* @param object
* @param missingTopLevelRequirements
* @param missingRequirementNames
* @param missingProductInformation all the product information requirements that could not be found. Can be empty but must not be <code>null</code>
* @param allRequirementsResourcesNotFound The {@link MissingRequirement} objects that were not found. Must not be <code>null</code>.
* @param featureConflicts the details of any feature conflicts which occurred during feature resolution, as returned from {@link Result#getConflicts()}
* @param resolvedPlatforms
* @param missingPlatforms Unknown platform names
* @param missingBasePlatforms unresolved versionless features needing platforms defined
*/
public RepositoryResolutionException(ResolutionException cause, Collection<String> topLevelFeaturesNotResolved, Collection<String> allRequirementsNotFound,
Azquelt marked this conversation as resolved.
Show resolved Hide resolved
Collection<ProductRequirementInformation> missingProductInformation, Collection<MissingRequirement> allRequirementsResourcesNotFound,
Map<String, Collection<Chain>> featureConflicts, Set<String> resolvedPlatforms, Set<String> missingPlatforms,
List<String> missingBasePlatforms) {
super(cause);
this.topLevelFeaturesNotResolved = topLevelFeaturesNotResolved;
this.allRequirementsNotFound = allRequirementsNotFound;
this.missingProductInformation = missingProductInformation;
this.allRequirementsResourcesNotFound = allRequirementsResourcesNotFound;
this.featureConflicts = featureConflicts;
this.resolvedPlatforms = resolvedPlatforms;
this.missingPlatforms = missingPlatforms;
this.missingBasePlatforms = missingBasePlatforms;

}

/**
* Returns a collection of top level feature names that were not resolved.
*
Expand Down Expand Up @@ -106,9 +139,9 @@ public ResolutionException getCause() {
* on a {@link ProductRequirementInformation} is not in the form digit.digit.digit.digit then it will be ignored.
*
* @param productId The product ID to find the minimum missing version for or <code>null</code> to match to all products
* @param version The version to find the minimum missing version for by matching the first three parts so if you supply "9.0.0.0" and this item applies to version "8.5.5.3"
* and "9.0.0.1" then "9.0.0.1" will be returned. Supply <code>null</code> to match all versions
* @param edition The edition to find the minimum missing version for or <code>null</code> to match to all products
* @param version The version to find the minimum missing version for by matching the first three parts so if you supply "9.0.0.0" and this item applies to version "8.5.5.3"
* and "9.0.0.1" then "9.0.0.1" will be returned. Supply <code>null</code> to match all versions
* @param edition The edition to find the minimum missing version for or <code>null</code> to match to all products
* @return The minimum missing version or <code>null</code> if there were no relevant matches
*/
public String getMinimumVersionForMissingProduct(String productId, String version, String edition) {
Expand Down Expand Up @@ -152,7 +185,7 @@ private Collection<LibertyVersion> filterVersions(Collection<LibertyVersion> min
* This method will iterate through the missingProductInformation and returned a filtered collection of all the {@link ProductRequirementInformation#versionRange}s.
*
* @param productId The product ID to find the version for or <code>null</code> to match to all products
* @param edition The edition to find the version for or <code>null</code> to match to all editions
* @param edition The edition to find the version for or <code>null</code> to match to all editions
*
* @return the version ranges which apply to the given product ID and edition
*/
Expand Down Expand Up @@ -185,9 +218,9 @@ private Collection<LibertyVersionRange> filterVersionRanges(String productId, St
* indicate a fairly odd repository setup.</p>
*
* @param productId The product ID to find the maximum missing version for or <code>null</code> to match to all products
* @param version The version to find the maximum missing version for by matching the first three parts so if you supply "8.5.5.2" and this item applies to version "8.5.5.3"
* and "9.0.0.1" then "8.5.5.3" will be returned. Supply <code>null</code> to match all versions
* @param edition The edition to find the maximum missing version for or <code>null</code> to match to all products
* @param version The version to find the maximum missing version for by matching the first three parts so if you supply "8.5.5.2" and this item applies to version "8.5.5.3"
* and "9.0.0.1" then "8.5.5.3" will be returned. Supply <code>null</code> to match all versions
* @param edition The edition to find the maximum missing version for or <code>null</code> to match to all products
* @return The maximum missing version or <code>null</code> if there were no relevant matches or the maximum version is unbounded
*/
public String getMaximumVersionForMissingProduct(String productId, String version, String edition) {
Expand Down Expand Up @@ -251,6 +284,16 @@ public Map<String, Collection<Chain>> getFeatureConflicts() {
@Override
public String getMessage() {
StringBuilder sb = new StringBuilder();

if (!getMissingPlatforms().isEmpty()) {
for (String missing : getMissingPlatforms()) {
sb.append("Platform: ").append(missing).append(" couldn't be found, no versionless features will be resolved").append("\n");
}
}
if (getResolvedPlatforms().isEmpty() && getMissingPlatforms().isEmpty()) {
sb.append("Platform couldn't be determined, no versionless features will be resolved").append("\n");
}

for (String missing : getTopLevelFeaturesNotResolved()) {
sb.append("Top level feature not resolved: resource=").append(missing).append("\n");
}
Expand Down Expand Up @@ -329,4 +372,25 @@ private String getResourceName(RepositoryResource resource) {
}
}

/**
* @return the resolvedPlatforms
*/
public Set<String> getResolvedPlatforms() {
return resolvedPlatforms;
}

/**
* @return the missingPlatforms
*/
public Set<String> getMissingPlatforms() {
return missingPlatforms;
}

/**
* @return the missingBasePlatforms
*/
public List<String> getMissingBasePlatforms() {
return missingBasePlatforms;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add more documentation about what each of these fields means and what data it contains.

These fields look like they are used in other places, but here seems like the most logical place to document them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a little bit of doc on the constructor and it sounds like missingPlaforms and missingBasePlatforms are completely different? That could do with a better explanation and possibly missingBasePlatforms should be renamed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes tried to add javadoc - one is simply a missspelling of a platform name - one is related to a base name like MP or jakarta realted to a versionless feature - if they can't be derived up front - its an error, and the reason the feature isn't resolved.


}
Loading