Only archive products that have their configuration fully defined.

Author: rmseng

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/cfg/MmtcConfig.java

@@ -1248,7 +1248,7 @@ public void validate() throws MmtcException {
     }
 
 
-    private static final List<String> REQD_SCLK_SCET_CONFIG_KEY_GROUP = Arrays.asList(
+    public static final List<String> REQD_SCLK_SCET_CONFIG_KEY_GROUP = Arrays.asList(
             "product.sclkScetFile.create",
             "product.sclkScetFile.dir",
             "product.sclkScetFile.baseName",
@@ -1259,28 +1259,36 @@ public void validate() throws MmtcException {
             "product.sclkScetFile.scetUtcPrecision"
     );
 
-    private static final List<String> REQD_UPLINK_CMD_FILE_CONFIG_KEY_GROUP = Arrays.asList(
+    public static final List<String> REQD_UPLINK_CMD_FILE_CONFIG_KEY_GROUP = Arrays.asList(
             "product.uplinkCmdFile.create",
             "product.uplinkCmdFile.outputDir",
             "product.uplinkCmdFile.baseName"
     );
 
-    public void validateSclkScetConfiguration() throws MmtcException {
-        List<String> missingKeys = checkForMissingKeysInGroup(REQD_SCLK_SCET_CONFIG_KEY_GROUP);
+    public void ensureValidSclkScetConfiguration() throws MmtcException {
+        final List<String> missingKeys = getMissingSclkScetConfigurationKeys();
 
         if (! missingKeys.isEmpty()) {
             throw new MmtcException("SCLK-SCET operations require the following keys to be set: " + missingKeys.toString());
         }
     }
 
-    public void validateUplinkCmdFileConfiguration() throws MmtcException {
-        List<String> missingKeys = checkForMissingKeysInGroup(REQD_UPLINK_CMD_FILE_CONFIG_KEY_GROUP);
+    public List<String> getMissingSclkScetConfigurationKeys() {
+        return checkForMissingKeysInGroup(REQD_SCLK_SCET_CONFIG_KEY_GROUP);
+    }
+
+    public void ensureValidUplinkCmdFileConfiguration() throws MmtcException {
+        List<String> missingKeys = getMissingUplinkCmdFileConfigurationKeys();
 
         if (! missingKeys.isEmpty()) {
             throw new MmtcException("Uplink command file operations require the following keys to be set: " + missingKeys.toString());
         }
     }
 
+    public List<String> getMissingUplinkCmdFileConfigurationKeys() {
+        return checkForMissingKeysInGroup(REQD_UPLINK_CMD_FILE_CONFIG_KEY_GROUP);
+    }
+
     private List<String> checkForMissingKeysInGroup(List<String> requiredKeys) {
         List<String> missingKeys = new ArrayList();
 

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/cfg/TimeCorrelationAppConfig.java

@@ -352,11 +352,11 @@ public void validate() throws MmtcException {
         super.validate();
 
         if (createSclkScetFile()) {
-            validateSclkScetConfiguration();
+            ensureValidSclkScetConfiguration();
         }
 
         if (isCreateUplinkCmdFile()) {
-            validateUplinkCmdFileConfiguration();
+            ensureValidUplinkCmdFileConfiguration();
         }
     }
 }

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/definition/OutputProductDefinition.java

@@ -42,11 +42,20 @@ public final void setIsBuiltIn(boolean newIsBuiltInStatus) {
         isBuiltIn.set(newIsBuiltInStatus);
     }
 
-
     public final boolean isBuiltIn() {
         return isBuiltIn.get();
     }
 
+    public abstract boolean isConfigured(MmtcConfig config);
+
+    /**
+     * Where this product should be written, given the current time correlation
+     *
+     * @param context an object describing the time correlation inputs and results, possibly to be used in determining whether an output product should be written
+     * @return true if the product should be written, false otherwise
+     */
+    public abstract boolean shouldBeWritten(TimeCorrelationContext context);
+
     /**
      * 'Resolve' the location of the output product file(s) on disk for this definition.
      *
@@ -56,13 +65,6 @@ public final boolean isBuiltIn() {
      */
     public abstract T resolveLocation(MmtcConfig config) throws MmtcException;
 
-    /**
-     * Where this product should be written, given the current time correlation
-     *
-     * @param context an object describing the time correlation inputs and results, possibly to be used in determining whether an output product should be written
-     * @return true if the product should be written, false otherwise
-     */
-    public abstract boolean shouldBeWritten(TimeCorrelationContext context);
 
     /**
      * Generates a string summarizing the hypothetical changes to an output product that would have been made had this been a real

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/definition/RawTlmTableProductDefinition.java

@@ -23,6 +23,11 @@ public ResolvedProductPath resolveLocation(MmtcConfig config) {
         return new ResolvedProductPath(config.getRawTelemetryTablePath());
     }
 
+    @Override
+    public boolean isConfigured(MmtcConfig config) {
+        return true;
+    }
+
     @Override
     public boolean shouldBeWritten(TimeCorrelationContext context) {
         return true;

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/definition/SclkKernelProductDefinition.java

@@ -40,6 +40,11 @@ public ProductWriteResult writeNewProduct(TimeCorrelationContext ctx) throws Mmt
         return SclkKernel.writeNewProduct(ctx);
     }
 
+    @Override
+    public boolean isConfigured(MmtcConfig config) {
+        return true;
+    }
+
     @Override
     public boolean shouldBeWritten(TimeCorrelationContext context) {
         return true;

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/definition/SclkScetProductDefinition.java

@@ -11,7 +11,6 @@
 import edu.jhuapl.sd.sig.mmtc.util.TimeConvertException;
 
 import java.io.IOException;
-import java.util.Arrays;
 
 import java.nio.file.Path;
 import java.util.HashMap;
@@ -20,10 +19,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
-import java.nio.file.Path;
-import java.util.HashMap;
-import java.util.Map;
-
 /**
  * Describes the set of SCLK kernel output products that MMTC performs operations on.
  * A single SCLK kernel is modeled by {@link SclkKernel}.
@@ -34,9 +29,14 @@ public SclkScetProductDefinition() {
     }
     private final int ENTRIES_TO_PRINT = 4;
 
+    @Override
+    public boolean isConfigured(MmtcConfig conf) {
+        return conf.getMissingSclkScetConfigurationKeys().isEmpty();
+    }
+
     @Override
     public ResolvedProductDirPrefixSuffix resolveLocation(MmtcConfig conf) throws MmtcException {
-        conf.validateSclkScetConfiguration();
+        conf.ensureValidSclkScetConfiguration();
 
         return new ResolvedProductDirPrefixSuffix(
                 conf.getSclkScetOutputDir().toAbsolutePath(),

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/definition/TimeHistoryFileProductDefinition.java

@@ -29,6 +29,11 @@ public boolean shouldBeWritten(TimeCorrelationContext ctx) {
         return ctx.config.createTimeHistoryFile();
     }
 
+    @Override
+    public boolean isConfigured(MmtcConfig config) {
+        return true;
+    }
+
     @Override
     public String getDryRunPrintout(TimeCorrelationContext ctx) throws MmtcException {
         TimeHistoryFile timeHistFile = new TimeHistoryFile(ctx.config.getTimeHistoryFilePath(), ctx.config.getTimeHistoryFileExcludeColumns());

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/definition/UplinkCommandFileProductDefinition.java

@@ -24,7 +24,7 @@ public UplinkCommandFileProductDefinition() {
 
     @Override
     public ResolvedProductDirPrefixSuffix resolveLocation(MmtcConfig conf) throws MmtcException {
-        conf.validateUplinkCmdFileConfiguration();
+        conf.ensureValidUplinkCmdFileConfiguration();
 
         return new ResolvedProductDirPrefixSuffix(
                 Paths.get(conf.getUplinkCmdFileDir()).toAbsolutePath(),
@@ -33,6 +33,11 @@ public ResolvedProductDirPrefixSuffix resolveLocation(MmtcConfig conf) throws Mm
         );
     }
 
+    @Override
+    public boolean isConfigured(MmtcConfig config) {
+        return config.getMissingUplinkCmdFileConfigurationKeys().isEmpty();
+    }
+
     @Override
     public boolean shouldBeWritten(TimeCorrelationContext context) {
         return context.config.isCreateUplinkCmdFile();

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/model/SclkKernel.java

@@ -113,7 +113,6 @@ public CorrelationTriplet(double encSclk, String tdtStr, double clkChgRate) {
         }
     }
 
-
     /**
      * Overwrites the clock change rate field in the last time correlation record in the product with
      * the supplied value.

mmtc-core/src/main/java/edu/jhuapl/sd/sig/mmtc/products/util/FileZipArchiver.java

@@ -13,9 +13,6 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.time.Instant;
-import java.time.OffsetDateTime;
 import java.time.ZoneOffset;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
@@ -24,7 +21,6 @@
 import java.util.zip.ZipOutputStream;
 
 import static edu.jhuapl.sd.sig.mmtc.app.MmtcCli.USER_NOTICE;
-import static edu.jhuapl.sd.sig.mmtc.util.TimeConvert.ISO_UTC_DOY_FORMAT_NO_SUBSECONDS;
 
 // Zips and stores a copy of files to a single zip on the filesystem
 public class FileZipArchiver {
@@ -71,7 +67,9 @@ public static void writeAllOutputProductsToArchive(MmtcConfig config, String arc
 
         final Set<Path> allFilepathsToBackup = new HashSet<>();
         for (OutputProductDefinition<?> def : config.getAllOutputProductDefs()) {
-            allFilepathsToBackup.addAll(def.resolveAllExistingPaths(config));
+            if (def.isConfigured(config)) {
+                allFilepathsToBackup.addAll(def.resolveAllExistingPaths(config));
+            }
         }
         allFilepathsToBackup.add(config.getRunHistoryFilePath().toAbsolutePath());