22317391561

Committed 23 Feb 2026 05:30PM UTC coverage: 70.257% (-0.2%) from 70.474%

Build # 22317391561

Build Type

Pull #1714

github

Committed by

web-flow

Commit Message

Merge 5be048514 into 379acdc9d

Pull Request Pull Request #1714: #404: #1713: advanced logging

Run Details

4066 of 6384 branches covered (63.69%)

Branch coverage included in aggregate %.

10598 of 14488 relevant lines covered (73.15%)

3.08 hits per line

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

90.05

cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManagerImpl.java

package com.devonfw.tools.ide.commandlet;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.devonfw.tools.ide.cli.CliArgument;
import com.devonfw.tools.ide.cli.CliArguments;
import com.devonfw.tools.ide.completion.CompletionCandidateCollector;
import com.devonfw.tools.ide.context.IdeContext;
import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;
import com.devonfw.tools.ide.property.KeywordProperty;
import com.devonfw.tools.ide.property.Property;
import com.devonfw.tools.ide.tool.androidstudio.AndroidStudio;
import com.devonfw.tools.ide.tool.aws.Aws;
import com.devonfw.tools.ide.tool.az.Azure;
import com.devonfw.tools.ide.tool.corepack.Corepack;
import com.devonfw.tools.ide.tool.docker.Docker;
import com.devonfw.tools.ide.tool.dotnet.DotNet;
import com.devonfw.tools.ide.tool.eclipse.Eclipse;
import com.devonfw.tools.ide.tool.gcviewer.GcViewer;
import com.devonfw.tools.ide.tool.gh.Gh;
import com.devonfw.tools.ide.tool.graalvm.GraalVm;
import com.devonfw.tools.ide.tool.gradle.Gradle;
import com.devonfw.tools.ide.tool.helm.Helm;
import com.devonfw.tools.ide.tool.intellij.Intellij;
import com.devonfw.tools.ide.tool.jasypt.Jasypt;
import com.devonfw.tools.ide.tool.java.Java;
import com.devonfw.tools.ide.tool.jmc.Jmc;
import com.devonfw.tools.ide.tool.kotlinc.Kotlinc;
import com.devonfw.tools.ide.tool.kotlinc.KotlincNative;
import com.devonfw.tools.ide.tool.kubectl.KubeCtl;
import com.devonfw.tools.ide.tool.lazydocker.LazyDocker;
import com.devonfw.tools.ide.tool.mvn.Mvn;
import com.devonfw.tools.ide.tool.ng.Ng;
import com.devonfw.tools.ide.tool.node.Node;
import com.devonfw.tools.ide.tool.npm.Npm;
import com.devonfw.tools.ide.tool.oc.Oc;
import com.devonfw.tools.ide.tool.pgadmin.PgAdmin;
import com.devonfw.tools.ide.tool.pip.Pip;
import com.devonfw.tools.ide.tool.pycharm.Pycharm;
import com.devonfw.tools.ide.tool.python.Python;
import com.devonfw.tools.ide.tool.quarkus.Quarkus;
import com.devonfw.tools.ide.tool.sonar.Sonar;
import com.devonfw.tools.ide.tool.spring.Spring;
import com.devonfw.tools.ide.tool.terraform.Terraform;
import com.devonfw.tools.ide.tool.tomcat.Tomcat;
import com.devonfw.tools.ide.tool.uv.Uv;
import com.devonfw.tools.ide.tool.vscode.Vscode;
import com.devonfw.tools.ide.tool.yarn.Yarn;

/**
 * Implementation of {@link CommandletManager}.
 */
public class CommandletManagerImpl implements CommandletManager {

  private static final Logger LOG = LoggerFactory.getLogger(CommandletManagerImpl.class);

  private final IdeContext context;

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

  private final Map<String, Commandlet> commandletNameMap;

  private final Map<String, Commandlet> firstKeywordMap;

  private final Collection<Commandlet> commandlets;

