Skip to content

Commit

Permalink
Unify Constants and modernize CollectAction
Browse files Browse the repository at this point in the history 
Currently CollectAction and Collect (Phase) both use a parameter
'artifactRequests' but both define them separately.

This unify the access to the constant and modernize the CollectAction to
use collections instead of raw arrays.
  • Loading branch information
@laeubi
laeubi committed Apr 23, 2024
1 parent ef2ce2f commit 35235b0
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 29 deletions.
3 changes: 2 additions & 1 deletion ...se.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/InstallableUnitPhase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
*
* Contributors:
* IBM Corporation - initial API and implementation
* WindRiver - https://bugs.eclipse.org/bugs/show_bug.cgi?id=227372
Expand All @@ -25,6 +25,7 @@ public abstract class InstallableUnitPhase extends Phase {
public static final String PARM_ARTIFACT = "artifact"; //$NON-NLS-1$
public static final String PARM_IU = "iu"; //$NON-NLS-1$
public static final String PARM_INSTALL_FOLDER = "installFolder"; //$NON-NLS-1$
public static final String PARM_ARTIFACT_REQUESTS = "artifactRequests"; //$NON-NLS-1$

protected InstallableUnitPhase(String phaseId, int weight, boolean forced) {
super(phaseId, weight, forced);
Expand Down
2 changes: 1 addition & 1 deletion ....eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Collect.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* The goal of the collect phase is to ask the touchpoints if the artifacts associated with an IU need to be downloaded.
*/
public class Collect extends InstallableUnitPhase {
public static final String PARM_ARTIFACT_REQUESTS = "artifactRequests"; //$NON-NLS-1$

public static final String NO_ARTIFACT_REPOSITORIES_AVAILABLE = "noArtifactRepositoriesAvailable"; //$NON-NLS-1$
private static final String PARM_IUS = "ius"; //$NON-NLS-1$
private IProvisioningAgent agent = null;
Expand Down
4 changes: 2 additions & 2 deletions ...g.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Sizing.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ protected String getProblemMessage() {
@Override
protected IStatus completePhase(IProgressMonitor monitor, IProfile profile, Map<String, Object> parameters) {
@SuppressWarnings("unchecked")
List<IArtifactRequest[]> artifactRequests = (List<IArtifactRequest[]>) parameters.get(Collect.PARM_ARTIFACT_REQUESTS);
List<IArtifactRequest[]> artifactRequests = (List<IArtifactRequest[]>) parameters.get(PARM_ARTIFACT_REQUESTS);
ProvisioningContext context = (ProvisioningContext) parameters.get(PARM_CONTEXT);
int statusCode = 0;

Expand Down Expand Up @@ -131,7 +131,7 @@ protected IStatus completePhase(IProgressMonitor monitor, IProfile profile, Map<

@Override
protected IStatus initializePhase(IProgressMonitor monitor, IProfile profile, Map<String, Object> parameters) {
parameters.put(Collect.PARM_ARTIFACT_REQUESTS, new ArrayList<>());
parameters.put(PARM_ARTIFACT_REQUESTS, new ArrayList<>());
return null;
}

Expand Down
7 changes: 4 additions & 3 deletions ...uinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/eclipse/CollectActionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import java.util.List;
import java.util.Map;
import org.eclipse.equinox.internal.p2.engine.InstallableUnitOperand;
import org.eclipse.equinox.internal.p2.engine.phases.Collect;
import org.eclipse.equinox.internal.p2.engine.InstallableUnitPhase;
import org.eclipse.equinox.internal.p2.touchpoint.eclipse.EclipseTouchpoint;
import org.eclipse.equinox.internal.p2.touchpoint.eclipse.Util;
import org.eclipse.equinox.internal.p2.touchpoint.eclipse.actions.ActionConstants;
Expand Down Expand Up @@ -69,15 +69,16 @@ public void testExecuteUndo() throws Exception {
Map<String, Object> parameters = new HashMap<>();
parameters.put(ActionConstants.PARM_AGENT, getAgent());
parameters.put(ActionConstants.PARM_PROFILE, profile);
parameters.put(Collect.PARM_ARTIFACT_REQUESTS, new ArrayList<>());
parameters.put(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS, new ArrayList<>());
EclipseTouchpoint touchpoint = new EclipseTouchpoint();
touchpoint.initializePhase(null, profile, "test", parameters);
InstallableUnitOperand operand = new InstallableUnitOperand(null, iu);
parameters.put("iu", operand.second());
touchpoint.initializeOperand(profile, parameters);
parameters = Collections.unmodifiableMap(parameters);

List<IArtifactRequest[]> requests = (List<IArtifactRequest[]>) parameters.get(Collect.PARM_ARTIFACT_REQUESTS);
List<IArtifactRequest[]> requests = (List<IArtifactRequest[]>) parameters
.get(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS);
assertFalse(hasRequest(requests, key));
CollectAction action = new CollectAction();
action.execute(parameters);
Expand Down
7 changes: 4 additions & 3 deletions ...uinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/natives/CollectActionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.equinox.internal.p2.engine.phases.Collect;
import org.eclipse.equinox.internal.p2.engine.InstallableUnitPhase;
import org.eclipse.equinox.internal.p2.touchpoint.natives.NativeTouchpoint;
import org.eclipse.equinox.internal.p2.touchpoint.natives.actions.ActionConstants;
import org.eclipse.equinox.internal.p2.touchpoint.natives.actions.CollectAction;
Expand Down Expand Up @@ -63,14 +63,15 @@ public void testExecuteUndo() {
Map<String, Object> parameters = new HashMap<>();
parameters.put(ActionConstants.PARM_AGENT, getAgent());
parameters.put(ActionConstants.PARM_PROFILE, profile);
parameters.put(Collect.PARM_ARTIFACT_REQUESTS, new ArrayList<>());
parameters.put(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS, new ArrayList<>());
NativeTouchpoint touchpoint = new NativeTouchpoint();
touchpoint.initializePhase(null, profile, "test", parameters);
parameters.put("iu", iu);
touchpoint.initializeOperand(profile, parameters);
parameters = Collections.unmodifiableMap(parameters);

List<IArtifactRequest[]> requests = (List<IArtifactRequest[]>) parameters.get(Collect.PARM_ARTIFACT_REQUESTS);
List<IArtifactRequest[]> requests = (List<IArtifactRequest[]>) parameters
.get(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS);
assertFalse(hasRequest(requests, key));
CollectAction action = new CollectAction();
action.execute(parameters);
Expand Down
1 change: 0 additions & 1 deletion ...tives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/ActionConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ public class ActionConstants {
public static final String PARM_IU = "iu"; //$NON-NLS-1$
public static final String PIPE = "|"; //$NON-NLS-1$
public static final String PARM_AT_ARTIFACT = "@artifact"; //$NON-NLS-1$
public static final String PARM_ARTIFACT_REQUESTS = "artifactRequests"; //$NON-NLS-1$
public static final String PARM_PROFILE = "profile"; //$NON-NLS-1$
public static final String PARM_LINK_NAME = "linkName"; //$NON-NLS-1$
public static final String PARM_LINK_TARGET = "linkTarget"; //$NON-NLS-1$
Expand Down
38 changes: 20 additions & 18 deletions ...natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/CollectAction.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
*******************************************************************************/
package org.eclipse.equinox.internal.p2.touchpoint.natives.actions;

import java.util.Collection;
import java.util.Map;
import java.util.*;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.equinox.internal.p2.engine.InstallableUnitPhase;
import org.eclipse.equinox.internal.p2.touchpoint.natives.Util;
import org.eclipse.equinox.p2.core.IProvisioningAgent;
import org.eclipse.equinox.p2.core.ProvisionException;
Expand All @@ -37,10 +37,13 @@ public IStatus execute(Map<String, Object> parameters) {
IProvisioningAgent agent = (IProvisioningAgent) parameters.get(ActionConstants.PARM_AGENT);
IInstallableUnit iu = (IInstallableUnit) parameters.get(ActionConstants.PARM_IU);
try {
IArtifactRequest[] requests = collect(agent, iu, profile);
@SuppressWarnings("unchecked")
Collection<IArtifactRequest[]> artifactRequests = (Collection<IArtifactRequest[]>) parameters.get(ActionConstants.PARM_ARTIFACT_REQUESTS);
artifactRequests.add(requests);
List<IArtifactRequest> requests = collect(agent, iu, profile);
if (!requests.isEmpty()) {
@SuppressWarnings("unchecked")
Collection<IArtifactRequest[]> artifactRequests = (Collection<IArtifactRequest[]>) parameters
.get(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS);
artifactRequests.add(requests.toArray(IArtifactRequest[]::new));
}
} catch (ProvisionException e) {
return e.getStatus();
}
Expand All @@ -53,22 +56,21 @@ public IStatus undo(Map<String, Object> parameters) {
return Status.OK_STATUS;
}

IArtifactRequest[] collect(IProvisioningAgent agent, IInstallableUnit installableUnit, IProfile profile) throws ProvisionException {
private List<IArtifactRequest> collect(IProvisioningAgent agent, IInstallableUnit installableUnit, IProfile profile)
throws ProvisionException {
Collection<IArtifactKey> toDownload = installableUnit.getArtifacts();
if (toDownload == null)
return new IArtifactRequest[0];
if (toDownload == null || toDownload.isEmpty()) {
return List.of();
}
IArtifactRepository destination = Util.getDownloadCacheRepo(agent);
IArtifactRequest[] requests = new IArtifactRequest[toDownload.size()];
int count = 0;
List<IArtifactRequest> requests = new ArrayList<>(toDownload.size());
for (IArtifactKey key : toDownload) {
//TODO Here there are cases where the download is not necessary again because what needs to be done is just a configuration step
requests[count++] = Util.getArtifactRepositoryManager(agent).createMirrorRequest(key, destination, null, null, profile.getProperty(IProfile.PROP_STATS_PARAMETERS));
// TODO Here there are cases where the download is not necessary again because
// what needs to be done is just a configuration step
requests.add(Util.getArtifactRepositoryManager(agent).createMirrorRequest(key, destination, null, null,
profile.getProperty(IProfile.PROP_STATS_PARAMETERS)));
}

if (requests.length == count)
return requests;
IArtifactRequest[] result = new IArtifactRequest[count];
System.arraycopy(requests, 0, result, 0, count);
return result;
return requests;
}
}

0 comments on commit 35235b0

Please sign in to comment.