devonfw / IDEasy / 27946232652

coverage: 71.451% (+0.07%) from 71.381%
27946232652

Pull #2061

github

web-flow 
Merge 2a887be7a into 3a08f1d5c
Pull Request #2061: #1909: create commandlet for mvnd

4701 of 7284 branches covered (64.54%)

Branch coverage included in aggregate %.

12180 of 16342 relevant lines covered (74.53%)

3.15 hits per line

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

91.75
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.cdk.Cdk;










25



import com.devonfw.tools.ide.tool.claude.Claude;










26



import com.devonfw.tools.ide.tool.copilot.Copilot;










27



import com.devonfw.tools.ide.tool.corepack.Corepack;










28



import com.devonfw.tools.ide.tool.docker.Docker;










29



import com.devonfw.tools.ide.tool.dotnet.DotNet;










30



import com.devonfw.tools.ide.tool.eclipse.Eclipse;










31



import com.devonfw.tools.ide.tool.gcviewer.GcViewer;










32



import com.devonfw.tools.ide.tool.gh.Gh;










33



import com.devonfw.tools.ide.tool.go.Go;










34



import com.devonfw.tools.ide.tool.graalvm.GraalVm;










35



import com.devonfw.tools.ide.tool.gradle.Gradle;










36



import com.devonfw.tools.ide.tool.gui.Gui;










37



import com.devonfw.tools.ide.tool.helm.Helm;










38



import com.devonfw.tools.ide.tool.inso.Inso;










39



import com.devonfw.tools.ide.tool.intellij.Intellij;










40



import com.devonfw.tools.ide.tool.jasypt.Jasypt;










41



import com.devonfw.tools.ide.tool.java.Java;










42



import com.devonfw.tools.ide.tool.jmc.Jmc;










43



import com.devonfw.tools.ide.tool.kotlinc.Kotlinc;










44



import com.devonfw.tools.ide.tool.kotlinc.KotlincNative;










45



import com.devonfw.tools.ide.tool.kubectl.KubeCtl;










46



import com.devonfw.tools.ide.tool.lazydocker.LazyDocker;










47



import com.devonfw.tools.ide.tool.msvc.Msvc;










48



import com.devonfw.tools.ide.tool.mvn.Mvn;










49



import com.devonfw.tools.ide.tool.mvnd.Mvnd;










50



import com.devonfw.tools.ide.tool.nest.Nest;










51



import com.devonfw.tools.ide.tool.ng.Ng;










52



import com.devonfw.tools.ide.tool.node.Node;










53



import com.devonfw.tools.ide.tool.npm.Npm;










54



import com.devonfw.tools.ide.tool.oc.Oc;










55



import com.devonfw.tools.ide.tool.pgadmin.PgAdmin;










56



import com.devonfw.tools.ide.tool.pip.Pip;










57



import com.devonfw.tools.ide.tool.pycharm.Pycharm;










58



import com.devonfw.tools.ide.tool.python.Python;










59



import com.devonfw.tools.ide.tool.quarkus.Quarkus;










60



import com.devonfw.tools.ide.tool.rust.Rust;










61



import com.devonfw.tools.ide.tool.sonar.Sonar;










62



import com.devonfw.tools.ide.tool.spring.Spring;










63



import com.devonfw.tools.ide.tool.spyder.Spyder;










64



import com.devonfw.tools.ide.tool.squirrelsql.SquirrelSql;










65



import com.devonfw.tools.ide.tool.task.Task;










66



import com.devonfw.tools.ide.tool.terraform.Terraform;










67



import com.devonfw.tools.ide.tool.tomcat.Tomcat;










68



import com.devonfw.tools.ide.tool.uv.Uv;










69



import com.devonfw.tools.ide.tool.vscode.Vscode;










70



import com.devonfw.tools.ide.tool.yarn.Yarn;










71












72



/**










73



 * Implementation of {@link CommandletManager}.










74



 */










75



public class CommandletManagerImpl implements CommandletManager {










76












77



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




4✔





78












79



  private final IdeContext context;










80












81



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










82












83



  private final Map<String, Commandlet> commandletNameMap;










84












85



  private final Map<String, Commandlet> firstKeywordMap;










86












87



  private final Collection<Commandlet> commandlets;










88












89



  /**










90



   * The constructor.










91



   *










92



   * @param context the {@link IdeContext}.










93



   */










94



