• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

devonfw / IDEasy / 24983767603

27 Apr 2026 08:08AM UTC coverage: 70.641% (-0.04%) from 70.679%
24983767603

push

github

web-flow
#1724: Create GUI commandlet (#1782)

Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>

4380 of 6846 branches covered (63.98%)

Branch coverage included in aggregate %.

11284 of 15328 relevant lines covered (73.62%)

3.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.26
cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManagerImpl.java
1
package com.devonfw.tools.ide.commandlet;
2

3
import java.util.Collection;
4
import java.util.Collections;
5
import java.util.HashMap;
6
import java.util.Iterator;
7
import java.util.List;
8
import java.util.Map;
9
import java.util.NoSuchElementException;
10

11
import org.slf4j.Logger;
12
import org.slf4j.LoggerFactory;
13

14
import com.devonfw.tools.ide.cli.CliArgument;
15
import com.devonfw.tools.ide.cli.CliArguments;
16
import com.devonfw.tools.ide.completion.CompletionCandidateCollector;
17
import com.devonfw.tools.ide.context.IdeContext;
18
import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;
19
import com.devonfw.tools.ide.property.KeywordProperty;
20
import com.devonfw.tools.ide.property.Property;
21
import com.devonfw.tools.ide.tool.androidstudio.AndroidStudio;
22
import com.devonfw.tools.ide.tool.aws.Aws;
23
import com.devonfw.tools.ide.tool.az.Azure;
24
import com.devonfw.tools.ide.tool.corepack.Corepack;
25
import com.devonfw.tools.ide.tool.docker.Docker;
26
import com.devonfw.tools.ide.tool.dotnet.DotNet;
27
import com.devonfw.tools.ide.tool.eclipse.Eclipse;
28
import com.devonfw.tools.ide.tool.gcviewer.GcViewer;
29
import com.devonfw.tools.ide.tool.gh.Gh;
30
import com.devonfw.tools.ide.tool.go.Go;
31
import com.devonfw.tools.ide.tool.graalvm.GraalVm;
32
import com.devonfw.tools.ide.tool.gradle.Gradle;
33
import com.devonfw.tools.ide.tool.gui.Gui;
34
import com.devonfw.tools.ide.tool.helm.Helm;
35
import com.devonfw.tools.ide.tool.intellij.Intellij;
36
import com.devonfw.tools.ide.tool.jasypt.Jasypt;
37
import com.devonfw.tools.ide.tool.java.Java;
38
import com.devonfw.tools.ide.tool.jmc.Jmc;
39
import com.devonfw.tools.ide.tool.kotlinc.Kotlinc;
40
import com.devonfw.tools.ide.tool.kotlinc.KotlincNative;
41
import com.devonfw.tools.ide.tool.kubectl.KubeCtl;
42
import com.devonfw.tools.ide.tool.lazydocker.LazyDocker;
43
import com.devonfw.tools.ide.tool.mvn.Mvn;
44
import com.devonfw.tools.ide.tool.ng.Ng;
45
import com.devonfw.tools.ide.tool.node.Node;
46
import com.devonfw.tools.ide.tool.npm.Npm;
47
import com.devonfw.tools.ide.tool.oc.Oc;
48
import com.devonfw.tools.ide.tool.pgadmin.PgAdmin;
49
import com.devonfw.tools.ide.tool.pip.Pip;
50
import com.devonfw.tools.ide.tool.pycharm.Pycharm;
51
import com.devonfw.tools.ide.tool.python.Python;
52
import com.devonfw.tools.ide.tool.quarkus.Quarkus;
53
import com.devonfw.tools.ide.tool.sonar.Sonar;
54
import com.devonfw.tools.ide.tool.spring.Spring;
55
import com.devonfw.tools.ide.tool.squirrelsql.SquirrelSql;
56
import com.devonfw.tools.ide.tool.terraform.Terraform;
57
import com.devonfw.tools.ide.tool.tomcat.Tomcat;
58
import com.devonfw.tools.ide.tool.uv.Uv;
59
import com.devonfw.tools.ide.tool.vscode.Vscode;
60
import com.devonfw.tools.ide.tool.yarn.Yarn;
61

62
/**
63
 * Implementation of {@link CommandletManager}.
64
 */
