Add non-IU artifact repositories to the planner resolution #874

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/Messages.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2021 IBM Corporation and others.
+ * Copyright (c) 2009, 2023 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -80,6 +80,8 @@ public class Messages extends NLS {
  public static String RemoteTargetHandle_invalid_URI;
  public static String RemoteTargetHandle_malformed_URL;
  public static String RemoteTargetHandle_ioproblem;
+ public static String VirtualArtifactRepository_0;
+ public static String VirtualArtifactRepository_1;
 
 
  static {

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/Messages.properties

@@ -1,5 +1,5 @@
 ###############################################################################
-# Copyright (c) 2009, 2021 IBM Corporation and others.
+# Copyright (c) 2009, 2023 IBM Corporation and others.
 #
 # This program and the accompanying materials
 # are made available under the terms of the Eclipse Public License 2.0
@@ -73,4 +73,6 @@ TargetRefrenceLocationFactory_Unsupported_Type=Type {0} is not supported by this
 TargetRefrenceLocationFactory_Parsing_Failed=Parsing location content failed: {0}
 RemoteTargetHandle_invalid_URI=Invalid URI: {0}
 RemoteTargetHandle_malformed_URL=URI {0} can not be converted to an URL: {1}
-RemoteTargetHandle_ioproblem=Reading URI {0} failed: {1}
+RemoteTargetHandle_ioproblem=Reading URI {0} failed: {1}
+VirtualArtifactRepository_0=Target bundle is not resolved: {0}
+VirtualArtifactRepository_1=Artifact location not found for descriptor: {0}

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/P2TargetUtils.java

@@ -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
@@ -1078,11 +1078,24 @@ private void resolveWithPlanner(ITargetDefinition target, IProgressMonitor monit
  request.setInstallableUnitProfileProperty(unit, PROP_INSTALLED_IU, Boolean.toString(true));
  }
 
- ProvisioningContext context = new ProvisioningContext(getAgent());
+ List<IArtifactRepository> extraArtifactRepositories = new ArrayList<>();
+ List<IMetadataRepository> extraMetadataRepositories = new ArrayList<>();
+ addAdditionalProvisionIUs(target, extraArtifactRepositories, extraMetadataRepositories);
+ ProvisioningContext context = new ProvisioningContext(getAgent()) {
+ @Override
+ public IQueryable<IArtifactRepository> getArtifactRepositories(IProgressMonitor monitor) {
+ return QueryUtil.compoundQueryable(super.getArtifactRepositories(monitor),
+ (query, ignore) -> query.perform(extraArtifactRepositories.iterator()));
+ }
+ @Override
+ public IQueryable<IInstallableUnit> getMetadata(IProgressMonitor monitor) {
+ return QueryUtil.compoundQueryable(super.getMetadata(monitor),
+ QueryUtil.compoundQueryable(extraMetadataRepositories));
+ }
+ };
  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));
 
  IProvisioningPlan plan = planner.getProvisioningPlan(request, context, subMonitor.split(20));
  IStatus status = plan.getStatus();
@@ -1553,8 +1566,9 @@ private Collection<URI> getMetadataRepositories(ITargetDefinition target) throws
  return result;
  }
 
