devonfw / IDEasy / 29996096637

coverage: 72.498% (+0.002%) from 72.496%
29996096637

Pull #2202

github

web-flow 
Merge 3b78421f1 into 5b6cc3011
Pull Request #2202: #2187: Integrate Ruff

4971 of 7586 branches covered (65.53%)

Branch coverage included in aggregate %.

12828 of 16965 relevant lines covered (75.61%)

3.2 hits per line

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

91.9
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.just.Just;










44



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










45



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










46



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










47



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










48



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










49



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










50



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










51



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










52



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










53



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










54



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










55



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










56



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










57



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










58



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










59



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










60



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










61



import com.devonfw.tools.ide.tool.ruff.Ruff;










62



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










63



import com.devonfw.tools.ide.tool.soapui.SoapUi;










64



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










65



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










66



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










67



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










68



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










69



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










70



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










71



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










72



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










73



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










74












75



/**










76



 * Implementation of {@link CommandletManager}.










77



 */










78



public class CommandletManagerImpl implements CommandletManager {










79












80



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




4✔





81












82



  private final IdeContext context;










83












84



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










85












86



  private final Map<String, Commandlet> commandletNameMap;










87












88



  private final Map<String, Commandlet> firstKeywordMap;










89












90



  private final Collection<Commandlet> commandlets;










91












92



  /**










93



   * The constructor.










94



   *










95



   * @param context the {@link IdeContext}.










96



   */










97



  public CommandletManagerImpl(IdeContext context) {










98












99



    super();




2✔





100



    this.context = context;




3✔





101



    this.commandletTypeMap = new HashMap<>();




5✔





102



    this.commandletNameMap = new HashMap<>();




5✔





103



    this.firstKeywordMap = new HashMap<>();




5✔





104



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




6✔





105



    add(new HelpCommandlet(context));




6✔





106



    add(new EnvironmentCommandlet(context));




6✔





107



    add(new CompleteCommandlet(context));




6✔





108



    add(new ShellCommandlet(context));




6✔





109



    add(new InstallCommandlet(context));




6✔





110



    add(new VersionSetCommandlet(context));




6✔





111



    add(new VersionGetCommandlet(context));




6✔





112



    add(new VersionListCommandlet(context));




6✔





113



    add(new EditionGetCommandlet(context));




6✔





114



    add(new EditionSetCommandlet(context));




6✔





115



    add(new EditionListCommandlet(context));




6✔





116



    add(new VersionCommandlet(context));




6✔





117



    add(new StatusCommandlet(context));




6✔





118



    add(new RepositoryCommandlet(context));




6✔





119



    add(new UninstallCommandlet(context));




6✔





120



    add(new LnCommandlet(context));




6✔





121



    add(new UpdateCommandlet(context));




6✔





122



    add(new UpgradeSettingsCommandlet(context));




6✔





123



    add(new CreateCommandlet(context));




6✔





124



    add(new BuildCommandlet(context));




6✔





125



    add(new ReleaseCommandlet(context));




6✔





126



    add(new InstallPluginCommandlet(context));




6✔





127



    add(new UninstallPluginCommandlet(context));




6✔





128



    add(new UpgradeCommandlet(context));




6✔





129



    add(new TruststoreCommandlet(context));




6✔





130



    add(new Gh(context));




6✔





131



    add(new Helm(context));




6✔





132



    add(new Java(context));




6✔





133



    add(new Ng(context));




6✔





134



    add(new Node(context));




6✔





135



    add(new Npm(context));




6✔





136



    add(new Mvn(context));




6✔





137



    add(new Msvc(context));




6✔





138



    add(new GcViewer(context));




6✔





139



    add(new Gradle(context));




6✔





140



    add(new Eclipse(context));




6✔





141



    add(new Terraform(context));




6✔





142



    add(new Oc(context));




6✔





143



    add(new Quarkus(context));




6✔





144



    add(new Rust(context));




6✔





145



    add(new Kotlinc(context));




6✔





146



    add(new KotlincNative(context));




6✔





147



    add(new KubeCtl(context));




6✔





148



    add(new Tomcat(context));




6✔





149



    add(new Task(context));




6✔





150



    add(new Vscode(context));




6✔





151



    add(new Azure(context));




6✔





152



    add(new Aws(context));




6✔





153



    add(new Jmc(context));




6✔





154



    add(new DotNet(context));




6✔





155



    add(new Inso(context));




6✔





156



    add(new Intellij(context));




6✔





157



    add(new Jasypt(context));




6✔





158



    add(new Docker(context));




6✔





159



    add(new Sonar(context));




6✔





160



    add(new AndroidStudio(context));




6✔





161



    add(new GraalVm(context));




6✔





162



    add(new PgAdmin(context));




6✔





163



    add(new LazyDocker(context));




6✔





164



    add(new Python(context));




6✔





165



    add(new Pycharm(context));




6✔





166



    add(new Spring(context));




6✔





167



    add(new Uv(context));




6✔





168



    add(new Yarn(context));




6✔





169



    add(new Copilot(context));




6✔





170



    add(new Corepack(context));




6✔





171



    add(new Pip(context));




6✔





172



    add(new Go(context));




6✔





173



    add(new Gui(context));




6✔





174



    add(new SquirrelSql(context));




6✔





175



    add(new Spyder(context));




6✔





176



    add(new Nest(context));




6✔





177



    add(new Cdk(context));




6✔





178



    add(new Claude(context));




6✔





179



    add(new Mvnd(context));




6✔





180



    add(new Just(context));




6✔





181



    add(new SoapUi(context));




6✔





182



    add(new Ruff(context));




6✔





183



  }




1✔





184












185



