devonfw / IDEasy / 26504038966

coverage: 71.056% (-0.001%) from 71.057%
26504038966

Pull #1954

github

web-flow 
Merge c48f3bf26 into ca409b964
Pull Request #1954: #1946: spyder commandlet

4481 of 6990 branches covered (64.11%)

Branch coverage included in aggregate %.

11628 of 15681 relevant lines covered (74.15%)

3.13 hits per line

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

90.59
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.completion.CompletionCandidateCollector;










19



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










20



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










21



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










22



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










23



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










24



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










25



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










26



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










27



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










28



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










29



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










30



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










31



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










32



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










33



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










34



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










35



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










36



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










37



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










38



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










39



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










40



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










41



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










42



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










43



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










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.mvn.Mvn;










49



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










50



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










51



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










52



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










53



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










54



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










55



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










56



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










57



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










58



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










59



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










60



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










61



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










62



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










63



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










64



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










65



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










66



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










67



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










68












69



/**










70



 * Implementation of {@link CommandletManager}.










71



 */










72



public class CommandletManagerImpl implements CommandletManager {










73












74



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




4✔





75












76



  private final IdeContext context;










77












78



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










79












80



  private final Map<String, Commandlet> commandletNameMap;










81












82



  private final Map<String, Commandlet> firstKeywordMap;










83












84



  private final Collection<Commandlet> commandlets;










85












86



  /**










87



   * The constructor.










88



   *










89



   * @param context the {@link IdeContext}.










90



   */










91



  public CommandletManagerImpl(IdeContext context) {










92












93



    super();




2✔





94



    this.context = context;




3✔





95



    this.commandletTypeMap = new HashMap<>();




5✔





96



    this.commandletNameMap = new HashMap<>();




5✔





97



    this.firstKeywordMap = new HashMap<>();




5✔





98



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




6✔





99



    add(new HelpCommandlet(context));




6✔





100



    add(new EnvironmentCommandlet(context));




6✔





101



    add(new CompleteCommandlet(context));




6✔





102



    add(new ShellCommandlet(context));




6✔





103



    add(new InstallCommandlet(context));




6✔





104



    add(new VersionSetCommandlet(context));




6✔





105



    add(new VersionGetCommandlet(context));




6✔





106



    add(new VersionListCommandlet(context));




6✔





107



    add(new EditionGetCommandlet(context));




6✔





108



    add(new EditionSetCommandlet(context));




6✔





109



    add(new EditionListCommandlet(context));




6✔





110



    add(new VersionCommandlet(context));




6✔





111



    add(new StatusCommandlet(context));




6✔





112



    add(new RepositoryCommandlet(context));




6✔





113



    add(new UninstallCommandlet(context));




6✔





114



    add(new LnCommandlet(context));




6✔





115



    add(new UpdateCommandlet(context));




6✔





116



    add(new UpgradeSettingsCommandlet(context));




6✔





117



    add(new CreateCommandlet(context));




6✔





118



    add(new BuildCommandlet(context));




6✔





119



    add(new InstallPluginCommandlet(context));




6✔





120



    add(new UninstallPluginCommandlet(context));




6✔





121



    add(new UpgradeCommandlet(context));




6✔





122



    add(new TruststoreCommandlet(context));




6✔





123



    add(new Gh(context));




6✔





124



    add(new Helm(context));




6✔





125



    add(new Java(context));




6✔





126



    add(new Ng(context));




6✔





127



    add(new Node(context));




6✔





128



    add(new Npm(context));




6✔





129



    add(new Mvn(context));




6✔





130



    add(new GcViewer(context));




6✔





131



    add(new Gradle(context));




6✔





132



    add(new Eclipse(context));




6✔





133



    add(new Terraform(context));




6✔





134



    add(new Oc(context));




6✔





135



    add(new Quarkus(context));




6✔





136



    add(new Kotlinc(context));




6✔





137



    add(new KotlincNative(context));




6✔





138



    add(new KubeCtl(context));




6✔





139



    add(new Tomcat(context));




6✔





140



    add(new Vscode(context));




6✔





141



    add(new Azure(context));




6✔





142



    add(new Aws(context));




6✔





143



    add(new Jmc(context));




6✔





144



    add(new DotNet(context));




6✔





145



    add(new Inso(context));




6✔





146



    add(new Intellij(context));




6✔





147



    add(new Jasypt(context));




6✔





148



    add(new Docker(context));




6✔





149



    add(new Sonar(context));




6✔





150



    add(new AndroidStudio(context));




6✔





151



    add(new GraalVm(context));




6✔





152



    add(new PgAdmin(context));




6✔





153



    add(new LazyDocker(context));




6✔





154



    add(new Python(context));




6✔





155



    add(new Pycharm(context));




6✔





156



    add(new Spring(context));




6✔





157



    add(new Uv(context));




6✔





158



    add(new Yarn(context));




6✔





159



    add(new Copilot(context));




6✔





160



    add(new Corepack(context));




6✔





161



    add(new Pip(context));




6✔





162



    add(new Go(context));




6✔





163



    add(new Gui(context));




6✔





164



    add(new SquirrelSql(context));




6✔





165



    add(new Spyder(context));




6✔





166



    add(new Nest(context));




6✔





167



    add(new Cdk(context));




6✔





168



    add(new Claude(context));




6✔





169



  }




1✔





170












171



