Skip to content

Commit

Permalink
Add non-IU artifact repositories to the planner resolution eclipse-pd…
Browse files Browse the repository at this point in the history
…e#792

Given that units from non-IU locations are considered when resolving
IUs, it may happen that units are contained in the resolution path,
which are not contained by any repository. This may break previously
functional target definitions.

To resolve this problem, an in-memory artifact and metadata repository
is created, based on the metadata of the non-IU locations. Those
repositories are then added to the provisioning context for further
processing.

Amends dd321b5
  • Loading branch information
ptziegler committed Dec 1, 2023
1 parent a31752b commit 82b730c
Show file tree
Hide file tree
Showing 5 changed files with 347 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
/*******************************************************************************
* Copyright (c) 2023 Patrick Ziegler and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Patrick Ziegler - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.internal.core.target;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.equinox.frameworkadmin.BundleInfo;
import org.eclipse.equinox.internal.p2.metadata.expression.QueryResult;
import org.eclipse.equinox.p2.core.IProvisioningAgent;
import org.eclipse.equinox.p2.core.ProvisionException;
import org.eclipse.equinox.p2.metadata.IArtifactKey;
import org.eclipse.equinox.p2.publisher.eclipse.BundlesAction;
import org.eclipse.equinox.p2.publisher.eclipse.FeaturesAction;
import org.eclipse.equinox.p2.query.IQuery;
import org.eclipse.equinox.p2.query.IQueryResult;
import org.eclipse.equinox.p2.query.IQueryable;
import org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor;
import org.eclipse.equinox.p2.repository.artifact.IArtifactRequest;
import org.eclipse.equinox.p2.repository.artifact.spi.AbstractArtifactRepository;
import org.eclipse.equinox.p2.repository.artifact.spi.ArtifactDescriptor;
import org.eclipse.pde.core.target.ITargetLocation;
import org.eclipse.pde.core.target.TargetBundle;
import org.eclipse.pde.core.target.TargetFeature;
import org.eclipse.pde.internal.core.PDECore;
import org.eclipse.pde.internal.core.ifeature.IFeatureModel;

/**
* In-Memory representation of a artifact repository based on a non-IU target
* location. This repository is used during the planner resolution of an IU
* target location to supply artifacts from other (non-IU) locations.
*/
@SuppressWarnings("restriction")
public class FileArtifactRepository extends AbstractArtifactRepository {
private static final String NAME = "Non-IU Artifact Repository";
private static final String DESCRIPTION = """
In-Memory repository created for a single Non-IU repository, used
during the planner resolution of a real IU repository, in order to
grant access to external, installable units.
""";
private static final String SCHEME = "memory://"; //$NON-NLS-1$
private final Map<IArtifactDescriptor, File> artifacts = new HashMap<>();

public FileArtifactRepository(IProvisioningAgent agent, ITargetLocation targetLocation) {
super(agent, NAME, null, null, URI.create(SCHEME + UUID.randomUUID()), DESCRIPTION, null, null);
Assert.isTrue(targetLocation.isResolved());
for (TargetBundle targetBundle : targetLocation.getBundles()) {
if (!targetBundle.getStatus().isOK()) {
PDECore.log(Status.warning("Target bundle is not resolved: " + targetBundle));
continue;
}
BundleInfo bundleInfo = targetBundle.getBundleInfo();
URI bundleLocation = bundleInfo.getLocation();
if (bundleLocation == null) {
PDECore.log(Status.warning("Bundle location not found for: " + bundleInfo));
continue;
}
File bundleFile = new File(bundleLocation);
if (!bundleFile.exists()) {
PDECore.log(Status.warning("Bundle file doesn't exist: " + bundleFile));
continue;
}
IArtifactKey artifactKey = BundlesAction.createBundleArtifactKey(bundleInfo.getSymbolicName(),
bundleInfo.getVersion());
IArtifactDescriptor artifactDesriptor = new ArtifactDescriptor(artifactKey);
if (artifacts.containsKey(artifactDesriptor)) {
PDECore.log(Status.warning("Artifact already exists: " + artifactDesriptor));
continue;
}
artifacts.put(artifactDesriptor, bundleFile);
}
for (TargetFeature targetFeature : targetLocation.getFeatures()) {
String featureLocation = ((IFeatureModel) targetFeature.getFeatureModel()).getInstallLocation();
if (featureLocation == null) {
PDECore.log(Status.warning("Feature location not found for: " + targetFeature));
continue;
}
File featureFile = new File(featureLocation);
if (!featureFile.exists()) {
PDECore.log(Status.warning("Feature file doesn't exist: " + featureFile));
continue;
}
IArtifactKey artifactKey = FeaturesAction.createFeatureArtifactKey(targetFeature.getId(),
targetFeature.getVersion());
IArtifactDescriptor artifactDesriptor = new ArtifactDescriptor(artifactKey);
if (artifacts.containsKey(artifactDesriptor)) {
PDECore.log(Status.warning("Artifact already exists: " + artifactDesriptor));
continue;
}
artifacts.put(artifactDesriptor, featureFile);
}
}

@Override
public IStatus getRawArtifact(IArtifactDescriptor descriptor, OutputStream destination, IProgressMonitor monitor) {
File artifactFile = artifacts.get(descriptor);
if (artifactFile == null) {
return Status.error("Artifact not found: " + descriptor);
}
try (FileInputStream is = new FileInputStream(artifactFile)) {
is.transferTo(destination);
return Status.OK_STATUS;
} catch (IOException e) {
return Status.error(e.getLocalizedMessage(), e);
}
}

@Override
public IQueryable<IArtifactDescriptor> descriptorQueryable() {
return (query, monitor) -> query.perform(artifacts.keySet().iterator());
}

@Override
public IQueryResult<IArtifactKey> query(IQuery<IArtifactKey> query, IProgressMonitor monitor) {
return new QueryResult<>(artifacts.keySet().stream().map(IArtifactDescriptor::getArtifactKey).iterator());
}

@Override
public boolean contains(IArtifactDescriptor descriptor) {
return artifacts.containsValue(descriptor);
}

@Override
public boolean contains(IArtifactKey key) {
return artifacts.keySet().stream().anyMatch(descriptor -> key.equals(descriptor.getArtifactKey()));
}

@Override
public IStatus getArtifact(IArtifactDescriptor descriptor, OutputStream destination, IProgressMonitor monitor) {
return getRawArtifact(descriptor, destination, monitor);
}

@Override
public IArtifactDescriptor[] getArtifactDescriptors(IArtifactKey key) {
return artifacts.keySet().stream() //
.filter(descriptor -> key.equals(descriptor.getArtifactKey())) //
.toArray(IArtifactDescriptor[]::new);
}

@Override
public IStatus getArtifacts(IArtifactRequest[] requests, IProgressMonitor monitor) {
MultiStatus multiStatus = new MultiStatus(getClass(), IStatus.INFO, "");
SubMonitor subMonitor = SubMonitor.convert(monitor, requests.length);
for (IArtifactRequest request : requests) {
request.perform(this, subMonitor.split(1));
multiStatus.add(request.getResult());
}
return Status.OK_STATUS;
}

@Override
public OutputStream getOutputStream(IArtifactDescriptor descriptor) throws ProvisionException {
throw new ProvisionException("Artifact repository must not be modified!");
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*******************************************************************************
* Copyright (c) 2023 Patrick Ziegler and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Patrick Ziegler - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.internal.core.target;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.equinox.p2.core.IProvisioningAgent;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.query.IQuery;
import org.eclipse.equinox.p2.query.IQueryResult;
import org.eclipse.equinox.p2.repository.IRepositoryReference;
import org.eclipse.equinox.p2.repository.metadata.spi.AbstractMetadataRepository;

/**
* In-Memory representation of a metadata repository based on a non-IU target
* location. This repository is used during the planner resolution of an IU
* target location to supply the metadata from other (non-IU) locations.
*/
public class FileMetadataRepository extends AbstractMetadataRepository {
private final List<IInstallableUnit> installableUnits;

public FileMetadataRepository(IProvisioningAgent agent, List<IInstallableUnit> installableUnits) {
super(agent);
this.installableUnits = List.copyOf(installableUnits);
}


@Override
public Collection<IRepositoryReference> getReferences() {
return Collections.emptySet();
}

@Override
public IQueryResult<IInstallableUnit> query(IQuery<IInstallableUnit> query, IProgressMonitor monitor) {
return query.perform(installableUnits.iterator());
}

@Override
public void initialize(RepositoryState state) {
// nothing to do
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2010, 2018 EclipseSource Inc. and others.
* Copyright (c) 2010, 2023 EclipseSource Inc. and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
Expand All @@ -17,6 +17,7 @@
package org.eclipse.pde.internal.core.target;

import java.io.File;
import java.lang.reflect.Field;
import java.net.URI;
import java.nio.file.Path;
import java.util.ArrayList;
Expand All @@ -32,6 +33,7 @@
import java.util.Set;
import java.util.WeakHashMap;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Consumer;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
Expand Down Expand Up @@ -69,6 +71,7 @@
import org.eclipse.equinox.p2.metadata.Version;
import org.eclipse.equinox.p2.planner.IPlanner;
import org.eclipse.equinox.p2.planner.IProfileChangeRequest;
import org.eclipse.equinox.p2.query.CollectionResult;
import org.eclipse.equinox.p2.query.IQuery;
import org.eclipse.equinox.p2.query.IQueryResult;
import org.eclipse.equinox.p2.query.IQueryable;
Expand Down Expand Up @@ -1078,11 +1081,40 @@ private void resolveWithPlanner(ITargetDefinition target, IProgressMonitor monit
request.setInstallableUnitProfileProperty(unit, PROP_INSTALLED_IU, Boolean.toString(true));
}

ProvisioningContext context = new ProvisioningContext(getAgent());
IProvisioningAgent agent = getAgent();
List<IInstallableUnit> extraInstallableUnits = new ArrayList<>();
List<IArtifactRepository> extraArtifactRepositories = new ArrayList<>();
List<IMetadataRepository> extraMetadataRepositories = new ArrayList<>();
getAdditionalProvisionIUs(target, container -> {
List<IInstallableUnit> installableUnits = InstallableUnitGenerator //
.generateInstallableUnits(container.getBundles(), container.getFeatures()) //
.toList();
extraArtifactRepositories.add(new FileArtifactRepository(agent, container));
extraMetadataRepositories.add(new FileMetadataRepository(agent, installableUnits));
extraInstallableUnits.addAll(installableUnits);
});
ProvisioningContext context = new ProvisioningContext(agent) {
@Override
public IQueryable<IArtifactRepository> getArtifactRepositories(IProgressMonitor monitor) {
return (query, monitor2) -> {
List<IArtifactRepository> artifactRepositories = new ArrayList<>();
try {
IQueryable<IArtifactRepository> oldQueryable = super.getArtifactRepositories(monitor2);
Field f = oldQueryable.getClass().getDeclaredField("repositories");
f.setAccessible(true);
artifactRepositories.addAll((List<IArtifactRepository>) f.get(oldQueryable));
} catch(Exception e) {
e.printStackTrace();
}
artifactRepositories.addAll(extraArtifactRepositories);
return new CollectionResult(artifactRepositories);
};
}
};
context.setProperty(ProvisioningContext.FOLLOW_REPOSITORY_REFERENCES, Boolean.toString(true));
context.setMetadataRepositories(getMetadataRepositories(target).toArray(URI[]::new));
context.setArtifactRepositories(getArtifactRepositories(target).toArray(URI[]::new));
context.setExtraInstallableUnits(getAdditionalProvisionIUs(target));
context.setExtraInstallableUnits(extraInstallableUnits);

IProvisioningPlan plan = planner.getProvisioningPlan(request, context, subMonitor.split(20));
IStatus status = plan.getStatus();
Expand Down Expand Up @@ -1553,8 +1585,8 @@ private Collection<URI> getMetadataRepositories(ITargetDefinition target) throws
return result;
}

private List<IInstallableUnit> getAdditionalProvisionIUs(ITargetDefinition target) throws CoreException {
List<IInstallableUnit> result = new ArrayList<>();
private void getAdditionalProvisionIUs(ITargetDefinition target, Consumer<ITargetLocation> callback)
throws CoreException {
ITargetLocation[] containers = target.getTargetLocations();
if (containers != null) {
for (ITargetLocation container : containers) {
Expand All @@ -1564,17 +1596,15 @@ private List<IInstallableUnit> getAdditionalProvisionIUs(ITargetDefinition targe
}
if (container instanceof TargetReferenceBundleContainer targetRefContainer) {
ITargetDefinition referencedTargetDefinition = targetRefContainer.getTargetDefinition();
result.addAll(getAdditionalProvisionIUs(referencedTargetDefinition));
getAdditionalProvisionIUs(referencedTargetDefinition, callback);
continue;
}
if (!container.isResolved()) {
container.resolve(target, new NullProgressMonitor());
}
InstallableUnitGenerator.generateInstallableUnits(container.getBundles(), container.getFeatures())
.forEach(result::add);
callback.accept(container);
}
}
return result;
}

private static final String NATIVE_ARTIFACTS = "nativeArtifacts"; //$NON-NLS-1$
Expand Down
1 change: 1 addition & 0 deletions ui/org.eclipse.pde.ui.tests/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Require-Bundle: org.eclipse.pde.ui,
org.eclipse.equinox.p2.repository,
org.eclipse.equinox.p2.metadata,
org.eclipse.equinox.p2.engine,
org.eclipse.equinox.p2.publisher.eclipse,
org.eclipse.ui.forms,
org.eclipse.ui.workbench.texteditor,
org.eclipse.jface.text,
Expand Down
Loading

0 comments on commit 82b730c

Please sign in to comment.