20007338019

Committed 07 Dec 2025 04:50PM UTC coverage: 70.003% (-0.1%) from 70.101%

Build # 20007338019

Build Type

push

github

Committed by

web-flow

Commit Message

#39: pip commandlet (#1639)

Co-authored-by: Malte Brunnlieb <malte.brunnlieb@capgemini.com>
Co-authored-by: Malte Brunnlieb <maybeec@users.noreply.github.com>
Co-authored-by: jan-vcapgemini <59438728+jan-vcapgemini@users.noreply.github.com>
Co-authored-by: jan-vcapgemini <jan-vincent.hoelzle@capgemini.com>

Run Details

3909 of 6137 branches covered (63.7%)

Branch coverage included in aggregate %.

10030 of 13775 relevant lines covered (72.81%)

3.15 hits per line

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

90.0

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

devonfw / IDEasy / 20007338019

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