#142 and #94: Plugin based commandlet feature and PluginBasedCommandlet #153
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -15,4 +15,4 @@ jobs: | |
| - name: Build project with Maven | ||
| run: mvn -B -ntp -Dstyle.color=always install | ||
| - name: Coveralls GitHub Action | ||
| uses: coverallsapp/[email protected] | ||
This file contains 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 |
|---|---|---|
|
|
@@ -24,4 +24,4 @@ jobs: | |
| SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} | ||
| run: mvn --settings .mvn/settings.xml -DskipTests=true -Darchetype.test.skip=true -Dmaven.install.skip=true -Dstyle.color=always -B -ntp deploy | ||
| - name: Coveralls GitHub Action | ||
| uses: coverallsapp/[email protected] | ||
This file contains 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 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 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 |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| package com.devonfw.tools.ide.tool; | ||
|
|
||
| import com.devonfw.tools.ide.common.Tag; | ||
| import com.devonfw.tools.ide.cli.CliException; | ||
| import com.devonfw.tools.ide.context.IdeContext; | ||
| import com.devonfw.tools.ide.io.FileAccess; | ||
| import com.devonfw.tools.ide.tool.ide.IdeToolCommandlet; | ||
| import com.devonfw.tools.ide.tool.ide.PluginDescriptor; | ||
| import com.devonfw.tools.ide.tool.ide.PluginDescriptorImpl; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.*; | ||
|
There was a problem hiding this comment. your IDE settings are outdated/incorrect. Star-Imports are discouraged. According to our IDE settings this should also be auto-configured correctly for Intellij (maybe ask @jan-vcapgemini if it is not working for you) and for Eclipse it was correct from the beginning. |
||
| import java.util.stream.Stream; | ||
|
|
||
| public abstract class PluginBasedCommandlet extends LocalToolCommandlet { | ||
|
|
||
| private Map<String, PluginDescriptor> pluginsMap; | ||
|
|
||
| private Collection<PluginDescriptor> configuredPlugins; | ||
|
|
||
| /** | ||
| * The constructor. | ||
| * | ||
| * @param context the {@link IdeContext}. | ||
| * @param tool the {@link #getName() tool name}. | ||
| * @param tags the {@link #getTags() tags} classifying the tool. Should be created via {@link Set#of(Object) Set.of} | ||
| * method. | ||
| */ | ||
| public PluginBasedCommandlet(IdeContext context, String tool, Set<Tag> tags) { | ||
|
|
||
| super(context, tool, tags); | ||
| } | ||
|
|
||
|
|
||
| protected Map<String, PluginDescriptor> getPluginsMap() { | ||
|
|
||
| if (this.pluginsMap == null) { | ||
| Map<String, PluginDescriptor> map = new HashMap<>(); | ||
|
|
||
| // Load project-specific plugins | ||
| Path pluginsPath = getPluginsConfigPath(); | ||
| loadPluginsFromDirectory(map, pluginsPath); | ||
|
|
||
| // Load user-specific plugins | ||
| Path userPluginsPath = getUserHomePluginsConfigPath(); | ||
| loadPluginsFromDirectory(map, userPluginsPath); | ||
|
|
||
| this.pluginsMap = map; | ||
| } | ||
|
|
||
| return this.pluginsMap; | ||
| } | ||
|
|
||
| private void loadPluginsFromDirectory(Map<String, PluginDescriptor> map, Path pluginsPath) { | ||
| if (Files.isDirectory(pluginsPath)) { | ||
| try (Stream<Path> childStream = Files.list(pluginsPath)) { | ||
| Iterator<Path> iterator = childStream.iterator(); | ||
| while (iterator.hasNext()) { | ||
| Path child = iterator.next(); | ||
| String filename = child.getFileName().toString(); | ||
| if (filename.endsWith(IdeContext.EXT_PROPERTIES) && Files.exists(child)) { | ||
| PluginDescriptor descriptor = PluginDescriptorImpl.of(child, this.context, isPluginUrlNeeded()); | ||
|
|
||
| // Priority to user-specific plugins | ||
| map.put(descriptor.getName(), descriptor); | ||
| } | ||
| } | ||
| } catch (IOException e) { | ||
| throw new IllegalStateException("Failed to list children of directory " + pluginsPath, e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return {@code true} if {@link PluginDescriptor#getUrl() plugin URL} property is needed, {@code false} otherwise. | ||
| */ | ||
| protected boolean isPluginUrlNeeded() { | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| protected Path getPluginsConfigPath() { | ||
|
|
||
| return this.context.getSettingsPath().resolve(this.tool).resolve(IdeContext.FOLDER_PLUGINS); | ||
| } | ||
|
|
||
| private Path getUserHomePluginsConfigPath() { | ||
|
|
||
| return context.getUserHome().resolve(Paths.get(".ide", "settings", this.tool, IdeContext.FOLDER_PLUGINS)); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @return the immutable {@link Collection} of {@link PluginDescriptor}s configured for this IDE tool. | ||
| */ | ||
| public Collection<PluginDescriptor> getConfiguredPlugins() { | ||
|
|
||
| if (this.configuredPlugins == null) { | ||
| this.configuredPlugins = Collections.unmodifiableCollection(getPluginsMap().values()); | ||
| } | ||
| return this.configuredPlugins; | ||
| } | ||
|
|
||
| /** | ||
| * @return the {@link Path} where the plugins of this {@link IdeToolCommandlet} shall be installed. | ||
| */ | ||
| public Path getPluginsInstallationPath() { | ||
|
|
||
| return this.context.getPluginsPath().resolve(this.tool); | ||
| } | ||
|
|
||
| /** | ||
| * @param plugin the {@link PluginDescriptor} to install. | ||
| */ | ||
| public abstract void installPlugin(PluginDescriptor plugin); | ||
|
|
||
| /** | ||
| * @param plugin the {@link PluginDescriptor} to uninstall. | ||
| */ | ||
| public void uninstallPlugin(PluginDescriptor plugin) { | ||
|
|
||
| Path pluginsPath = getPluginsInstallationPath(); | ||
| if (!Files.isDirectory(pluginsPath)) { | ||
| this.context.debug("Omitting to uninstall plugin {} ({}) as plugins folder does not exist at {}", | ||
| plugin.getName(), plugin.getId(), pluginsPath); | ||
| return; | ||
| } | ||
| FileAccess fileAccess = this.context.getFileAccess(); | ||
| Path match = fileAccess.findFirst(pluginsPath, p -> p.getFileName().toString().startsWith(plugin.getId()), false); | ||
| if (match == null) { | ||
| this.context.debug("Omitting to uninstall plugin {} ({}) as plugins folder does not contain a match at {}", | ||
| plugin.getName(), plugin.getId(), pluginsPath); | ||
| return; | ||
| } | ||
| fileAccess.delete(match); | ||
| } | ||
|
|
||
| /** | ||
| * @param key the filename of the properties file configuring the requested plugin (typically excluding the | ||
| * ".properties" extension). | ||
| * @return the {@link PluginDescriptor} for the given {@code key}. | ||
| */ | ||
| public PluginDescriptor getPlugin(String key) { | ||
|
|
||
| if (key == null) { | ||
| return null; | ||
| } | ||
| if (key.endsWith(IdeContext.EXT_PROPERTIES)) { | ||
| key = key.substring(0, key.length() - IdeContext.EXT_PROPERTIES.length()); | ||
| } | ||
| PluginDescriptor pluginDescriptor = getPluginsMap().get(key); | ||
| if (pluginDescriptor == null) { | ||
| throw new CliException( | ||
| "Could not find plugin " + key + " at " + getPluginsConfigPath().resolve(key) + ".properties"); | ||
| } | ||
| return pluginDescriptor; | ||
| } | ||
| } | ||
This file contains 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
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.
please keep this badge added by Moritz for the coverage.