Skip to content

Commit

Permalink
Remove attributes in PDE launch configurations instead of explicitly
Browse files Browse the repository at this point in the history 
setting them to their default values

The attributes in  question are:
- DESELECTED_WORKSPACE_BUNDLES --> []
- USE_CUSTOM_FEATURES --> false
- SHOW_SELECTED_ONLY --> false
- INCLUDE_OPTIONAL --> true
- AUTOMATIC_ADD --> true

The reason to do this is that 2 launch configurations are considered
different if one of them explicitly sets an attribute to its default
value (because it then has 1 more attribute)
  • Loading branch information
@fedejeanne
fedejeanne committed Apr 26, 2024
1 parent 62638c3 commit 1a7c452
Show file tree
Hide file tree
Showing 10 changed files with 70 additions and 30 deletions.
2 changes: 1 addition & 1 deletion ...lipse.pde.launching/src/org/eclipse/pde/launching/OSGiLaunchConfigurationInitializer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ protected void initializeBundleState(ILaunchConfigurationWorkingCopy configurati
}
configuration.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, workspaceBundles);
configuration.setAttribute(IPDELauncherConstants.SELECTED_TARGET_BUNDLES, targetBundles);
configuration.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
configuration.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
}

private boolean isSourceBundle(PDEState pdeState, IPluginModelBase model) {
Expand Down
22 changes: 11 additions & 11 deletions ui/org.eclipse.pde.ui.tests/src/org/eclipse/pde/ui/tests/launcher/PluginBasedLaunchTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public void testGetMergedBundleMap_mixedPluginsFromWorkspaceWithAutomaticAddAndT

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*1.0.0", "plugin.b"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*2.0.0", "plugin.c"));
wc.setAttribute(IPDELauncherConstants.SELECTED_TARGET_BUNDLES,
Set.of("plugin.x*2.0.0", "plugin.x*3.0.0", "plugin.y"));
Expand Down Expand Up @@ -371,7 +371,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_noDisabledPlug

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*1.0.0"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
};

Set<BundleLocationDescriptor> expectedBundles = Set.of( //
Expand All @@ -394,7 +394,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_singleVersionP

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*1.0.0"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, Set.of("plugin.c"));
};

Expand All @@ -417,7 +417,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_singleVersionP

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*1.0.0"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, Set.of("plugin.c*1.0.0"));
};

Expand Down Expand Up @@ -447,7 +447,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_multiVersionPl

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*1.0.0"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES,
Set.of("plugin.a*2.0.0", "plugin.a*4.0.0"));
};
Expand All @@ -471,7 +471,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_multiVersionPl

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of());
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES,
Set.of("plugin.a*1.0.0", "plugin.a*3.0.0"));
};
Expand All @@ -494,7 +494,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_multiVersionPl

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*2.0.0"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a"));
};

Expand All @@ -516,7 +516,7 @@ public void testGetMergedBundleMap_automaticAddedWorkspacePlugins_sameMMMVersion

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.SELECTED_WORKSPACE_BUNDLES, Set.of("plugin.a*1.0.0.202111250056"));
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
};

Set<BundleLocationDescriptor> expectedBundles = Set.of( //
Expand Down Expand Up @@ -777,7 +777,7 @@ public void testGetMergedBundleMap_workspacePluginAddedAutomaticallyAndTargetPlu
bundle("plugin.b", "1.0.1"));

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.SELECTED_TARGET_BUNDLES, Set.of("plugin.a", "plugin.b*1.0.1"));
};

Expand All @@ -799,7 +799,7 @@ public void testGetMergedBundleMap_workspacePluginAddedAutomaticallyAndTargetPlu
bundle("plugin.a", "1.0.0.202111102345"));

Consumer<ILaunchConfigurationWorkingCopy> launchConfigSetup = wc -> {
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
wc.setAttribute(IPDELauncherConstants.SELECTED_TARGET_BUNDLES, Set.of("plugin.a*1.0.0.202111102345"));
};