  /**
   * The constructor.
   *
   * @param context the {@link IdeContext}.
   */
  public CommandletManagerImpl(IdeContext context) {

    super();
    this.context = context;
    this.commandletTypeMap = new HashMap<>();
    this.commandletNameMap = new HashMap<>();
    this.firstKeywordMap = new HashMap<>();
    this.commandlets = Collections.unmodifiableCollection(this.commandletTypeMap.values());
    add(new HelpCommandlet(context));
    add(new EnvironmentCommandlet(context));
    add(new CompleteCommandlet(context));
    add(new ShellCommandlet(context));
    add(new InstallCommandlet(context));
    add(new VersionSetCommandlet(context));
    add(new VersionGetCommandlet(context));
    add(new VersionListCommandlet(context));
    add(new EditionGetCommandlet(context));
    add(new EditionSetCommandlet(context));
    add(new EditionListCommandlet(context));
    add(new VersionCommandlet(context));
    add(new StatusCommandlet(context));
    add(new RepositoryCommandlet(context));
    add(new UninstallCommandlet(context));
    add(new UpdateCommandlet(context));
    add(new UpgradeSettingsCommandlet(context));
    add(new CreateCommandlet(context));
    add(new BuildCommandlet(context));
    add(new InstallPluginCommandlet(context));
    add(new UninstallPluginCommandlet(context));
    add(new UpgradeCommandlet(context));
    add(new Gh(context));
    add(new Helm(context));
    add(new Java(context));
    add(new Ng(context));
    add(new Node(context));
    add(new Npm(context));
    add(new Mvn(context));
    add(new GcViewer(context));
    add(new Gradle(context));
    add(new Eclipse(context));
    add(new Terraform(context));
    add(new Oc(context));
    add(new Quarkus(context));
    add(new Kotlinc(context));
    add(new KotlincNative(context));
    add(new KubeCtl(context));
    add(new Tomcat(context));
    add(new Vscode(context));
    add(new Azure(context));
    add(new Aws(context));
    add(new Jmc(context));
    add(new DotNet(context));
    add(new Intellij(context));
    add(new Jasypt(context));
    add(new Docker(context));
    add(new Sonar(context));
    add(new AndroidStudio(context));
    add(new GraalVm(context));
    add(new PgAdmin(context));
    add(new LazyDocker(context));
    add(new Python(context));
    add(new Pycharm(context));
    add(new Spring(context));
    add(new Uv(context));
    add(new Yarn(context));
    add(new Corepack(context));
    add(new Pip(context));
  }

  /**
   * @param commandlet the {@link Commandlet} to add.
   */
  protected void add(Commandlet commandlet) {

    boolean hasRequiredProperty = false;
    List<Property<?>> properties = commandlet.getProperties();
    int propertyCount = properties.size();
    KeywordProperty keyword = commandlet.getFirstKeyword();
    if (keyword != null) {
      String name = keyword.getName();
      registerKeyword(name, commandlet);
      String optionName = keyword.getOptionName();
      if (!optionName.equals(name)) {
        registerKeyword(optionName, commandlet);
      }
      String alias = keyword.getAlias();
      if (alias != null) {
        registerKeyword(alias, commandlet);
      }
    }
    for (int i = 0; i < propertyCount; i++) {
      Property<?> property = properties.get(i);
      if (property.isRequired()) {
        hasRequiredProperty = true;
        break;
      }
    }
    if (!hasRequiredProperty) {
      throw new IllegalStateException("Commandlet " + commandlet + " must have at least one mandatory property!");
    }
    this.commandletTypeMap.put(commandlet.getClass(), commandlet);
    Commandlet duplicate = this.commandletNameMap.put(commandlet.getName(), commandlet);
    if (duplicate != null) {
      throw new IllegalStateException("Commandlet " + commandlet + " has the same name as " + duplicate);
    }
  }

  private void registerKeyword(String keyword, Commandlet commandlet) {

    Commandlet duplicate = this.firstKeywordMap.putIfAbsent(keyword, commandlet);
    if (duplicate != null) {
      LOG.debug("Duplicate keyword {} already used by {} so it cannot be associated also with {}", keyword, duplicate, commandlet);
    }
  }

  @Override
  public Collection<Commandlet> getCommandlets() {

    return this.commandlets;
  }

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