  public CommandletManagerImpl(IdeContext context) {










95












96



    super();




2✔





97



    this.context = context;




3✔





98



    this.commandletTypeMap = new HashMap<>();




5✔





99



    this.commandletNameMap = new HashMap<>();




5✔





100



    this.firstKeywordMap = new HashMap<>();




5✔





101



    this.commandlets = Collections.unmodifiableCollection(this.commandletTypeMap.values());




6✔





102



    add(new HelpCommandlet(context));




6✔





103



    add(new EnvironmentCommandlet(context));




6✔





104



    add(new CompleteCommandlet(context));




6✔





105



    add(new ShellCommandlet(context));




6✔





106



    add(new InstallCommandlet(context));




6✔





107



    add(new VersionSetCommandlet(context));




6✔





108



    add(new VersionGetCommandlet(context));




6✔





109



    add(new VersionListCommandlet(context));




6✔





110



    add(new EditionGetCommandlet(context));




6✔





111



    add(new EditionSetCommandlet(context));




6✔





112



    add(new EditionListCommandlet(context));




6✔





113



    add(new VersionCommandlet(context));




6✔





114



    add(new StatusCommandlet(context));




6✔





115



    add(new RepositoryCommandlet(context));




6✔





116



    add(new UninstallCommandlet(context));




6✔





117



    add(new LnCommandlet(context));




6✔





118



    add(new UpdateCommandlet(context));




6✔





119



    add(new UpgradeSettingsCommandlet(context));




6✔





120



    add(new CreateCommandlet(context));




6✔





121



    add(new BuildCommandlet(context));




6✔





122



    add(new InstallPluginCommandlet(context));




6✔





123



    add(new UninstallPluginCommandlet(context));




6✔





124



    add(new UpgradeCommandlet(context));




6✔





125



    add(new TruststoreCommandlet(context));




6✔





126



    add(new Gh(context));




6✔





127



    add(new Helm(context));




6✔





128



    add(new Java(context));




6✔





129



    add(new Ng(context));




6✔





130



    add(new Node(context));




6✔





131



    add(new Npm(context));




6✔





132



    add(new Mvn(context));




6✔





133



    add(new Msvc(context));




6✔





134



    add(new GcViewer(context));




6✔





135



    add(new Gradle(context));




6✔





136



    add(new Eclipse(context));




6✔





137



    add(new Terraform(context));




6✔





138



    add(new Oc(context));




6✔





139



    add(new Quarkus(context));




6✔





140



    add(new Rust(context));




6✔





141



    add(new Kotlinc(context));




6✔





142



    add(new KotlincNative(context));




6✔





143



    add(new KubeCtl(context));




6✔





144



    add(new Tomcat(context));




6✔





145



    add(new Task(context));




6✔





146



    add(new Vscode(context));




6✔





147



    add(new Azure(context));




6✔





148



    add(new Aws(context));




6✔





149



    add(new Jmc(context));




6✔





150



    add(new DotNet(context));




6✔





151



    add(new Inso(context));




6✔





152



    add(new Intellij(context));




6✔





153



    add(new Jasypt(context));




6✔





154



    add(new Docker(context));




6✔





155



    add(new Sonar(context));




6✔





156



    add(new AndroidStudio(context));




6✔





157



    add(new GraalVm(context));




6✔





158



    add(new PgAdmin(context));




6✔





159



    add(new LazyDocker(context));




6✔





160



    add(new Python(context));




6✔





161



    add(new Pycharm(context));




6✔





162



    add(new Spring(context));




6✔





163



    add(new Uv(context));




6✔





164



    add(new Yarn(context));




6✔





165



    add(new Copilot(context));




6✔





166



    add(new Corepack(context));




6✔





167



    add(new Pip(context));




6✔





168



    add(new Go(context));




6✔





169



    add(new Gui(context));




6✔





170



    add(new SquirrelSql(context));




6✔





171



    add(new Spyder(context));




6✔





172



    add(new Nest(context));




6✔





173



    add(new Cdk(context));




6✔





174



    add(new Claude(context));




6✔





175



    add(new Mvnd(context));




6✔





176



  }




1✔





177












178



  /**










179



   * @param commandlet the {@link Commandlet} to add.










180



   */










181



  protected void add(Commandlet commandlet) {










182












183



    boolean hasRequiredProperty = false;




2✔





184



    List<Property<?>> properties = commandlet.getProperties();




3✔





185



    int propertyCount = properties.size();




3✔





186



    KeywordProperty keyword = commandlet.getFirstKeyword();




3✔





187



    if (keyword != null) {





2!





188



      String name = keyword.getName();




3✔





189



      registerKeyword(name, commandlet);




4✔





190



      String optionName = keyword.getOptionName();




3✔





191



      if (!optionName.equals(name)) {





4✔





192



        registerKeyword(optionName, commandlet);




4✔





193



      }










194



      String alias = keyword.getAlias();




3✔





195



      if (alias != null) {





2✔





196



        registerKeyword(alias, commandlet);




4✔





197



      }










198



    }










199



    for (int i = 0; i < propertyCount; i++) {





5!





200



      Property<?> property = properties.get(i);




5✔





201



      if (property.isRequired()) {





3!





202



        hasRequiredProperty = true;




2✔





203



        break;




1✔





204



      }










205



    }










206



    if (!hasRequiredProperty) {





2!





207



      throw new IllegalStateException("Commandlet " + commandlet + " must have at least one mandatory property!");




×







208



    }










209



    this.commandletTypeMap.put(commandlet.getClass(), commandlet);




7✔





210



    Commandlet duplicate = this.commandletNameMap.put(commandlet.getName(), commandlet);




8✔





211



    if (duplicate != null) {





2!





212



      throw new IllegalStateException("Commandlet " + commandlet + " has the same name as " + duplicate);




×







213



    }










214



  }




1✔





215












216



  private void registerKeyword(String keyword, Commandlet commandlet) {










217












218



    Commandlet duplicate = this.firstKeywordMap.putIfAbsent(keyword, commandlet);




7✔





219



    if (duplicate != null) {





2!





220



      LOG.debug("Duplicate keyword {} already used by {} so it cannot be associated also with {}", keyword, duplicate, commandlet);




×







221



    }










222



  }




1✔





223












224



  @Override










225



  public Collection<Commandlet> getCommandlets() {










226












227



    return this.commandlets;




3✔





228



  }










229












230



  @Override










231



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










232












233



    Commandlet commandlet = this.commandletTypeMap.get(commandletType);




6✔





234



    if (commandlet == null) {





2!





235



      throw new IllegalStateException("Commandlet for type " + commandletType + " is not registered!");




×







236



    }










237



    return commandletType.cast(commandlet);




5✔





238



  }










239












240



  @Override










241



  public Commandlet getCommandlet(String name) {










242












243



    return this.commandletNameMap.get(name);




6✔





244



  }










245












246



  @Override










247



  public Commandlet getCommandletByFirstKeyword(String keyword) {










248












249



    return this.firstKeywordMap.get(keyword);




6✔





250



  }










251












252



  @Override










253



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










254












255



    CliArgument current = arguments.current();




3✔





256



    if (current.isEnd()) {





3✔





257



      return Collections.emptyIterator();




2✔





258



    }










259



    String keyword = current.get();




3✔





260



    Commandlet commandlet = getCommandletByFirstKeyword(keyword);




4✔





261



    if ((commandlet == null) && (collector == null)) {





4✔





262



      return Collections.emptyIterator();




2✔





263



    }










264



    return new CommandletFinder(commandlet, arguments.copy(), collector);




9✔





265



  }










266












267



  private final class CommandletFinder implements Iterator<Commandlet> {




1✔





268












269



    private final Commandlet firstCandidate;










270












271



    private final Iterator<Commandlet> commandletIterator;










272












273



    private final CliArguments arguments;










274












275



    private final CompletionCandidateCollector collector;










276












277



    private Commandlet next;










278












279



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




8✔





280












281



      this.firstCandidate = firstCandidate;




3✔





282



      this.commandletIterator = getCommandlets().iterator();




5✔





283



      this.arguments = arguments;




3✔





284



      this.collector = collector;




3✔





285



      if (isSuitable(firstCandidate)) {





4✔





286



        this.next = firstCandidate;




4✔





287



      } else {










288



        this.next = findNext();




4✔





289



      }










290



    }




1✔





291












292



    @Override










293



    public boolean hasNext() {










294












295



      return this.next != null;





7✔





296



    }










297












298



    @Override










299



    public Commandlet next() {










300












301



      if (this.next == null) {





3!





302



        throw new NoSuchElementException();




×







303



      }










304



      Commandlet result = this.next;




3✔





305



      this.next = findNext();




4✔





306



      return result;




2✔





307



    }










308












309



    private boolean isSuitable(Commandlet commandlet) {










310












311



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





14✔





312



    }










313












314



    private Commandlet findNext() {










315












316



      while (this.commandletIterator.hasNext()) {





4✔





317



        Commandlet cmd = this.commandletIterator.next();




5✔





318



        if ((cmd != this.firstCandidate) && isSuitable(cmd)) {





8✔





319



          List<Property<?>> properties = cmd.getProperties();




3✔





320



          // validation should already be done in add method and could be removed here...










321



          if (properties.isEmpty()) {





3!





322



            assert false : cmd.getClass().getSimpleName() + " has no properties!";




×







323



          } else {










324



            Property<?> property = properties.getFirst();




4✔





325



            if (property instanceof KeywordProperty) {





3!





326



              boolean matches = property.apply(arguments.copy(), context, cmd, this.collector);




12✔





327



              if (matches) {





2✔





328



                return cmd;




2✔





329



              }










330



            } else {




1✔





331



              assert false : cmd.getClass().getSimpleName() + " is invalid as first property must be keyword property but is " + property;




×







332



            }










333



          }










334



        }










335



      }




1✔





336



      return null;




2✔





337



    }










338



  }










339



}
























    

  • 

    •