Expand Down Expand Up @@ -1044,7 +1044,7 @@ private static ILaunchConfigurationWorkingCopy createPluginLaunchConfig(String n
ILaunchConfigurationType type = launchManager.getLaunchConfigurationType("org.eclipse.pde.ui.RuntimeWorkbench");
ILaunchConfigurationWorkingCopy wc = type.newInstance(null, name);
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, false);
wc.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, false);
wc.removeAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES);
wc.setAttribute(IPDELauncherConstants.USE_DEFAULT, false);
return wc;
}
Expand Down
27 changes: 21 additions & 6 deletions ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/launcher/AbstractPluginBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -948,21 +948,36 @@ public void performApply(ILaunchConfigurationWorkingCopy config) {
config.setAttribute(IPDELauncherConstants.AUTOMATIC_INCLUDE_REQUIREMENTS, includeRequirements);
fAutoIncludeRequirementsButtonChanged = false;
}
config.setAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL, fIncludeOptionalButton.getSelection());
config.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, fAddWorkspaceButton.getSelection());
boolean includeOptional = fIncludeOptionalButton.getSelection();
if (!includeOptional) {
config.setAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL, false);
} else {
config.removeAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL);
}
boolean automaticAdd = fAddWorkspaceButton.getSelection();
if (!automaticAdd) {
config.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, false);
} else {
config.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
}
config.setAttribute(IPDELauncherConstants.AUTOMATIC_VALIDATE, fAutoValidate.getSelection());
config.setAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY, fFilterButton.getSelection());
boolean showSelectedOnly = fFilterButton.getSelection();
if (showSelectedOnly) {
config.setAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY, true);
} else {
config.removeAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY);
}
savePluginState(config);
updateCounter();
}

protected abstract void savePluginState(ILaunchConfigurationWorkingCopy config);

public void setDefaults(ILaunchConfigurationWorkingCopy config) {
config.setAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL, true);
config.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
config.removeAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL);
config.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
config.setAttribute(IPDELauncherConstants.AUTOMATIC_VALIDATE, true);
config.setAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY, false);
config.removeAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY);
}

public void enableViewer(boolean enable) {
Expand Down
9 changes: 7 additions & 2 deletions ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/launcher/FeatureBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,12 @@ public void performApply(ILaunchConfigurationWorkingCopy config) {
config.setAttribute(IPDELauncherConstants.AUTOMATIC_INCLUDE_REQUIREMENTS, includeRequirements);
fAutoIncludeRequirementsButtonChanged = false;
}
config.setAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY, fFilterButton.getSelection());
boolean showSelectedOnly = fFilterButton.getSelection();
if (showSelectedOnly) {
config.setAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY, true);
} else {
config.removeAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY);
}
config.setAttribute(IPDELauncherConstants.FEATURE_DEFAULT_LOCATION, fFeatureWorkspaceButton.getSelection() ? IPDELauncherConstants.LOCATION_WORKSPACE : IPDELauncherConstants.LOCATION_EXTERNAL);
config.setAttribute(IPDELauncherConstants.FEATURE_PLUGIN_RESOLUTION, fWorkspacePluginButton.getSelection() ? IPDELauncherConstants.LOCATION_WORKSPACE : IPDELauncherConstants.LOCATION_EXTERNAL);
config.setAttribute(IPDELauncherConstants.AUTOMATIC_VALIDATE, fAutoValidate.getSelection());
Expand Down Expand Up @@ -1256,7 +1261,7 @@ private void saveSortOrder() {
}

public void setDefaults(ILaunchConfigurationWorkingCopy config) {
config.setAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY, false);
config.removeAttribute(IPDELauncherConstants.SHOW_SELECTED_ONLY);
config.setAttribute(IPDELauncherConstants.FEATURE_DEFAULT_LOCATION, IPDELauncherConstants.LOCATION_WORKSPACE);
config.setAttribute(IPDELauncherConstants.FEATURE_PLUGIN_RESOLUTION, IPDELauncherConstants.LOCATION_WORKSPACE);
config.setAttribute(IPDELauncherConstants.AUTOMATIC_VALIDATE, true);
Expand Down
6 changes: 5 additions & 1 deletion ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/launcher/OSGiBundleBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,11 @@ protected void savePluginState(ILaunchConfigurationWorkingCopy config) {
}
}
}
config.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, buffer.getNameSet());
if (!buffer.getNameSet().isEmpty()) {
config.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, buffer.getNameSet());
} else {
config.removeAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES);
}
}

public void initializeFrom(ILaunchConfiguration configuration) throws CoreException {
Expand Down
7 changes: 6 additions & 1 deletion ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/launcher/OSGiFrameworkBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,12 @@ private void initializeFramework(ILaunchConfiguration config) throws CoreExcepti

public void performApply(ILaunchConfigurationWorkingCopy config) {
config.setAttribute(IPDELauncherConstants.USE_DEFAULT, fLaunchWithCombo.getSelectionIndex() == 0);
config.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, fLaunchWithCombo.getSelectionIndex() == 1);
boolean useCustomFeatures = fLaunchWithCombo.getSelectionIndex() == 1;
if (useCustomFeatures) {
config.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, true);
} else {
config.removeAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES);
}
config.setAttribute(IPDELauncherConstants.DEFAULT_AUTO_START, Boolean.toString(true).equals(fDefaultAutoStart.getText()));
config.setAttribute(IPDELauncherConstants.DEFAULT_START_LEVEL, fDefaultStartLevel.getSelection());

