Fixed a schema generation bug causing an existing test to fail due to…

… improper handling of JSON keys. Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance. Resolves usnistgov/metaschema-java#241.
david-waltermire · Sep 7, 2024 · 047da2d · 047da2d
1 parent 75a0c9b
commit 047da2d
Show file tree

Hide file tree

Showing 24 changed files with 623 additions and 218 deletions.
diff --git a/.lycheeignore b/.lycheeignore
@@ -16,6 +16,7 @@ https://github.com/hamcrest/JavaHamcrest/hamcrest-core
 https://github.com/javaparser/.*
 https://github.com/vsch/flexmark-java/.*
 https://hc.apache.org/httpcomponents-client-5.0.x/5.1.3/httpclient5/
+https://logback.qos.ch/logback-.*
 https://logging.apache.org/log4j/2.x/log4j/.*
 http://mojo.codehaus.org/.*
 https://pmd.github.io/latest/pmd_userdocs_cpd.html
@@ -27,13 +28,15 @@ https://www.antlr.org/antlr4-runtime/
 http://www.eclipse.org/eclipselink/moxy/org.eclipse.persistence.moxy
 http://www.eclipse.org/sisu/org.eclipse.sisu.plexus/
 http://www.eclipse.org/sisu/org.eclipse.sisu.inject/
+http://www.jdom.org/
 http://www.mojohaus.org/appassembler-maven-plugin/appassembler/appassembler-maven-plugin
 http://www.seamframework.org/Weld/cdi-api
 http://www.thymeleaf.org/thymeleaf-lib/thymeleaf
 # broken license references
 https://opensource.org/licenses/Apache-2.0,https://opensource.org/licenses/EPL-2.0
 # prone to long timeouts
-http://nexus.sonatype.org/oss-repository-hosting.html/.*
 https://glassfish.dev.java.net/.*
-
-
+http://nexus.sonatype.org/oss-repository-hosting.html/.*
+https://projects.eclipse.org/projects/eclipse.jdt
+# fix later
+https://github.com/metaschema-framework/liboscal-java/
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/DefaultItemWriter.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/DefaultItemWriter.java
@@ -0,0 +1,131 @@
+/*
+ * SPDX-FileCopyrightText: none
+ * SPDX-License-Identifier: CC0-1.0
+ */
+
+package gov.nist.secauto.metaschema.core.metapath.item;
+
+import gov.nist.secauto.metaschema.core.metapath.ICollectionValue;
+import gov.nist.secauto.metaschema.core.metapath.ISequence;
+import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
+import gov.nist.secauto.metaschema.core.metapath.item.function.IArrayItem;
+import gov.nist.secauto.metaschema.core.metapath.item.function.IMapItem;
+import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
+
+import java.io.PrintWriter;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+public class DefaultItemWriter implements IItemWriter {
+
+  @NonNull
+  private final PrintWriter writer;
+  @NonNull
+  private final Visitor visitor = new Visitor();
+
+  public DefaultItemWriter(@NonNull PrintWriter writer) {
+    this.writer = writer;
+  }
+
+  @Override
+  public void writeSequence(ISequence<?> sequence) {
+    boolean wrap = sequence.size() != 1;
+    if (wrap) {
+      writer.append('(');
+    }
+    boolean first = true;
+    for (IItem item : sequence) {
+
+      if (first) {
+        first = false;
+      } else {
+        writer.append(',');
+      }
+
+      item.accept(visitor);
+    }
+
+    if (wrap) {
+      writer.append(')');
+    }
+  }
+
+  @Override
+  public void writeArray(IArrayItem<?> array) {
+    writer.append('[');
+    boolean first = true;
+    for (ICollectionValue value : array) {
+      assert value != null;
+
+      if (first) {
+        first = false;
+      } else {
+        writer.append(',');
+      }
+
+      writeCollectionValue(value);
+    }
+    writer.append(']');
+  }
+
+  @Override
+  public void writeMap(IMapItem<?> map) {
+    writer.append("map {");
+    boolean first = true;
+    for (ICollectionValue value : map.values()) {
+      assert value != null;
+
+      if (first) {
+        first = false;
+      } else {
+        writer.append(',');
+      }
+
+      writeCollectionValue(value);
+    }
+    writer.append('}');
+  }
+
+  @Override
+  public void writeNode(INodeItem node) {
+    writer.append(node.getBaseUri().toString());
+    writer.append('#');
+    writer.append(node.getMetapath());
+  }
+
+  @Override
+  public void writeAtomicValue(IAnyAtomicItem node) {
+    writer.append(node.asString());
+  }
+
+  protected void writeCollectionValue(@NonNull ICollectionValue value) {
+    if (value instanceof IItem) {
+      ((IItem) value).accept(visitor);
+    } else if (value instanceof ISequence) {
+      writeSequence((ISequence<?>) value);
+    }
+  }
+
+  private final class Visitor implements IItemVisitor {
+
+    @Override
+    public void visit(IArrayItem<?> array) {
+      writeArray(array);
+    }
+
+    @Override
+    public void visit(IMapItem<?> map) {
+      writeMap(map);
+    }
+
+    @Override
+    public void visit(INodeItem node) {
+      writeNode(node);
+    }
+
+    @Override
+    public void visit(IAnyAtomicItem node) {
+      writeAtomicValue(node);
+    }
+  }
+}
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/IItem.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/IItem.java
@@ -11,6 +11,8 @@
 
 import java.util.stream.Stream;
 