65
public class CommandletManagerImpl implements CommandletManager {
66

67
  private static final Logger LOG = LoggerFactory.getLogger(CommandletManagerImpl.class);
4✔
68

69
  private final IdeContext context;
70

71
  private final Map<Class<? extends Commandlet>, Commandlet> commandletTypeMap;
72

73
  private final Map<String, Commandlet> commandletNameMap;
74

75
  private final Map<String, Commandlet> firstKeywordMap;
76

77
  private final Collection<Commandlet> commandlets;
78

79
  /**
80
   * The constructor.
81
   *
82
   * @param context the {@link IdeContext}.
83
   */
84
  public CommandletManagerImpl(IdeContext context) {
85

86
    super();
2✔
87
    this.context = context;
3✔
88
    this.commandletTypeMap = new HashMap<>();
5✔
89
    this.commandletNameMap = new HashMap<>();
5✔
90
    this.firstKeywordMap = new HashMap<>();
5✔
91
    this.commandlets = Collections.unmodifiableCollection(this.commandletTypeMap.values());
6✔
92
    add(new HelpCommandlet(context));
6✔
93
    add(new EnvironmentCommandlet(context));
6✔
94
    add(new CompleteCommandlet(context));
6✔
95
    add(new ShellCommandlet(context));
6✔
96
    add(new InstallCommandlet(context));
6✔
97
    add(new VersionSetCommandlet(context));
6✔
98
    add(new VersionGetCommandlet(context));
6✔
99
    add(new VersionListCommandlet(context));
6✔
100
    add(new EditionGetCommandlet(context));
6✔
101
    add(new EditionSetCommandlet(context));
6✔
102
    add(new EditionListCommandlet(context));
6✔
103
    add(new VersionCommandlet(context));
6✔
104
    add(new StatusCommandlet(context));
6✔
105
    add(new RepositoryCommandlet(context));
6✔
106
    add(new UninstallCommandlet(context));
6✔
107
    add(new UpdateCommandlet(context));
6✔
108
    add(new UpgradeSettingsCommandlet(context));
6✔
109
    add(new CreateCommandlet(context));
6✔
110
    add(new BuildCommandlet(context));
6✔
111
    add(new InstallPluginCommandlet(context));
6✔
112
    add(new UninstallPluginCommandlet(context));
6✔
113
    add(new UpgradeCommandlet(context));
6✔
114
    add(new TruststoreCommandlet(context));
6✔
115
    add(new Gh(context));
6✔
116
    add(new Helm(context));
6✔
117
    add(new Java(context));
6✔
118
    add(new Ng(context));
6✔
119
    add(new Node(context));
6✔
120
    add(new Npm(context));
6✔
121
    add(new Mvn(context));
6✔
122
    add(new GcViewer(context));
6✔
123
    add(new Gradle(context));
6✔
124
    add(new Eclipse(context));
6✔
125
    add(new Terraform(context));
6✔
126
    add(new Oc(context));
6✔
127
    add(new Quarkus(context));
6✔
128
    add(new Kotlinc(context));
6✔
129
    add(new KotlincNative(context));
6✔
130
    add(new KubeCtl(context));
6✔
131
    add(new Tomcat(context));
6✔
132
    add(new Vscode(context));
6✔
133
    add(new Azure(context));
6✔
134
    add(new Aws(context));
6✔
135
    add(new Jmc(context));
6✔
136
    add(new DotNet(context));
6✔
137
    add(new Intellij(context));
6✔
138
    add(new Jasypt(context));
6✔
139
    add(new Docker(context));
6✔
140
    add(new Sonar(context));
6✔
141
    add(new AndroidStudio(context));
6✔
142
    add(new GraalVm(context));
6✔
143
    add(new PgAdmin(context));
6✔
144
    add(new LazyDocker(context));
6✔
145
    add(new Python(context));
6✔
146
    add(new Pycharm(context));
6✔
147
    add(new Spring(context));
6✔
148
    add(new Uv(context));
6✔
149
    add(new Yarn(context));
6✔
150
    add(new Corepack(context));
6✔
151
    add(new Pip(context));
6✔
152
    add(new Go(context));
6✔
153
    add(new Gui(context));
6✔
154
    add(new SquirrelSql(context));
6✔
155
  }
1✔
156

157
  /**
158
   * @param commandlet the {@link Commandlet} to add.
159
   */
160
  protected void add(Commandlet commandlet) {
161

162
    boolean hasRequiredProperty = false;
2✔
163
    List<Property<?>> properties = commandlet.getProperties();
3✔
164
    int propertyCount = properties.size();
3✔
165
    KeywordProperty keyword = commandlet.getFirstKeyword();
3✔
166
    if (keyword != null) {
2!
167
      String name = keyword.getName();
3✔
168
      registerKeyword(name, commandlet);
4✔
169
      String optionName = keyword.getOptionName();
3✔
170
      if (!optionName.equals(name)) {
4✔
171
        registerKeyword(optionName, commandlet);
4✔
172
      }
173
      String alias = keyword.getAlias();
3✔
174
      if (alias != null) {
2✔
175
        registerKeyword(alias, commandlet);
4✔
176
      }
177
    }
178
    for (int i = 0; i < propertyCount; i++) {
5!
179
      Property<?> property = properties.get(i);
5✔
180
      if (property.isRequired()) {
3!
181
        hasRequiredProperty = true;
2✔
182
        break;
1✔
183
      }
184
    }
185
    if (!hasRequiredProperty) {
2!
186
      throw new IllegalStateException("Commandlet " + commandlet + " must have at least one mandatory property!");
×
187
    }
188
    this.commandletTypeMap.put(commandlet.getClass(), commandlet);
7✔
189
    Commandlet duplicate = this.commandletNameMap.put(commandlet.getName(), commandlet);
8✔
190
    if (duplicate != null) {
2!
191
      throw new IllegalStateException("Commandlet " + commandlet + " has the same name as " + duplicate);
×
192
    }
193
  }
1✔
194

195
  private void registerKeyword(String keyword, Commandlet commandlet) {
196

197
    Commandlet duplicate = this.firstKeywordMap.putIfAbsent(keyword, commandlet);
7✔
198
    if (duplicate != null) {
2!
199
      LOG.debug("Duplicate keyword {} already used by {} so it cannot be associated also with {}", keyword, duplicate, commandlet);
×
200
    }
201
  }
1✔
202

203
  @Override
204
  public Collection<Commandlet> getCommandlets() {
205

206
    return this.commandlets;
3✔
207
  }
208

209
  @Override
210
  public <C extends Commandlet> C getCommandlet(Class<C> commandletType) {
211

212
    Commandlet commandlet = this.commandletTypeMap.get(commandletType);
6✔
213
    if (commandlet == null) {
2!
214
      throw new IllegalStateException("Commandlet for type " + commandletType + " is not registered!");
×
215
    }
216
    return commandletType.cast(commandlet);
5✔
217
  }
218

219
  @Override
220
  public Commandlet getCommandlet(String name) {
221

222
    return this.commandletNameMap.get(name);
6✔
223
  }
224

225
  @Override
226
  public Commandlet getCommandletByFirstKeyword(String keyword) {
227

228
    return this.firstKeywordMap.get(keyword);
6✔
229
  }
230

231
  @Override
232
  public Iterator<Commandlet> findCommandlet(CliArguments arguments, CompletionCandidateCollector collector) {
233

234
    CliArgument current = arguments.current();
3✔
235
    if (current.isEnd()) {
3!
236
      return Collections.emptyIterator();
×
237
    }
238
    String keyword = current.get();
3✔
239
    Commandlet commandlet = getCommandletByFirstKeyword(keyword);
4✔
240
    if ((commandlet == null) && (collector == null)) {
4✔
241
      return Collections.emptyIterator();
2✔
242
    }
243
    return new CommandletFinder(commandlet, arguments.copy(), collector);
9✔
244
  }
245

246
  private final class CommandletFinder implements Iterator<Commandlet> {
1✔
247

248
    private final Commandlet firstCandidate;
249

250
    private final Iterator<Commandlet> commandletIterator;
251

252
    private final CliArguments arguments;
253

254
    private final CompletionCandidateCollector collector;
255

256
    private Commandlet next;
257

258
    private CommandletFinder(Commandlet firstCandidate, CliArguments arguments, CompletionCandidateCollector collector) {
8✔
259

260
      this.firstCandidate = firstCandidate;
3✔
261
      this.commandletIterator = getCommandlets().iterator();
5✔
262
      this.arguments = arguments;
3✔
263
      this.collector = collector;
3✔
264
      if (isSuitable(firstCandidate)) {
4✔
265
        this.next = firstCandidate;
4✔
266
      } else {
267
        this.next = findNext();
4✔
268
      }
269
    }
1✔
270

271
    @Override
272
    public boolean hasNext() {
273

274
      return this.next != null;
7✔
275
    }
276

277
    @Override
278
    public Commandlet next() {
279

280
      if (this.next == null) {
3!
281
        throw new NoSuchElementException();
×
282
      }
283
      Commandlet result = this.next;
3✔
284
      this.next = findNext();
4✔
285
      return result;
2✔
286
    }
287

288
    private boolean isSuitable(Commandlet commandlet) {
289

290
      return (commandlet != null) && (!commandlet.isIdeHomeRequired() || (context.getIdeHome() != null));
14✔
291
    }
292

293
    private Commandlet findNext() {
294

295
      while (this.commandletIterator.hasNext()) {
4✔
296
        Commandlet cmd = this.commandletIterator.next();
5✔
297
        if ((cmd != this.firstCandidate) && isSuitable(cmd)) {
8✔
298
          List<Property<?>> properties = cmd.getProperties();
3✔
299
          // validation should already be done in add method and could be removed here...
300
          if (properties.isEmpty()) {
3!
301
            assert false : cmd.getClass().getSimpleName() + " has no properties!";
×
302
          } else {
303
            Property<?> property = properties.getFirst();
4✔
304
            if (property instanceof KeywordProperty) {
3!
305
              boolean matches = property.apply(arguments.copy(), context, cmd, this.collector);
12✔
306
              if (matches) {
2✔
307
                return cmd;
2✔
308
              }
309
            } else {
1✔
310
              assert false : cmd.getClass().getSimpleName() + " is invalid as first property must be keyword property but is " + property;
×
311
            }
312
          }
313
        }
314
      }
1✔
315
      return null;
2✔
316
    }
317
  }
318
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc