devonfw / IDEasy / 28829443960

coverage: 71.749% (-0.3%) from 72.066%
28829443960

Pull #1957

github

web-flow 
Merge 3e5330d28 into ce85d84c3
Pull Request #1957: #1953: Implement base functionality of Cleanup Commandlet

4876 of 7508 branches covered (64.94%)

Branch coverage included in aggregate %.

12536 of 16760 relevant lines covered (74.8%)

3.17 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 com.devonfw.tools.ide.tool.inso.Inso;










12












13



import org.slf4j.Logger;










14



import org.slf4j.LoggerFactory;










15












16



import com.devonfw.tools.ide.cli.CliArgument;










17



import com.devonfw.tools.ide.cli.CliArguments;










18



import com.devonfw.tools.ide.commandlet.cleanup.CleanupCommandlet;










19



import com.devonfw.tools.ide.completion.CompletionCandidateCollector;










20



import com.devonfw.tools.ide.context.IdeContext;










21



import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;










22



import com.devonfw.tools.ide.property.KeywordProperty;










23



import com.devonfw.tools.ide.property.Property;










24



import com.devonfw.tools.ide.tool.androidstudio.AndroidStudio;










25



import com.devonfw.tools.ide.tool.aws.Aws;










26



import com.devonfw.tools.ide.tool.az.Azure;










27



import com.devonfw.tools.ide.tool.cdk.Cdk;










28



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










29



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










30



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










31



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










32



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










33



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










34



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










35



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










36



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










37



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










38



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










39



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










40



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










41



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










42



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










43



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










44



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










45



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










46



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










47



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










48



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










49



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










50



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










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.rust.Rust;










62



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










63



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










64



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










65



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










66



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










67



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










68



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










69



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










70



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










71



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










72












73



/**










74



 * Implementation of {@link CommandletManager}.










75



 */










76



public class CommandletManagerImpl implements CommandletManager {










77












78



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




4✔





79












80



  private final IdeContext context;










81












82



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










83












84



  private final Map<String, Commandlet> commandletNameMap;










85












86



  private final Map<String, Commandlet> firstKeywordMap;










87












88



  private final Collection<Commandlet> commandlets;










89












90



  /**










91



   * The constructor.










92



   *










93



   * @param context the {@link IdeContext}.










94



   */










95



  public CommandletManagerImpl(IdeContext context) {










96












97



    super();




2✔





98



    this.context = context;




3✔





99



    this.commandletTypeMap = new HashMap<>();




5✔





100



    this.commandletNameMap = new HashMap<>();




5✔





101



    this.firstKeywordMap = new HashMap<>();




5✔





102



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




6✔





103



    add(new HelpCommandlet(context));




6✔





104



    add(new EnvironmentCommandlet(context));




6✔





105



    add(new CompleteCommandlet(context));




6✔





106



    add(new ShellCommandlet(context));




6✔





107



    add(new InstallCommandlet(context));




6✔





108



    add(new VersionSetCommandlet(context));




6✔





109



    add(new VersionGetCommandlet(context));




6✔





110



    add(new VersionListCommandlet(context));




6✔





111



    add(new EditionGetCommandlet(context));




6✔





112



    add(new EditionSetCommandlet(context));




6✔





113



    add(new EditionListCommandlet(context));




6✔





114



    add(new VersionCommandlet(context));




6✔





115



    add(new StatusCommandlet(context));




6✔





116



    add(new RepositoryCommandlet(context));




6✔





117



    add(new UninstallCommandlet(context));




6✔





118



    add(new LnCommandlet(context));




6✔





119



    add(new UpdateCommandlet(context));




6✔





120



    add(new CleanupCommandlet(context));




6✔





121



    add(new UpgradeSettingsCommandlet(context));




6✔





122



    add(new CreateCommandlet(context));




6✔





123



    add(new BuildCommandlet(context));




6✔





124



    add(new InstallPluginCommandlet(context));




6✔





125



    add(new UninstallPluginCommandlet(context));




6✔





126



    add(new UpgradeCommandlet(context));




6✔





127



    add(new TruststoreCommandlet(context));




6✔





128



    add(new Gh(context));




6✔





129



    add(new Helm(context));




6✔





130



    add(new Java(context));




6✔





131



    add(new Ng(context));




6✔





132



    add(new Node(context));




6✔





133



    add(new Npm(context));




6✔





134



    add(new Mvn(context));




6✔





135



    add(new Msvc(context));




6✔





136



    add(new GcViewer(context));




6✔





137



    add(new Gradle(context));




6✔





138



    add(new Eclipse(context));




6✔





139



    add(new Terraform(context));




6✔





140



    add(new Oc(context));




6✔





141



    add(new Quarkus(context));




6✔





142



    add(new Rust(context));




6✔





143



    add(new Kotlinc(context));




6✔





144



    add(new KotlincNative(context));




6✔





145



    add(new KubeCtl(context));




6✔





146



    add(new Tomcat(context));




6✔





147



    add(new Task(context));




6✔





148



    add(new Vscode(context));




6✔





149



    add(new Azure(context));




6✔





150



    add(new Aws(context));




6✔





151



    add(new Jmc(context));




6✔





152



    add(new DotNet(context));




6✔





153



    add(new Inso(context));




6✔





154



    add(new Intellij(context));




6✔





155



    add(new Jasypt(context));




6✔





156



    add(new Docker(context));




6✔





157



    add(new Sonar(context));




6✔





158



    add(new AndroidStudio(context));




6✔





159



    add(new GraalVm(context));




6✔





160



    add(new PgAdmin(context));




6✔





161



    add(new LazyDocker(context));




6✔





162



    add(new Python(context));




6✔





163



    add(new Pycharm(context));




6✔





164



    add(new Spring(context));




6✔





165



    add(new Uv(context));




6✔





166



    add(new Yarn(context));




6✔





167



    add(new Copilot(context));




6✔





168



    add(new Corepack(context));




6✔





169



    add(new Pip(context));




6✔





170



    add(new Go(context));




6✔





171



    add(new Gui(context));




6✔





172



    add(new SquirrelSql(context));




6✔





173



    add(new Spyder(context));




6✔





174



    add(new Nest(context));




6✔





175



    add(new Cdk(context));




6✔





176



    add(new Claude(context));




6✔





177



  }




1✔





178












179



