12243460377

Committed 09 Dec 2024 08:09PM UTC coverage: 67.098% (+0.03%) from 67.069%

Build # 12243460377

Build Type

push

github

Committed by

web-flow

Commit Message

#834 : support for --help (#876)

Run Details

2554 of 4154 branches covered (61.48%)

Branch coverage included in aggregate %.

6627 of 9529 relevant lines covered (69.55%)

3.06 hits per line

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

86.03

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.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.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 CreateCommandlet(context));
    add(new BuildCommandlet(context));
    add(new InstallPluginCommandlet(context));
    add(new UninstallPluginCommandlet(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));
  }

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

devonfw / IDEasy / 12243460377

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