#2097: Configure Ide Plugins in the GUI #2150
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,7 +52,7 @@ protected String getBinaryName() { | |
| } | ||
|
|
||
| @Override | ||
| public Path getPluginsConfigPath() { | ||
|
|
||
| if (EDITION_VSCODIUM.equals(getConfiguredEdition())) { | ||
| Path vscodiumPluginsPath = this.context.getSettingsPath().resolve(EDITION_VSCODIUM).resolve(IdeContext.FOLDER_PLUGINS); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ | |
| import java.nio.file.Path; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Properties; | ||
| import java.util.Set; | ||
|
|
||
| import org.junit.jupiter.api.BeforeAll; | ||
|
|
@@ -62,17 +63,18 @@ void testGetPluginsMap() { | |
| void testInstallPluginsWithForce() { | ||
|
|
||
| //arrange | ||
| IdeTestContext localContext = newContext(PROJECT_BASIC, null, true); | ||
| localContext.getStartContext().setForcePlugins(true); | ||
| final ExamplePluginBasedCommandlet pluginBasedCommandlet = new ExamplePluginBasedCommandlet(localContext, TOOL, tags); | ||
|
|
||
| //act | ||
| pluginBasedCommandlet.installPlugins( | ||
| List.of(ToolPluginDescriptor.of(localContext.getSettingsPath().resolve(ANY_EDIT_PLUGIN_PATH), localContext, false)), | ||
| new ProcessContextTestImpl(localContext)); | ||
|
|
||
| //assert - Check if we skip the markerfile-check because we force the plugins to install | ||
| assertThat(localContext).logAtSuccess().hasMessage("Successfully ended step 'Install plugin anyedit'."); | ||
| assertThat(localContext).log().hasNoMessageContaining("Skipping installation of plugin '{}' due to existing marker file: "); | ||
| } | ||
|
|
||
| @Test | ||
|
|
@@ -101,6 +103,69 @@ void testMarkerFileContainsVersionSegment() { | |
| assertThat(markerFilePath.getFileName().toString()).contains("plugin-name.version-1.2.3_build_4"); | ||
| } | ||
|
|
||
| @Test | ||
| void testIsPluginUrlNeeded_returnsFalseByDefault() { | ||
|
|
||
| ExamplePluginBasedCommandlet commandlet = new ExamplePluginBasedCommandlet(context, TOOL, null); | ||
|
|
||
| assertThat(commandlet.isPluginUrlNeeded()).isFalse(); | ||
| } | ||
|
|
||
| @Test | ||
| void testCreatePlugin_createsPropertiesFileWithActiveTrue() throws IOException { | ||
|
|
||
| IdeTestContext localContext = newContext(PROJECT_BASIC, null, false); | ||
| ExamplePluginBasedCommandlet commandlet = new ExamplePluginBasedCommandlet(localContext, TOOL, null); | ||
|
|
||
| ToolPluginDescriptor result = commandlet.createPlugin("create-basic-plugin", "com.example.basic", null, null); | ||
|
|
||
| assertThat(result.name()).isEqualTo("create-basic-plugin"); | ||
| assertThat(result.id()).isEqualTo("com.example.basic"); | ||
| assertThat(result.active()).isTrue(); | ||
|
|
||
| Path pluginFile = commandlet.getPluginsConfigPath().resolve("create-basic-plugin.properties"); | ||
| assertThat(pluginFile).exists(); | ||
| Properties props = new Properties(); | ||
| try (var in = Files.newInputStream(pluginFile)) { | ||
| props.load(in); | ||
| } | ||
| assertThat(props.getProperty("active")).isEqualTo("true"); | ||
| assertThat(props.getProperty("id")).isEqualTo("com.example.basic"); | ||
| assertThat(props.containsKey("url")).isFalse(); | ||
| assertThat(props.containsKey("tags")).isFalse(); | ||
| } | ||
|
|
||
| @Test | ||
| void testCreatePlugin_writesUrlAndTagsWhenProvided() throws IOException { | ||
|
|
||
| IdeTestContext localContext = newContext(PROJECT_BASIC, null, false); | ||
| ExamplePluginBasedCommandlet commandlet = new ExamplePluginBasedCommandlet(localContext, TOOL, null); | ||
|
|
||
| commandlet.createPlugin("create-full-plugin", "com.example.full", "https://example.com/update", "java,ide"); | ||
|
|
||
| Path pluginFile = commandlet.getPluginsConfigPath().resolve("create-full-plugin.properties"); | ||
| Properties props = new Properties(); | ||
| try (var in = Files.newInputStream(pluginFile)) { | ||
| props.load(in); | ||
| } | ||
| assertThat(props.getProperty("url")).isEqualTo("https://example.com/update"); | ||
| assertThat(props.getProperty("tags")).isEqualTo("java,ide"); | ||
| } | ||
|
|
||
| @Test | ||
| void testCreatePlugin_clearsCacheSoNewPluginAppearsInGetPlugins() { | ||
|
|
||
| IdeTestContext localContext = newContext(PROJECT_BASIC, null, true); | ||
| ExamplePluginBasedCommandlet commandlet = new ExamplePluginBasedCommandlet(localContext, TOOL, null); | ||
|
|
||
| assertThat(commandlet.getPlugins().getByName("create-cache-plugin")).isNull(); | ||
|
|
||
| commandlet.createPlugin("create-cache-plugin", "com.example.cache", null, null); | ||
|
|
||
| assertThat(commandlet.getPlugins().getByName("create-cache-plugin")).isNotNull(); | ||
| assertThat(commandlet.getPlugins().getByName("create-cache-plugin").active()).isTrue(); | ||
| } | ||
|
|
||
| @Test | ||
| void testCreatePluginMarkerFileDeletesOtherVersionMarkers() { | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,8 +7,13 @@ | |
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import javafx.fxml.FXML; | ||
| import javafx.fxml.FXMLLoader; | ||
| import javafx.scene.Parent; | ||
| import javafx.scene.control.Button; | ||
| import javafx.scene.control.ComboBox; | ||
| import javafx.scene.control.Tab; | ||
| import javafx.scene.control.TabPane; | ||
| import javafx.scene.control.Tooltip; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
@@ -17,6 +22,7 @@ | |
| import com.devonfw.ide.gui.context.ProjectManager; | ||
| import com.devonfw.ide.gui.modal.IdeDialog; | ||
| import com.devonfw.ide.gui.nls.NlsService; | ||
| import com.devonfw.ide.gui.settings.ToolSettingsController; | ||
|
|
||
| /** | ||
| * Controller of the main screen of the dashboard GUI. | ||
|
|
@@ -49,6 +55,15 @@ public class MainController { | |
| @FXML | ||
| private Button vsCodeOpen; | ||
|
|
||
| @FXML | ||
| private TabPane tabPane; | ||
|
|
||
| @FXML | ||
| private Tab mainTab; | ||
|
|
||
| @FXML | ||
| private Tab toolConfigTab; | ||
|
|
||
| private final String directoryPath; | ||
|
|
||
| private final Map<String, Locale> languageMap; | ||
|
|
@@ -73,6 +88,13 @@ public MainController(String directoryPath, NlsService nlsService) { | |
| private void initialize() { | ||
| setProjectsComboBox(); | ||
| initLanguageComboBox(); | ||
| toolConfigTab.setDisable(true); | ||
| toolConfigTab.setTooltip(new Tooltip(nlsService.get("toolConfigDisabled"))); | ||
| tabPane.getSelectionModel().selectedItemProperty().addListener((obs, oldTab, newTab) -> { | ||
| if (newTab == toolConfigTab) { | ||
| loadToolConfigContent(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| private void initLanguageComboBox() { | ||
|
|
@@ -148,7 +170,6 @@ private void openVsCode() { | |
| openIDE("vscode"); | ||
| } | ||
|
|
||
| private void setProjectsComboBox() { | ||
|
|
||
| assert (directoryPath != null) : "directoryPath is null! Please check the setup of your environment variables (IDE_ROOT)"; | ||
|
|
@@ -163,6 +184,7 @@ private void setProjectsComboBox() { | |
| setWorkspaceComboBox(); | ||
|
|
||
| selectedWorkspace.setDisable(false); | ||
|
|
||
| }); | ||
| } | ||
|
|
||
|
|
@@ -185,9 +207,24 @@ private void setWorkspaceComboBox() { | |
| eclipseOpen.setDisable(false); | ||
| intellijOpen.setDisable(false); | ||
| vsCodeOpen.setDisable(false); | ||
| toolConfigTab.setDisable(false); | ||
| // If tool config is already open, reload it to reflect the new context | ||
| if (toolConfigTab.isSelected()) { | ||
| loadToolConfigContent(); | ||
| } | ||
| // Pre-warm ide-urls git repo in background so the first open is fast | ||
| Thread preWarm = new Thread(() -> { | ||
| try { | ||
| IdeGuiStateManager.getInstance().getCurrentContext().getUrls(); | ||
| } catch (Exception ignored) { | ||
| } | ||
| }); | ||
| preWarm.setDaemon(true); | ||
| preWarm.start(); | ||
| }); | ||
| } | ||
|
|
||
|
|
||
| private void openIDE(String inIde) { | ||
|
|
||
| IdeGuiStateManager | ||
|
|
@@ -198,6 +235,22 @@ private void openIDE(String inIde) { | |
| .run(); | ||
| } | ||
|
|
||
| private void loadToolConfigContent() { | ||
|
|
||
| try { | ||
| ToolSettingsController controller = new ToolSettingsController(nlsService); | ||
| FXMLLoader loader = new FXMLLoader(getClass().getResource("/com/devonfw/ide/gui/tools-config.fxml")); | ||
| loader.setController(controller); | ||
| loader.setResources(nlsService.getResourceBundle()); | ||
| Parent content = loader.load(); | ||
| controller.setOnClose(() -> tabPane.getSelectionModel().select(mainTab)); | ||
| toolConfigTab.setContent(content); | ||
| } catch (Exception e) { | ||
| LOG.error("Failed to load tool config view", e); | ||
| new IdeDialog(IdeDialog.AlertType.ERROR, e.getMessage()).showAndWait(); | ||
| } | ||
| } | ||
|
|
||
| private void updateContext(String selectedProjectName, String selectedWorkspaceName) { | ||
| try { | ||
| IdeGuiStateManager.getInstance().switchContext(selectedProjectName, selectedWorkspaceName); | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optional suggestion: consider checking if a plugin with the same name already exists before creating it. Otherwise, adding the same plugin multiple times can temporarily result in duplicate entries being shown in the UI.