#438: add ValidationState (#569)

cli/src/main/java/com/devonfw/tools/ide/commandlet/Commandlet.java

@@ -13,6 +13,8 @@
 import com.devonfw.tools.ide.property.Property;
 import com.devonfw.tools.ide.tool.ToolCommandlet;
 import com.devonfw.tools.ide.tool.plugin.PluginDescriptor;
+import com.devonfw.tools.ide.validation.ValidationResult;
+import com.devonfw.tools.ide.validation.ValidationState;
 import com.devonfw.tools.ide.version.VersionIdentifier;
 
 /**
@@ -219,20 +221,13 @@ public boolean isProcessableOutput() {
    * @return {@code true} if this {@link Commandlet} is the valid candidate to be {@link #run()}, {@code false} otherwise.
    * @see Property#validate()
    */
-  public boolean validate() {
-
+  public ValidationResult validate() {
+    ValidationState state = new ValidationState(null);
     // avoid validation exception if not a candidate to be run.
     for (Property<?> property : this.propertiesList) {
-      if (property.isRequired() && (property.getValue() == null)) {
-        return false;
-      }
-    }
-    for (Property<?> property : this.propertiesList) {
-      if (!property.validate()) {
-        return false;
-      }
+      state.add(property.validate());
     }
-    return true;
+    return state;
   }
 
   /**

cli/src/main/java/com/devonfw/tools/ide/commandlet/InstallCommandlet.java

@@ -4,6 +4,7 @@
 import com.devonfw.tools.ide.property.ToolProperty;
 import com.devonfw.tools.ide.property.VersionProperty;
 import com.devonfw.tools.ide.tool.ToolCommandlet;
+import com.devonfw.tools.ide.validation.ValidationState;
 import com.devonfw.tools.ide.version.VersionIdentifier;
 
 /**
@@ -29,7 +30,12 @@ public InstallCommandlet(IdeContext context) {
     super(context);
     addKeyword(getName());
     this.tool = add(new ToolProperty("", true, "tool"));
-    this.version = add(new VersionProperty("", false, "version"));
+    this.version = add(new VersionProperty("", false, "version",
+        (v, state) -> {
+          if (!v.isValid()) {
+            state.addErrorMessage("Given version " + v + " is not a valid version");
+          }
+        }));
   }
 
   @Override

cli/src/main/java/com/devonfw/tools/ide/commandlet/ShellCommandlet.java

@@ -199,6 +199,6 @@ private boolean apply(CliArgument argument, Commandlet commandlet) {
       }
       currentArgument = currentArgument.getNext(!endOpts);
     }
-    return commandlet.validate();
+    return commandlet.validate().isValid();
   }
 }

cli/src/main/java/com/devonfw/tools/ide/context/AbstractIdeContext.java

@@ -50,6 +50,8 @@
 import com.devonfw.tools.ide.step.Step;
 import com.devonfw.tools.ide.step.StepImpl;
 import com.devonfw.tools.ide.url.model.UrlMetadata;
+import com.devonfw.tools.ide.validation.ValidationResult;
+import com.devonfw.tools.ide.validation.ValidationState;
 import com.devonfw.tools.ide.variable.IdeVariables;
 
 /**
@@ -774,25 +776,28 @@ public int run(CliArguments arguments) {
       if (!current.isEnd()) {
         String keyword = current.get();
         firstCandidate = this.commandletManager.getCommandletByFirstKeyword(keyword);
-        boolean matches;
+        ValidationResult firstResult = null;
         if (firstCandidate != null) {
-          matches = applyAndRun(arguments.copy(), firstCandidate);
-          if (matches) {
+          firstResult = applyAndRun(arguments.copy(), firstCandidate);
+          if (firstResult.isValid()) {
             supressStepSuccess = firstCandidate.isSuppressStepSuccess();
             step.success();
             return ProcessResult.SUCCESS;
           }
         }
         for (Commandlet cmd : this.commandletManager.getCommandlets()) {
           if (cmd != firstCandidate) {
-            matches = applyAndRun(arguments.copy(), cmd);
-            if (matches) {
+            ValidationResult result = applyAndRun(arguments.copy(), cmd);
+            if (result.isValid()) {
               supressStepSuccess = cmd.isSuppressStepSuccess();
               step.success();
               return ProcessResult.SUCCESS;
             }
           }
         }
+        if (firstResult != null) {
+          throw new CliException(firstResult.getErrorMessage());
+        }
         step.error("Invalid arguments: {}", current.getArgs());
       }
 
@@ -818,15 +823,15 @@ public int run(CliArguments arguments) {
    * @return {@code true} if the given {@link Commandlet} matched and did {@link Commandlet#run() run} successfully, {@code false} otherwise (the
    *     {@link Commandlet} did not match and we have to try a different candidate).
    */
-  private boolean applyAndRun(CliArguments arguments, Commandlet cmd) {
+  private ValidationResult applyAndRun(CliArguments arguments, Commandlet cmd) {
 
     cmd.clearProperties();
 
-    boolean matches = apply(arguments, cmd, null);
-    if (matches) {
-      matches = cmd.validate();
+    ValidationResult result = apply(arguments, cmd, null);
+    if (result.isValid()) {
+      result = cmd.validate();
     }
-    if (matches) {
+    if (result.isValid()) {
       debug("Running commandlet {}", cmd);
       if (cmd.isIdeHomeRequired() && (this.ideHome == null)) {
         throw new CliException(getMessageIdeHomeNotFound(), ProcessResult.NO_IDE_HOME);
@@ -868,7 +873,7 @@ private boolean applyAndRun(CliArguments arguments, Commandlet cmd) {
     } else {
       trace("Commandlet did not match");
     }
-    return matches;
+    return result;
   }
 
   /**
@@ -914,7 +919,7 @@ private boolean completeCommandlet(CliArguments arguments, Commandlet cmd, Compl
     if (cmd.isIdeHomeRequired() && (this.ideHome == null)) {
       return false;
     } else {
-      return apply(arguments.copy(), cmd, collector);
+      return apply(arguments.copy(), cmd, collector).isValid();
     }
   }
 
@@ -927,7 +932,7 @@ private boolean completeCommandlet(CliArguments arguments, Commandlet cmd, Compl
    * @return {@code true} if the given {@link Commandlet} matches to the given {@link CliArgument}(s) and those have been applied (set in the {@link Commandlet}
    *     and {@link Commandlet#validate() validated}), {@code false} otherwise (the {@link Commandlet} did not match and we have to try a different candidate).
    */
-  public boolean apply(CliArguments arguments, Commandlet cmd, CompletionCandidateCollector collector) {
+  public ValidationResult apply(CliArguments arguments, Commandlet cmd, CompletionCandidateCollector collector) {
 
     trace("Trying to match arguments to commandlet {}", cmd.getName());
     CliArgument currentArgument = arguments.current();
@@ -952,7 +957,9 @@ public boolean apply(CliArguments arguments, Commandlet cmd, CompletionCandidate
       }
       if (currentProperty == null) {
         trace("No option or next value found");
-        return false;
+        ValidationState state = new ValidationState(null);
+        state.addErrorMessage("No matching property found");
+        return state;
       }
       trace("Next property candidate to match argument is {}", currentProperty);
       if (currentProperty == property) {
@@ -969,11 +976,13 @@ public boolean apply(CliArguments arguments, Commandlet cmd, CompletionCandidate
       }
       boolean matches = currentProperty.apply(arguments, this, cmd, collector);
       if (!matches || currentArgument.isCompletion()) {
-        return false;
+        ValidationState state = new ValidationState(null);
+        state.addErrorMessage("No matching property found");
+        return state;
       }
       currentArgument = arguments.current();
     }
-    return true;
+    return new ValidationState(null);
   }
 
   @Override

cli/src/main/java/com/devonfw/tools/ide/property/CommandletProperty.java

@@ -1,10 +1,9 @@
 package com.devonfw.tools.ide.property;
 
-import java.util.function.Consumer;
-
 import com.devonfw.tools.ide.commandlet.Commandlet;
 import com.devonfw.tools.ide.completion.CompletionCandidateCollector;
 import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.validation.PropertyValidator;
 
 /**
  * {@link Property} with {@link #getValueType() value type} {@link Commandlet}.
@@ -29,9 +28,9 @@ public CommandletProperty(String name, boolean required, String alias) {
    * @param name the {@link #getName() property name}.
    * @param required the {@link #isRequired() required flag}.
    * @param alias the {@link #getAlias() property alias}.
-   * @param validator the {@link Consumer} used to {@link #validate() validate} the {@link #getValue() value}.
+   * @param validator the {@link PropertyValidator} used to {@link #validate() validate} the {@link #getValue() value}.
    */
-  public CommandletProperty(String name, boolean required, String alias, Consumer<Commandlet> validator) {
+  public CommandletProperty(String name, boolean required, String alias, PropertyValidator<Commandlet> validator) {
 
     super(name, required, alias, false, validator);
   }

cli/src/main/java/com/devonfw/tools/ide/property/EditionProperty.java

@@ -1,8 +1,7 @@
 package com.devonfw.tools.ide.property;
 
-import java.util.function.Consumer;
-
 import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.validation.PropertyValidator;
 
 public class EditionProperty extends Property<String> {
 
@@ -24,9 +23,9 @@ public EditionProperty(String name, boolean required, String alias) {
    * @param name the {@link #getName() property name}.
    * @param required the {@link #isRequired() required flag}.
    * @param alias the {@link #getAlias() property alias}.
-   * @param validator the {@link Consumer} used to {@link #validate() validate} the {@link #getValue() value}.
+   * @param validator the {@link PropertyValidator} used to {@link #validate() validate} the {@link #getValue() value}.
    */
-  public EditionProperty(String name, boolean required, String alias, Consumer<String> validator) {
+  public EditionProperty(String name, boolean required, String alias, PropertyValidator<String> validator) {
 
     super(name, required, alias, false, validator);
   }

cli/src/main/java/com/devonfw/tools/ide/property/FileProperty.java

@@ -1,7 +1,8 @@
 package com.devonfw.tools.ide.property;
 
 import java.nio.file.Path;
-import java.util.function.Consumer;
+
+import com.devonfw.tools.ide.validation.PropertyValidator;
 
 /**
  * {@link PathProperty} for a file.
@@ -28,9 +29,9 @@ public FileProperty(String name, boolean required, String alias, boolean mustExi
    * @param required the {@link #isRequired() required flag}.
    * @param alias the {@link #getAlias() property alias}.
    * @param mustExist the {@link #isPathRequiredToExist() required to exist flag}.
-   * @param validator the {@link Consumer} used to {@link #validate() validate} the {@link #getValue() value}.
+   * @param validator the {@link PropertyValidator} used to {@link #validate() validate} the {@link #getValue() value}.
    */
-  public FileProperty(String name, boolean required, String alias, boolean mustExist, Consumer<Path> validator) {
+  public FileProperty(String name, boolean required, String alias, boolean mustExist, PropertyValidator<Path> validator) {
 
     super(name, required, alias, mustExist, validator);
   }

cli/src/main/java/com/devonfw/tools/ide/property/FolderProperty.java

@@ -1,7 +1,8 @@
 package com.devonfw.tools.ide.property;
 
 import java.nio.file.Path;
-import java.util.function.Consumer;
+
+import com.devonfw.tools.ide.validation.PropertyValidator;
 
 /**
  * {@link PathProperty} for a folder (directory).
@@ -28,9 +29,9 @@ public FolderProperty(String name, boolean required, String alias, boolean mustE
    * @param required the {@link #isRequired() required flag}.
    * @param alias the {@link #getAlias() property alias}.
    * @param mustExist the {@link #isPathRequiredToExist() required to exist flag}.
-   * @param validator the {@link Consumer} used to {@link #validate() validate} the {@link #getValue() value}.
+   * @param validator the {@link PropertyValidator} used to {@link #validate() validate} the {@link #getValue() value}.
    */
-  public FolderProperty(String name, boolean required, String alias, boolean mustExist, Consumer<Path> validator) {
+  public FolderProperty(String name, boolean required, String alias, boolean mustExist, PropertyValidator<Path> validator) {
 
     super(name, required, alias, mustExist, validator);
   }

cli/src/main/java/com/devonfw/tools/ide/property/LocaleProperty.java

@@ -2,11 +2,11 @@
 
 import java.util.Arrays;
 import java.util.Locale;
-import java.util.function.Consumer;
 
 import com.devonfw.tools.ide.commandlet.Commandlet;
 import com.devonfw.tools.ide.completion.CompletionCandidateCollector;
 import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.validation.PropertyValidator;
 
 /**
  * {@link Property} with {@link Locale} as {@link #getValueType() value type}.
@@ -33,9 +33,9 @@ public LocaleProperty(String name, boolean required, String alias) {
    * @param name the {@link #getName() property name}.
    * @param required the {@link #isRequired() required flag}.
    * @param alias the {@link #getAlias() property alias}.
-   * @param validator the {@link Consumer} used to {@link #validate() validate} the {@link #getValue() value}.
+   * @param validator the {@link PropertyValidator} used to {@link #validate() validate} the {@link #getValue() value}.
    */
-  public LocaleProperty(String name, boolean required, String alias, Consumer<Locale> validator) {
+  public LocaleProperty(String name, boolean required, String alias, PropertyValidator<Locale> validator) {
 
     super(name, required, alias, false, validator);
   }

cli/src/main/java/com/devonfw/tools/ide/property/NumberProperty.java

@@ -1,8 +1,7 @@
 package com.devonfw.tools.ide.property;
 
-import java.util.function.Consumer;
-
 import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.validation.PropertyValidator;
 
 /**
  * {@link Property} with {@link #getValueType() value type} {@link Long}.
@@ -27,9 +26,9 @@ public NumberProperty(String name, boolean required, String alias) {
    * @param name the {@link #getName() property name}.
    * @param required the {@link #isRequired() required flag}.
    * @param alias the {@link #getAlias() property alias}.
-   * @param validator the {@link Consumer} used to {@link #validate() validate} the {@link #getValue() value}.
+   * @param validator the {@link PropertyValidator} used to {@link #validate() validate} the {@link #getValue() value}.
    */
-  public NumberProperty(String name, boolean required, String alias, Consumer<Long> validator) {
+  public NumberProperty(String name, boolean required, String alias, PropertyValidator<Long> validator) {
 
     super(name, required, alias, false, validator);
   }