    Commandlet commandlet = this.commandletTypeMap.get(commandletType);
    if (commandlet == null) {
      throw new IllegalStateException("Commandlet for type " + commandletType + " is not registered!");
    }
    return commandletType.cast(commandlet);
  }

  @Override
  public Commandlet getCommandlet(String name) {

    return this.commandletNameMap.get(name);
  }

  @Override
  public Commandlet getCommandletByFirstKeyword(String keyword) {

    return this.firstKeywordMap.get(keyword);
  }

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

    CliArgument current = arguments.current();
    if (current.isEnd()) {
      return Collections.emptyIterator();
    }
    String keyword = current.get();
    Commandlet commandlet = getCommandletByFirstKeyword(keyword);
    if ((commandlet == null) && (collector == null)) {
      return Collections.emptyIterator();
    }
    return new CommandletFinder(commandlet, arguments.copy(), collector);
  }

  private final class CommandletFinder implements Iterator<Commandlet> {

    private final Commandlet firstCandidate;

    private final Iterator<Commandlet> commandletIterator;

    private final CliArguments arguments;

    private final CompletionCandidateCollector collector;

    private Commandlet next;

    private CommandletFinder(Commandlet firstCandidate, CliArguments arguments, CompletionCandidateCollector collector) {

      this.firstCandidate = firstCandidate;
      this.commandletIterator = getCommandlets().iterator();
      this.arguments = arguments;
      this.collector = collector;
      if (isSuitable(firstCandidate)) {
        this.next = firstCandidate;
      } else {
        this.next = findNext();
      }
    }

    @Override
    public boolean hasNext() {

      return this.next != null;
    }

    @Override
    public Commandlet next() {

      if (this.next == null) {
        throw new NoSuchElementException();
      }
      Commandlet result = this.next;
      this.next = findNext();
      return result;
    }

    private boolean isSuitable(Commandlet commandlet) {

      return (commandlet != null) && (!commandlet.isIdeHomeRequired() || (context.getIdeHome() != null));
    }

    private Commandlet findNext() {

      while (this.commandletIterator.hasNext()) {
        Commandlet cmd = this.commandletIterator.next();
        if ((cmd != this.firstCandidate) && isSuitable(cmd)) {
          List<Property<?>> properties = cmd.getProperties();
          // validation should already be done in add method and could be removed here...
          if (properties.isEmpty()) {
            assert false : cmd.getClass().getSimpleName() + " has no properties!";
          } else {
            Property<?> property = properties.getFirst();
            if (property instanceof KeywordProperty) {
              boolean matches = property.apply(arguments.copy(), context, cmd, this.collector);
              if (matches) {
                return cmd;
              }
            } else {
              assert false : cmd.getClass().getSimpleName() + " is invalid as first property must be keyword property but is " + property;
            }
          }
        }
      }
      return null;
    }
  }
}

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.graalvm.GraalVm;
31	import com.devonfw.tools.ide.tool.gradle.Gradle;
32	import com.devonfw.tools.ide.tool.helm.Helm;
33	import com.devonfw.tools.ide.tool.intellij.Intellij;
34	import com.devonfw.tools.ide.tool.jasypt.Jasypt;
35	import com.devonfw.tools.ide.tool.java.Java;
36	import com.devonfw.tools.ide.tool.jmc.Jmc;
37	import com.devonfw.tools.ide.tool.kotlinc.Kotlinc;
38	import com.devonfw.tools.ide.tool.kotlinc.KotlincNative;
39	import com.devonfw.tools.ide.tool.kubectl.KubeCtl;
40	import com.devonfw.tools.ide.tool.lazydocker.LazyDocker;
41	import com.devonfw.tools.ide.tool.mvn.Mvn;
42	import com.devonfw.tools.ide.tool.ng.Ng;
43	import com.devonfw.tools.ide.tool.node.Node;
44	import com.devonfw.tools.ide.tool.npm.Npm;
45	import com.devonfw.tools.ide.tool.oc.Oc;
46	import com.devonfw.tools.ide.tool.pgadmin.PgAdmin;
47	import com.devonfw.tools.ide.tool.pip.Pip;
48	import com.devonfw.tools.ide.tool.pycharm.Pycharm;
49	import com.devonfw.tools.ide.tool.python.Python;
50	import com.devonfw.tools.ide.tool.quarkus.Quarkus;
51	import com.devonfw.tools.ide.tool.sonar.Sonar;
52	import com.devonfw.tools.ide.tool.spring.Spring;
53	import com.devonfw.tools.ide.tool.terraform.Terraform;
54	import com.devonfw.tools.ide.tool.tomcat.Tomcat;
55	import com.devonfw.tools.ide.tool.uv.Uv;
56	import com.devonfw.tools.ide.tool.vscode.Vscode;
57	import com.devonfw.tools.ide.tool.yarn.Yarn;
58
59	/**
60	* Implementation of {@link CommandletManager}.
61	*/
62	public class CommandletManagerImpl implements CommandletManager {
63
64	private static final Logger LOG = LoggerFactory.getLogger(CommandletManagerImpl.class);	4✔
65
66	private final IdeContext context;
67
68	private final Map<Class<? extends Commandlet>, Commandlet> commandletTypeMap;
69
70	private final Map<String, Commandlet> commandletNameMap;
71
72	private final Map<String, Commandlet> firstKeywordMap;
73
74	private final Collection<Commandlet> commandlets;
75
76	/**
77	* The constructor.
78	*
79	* @param context the {@link IdeContext}.
80	*/
81	public CommandletManagerImpl(IdeContext context) {
82
83	super();	2✔
84	this.context = context;	3✔
85	this.commandletTypeMap = new HashMap<>();	5✔
86	this.commandletNameMap = new HashMap<>();	5✔
87	this.firstKeywordMap = new HashMap<>();	5✔
88	this.commandlets = Collections.unmodifiableCollection(this.commandletTypeMap.values());	6✔
89	add(new HelpCommandlet(context));	6✔
90	add(new EnvironmentCommandlet(context));	6✔
91	add(new CompleteCommandlet(context));	6✔
92	add(new ShellCommandlet(context));	6✔
93	add(new InstallCommandlet(context));	6✔
94	add(new VersionSetCommandlet(context));	6✔
95	add(new VersionGetCommandlet(context));	6✔
96	add(new VersionListCommandlet(context));	6✔
97	add(new EditionGetCommandlet(context));	6✔
98	add(new EditionSetCommandlet(context));	6✔
99	add(new EditionListCommandlet(context));	6✔
100	add(new VersionCommandlet(context));	6✔
101	add(new StatusCommandlet(context));	6✔
102	add(new RepositoryCommandlet(context));	6✔
103	add(new UninstallCommandlet(context));	6✔
104	add(new UpdateCommandlet(context));	6✔
105	add(new UpgradeSettingsCommandlet(context));	6✔
106	add(new CreateCommandlet(context));	6✔
107	add(new BuildCommandlet(context));	6✔
108	add(new InstallPluginCommandlet(context));	6✔
109	add(new UninstallPluginCommandlet(context));	6✔
110	add(new UpgradeCommandlet(context));	6✔
111	add(new Gh(context));	6✔
112	add(new Helm(context));	6✔
113	add(new Java(context));	6✔
114	add(new Ng(context));	6✔
115	add(new Node(context));	6✔
116	add(new Npm(context));	6✔
117	add(new Mvn(context));	6✔
118	add(new GcViewer(context));	6✔
119	add(new Gradle(context));	6✔
120	add(new Eclipse(context));	6✔
121	add(new Terraform(context));	6✔
122	add(new Oc(context));	6✔
123	add(new Quarkus(context));	6✔
124	add(new Kotlinc(context));	6✔
125	add(new KotlincNative(context));	6✔
126	add(new KubeCtl(context));	6✔
127	add(new Tomcat(context));	6✔
128	add(new Vscode(context));	6✔
129	add(new Azure(context));	6✔
130	add(new Aws(context));	6✔
131	add(new Jmc(context));	6✔
132	add(new DotNet(context));	6✔
133	add(new Intellij(context));	6✔
134	add(new Jasypt(context));	6✔
135	add(new Docker(context));	6✔
136	add(new Sonar(context));	6✔
137	add(new AndroidStudio(context));	6✔
138	add(new GraalVm(context));	6✔
139	add(new PgAdmin(context));	6✔
140	add(new LazyDocker(context));	6✔
141	add(new Python(context));	6✔
142	add(new Pycharm(context));	6✔
143	add(new Spring(context));	6✔
144	add(new Uv(context));	6✔
145	add(new Yarn(context));	6✔
146	add(new Corepack(context));	6✔
147	add(new Pip(context));	6✔
148	}	1✔
149
150	/**
151	* @param commandlet the {@link Commandlet} to add.
152	*/
153	protected void add(Commandlet commandlet) {
154
155	boolean hasRequiredProperty = false;	2✔
156	List<Property<?>> properties = commandlet.getProperties();	3✔
157	int propertyCount = properties.size();	3✔
158	KeywordProperty keyword = commandlet.getFirstKeyword();	3✔
159	if (keyword != null) {	2!
160	String name = keyword.getName();	3✔
161	registerKeyword(name, commandlet);	4✔
162	String optionName = keyword.getOptionName();	3✔
163	if (!optionName.equals(name)) {	4✔
164	registerKeyword(optionName, commandlet);	4✔
165	}
166	String alias = keyword.getAlias();	3✔
167	if (alias != null) {	2✔
168	registerKeyword(alias, commandlet);	4✔
169	}
170	}
171	for (int i = 0; i < propertyCount; i++) {	5!
172	Property<?> property = properties.get(i);	5✔
173	if (property.isRequired()) {	3!
174	hasRequiredProperty = true;	2✔
175	break;	1✔
176	}
177	}
178	if (!hasRequiredProperty) {	2!
179	throw new IllegalStateException("Commandlet " + commandlet + " must have at least one mandatory property!");	×
180	}
181	this.commandletTypeMap.put(commandlet.getClass(), commandlet);	7✔
182	Commandlet duplicate = this.commandletNameMap.put(commandlet.getName(), commandlet);	8✔
183	if (duplicate != null) {	2!
184	throw new IllegalStateException("Commandlet " + commandlet + " has the same name as " + duplicate);	×
185	}
186	}	1✔
187
188	private void registerKeyword(String keyword, Commandlet commandlet) {
189
190	Commandlet duplicate = this.firstKeywordMap.putIfAbsent(keyword, commandlet);	7✔
191	if (duplicate != null) {	2!
192	LOG.debug("Duplicate keyword {} already used by {} so it cannot be associated also with {}", keyword, duplicate, commandlet);	×
193	}
194	}	1✔
195
196	@Override
197	public Collection<Commandlet> getCommandlets() {
198
199	return this.commandlets;	3✔
200	}
201
202	@Override
203	public <C extends Commandlet> C getCommandlet(Class<C> commandletType) {
204
205	Commandlet commandlet = this.commandletTypeMap.get(commandletType);	6✔
206	if (commandlet == null) {	2!
207	throw new IllegalStateException("Commandlet for type " + commandletType + " is not registered!");	×
208	}
209	return commandletType.cast(commandlet);	5✔
210	}
211
212	@Override
213	public Commandlet getCommandlet(String name) {
214
215	return this.commandletNameMap.get(name);	6✔
216	}
217
218	@Override
219	public Commandlet getCommandletByFirstKeyword(String keyword) {
220
221	return this.firstKeywordMap.get(keyword);	6✔
222	}
223
224	@Override
225	public Iterator<Commandlet> findCommandlet(CliArguments arguments, CompletionCandidateCollector collector) {
226
227	CliArgument current = arguments.current();	3✔
228	if (current.isEnd()) {	3!
229	return Collections.emptyIterator();	×
230	}
231	String keyword = current.get();	3✔
232	Commandlet commandlet = getCommandletByFirstKeyword(keyword);	4✔
233	if ((commandlet == null) && (collector == null)) {	4✔
234	return Collections.emptyIterator();	2✔
235	}
236	return new CommandletFinder(commandlet, arguments.copy(), collector);	9✔
237	}
238
239	private final class CommandletFinder implements Iterator<Commandlet> {	1✔
240
241	private final Commandlet firstCandidate;
242
243	private final Iterator<Commandlet> commandletIterator;
244
245	private final CliArguments arguments;
246
247	private final CompletionCandidateCollector collector;
248
249	private Commandlet next;
250
251	private CommandletFinder(Commandlet firstCandidate, CliArguments arguments, CompletionCandidateCollector collector) {	5✔
252
253	this.firstCandidate = firstCandidate;	3✔
254	this.commandletIterator = getCommandlets().iterator();	5✔
255	this.arguments = arguments;	3✔
256	this.collector = collector;	3✔
257	if (isSuitable(firstCandidate)) {	4✔
258	this.next = firstCandidate;	4✔
259	} else {
260	this.next = findNext();	4✔
261	}
262	}	1✔
263
264	@Override
265	public boolean hasNext() {
266
267	return this.next != null;	7✔
268	}
269
270	@Override
271	public Commandlet next() {
272
273	if (this.next == null) {	3!
274	throw new NoSuchElementException();	×
275	}
276	Commandlet result = this.next;	3✔
277	this.next = findNext();	4✔
278	return result;	2✔
279	}
280
281	private boolean isSuitable(Commandlet commandlet) {
282
283	return (commandlet != null) && (!commandlet.isIdeHomeRequired() \|\| (context.getIdeHome() != null));	14✔
284	}
285
286	private Commandlet findNext() {
287
288	while (this.commandletIterator.hasNext()) {	4✔
289	Commandlet cmd = this.commandletIterator.next();	5✔
290	if ((cmd != this.firstCandidate) && isSuitable(cmd)) {	8✔
291	List<Property<?>> properties = cmd.getProperties();	3✔
292	// validation should already be done in add method and could be removed here...
293	if (properties.isEmpty()) {	3!
294	assert false : cmd.getClass().getSimpleName() + " has no properties!";	×
295	} else {
296	Property<?> property = properties.getFirst();	4✔
297	if (property instanceof KeywordProperty) {	3!
298	boolean matches = property.apply(arguments.copy(), context, cmd, this.collector);	12✔
299	if (matches) {	2✔
300	return cmd;	2✔
301	}
302	} else {	1✔
303	assert false : cmd.getClass().getSimpleName() + " is invalid as first property must be keyword property but is " + property;	×
304	}
305	}
306	}
307	}	1✔
308	return null;	2✔
309	}
310	}
311	}

devonfw / IDEasy / 22317391561

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

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