  /**










172



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










173



   */










174



  protected void add(Commandlet commandlet) {










175












176



    boolean hasRequiredProperty = false;




2✔





177



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




3✔





178



    int propertyCount = properties.size();




3✔





179



    KeywordProperty keyword = commandlet.getFirstKeyword();




3✔





180



    if (keyword != null) {





2!





181



      String name = keyword.getName();




3✔





182



      registerKeyword(name, commandlet);




4✔





183



      String optionName = keyword.getOptionName();




3✔





184



      if (!optionName.equals(name)) {





4✔





185



        registerKeyword(optionName, commandlet);




4✔





186



      }










187



      String alias = keyword.getAlias();




3✔





188



      if (alias != null) {





2✔





189



        registerKeyword(alias, commandlet);




4✔





190



      }










191



    }










192



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





5!





193



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




5✔





194



      if (property.isRequired()) {





3!





195



        hasRequiredProperty = true;




2✔





196



        break;




1✔





197



      }










198



    }










199



    if (!hasRequiredProperty) {





2!





200



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




×







201



    }










202



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




7✔





203



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




8✔





204



    if (duplicate != null) {





2!





205



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




×







206



    }










207



  }




1✔





208












209



  private void registerKeyword(String keyword, Commandlet commandlet) {










210












211



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




7✔





212



    if (duplicate != null) {





2!





213



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




×







214



    }










215



  }




1✔





216












217



  @Override










218



  public Collection<Commandlet> getCommandlets() {










219












220



    return this.commandlets;




3✔





221



  }










222












223



  @Override










224



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










225












226



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




6✔





227



    if (commandlet == null) {





2!





228



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




×







229



    }










230



    return commandletType.cast(commandlet);




5✔





231



  }










232












233



  @Override










234



  public Commandlet getCommandlet(String name) {










235












236



    return this.commandletNameMap.get(name);




6✔





237



  }










238












239



  @Override










240



  public Commandlet getCommandletByFirstKeyword(String keyword) {










241












242



    return this.firstKeywordMap.get(keyword);




6✔





243



  }










244












245



  @Override










246



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










247












248



    CliArgument current = arguments.current();




3✔





249



    if (current.isEnd()) {





3!





250



      return Collections.emptyIterator();




×







251



    }










252



    String keyword = current.get();




3✔





253



    Commandlet commandlet = getCommandletByFirstKeyword(keyword);




4✔





254



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





4✔





255



      return Collections.emptyIterator();




2✔





256



    }










257



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




9✔





258



  }










259












260



  private final class CommandletFinder implements Iterator<Commandlet> {




1✔





261












262



    private final Commandlet firstCandidate;










263












264



    private final Iterator<Commandlet> commandletIterator;










265












266



    private final CliArguments arguments;










267












268



    private final CompletionCandidateCollector collector;










269












270



    private Commandlet next;










271












272



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




8✔





273












274



      this.firstCandidate = firstCandidate;




3✔





275



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




5✔





276



      this.arguments = arguments;




3✔





277



      this.collector = collector;




3✔





278



      if (isSuitable(firstCandidate)) {





4✔





279



        this.next = firstCandidate;




4✔





280



      } else {










281



        this.next = findNext();




4✔





282



      }










283



    }




1✔





284












285



    @Override










286



    public boolean hasNext() {










287












288



      return this.next != null;





7✔





289



    }










290












291



    @Override










292



    public Commandlet next() {










293












294



      if (this.next == null) {





3!





295



        throw new NoSuchElementException();




×







296



      }










297



      Commandlet result = this.next;




3✔





298



      this.next = findNext();




4✔





299



      return result;




2✔





300



    }










301












302



    private boolean isSuitable(Commandlet commandlet) {










303












304



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





14✔





305



    }










306












307



    private Commandlet findNext() {










308












309



      while (this.commandletIterator.hasNext()) {





4✔





310



        Commandlet cmd = this.commandletIterator.next();




5✔





311



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





8✔





312



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




3✔





313



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










314



          if (properties.isEmpty()) {





3!





315



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




×







316



          } else {










317



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




4✔





318



            if (property instanceof KeywordProperty) {





3!





319



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




12✔





320



              if (matches) {





2✔





321



                return cmd;




2✔





322



              }










323



            } else {




1✔





324



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




×







325



            }










326



          }










327



        }










328



      }




1✔





329



      return null;




2✔





330



    }










331



  }










332



}
























    

  • 

    •