  /**










180



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










181



   */










182



  protected void add(Commandlet commandlet) {










183












184



    boolean hasRequiredProperty = false;




2✔





185



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




3✔





186



    int propertyCount = properties.size();




3✔





187



    KeywordProperty keyword = commandlet.getFirstKeyword();




3✔





188



    if (keyword != null) {





2!





189



      String name = keyword.getName();




3✔





190



      registerKeyword(name, commandlet);




4✔





191



      String optionName = keyword.getOptionName();




3✔





192



      if (!optionName.equals(name)) {





4✔





193



        registerKeyword(optionName, commandlet);




4✔





194



      }










195



      String alias = keyword.getAlias();




3✔





196



      if (alias != null) {





2✔





197



        registerKeyword(alias, commandlet);




4✔





198



      }










199



    }










200



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





5!





201



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




5✔





202



      if (property.isRequired()) {





3!





203



        hasRequiredProperty = true;




2✔





204



        break;




1✔





205



      }










206



    }










207



    if (!hasRequiredProperty) {





2!





208



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




×







209



    }










210



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




7✔





211



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




8✔





212



    if (duplicate != null) {





2!





213



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




×







214



    }










215



  }




1✔





216












217



  private void registerKeyword(String keyword, Commandlet commandlet) {










218












219



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




7✔





220



    if (duplicate != null) {





2!





221



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




×







222



    }










223



  }




1✔





224












225



  @Override










226



  public Collection<Commandlet> getCommandlets() {










227












228



    return this.commandlets;




3✔





229



  }










230












231



  @Override










232



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










233












234



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




6✔





235



    if (commandlet == null) {





2!





236



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




×







237



    }










238



    return commandletType.cast(commandlet);




5✔





239



  }










240












241



  @Override










242



  public Commandlet getCommandlet(String name) {










243












244



    return this.commandletNameMap.get(name);




6✔





245



  }










246












247



  @Override










248



  public Commandlet getCommandletByFirstKeyword(String keyword) {










249












250



    return this.firstKeywordMap.get(keyword);




6✔





251



  }










252












253



  @Override










254



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










255












256



    CliArgument current = arguments.current();




3✔





257



    if (current.isEnd()) {





3✔





258



      return Collections.emptyIterator();




2✔





259



    }










260



    String keyword = current.get();




3✔





261



    Commandlet commandlet = getCommandletByFirstKeyword(keyword);




4✔





262



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





4✔





263



      return Collections.emptyIterator();




2✔





264



    }










265



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




9✔





266



  }










267












268



  private final class CommandletFinder implements Iterator<Commandlet> {




1✔





269












270



    private final Commandlet firstCandidate;










271












272



    private final Iterator<Commandlet> commandletIterator;










273












274



    private final CliArguments arguments;










275












276



    private final CompletionCandidateCollector collector;










277












278



    private Commandlet next;










279












280



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




8✔





281












282



      this.firstCandidate = firstCandidate;




3✔





283



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




5✔





284



      this.arguments = arguments;




3✔





285



      this.collector = collector;




3✔





286



      if (isSuitable(firstCandidate)) {





4✔





287



        this.next = firstCandidate;




4✔





288



      } else {










289



        this.next = findNext();




4✔





290



      }










291



    }




1✔





292












293



    @Override










294



    public boolean hasNext() {










295












296



      return this.next != null;





7✔





297



    }










298












299



    @Override










300



    public Commandlet next() {










301












302



      if (this.next == null) {





3!





303



        throw new NoSuchElementException();




×







304



      }










305



      Commandlet result = this.next;




3✔





306



      this.next = findNext();




4✔





307



      return result;




2✔





308



    }










309












310



    private boolean isSuitable(Commandlet commandlet) {










311












312



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





14✔





313



    }










314












315



    private Commandlet findNext() {










316












317



      while (this.commandletIterator.hasNext()) {





4✔





318



        Commandlet cmd = this.commandletIterator.next();




5✔





319



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





8✔





320



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




3✔





321



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










322



          if (properties.isEmpty()) {





3!





323



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




×







324



          } else {










325



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




4✔





326



            if (property instanceof KeywordProperty) {





3!





327



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




12✔





328



              if (matches) {





2✔





329



                return cmd;




2✔





330



              }










331



            } else {




1✔





332



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




×







333



            }










334



          }










335



        }










336



      }




1✔





337



      return null;




2✔





338



    }










339



  }










340



}
























    

  • 

    •