Expand Down
7 changes: 6 additions & 1 deletion ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/launcher/PluginBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,12 @@ protected void savePluginState(ILaunchConfigurationWorkingCopy config) {
}
}
}
config.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES, buffer.getNameSet());
if (!buffer.getNameSet().isEmpty()) {
config.setAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES,
buffer.getNameSet());
} else {
config.removeAttribute(IPDELauncherConstants.DESELECTED_WORKSPACE_BUNDLES);
}
}
}

Expand Down
2 changes: 1 addition & 1 deletion ui/org.eclipse.pde.ui/src/org/eclipse/pde/ui/launcher/EclipseLaunchShortcut.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ else if (TargetPlatformHelper.getTargetVersion() >= 3.2)
wc.setAttribute(IPDELauncherConstants.USE_PRODUCT, true);
wc.setAttribute(IPDELauncherConstants.PRODUCT, product);
}
wc.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true);
wc.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD);
} else {
String defaultProduct = TargetPlatform.getDefaultProduct();
if (defaultProduct != null) {
Expand Down
6 changes: 3 additions & 3 deletions ui/org.eclipse.pde.ui/src/org/eclipse/pde/ui/launcher/JUnitWorkbenchLaunchShortcut.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ protected ILaunchConfigurationWorkingCopy createLaunchConfiguration(IJavaElement
// Plug-ins to launch
configuration.setAttribute(IPDELauncherConstants.USE_DEFAULT, true);
configuration.setAttribute(IPDELauncherConstants.AUTOMATIC_VALIDATE, false);
configuration.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, false); // ignored
configuration.setAttribute(IPDELauncherConstants.AUTOMATIC_ADD, true); // ignored
configuration.setAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL, true); // ignored
configuration.removeAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES);
configuration.removeAttribute(IPDELauncherConstants.AUTOMATIC_ADD); // ignored
configuration.removeAttribute(IPDELauncherConstants.INCLUDE_OPTIONAL);

// Program arguments
String programArgs = LaunchArgumentsHelper.getInitialProgramArguments();
Expand Down
12 changes: 9 additions & 3 deletions ui/org.eclipse.pde.ui/src/org/eclipse/pde/ui/launcher/PluginsTab.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ public void createControl(Composite parent) {
@Override
public void initializeFrom(ILaunchConfiguration configuration) {
// Long-running initialization happens on first activation of this tab
System.out.println("PluginsTab.initializeFrom()");

Check warning on line 161 in ui/org.eclipse.pde.ui/src/org/eclipse/pde/ui/launcher/PluginsTab.java

View check run for this annotation

Jenkins - eclipse-pde / Compiler and API Tools

NLS 

NORMAL:
$
Non-externalized string literal; it should be followed by //$NON-NLS-
}

@Override
Expand Down Expand Up @@ -193,7 +194,7 @@ public void activated(ILaunchConfigurationWorkingCopy configuration) {
@Override
public void setDefaults(ILaunchConfigurationWorkingCopy configuration) {
configuration.setAttribute(IPDELauncherConstants.USE_DEFAULT, true);
configuration.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, false);
configuration.removeAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES);
fBlock.setDefaults(configuration);
}

Expand All @@ -204,8 +205,13 @@ public void performApply(ILaunchConfigurationWorkingCopy configuration) {
}
int index = fSelectionCombo.getSelectionIndex();
configuration.setAttribute(IPDELauncherConstants.USE_DEFAULT, index == DEFAULT_SELECTION);
configuration.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, index == FEATURE_SELECTION);
fBlock.performApply(configuration);
boolean useCustomFeatures = index == FEATURE_SELECTION;
if (useCustomFeatures) {
configuration.setAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES, true);
} else {
configuration.removeAttribute(IPDELauncherConstants.USE_CUSTOM_FEATURES);
}
fBlock.performApply(configuration);
// clear default values for auto-start and start-level if default
String autoText = fDefaultAutoStart.getText();
if (Boolean.toString(false).equals(autoText)) {
Expand Down

0 comments on commit 1a7c452

Please sign in to comment.