13504037823

Committed 24 Feb 2025 05:27PM UTC coverage: 68.039% (-0.007%) from 68.046%

Build # 13504037823

Build Type

Pull #1073

github

Committed by

web-flow

Commit Message

Merge 7e4494aed into 26864ea50

Pull Request Pull Request #1073: #38: Added LocalToolCommandlet for Python

Run Details

2997 of 4849 branches covered (61.81%)

Branch coverage included in aggregate %.

7779 of 10989 relevant lines covered (70.79%)

3.08 hits per line

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

88.52

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.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.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.python.Python;
import com.devonfw.tools.ide.tool.quarkus.Quarkus;
import com.devonfw.tools.ide.tool.sonar.Sonar;
import com.devonfw.tools.ide.tool.terraform.Terraform;
import com.devonfw.tools.ide.tool.tomcat.Tomcat;
import com.devonfw.tools.ide.tool.vscode.Vscode;

/**
 * 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 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));
  }

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

devonfw / IDEasy / 13504037823

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