From ecb0cdb9f7f2fe331a2ddd19400e8dd22aa1a98d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= Date: Tue, 23 Apr 2024 08:58:23 +0200 Subject: [PATCH] Unify Constants and modernize CollectAction 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. --- .../p2/engine/InstallableUnitPhase.java | 3 +- .../internal/p2/engine/phases/Collect.java | 2 +- .../internal/p2/engine/phases/Sizing.java | 4 +- .../touchpoint/eclipse/CollectActionTest.java | 7 ++-- .../touchpoint/natives/CollectActionTest.java | 7 ++-- .../natives/actions/ActionConstants.java | 1 - .../natives/actions/CollectAction.java | 42 ++++++++++--------- 7 files changed, 35 insertions(+), 31 deletions(-) diff --git a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/InstallableUnitPhase.java b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/InstallableUnitPhase.java index 3195109c43..7f29e5f006 100644 --- a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/InstallableUnitPhase.java +++ b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/InstallableUnitPhase.java @@ -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 @@ -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); diff --git a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Collect.java b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Collect.java index 0c2237675d..f6ee4da29b 100644 --- a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Collect.java +++ b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Collect.java @@ -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; diff --git a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Sizing.java b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Sizing.java index dc7c2e8915..f037699f09 100644 --- a/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Sizing.java +++ b/bundles/org.eclipse.equinox.p2.engine/src/org/eclipse/equinox/internal/p2/engine/phases/Sizing.java @@ -77,7 +77,7 @@ protected String getProblemMessage() { @Override protected IStatus completePhase(IProgressMonitor monitor, IProfile profile, Map parameters) { @SuppressWarnings("unchecked") - List artifactRequests = (List) parameters.get(Collect.PARM_ARTIFACT_REQUESTS); + List artifactRequests = (List) parameters.get(PARM_ARTIFACT_REQUESTS); ProvisioningContext context = (ProvisioningContext) parameters.get(PARM_CONTEXT); int statusCode = 0; @@ -131,7 +131,7 @@ protected IStatus completePhase(IProgressMonitor monitor, IProfile profile, Map< @Override protected IStatus initializePhase(IProgressMonitor monitor, IProfile profile, Map parameters) { - parameters.put(Collect.PARM_ARTIFACT_REQUESTS, new ArrayList<>()); + parameters.put(PARM_ARTIFACT_REQUESTS, new ArrayList<>()); return null; } diff --git a/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/eclipse/CollectActionTest.java b/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/eclipse/CollectActionTest.java index 012d4e4c71..b709c7084f 100644 --- a/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/eclipse/CollectActionTest.java +++ b/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/eclipse/CollectActionTest.java @@ -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; @@ -69,7 +69,7 @@ public void testExecuteUndo() throws Exception { Map 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); @@ -77,7 +77,8 @@ public void testExecuteUndo() throws Exception { touchpoint.initializeOperand(profile, parameters); parameters = Collections.unmodifiableMap(parameters); - List requests = (List) parameters.get(Collect.PARM_ARTIFACT_REQUESTS); + List requests = (List) parameters + .get(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS); assertFalse(hasRequest(requests, key)); CollectAction action = new CollectAction(); action.execute(parameters); diff --git a/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/natives/CollectActionTest.java b/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/natives/CollectActionTest.java index d50699f287..8e0493ca7e 100644 --- a/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/natives/CollectActionTest.java +++ b/bundles/org.eclipse.equinox.p2.tests/src/org/eclipse/equinox/p2/tests/touchpoint/natives/CollectActionTest.java @@ -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; @@ -63,14 +63,15 @@ public void testExecuteUndo() { Map 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 requests = (List) parameters.get(Collect.PARM_ARTIFACT_REQUESTS); + List requests = (List) parameters + .get(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS); assertFalse(hasRequest(requests, key)); CollectAction action = new CollectAction(); action.execute(parameters); diff --git a/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/ActionConstants.java b/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/ActionConstants.java index 07d45bb433..6055e0c3f0 100644 --- a/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/ActionConstants.java +++ b/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/ActionConstants.java @@ -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$ diff --git a/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/CollectAction.java b/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/CollectAction.java index 88bccfb7eb..8de3b9ce25 100644 --- a/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/CollectAction.java +++ b/bundles/org.eclipse.equinox.p2.touchpoint.natives/src/org/eclipse/equinox/internal/p2/touchpoint/natives/actions/CollectAction.java @@ -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; @@ -24,8 +24,7 @@ import org.eclipse.equinox.p2.engine.spi.ProvisioningAction; import org.eclipse.equinox.p2.metadata.IArtifactKey; import org.eclipse.equinox.p2.metadata.IInstallableUnit; -import org.eclipse.equinox.p2.repository.artifact.IArtifactRepository; -import org.eclipse.equinox.p2.repository.artifact.IArtifactRequest; +import org.eclipse.equinox.p2.repository.artifact.*; public class CollectAction extends ProvisioningAction { @@ -37,10 +36,13 @@ public IStatus execute(Map 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 artifactRequests = (Collection) parameters.get(ActionConstants.PARM_ARTIFACT_REQUESTS); - artifactRequests.add(requests); + List requests = collect(agent, iu, profile); + if (!requests.isEmpty()) { + @SuppressWarnings("unchecked") + Collection artifactRequests = (Collection) parameters + .get(InstallableUnitPhase.PARM_ARTIFACT_REQUESTS); + artifactRequests.add(requests.toArray(IArtifactRequest[]::new)); + } } catch (ProvisionException e) { return e.getStatus(); } @@ -53,22 +55,22 @@ public IStatus undo(Map parameters) { return Status.OK_STATUS; } - IArtifactRequest[] collect(IProvisioningAgent agent, IInstallableUnit installableUnit, IProfile profile) throws ProvisionException { + private List collect(IProvisioningAgent agent, IInstallableUnit installableUnit, IProfile profile) + throws ProvisionException { Collection 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; + IArtifactRepositoryManager manager = Util.getArtifactRepositoryManager(agent); + List 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(manager.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; } } \ No newline at end of file