Add SARIF help uri to console output (metaschema-framework#279)

* Added SARIF help URIs to console output. Resolves metaschema-framework#276. * Fixed logging output which was omitted completely. Also reformatted some source code.
david-waltermire · Dec 10, 2024 · 0d676b4 · 0d676b4
1 parent 6edab20
commit 0d676b4
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/...chema/src/main/java/gov/nist/secauto/metaschema/modules/sarif/SarifValidationHandler.java b/...chema/src/main/java/gov/nist/secauto/metaschema/modules/sarif/SarifValidationHandler.java
@@ -106,13 +106,13 @@ public String getLabel() {
   @NonNull
   static final String SARIF_NS = "https://docs.oasis-open.org/sarif/sarif/v2.1.0";
   @NonNull
-  static final IAttributable.Key SARIF_HELP_URL_KEY
+  public static final IAttributable.Key SARIF_HELP_URL_KEY
       = IAttributable.key("help-url", SARIF_NS);
   @NonNull
-  static final IAttributable.Key SARIF_HELP_TEXT_KEY
+  public static final IAttributable.Key SARIF_HELP_TEXT_KEY
       = IAttributable.key("help-text", SARIF_NS);
   @NonNull
-  static final IAttributable.Key SARIF_HELP_MARKDOWN_KEY
+  public static final IAttributable.Key SARIF_HELP_MARKDOWN_KEY
       = IAttributable.key("help-markdown", SARIF_NS);
 
   @NonNull

diff --git a/...hema-cli/src/main/java/gov/nist/secauto/metaschema/cli/util/LoggingValidationHandler.java b/...hema-cli/src/main/java/gov/nist/secauto/metaschema/cli/util/LoggingValidationHandler.java
@@ -13,6 +13,7 @@
 import gov.nist.secauto.metaschema.core.model.validation.IValidationFinding;
 import gov.nist.secauto.metaschema.core.model.validation.JsonSchemaContentValidator.JsonValidationFinding;
 import gov.nist.secauto.metaschema.core.model.validation.XmlSchemaContentValidator.XmlValidationFinding;
+import gov.nist.secauto.metaschema.modules.sarif.SarifValidationHandler;
 
 import org.apache.logging.log4j.LogBuilder;
 import org.apache.logging.log4j.LogManager;
@@ -22,6 +23,8 @@
 import org.xml.sax.SAXParseException;
 
 import java.net.URI;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
@@ -130,7 +133,17 @@ protected void handleConstraintValidationFinding(@NonNull ConstraintValidationFi
       ansi.format(" %s:", id);
     }
 
-    getLogger(finding).log(ansi.format(" %s", finding.getMessage()));
+    ansi.format(" %s", finding.getMessage());
+
+    Set<String> helpUrls = finding.getConstraints().stream()
+        .flatMap(constraint -> constraint.getPropertyValues(SarifValidationHandler.SARIF_HELP_URL_KEY).stream())
+        .collect(Collectors.toSet());
+    if (!helpUrls.isEmpty()) {
+      ansi.format(" (help: %s)",
+          helpUrls.stream().collect(Collectors.joining(", ")));
+    }
+
+    getLogger(finding).log(ansi);
   }
 
   @NonNull