- private List<IInstallableUnit> getAdditionalProvisionIUs(ITargetDefinition target) throws CoreException {
- List<IInstallableUnit> result = new ArrayList<>();
+ private void addAdditionalProvisionIUs(ITargetDefinition target,
+ Collection<IArtifactRepository> extraArtifactRepositories,
+ Collection<IMetadataRepository> extraMetadataRepositories) throws CoreException {
  ITargetLocation[] containers = target.getTargetLocations();
  if (containers != null) {
  for (ITargetLocation container : containers) {
@@ -1564,17 +1578,20 @@ private List<IInstallableUnit> getAdditionalProvisionIUs(ITargetDefinition targe
  }
  if (container instanceof TargetReferenceBundleContainer targetRefContainer) {
  ITargetDefinition referencedTargetDefinition = targetRefContainer.getTargetDefinition();
- result.addAll(getAdditionalProvisionIUs(referencedTargetDefinition));
+ addAdditionalProvisionIUs(referencedTargetDefinition, extraArtifactRepositories,
+ extraMetadataRepositories);
  continue;
  }
  if (!container.isResolved()) {
  container.resolve(target, new NullProgressMonitor());
  }
- InstallableUnitGenerator.generateInstallableUnits(container.getBundles(), container.getFeatures())
- .forEach(result::add);
+ extraArtifactRepositories.add(new VirtualArtifactRepository(getAgent(), container));
+ List<IInstallableUnit> installableUnits = InstallableUnitGenerator //
+ .generateInstallableUnits(container.getBundles(), container.getFeatures()) //
+ .toList();
+ extraMetadataRepositories.add(new VirtualMetadataRepository(getAgent(), installableUnits));
  }
  }
- return result;
  }
 
  private static final String NATIVE_ARTIFACTS = "nativeArtifacts"; //$NON-NLS-1$

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/VirtualArtifactRepository.java

@@ -0,0 +1,199 @@
+/*******************************************************************************
+ * 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.FileNotFoundException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.PrintWriter;
+import java.net.URI;
+import java.nio.file.Files;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+import java.util.jar.JarEntry;
+import java.util.jar.JarOutputStream;
+
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.CoreException;
+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.osgi.util.NLS;
+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.IFeature;
+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 VirtualArtifactRepository extends AbstractArtifactRepository {
+ private static final String NAME = "Non-IU Artifact Repository @ "; //$NON-NLS-1$
+ 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.
+ """; //$NON-NLS-1$
+ private static final String MEMORY_PREFIX = "memory://"; //$NON-NLS-1$
+ // BundleInfo or IFeatureModel
+ private final Map<IArtifactDescriptor, Object> artifacts = new HashMap<>();
+
+ public VirtualArtifactRepository(IProvisioningAgent agent, ITargetLocation targetLocation) {
+ super(agent, NAME + getLocationSafe(targetLocation), targetLocation.getType(), null,
+ URI.create(MEMORY_PREFIX + UUID.randomUUID()), DESCRIPTION + '\n' + targetLocation.serialize(), null,
+ null);
+ Assert.isTrue(targetLocation.isResolved());
+ for (TargetBundle targetBundle : targetLocation.getBundles()) {
+ if (!targetBundle.getStatus().isOK()) {
+ PDECore.log(Status.warning(NLS.bind(Messages.VirtualArtifactRepository_0, targetBundle)));
+ continue;
+ }
+ BundleInfo bundleInfo = targetBundle.getBundleInfo();
+ IArtifactKey artifactKey = BundlesAction.createBundleArtifactKey(bundleInfo.getSymbolicName(),
+ bundleInfo.getVersion());
+ IArtifactDescriptor artifactDesriptor = new ArtifactDescriptor(artifactKey);
+ artifacts.put(artifactDesriptor, bundleInfo);
+ }
+ for (TargetFeature targetFeature : targetLocation.getFeatures()) {
+ IArtifactKey artifactKey = FeaturesAction.createFeatureArtifactKey(targetFeature.getId(),
+ targetFeature.getVersion());
+ IArtifactDescriptor artifactDesriptor = new ArtifactDescriptor(artifactKey);
+ artifacts.put(artifactDesriptor, targetFeature.getFeatureModel());
+ }
+ }
+
+ private static String getLocationSafe(ITargetLocation targetLocation) {
+ try {
+ return targetLocation.getLocation(false);
+ } catch (CoreException e) {
+ return "<unknown>"; //$NON-NLS-1$
+ }
+ }
+
+ @Override
+ public IStatus getRawArtifact(IArtifactDescriptor descriptor, OutputStream destination, IProgressMonitor monitor) {
+ Object artifactModel = artifacts.get(descriptor);
+ if (artifactModel == null) {
+ return Status.error(NLS.bind(Messages.VirtualArtifactRepository_1, descriptor));
+ }
+ try {
+ transferArtifact(artifactModel, destination);
+ return Status.OK_STATUS;
+ } catch (Exception e) {
+ return Status.error(e.getLocalizedMessage(), e);
+ }
+ }
+
+ private void transferArtifact(Object artifactModel, OutputStream destination) throws Exception {
+ if (artifactModel instanceof BundleInfo bundleInfo) {
+ URI location = bundleInfo.getLocation();
+ if (location == null) {
+ throw new FileNotFoundException(bundleInfo.getSymbolicName());
+ }
+ try (InputStream is = location.toURL().openStream()) {
+ is.transferTo(destination);
+ }
+ } else if (artifactModel instanceof IFeatureModel featureModel) {
+ String installLocation = featureModel.getInstallLocation();
+ if (installLocation != null) {
+ File featureJar = new File(installLocation);
+ if (featureJar.isFile()) {
+ Files.copy(featureJar.toPath(), destination);
+ return;
+ }
+ }
+ IFeature feature = featureModel.getFeature();
+ // Generate in-memory feature jar (with only the feature.xml)
+ JarOutputStream jos = new JarOutputStream(destination);
+ jos.putNextEntry(new JarEntry("feature.xml")); //$NON-NLS-1$
+ PrintWriter printWriter = new PrintWriter(jos);
+ feature.write("", printWriter); //$NON-NLS-1$
+ printWriter.flush();
+ jos.finish();
+ } else {
+ throw new IllegalArgumentException(artifactModel.toString());
+ }
+ }
+
+ @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.containsKey(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, "Perform Artifact Requests"); //$NON-NLS-1$
+ SubMonitor subMonitor = SubMonitor.convert(monitor, requests.length);
+ for (IArtifactRequest request : requests) {
+ request.perform(this, subMonitor.split(1));
+ multiStatus.add(request.getResult());
+ }
+ return multiStatus.isOK() ? Status.OK_STATUS : multiStatus;
+ }
+
+ @Override
+ public OutputStream getOutputStream(IArtifactDescriptor descriptor) throws ProvisionException {
+ throw new ProvisionException("Artifact repository must not be modified!"); //$NON-NLS-1$
+ }
+
+}

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/VirtualMetadataRepository.java

@@ -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 VirtualMetadataRepository extends AbstractMetadataRepository {
+ private final List<IInstallableUnit> installableUnits;
+
+ public VirtualMetadataRepository(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
+ }
+}

ui/org.eclipse.pde.ui.tests/META-INF/MANIFEST.MF

@@ -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,