Merge pull request #973 from NASA-PDS/251003_948_Override_the_default_namespace_version

Added the -s option to LDDTool to override the LDD name space version number

Author: jordanpadams

model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DMDocument.java

@@ -349,7 +349,7 @@ public static boolean run(String[] args) throws Throwable {
 	  Namespace argparse4jNamespace = null;
 	  try {
 		  argparse4jNamespace = getArgumentParserNamespace(args);
-	  } catch (Throwable e) {
+	  } catch (Exception e) {
 		  return false;
 	  }
 
@@ -721,9 +721,6 @@ static private void init() {
 
 	// process state for used flags, files, and directories
 	    dmProcessState = new DMProcessState();
-	    
-	    // System.out.println("Debug main 240515");
-
 	    PDSOptionalFlag = false;
 	    LDDToolFlag = false;
 	    // Secondary LDD Models
@@ -1138,7 +1135,7 @@ static void setRegistryAttrFlag() {
     registryAttr.add("version_id");
   }
 
-  static Namespace getArgumentParserNamespace(String args[]) throws Throwable {
+  static Namespace getArgumentParserNamespace(String[] args) throws ArgumentParserException {
     parser = ArgumentParsers.newFor("LDDTool").build().defaultHelp(true).version(LDDToolVersionId)
         .description("LDDTool process control:");
 
@@ -1176,7 +1173,11 @@ static Namespace getArgumentParserNamespace(String args[]) throws Throwable {
 
     parser.addArgument("-N", "--namespace").dest("N").type(Boolean.class).nargs(1)
         .action(Arguments.storeTrue()).help("Print the list of configured namespaces to the log");
-
+    
+    parser.addArgument("-s", "--namespace-version").dest("s").type(Integer.class)
+    .help("Specify the namespace version number (positive integer). Required when using -s or --namespace-version.")
+    .action(Arguments.store());
+    
 	parser.addArgument("-1", "--im_specification").dest("1").type(Boolean.class).nargs(1)
         .action(Arguments.storeTrue())
         .help("Write the Information Model Specification for an LDD");
@@ -1295,6 +1296,15 @@ static boolean processArgumentParserNamespacePhase2(Namespace ns) {
       dmProcessState.setprintNamespaceFlag();
       printNamespaceFlag = true;
     }
+    
+    Integer lOverrideNameSpaceVersionInt = ns.getInt("s");
+    if (lOverrideNameSpaceVersionInt != null) {
+        if (lOverrideNameSpaceVersionInt <= 0) {
+        	lOverrideNameSpaceVersionInt = 1;
+        }
+        // Convert to string
+        dmProcessState.setOverrideNameSpaceVersionFlag(String.valueOf(lOverrideNameSpaceVersionInt));
+    }    
 
     Boolean dFlag = ns.getBoolean("d");
     if (dFlag) {
@@ -1360,6 +1370,7 @@ static boolean processArgumentParserNamespacePhase2(Namespace ns) {
       LDDSchemaFileSortArr.add(lLDDSchemaFileDefn);
       masterLDDSchemaFileDefn = lLDDSchemaFileDefn; // the last Ingest_LDD named is the master.
     }
+    masterLDDSchemaFileDefn.isMasterLDD = true; // the last Ingest_LDD named is the master.
     return true;
   }
 

model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/DMProcessState.java

@@ -45,13 +45,17 @@ public class DMProcessState {
   // written files map
   TreeMap<String, Integer> writtenFilesMap;
   TreeMap<Integer, String> writtenFilesSortMap;
+  
+  // variables
+  private String overrideNameSpaceVersion;
 
   public DMProcessState() {
     // init the process flag map
     processFlagMap = new TreeMap<>();
     processFlagSortMap = new TreeMap<>();
     writtenFilesMap = new TreeMap<>();
     writtenFilesSortMap = new TreeMap<>();
+    overrideNameSpaceVersion = "1";  // default
   }
 
   // - getters -
@@ -176,6 +180,14 @@ public Boolean getprintNamespaceFlag() {
     return false;
   }
 
+  public String getOverrideNameSpaceVersionFlag() {
+    Integer lProcessOrder = processFlagMap.get("Override Namespace Version");
+    if (lProcessOrder != null) {
+      return overrideNameSpaceVersion;
+    }
+    return null;
+  }
+
   public Boolean getLDDAttrElementFlag() {
     Integer lProcessOrder = processFlagMap.get("Attr Element Flag");
     if (lProcessOrder != null) {
@@ -326,7 +338,13 @@ public void setprintNamespaceFlag() {
     processFlagMap.put("Print Namespace Flag", 1100);
     return;
   }
-
+  
+  public void setOverrideNameSpaceVersionFlag(String overrideNameSpaceVersion) {
+    processFlagMap.put("Override Namespace Version", 1105);
+    this.overrideNameSpaceVersion = overrideNameSpaceVersion;
+    return;
+  }
+  
   public void setLDDAttrElementFlag() {
     processFlagMap.put("Attr Element Flag", 1110);
     return;
@@ -432,7 +450,6 @@ public void setRelativeFileSpecDOMModelJSON(SchemaFileDefn lSchemaFileDefn) {
   public void setRelativeFileSpecDDCSV(SchemaFileDefn lSchemaFileDefn) {
     writtenFilesMap.put(lSchemaFileDefn.relativeFileSpecDDCSV, 1110);
     // checkCreateDirectory not needed, file is in root directory
-    return;
   }
 
   public void setRelativeFileSpecCCSDSCSV(SchemaFileDefn lSchemaFileDefn) {

model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/LDDDOMParser.java

@@ -308,6 +308,15 @@ private void parseDocument(SchemaFileDefn lSchemaFileDefn) {
     }
 
     lSchemaFileDefn.setVersionIds(); // set variations of versions and all filenames
+    
+    // LDD version id might override the default IM version id
+    // https://url.com/ldd/v2 vs https://url.com/ldd/v1
+    if (lSchemaFileDefn.isMasterLDD) {
+    	String overrideNameSpaceVersion = DMDocument.dmProcessState.getOverrideNameSpaceVersionFlag();
+    	if (overrideNameSpaceVersion != null) {
+    		lSchemaFileDefn.setNameSpaceVersionId(overrideNameSpaceVersion);
+    	}
+    }
 
     String lStewardId = getTextValue(docEle, "steward_id");
     if (!(lStewardId == null || (lStewardId.indexOf("TBD") == 0))) {
@@ -379,25 +388,6 @@ private void resolveComponentsReferences(SchemaFileDefn lSchemaFileDefn) {
     validateEnumeratedFlags();
     Utility.registerMessage("0>info parseDocument.validateEnumeratedFlags() Done");
   }
-
-  private void printClassDebug(String lLable, String lIdentifier) {
-    DOMClass lClass = classMap.get(lIdentifier);
-    if (lClass == null) {
-      System.out.println("\ndebug label:" + lLable
-          + "  printClassDebug INVALID IDENTIFIER lIdentifier:" + lIdentifier);
-      return;
-    }
-    System.out.println(
-        "\ndebug label:" + lLable + "  printClassDebug lClass.identifier:" + lClass.identifier);
-    for (Iterator<DOMProp> j = lClass.ownedAttrArr.iterator(); j.hasNext();) {
-      DOMProp lDOMProp = j.next();
-      if (lDOMProp.domObject != null && lDOMProp.domObject instanceof DOMAttr) {
-        DOMAttr lDOMAttr = (DOMAttr) lDOMProp.domObject;
-        System.out.println("debug printClassDebug lDOMAttr.identifier:" + lDOMAttr.identifier);
-      }
-    }
-  }
-
 
 	// get the list of all DD_Attribute nodes
 	private void getAttributes (SchemaFileDefn lSchemaFileDefn, Element docEle) {			
@@ -2305,7 +2295,6 @@ private ArrayList<String> getXMLValueArr(String tagName, Element elem) {
           && (lNode.getNodeName().indexOf(tagName) == 0)) {
         Element lElement = (Element) lNode;
         String lVal = lElement.getFirstChild().getNodeValue();
-        // System.out.println("debug getXMLValueArr - local_identifier:" + lVal);
         if (lVal != null && lVal.length() > 0) {
           lValArr.add(lVal);
         }
@@ -3014,7 +3003,6 @@ public String getClassWord(String deName) {
 
   public String getDescriptorWord(boolean isValue, String deName) {
     String lDENameUpper = deName.toUpperCase();
-    // System.out.println("debug getDescriptorWord lDENameUpper:" + lDENameUpper);
     String lDescriptorWord = lDENameUpper;
     String lTerm = lDENameUpper;
     int lDENameUpperLen = lDENameUpper.length();

model-dmdocument/src/main/java/gov/nasa/pds/model/plugin/SchemaFileDefn.java

@@ -78,6 +78,7 @@ public class SchemaFileDefn {
 
   // isLDD indicates an LDD schema
   boolean isLDD;
+  boolean isMasterLDD; 
 
   // isDiscipline indicates a discipline schema
   boolean isDiscipline;
@@ -149,6 +150,7 @@ public SchemaFileDefn(String id) {
     governanceLevel = "TBD_governanceLevel";
     isMaster = false;
     isLDD = false;
+    isMasterLDD = false;
     isDiscipline = false;
     isMission = false;
     relativeFileSpecModelSpec_DOM = "TBD_relativeFileSpecModelSpec_DOM";
@@ -208,6 +210,11 @@ public String getSchemaVersionId() {
   public String getNameSpaceVersionId() {
 	  return ns_version_id;
   }
+  
+  //set ns_version_id
+  public void setNameSpaceVersionId(String nsVersionId) {
+	  this.ns_version_id = nsVersionId;
+  }
 
   //get identifier_version_id
   public String getIdentiferVersionId() {

test/smoke-tests.sh

@@ -11,17 +11,17 @@ if [ ! -f model-lddtool/target/lddtool*.tar.gz ]; then
 fi
 
 # Cleanup
-rm -fr ldd-repo/ lddtool-pkg/
+rm -fr ldd-repo/ ldd-repo-template/ lddtool-pkg/
 
 # Unpack lddtool
 mkdir lddtool-pkg
 tar -xvzf model-lddtool/target/lddtool*.tar.gz -C lddtool-pkg/
 
 echo "Test 1: ldd-template"
-git clone https://github.com/pds-data-dictionaries/ldd-template.git ldd-repo/
+git clone https://github.com/pds-data-dictionaries/ldd-template.git ldd-repo-template/
 
 # Run lddtool
-lddtool-pkg/lddtool*/bin/lddtool -lpJ ldd-repo/src/*IngestLDD.xml
+lddtool-pkg/lddtool*/bin/lddtool -lpJ ldd-repo-template/src/*IngestLDD.xml
 
 if [ $? -ne 0 ]; then
     echo "Test 1: FAILED"
@@ -30,7 +30,6 @@ fi
 echo "Test 1: SUCCESS"
 
 echo "Test 2: ldd-cart"
-rm -fr ldd-repo
 git clone https://github.com/pds-data-dictionaries/ldd-cart.git ldd-repo/
 
 cd ldd-repo/; git submodule update --init --force --remote; cd ..
@@ -66,4 +65,31 @@ if [ $count -ne 18 ]; then
 fi
 echo "Test 4: SUCCESS"
 
+# File count check
+echo "Test 5: Test -s option. https://github.com/NASA-PDS/pds4-information-model/issues/948"
+lddtool-pkg/lddtool*/bin/lddtool -lpJ -s 1000 ldd-repo-template/src/*IngestLDD.xml
+if [ $? -ne 0 ]; then
+    echo "Test 5: FAILED"
+    exit $?
+fi
+
+egrep '<sch:ns uri="http://pds.nasa.gov/pds4/example/v1000" prefix="example"/>' PDS4_EXAMPLE_*.sch > tmp.txt
+lines=$(wc -l tmp.txt | awk '{print $1}')
+
+if [ $lines -ne 1 ]; then
+    echo "Test 5: FAILED"
+    exit $?
+fi
+
+egrep 'http://pds.nasa.gov/pds4/example/v1000' PDS4_EXAMPLE_*.xsd > tmp.txt
+lines=$(wc -l tmp.txt | awk '{print $1}')
+
+if [ $lines -ne 2 ]; then
+    echo "Test 5: FAILED"
+    exit $?
+fi
+
+# Check if the output schema uses namespace with the applicable version
+echo "Test 5: SUCCESS"
+
 exit $?