  /**










186



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










187



   */










188



  protected void add(Commandlet commandlet) {










189












190



    boolean hasRequiredProperty = false;




2✔





191



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




3✔





192



    int propertyCount = properties.size();




3✔





193



    KeywordProperty keyword = commandlet.getFirstKeyword();




3✔





194



    if (keyword != null) {





2!





195



      String name = keyword.getName();




3✔





196



      registerKeyword(name, commandlet);




4✔





197



      String optionName = keyword.getOptionName();




3✔





198



      if (!optionName.equals(name)) {





4✔





199



        registerKeyword(optionName, commandlet);




4✔





200



      }










201



      String alias = keyword.getAlias();




3✔





202



      if (alias != null) {





2✔





203



        registerKeyword(alias, commandlet);




4✔





204



      }










205



    }










206



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





5!





207



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




5✔





208



      if (property.isRequired()) {





3!





209



        hasRequiredProperty = true;




2✔





210



        break;




1✔





211



      }










212



    }










213



    if (!hasRequiredProperty) {





2!





214



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




×







215



    }










216



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




7✔





217



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




8✔





218



    if (duplicate != null) {





2!





219



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




×







220



    }










221



  }




1✔





222












223



  private void registerKeyword(String keyword, Commandlet commandlet) {










224












225



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




7✔





226



    if (duplicate != null) {





2!





227



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




×







228



    }










229



  }




1✔





230












231



  @Override










232



  public Collection<Commandlet> getCommandlets() {










233












234



    return this.commandlets;




3✔





235



  }










236












237



  @Override










238



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










239












240



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




6✔





241



    if (commandlet == null) {





2!





242



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




×







243



    }










244



    return commandletType.cast(commandlet);




5✔





245



  }










246












247



  @Override










248



  public Commandlet getCommandlet(String name) {










249












250



    return this.commandletNameMap.get(name);




6✔





251



  }










252












253



  @Override










254



  public Commandlet getCommandletByFirstKeyword(String keyword) {










255












256



    return this.firstKeywordMap.get(keyword);




6✔





257



  }










258












259



  @Override










260



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










261












262



    CliArgument current = arguments.current();




3✔





263



    if (current.isEnd()) {





3✔





264



      return Collections.emptyIterator();




2✔





265



    }










266



    String keyword = current.get();




3✔





267



    Commandlet commandlet = getCommandletByFirstKeyword(keyword);




4✔





268



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





4✔





269



      return Collections.emptyIterator();




2✔





270



    }










271



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




9✔





272



  }










273












274



  private final class CommandletFinder implements Iterator<Commandlet> {




1✔





275












276



    private final Commandlet firstCandidate;










277












278



    private final Iterator<Commandlet> commandletIterator;










279












280



    private final CliArguments arguments;










281












282



    private final CompletionCandidateCollector collector;










283












284



    private Commandlet next;










285












286



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




8✔





287












288



      this.firstCandidate = firstCandidate;




3✔





289



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




5✔





290



      this.arguments = arguments;




3✔





291



      this.collector = collector;




3✔





292



      if (isSuitable(firstCandidate)) {





4✔





293



        this.next = firstCandidate;




4✔





294



      } else {










295



        this.next = findNext();




4✔





296



      }










297



    }




1✔





298












299



    @Override










300



    public boolean hasNext() {










301












302



      return this.next != null;





7✔





303



    }










304












305



    @Override










306



    public Commandlet next() {










307












308



      if (this.next == null) {





3!





309



        throw new NoSuchElementException();




×







310



      }










311



      Commandlet result = this.next;




3✔





312



      this.next = findNext();




4✔





313



      return result;




2✔





314



    }










315












316



    private boolean isSuitable(Commandlet commandlet) {










317












318



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





14✔





319



    }










320












321



    private Commandlet findNext() {










322












323



      while (this.commandletIterator.hasNext()) {





4✔





324



        Commandlet cmd = this.commandletIterator.next();




5✔





325



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





8✔





326



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




3✔





327



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










328



          if (properties.isEmpty()) {





3!





329



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




×







330



          } else {










331



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




4✔





332



            if (property instanceof KeywordProperty) {





3!





333



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




12✔





334



              if (matches) {





2✔





335



                return cmd;




2✔





336



              }










337



            } else {




1✔





338



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




×







339



            }










340



          }










341



        }










342



      }




1✔





343



      return null;




2✔





344



    }










345



  }










346



}
























    

  • 

    •