+import edu.umd.cs.findbugs.annotations.NonNull;
+
 public interface IItem extends ICollectionValue {
 
   /**
@@ -49,4 +51,6 @@ default ISequence<?> asSequence() {
   default Stream<? extends IItem> flatten() {
     return Stream.of(this);
   }
+
+  void accept(@NonNull IItemVisitor visitor);
 }
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/IItemVisitor.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/IItemVisitor.java
@@ -0,0 +1,23 @@
+/*
+ * SPDX-FileCopyrightText: none
+ * SPDX-License-Identifier: CC0-1.0
+ */
+
+package gov.nist.secauto.metaschema.core.metapath.item;
+
+import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
+import gov.nist.secauto.metaschema.core.metapath.item.function.IArrayItem;
+import gov.nist.secauto.metaschema.core.metapath.item.function.IMapItem;
+import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+public interface IItemVisitor {
+  void visit(@NonNull IArrayItem<?> array);
+
+  void visit(@NonNull IMapItem<?> map);
+
+  void visit(@NonNull INodeItem node);
+
+  void visit(@NonNull IAnyAtomicItem node);
+}
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/IItemWriter.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/IItemWriter.java
@@ -0,0 +1,26 @@
+/*
+ * SPDX-FileCopyrightText: none
+ * SPDX-License-Identifier: CC0-1.0
+ */
+
+package gov.nist.secauto.metaschema.core.metapath.item;
+
+import gov.nist.secauto.metaschema.core.metapath.ISequence;
+import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
+import gov.nist.secauto.metaschema.core.metapath.item.function.IArrayItem;
+import gov.nist.secauto.metaschema.core.metapath.item.function.IMapItem;
+import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+public interface IItemWriter {
+  void writeSequence(@NonNull ISequence<?> sequence);
+
+  void writeArray(@NonNull IArrayItem<?> array);
+
+  void writeMap(@NonNull IMapItem<?> map);
+
+  void writeNode(@NonNull INodeItem node);
+
+  void writeAtomicValue(@NonNull IAnyAtomicItem node);
+}
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/atomic/IAnyAtomicItem.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/atomic/IAnyAtomicItem.java
@@ -7,6 +7,7 @@
 
 import gov.nist.secauto.metaschema.core.datatype.IDataTypeAdapter;
 import gov.nist.secauto.metaschema.core.metapath.IPrintable;
+import gov.nist.secauto.metaschema.core.metapath.item.IItemVisitor;
 import gov.nist.secauto.metaschema.core.metapath.item.function.IMapItem;
 import gov.nist.secauto.metaschema.core.metapath.item.function.IMapKey;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
@@ -103,4 +104,9 @@ default IStringItem asStringItem() {
    *         than, equal to, or greater than the {@code item}.
    */
   int compareTo(@NonNull IAnyAtomicItem other);
+
+  @Override
+  default void accept(IItemVisitor visitor) {
+    visitor.visit(this);
+  }
 }
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/function/IArrayItem.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/function/IArrayItem.java
@@ -15,6 +15,7 @@
 import gov.nist.secauto.metaschema.core.metapath.impl.AbstractArrayItem;
 import gov.nist.secauto.metaschema.core.metapath.impl.ArrayItemN;
 import gov.nist.secauto.metaschema.core.metapath.item.IItem;
+import gov.nist.secauto.metaschema.core.metapath.item.IItemVisitor;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
 
 import java.util.ArrayList;
@@ -570,4 +571,9 @@ static <T extends ICollectionValue> IArrayItem<T> copyOf(@NonNull Collection<? e
             ? empty()
             : new ArrayItemN<>(new ArrayList<>(collection));
   }
+
+  @Override
+  default void accept(IItemVisitor visitor) {
+    visitor.visit(this);
+  }
 }
diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/function/IMapItem.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/function/IMapItem.java
@@ -16,6 +16,7 @@
 import gov.nist.secauto.metaschema.core.metapath.impl.AbstractMapItem;
 import gov.nist.secauto.metaschema.core.metapath.impl.MapItemN;
 import gov.nist.secauto.metaschema.core.metapath.item.IItem;
+import gov.nist.secauto.metaschema.core.metapath.item.IItemVisitor;
 import gov.nist.secauto.metaschema.core.metapath.item.atomic.IAnyAtomicItem;
 
 import java.util.LinkedHashMap;
@@ -782,4 +783,9 @@ IMapItem<V> copyOf(Map<? extends IMapKey, ? extends V> map) {
             ? empty()
             : new MapItemN<>(new LinkedHashMap<>(map));
   }
+
+  @Override
+  default void accept(IItemVisitor visitor) {
+    visitor.visit(this);
+  }
 }
diff --git a/...ava/gov/nist/secauto/metaschema/core/metapath/item/node/AbstractFlagInstanceNodeItem.java b/...ava/gov/nist/secauto/metaschema/core/metapath/item/node/AbstractFlagInstanceNodeItem.java
@@ -11,38 +11,11 @@
  * A {@link INodeItem} supported by a {@link IFlagInstance}.
  */
 abstract class AbstractFlagInstanceNodeItem
+    extends AbstractInstanceNodeItem<IFlagDefinition, IFlagInstance, IModelNodeItem<?, ?>>
     implements IFlagNodeItem {
-  @NonNull
-  private final IFlagInstance instance;
-  @NonNull
-  private final IModelNodeItem<?, ?> parent;
 
   public AbstractFlagInstanceNodeItem(@NonNull IFlagInstance instance, @NonNull IModelNodeItem<?, ?> parent) {
-    this.instance = instance;
-    this.parent = parent;
-  }
-
-  @Override
-  public IFlagDefinition getDefinition() {
-    return getInstance().getDefinition();
-  }
-
-  @Override
-  @NonNull
-  public IFlagInstance getInstance() {
-    return instance;
-  }
-
-  @Override
-  @NonNull
-  public IModelNodeItem<?, ?> getParentContentNodeItem() {
-    return getParentNodeItem();
-  }
-
-  @Override
-  @NonNull
-  public IModelNodeItem<?, ?> getParentNodeItem() {
-    return parent;
+    super(instance, parent);
   }
 
   @Override

diff --git a/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/node/INodeItem.java b/core/src/main/java/gov/nist/secauto/metaschema/core/metapath/item/node/INodeItem.java
@@ -5,6 +5,7 @@
 import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter;
 import gov.nist.secauto.metaschema.core.metapath.format.IPathSegment;
 import gov.nist.secauto.metaschema.core.metapath.item.IItem;
+import gov.nist.secauto.metaschema.core.metapath.item.IItemVisitor;
 import gov.nist.secauto.metaschema.core.model.IResourceLocation;
 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
 
@@ -285,4 +286,9 @@ default Stream<? extends IFlagNodeItem> flags() {
    */
   @NonNull
   StaticContext getStaticContext();
+
+  @Override
+  default void accept(IItemVisitor visitor) {
+    visitor.visit(this);
+  }
 }
diff --git a/databind/src/test/resources/metaschema/fields_with_flags/example.json b/databind/src/test/resources/metaschema/fields_with_flags/example.json
@@ -21,8 +21,8 @@
       }
     ],
     "complex-fields4": {
-      "complex-field4-1": {"STRVALUE": "test-string5"},
-      "complex-field4-2": {"STRVALUE": "test-string6"}
+      "complex-field4-1": "test-string5",
+      "complex-field4-2": "test-string6"
     }
   }
 }
diff --git a/metaschema-cli/pom.xml b/metaschema-cli/pom.xml
@@ -63,6 +63,17 @@
 			<groupId>org.apache.logging.log4j</groupId>
 			<artifactId>log4j-api</artifactId>
 		</dependency>
+
+		<dependency>
+		    <groupId>io.github.hakky54</groupId>
+		    <artifactId>logcaptor</artifactId>
+		    <scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.assertj</groupId>
+			<artifactId>assertj-core</artifactId>
+			<scope>test</scope>
+		</dependency>			
 	</dependencies>
 
 	<build>

diff --git a/...rc/main/java/gov/nist/secauto/metaschema/cli/commands/AbstractValidateContentCommand.java b/...rc/main/java/gov/nist/secauto/metaschema/cli/commands/AbstractValidateContentCommand.java
@@ -80,7 +80,7 @@ public abstract class AbstractValidateContentCommand
   private static final Option CONSTRAINTS_OPTION = ObjectUtils.notNull(
       Option.builder("c")
           .hasArgs()
-          .argName("URI")
+          .argName("URL")
           .desc("additional constraint definitions")
           .build());
   @NonNull