Testing App

Author: pkiraly

pom.xml

@@ -170,6 +170,12 @@
       <artifactId>jackson-databind</artifactId>
       <version>2.13.4.2</version>
     </dependency>
+    <dependency>
+      <groupId>com.github.stefanbirkner</groupId>
+      <artifactId>system-lambda</artifactId>
+      <version>1.2.1</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

src/main/java/de/gwdg/metadataqa/api/cli/App.java

@@ -21,6 +21,7 @@
 import org.apache.commons.lang3.StringUtils;
 
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.logging.Logger;
@@ -132,10 +133,16 @@ public static void main(String[] args) {
       CommandLine cmd = parser.parse(options, args);
       new App(cmd).run();
     } catch (MissingOptionException ex) {
-      formatter.printHelp(appName, appHeader, options, "Missing options: " + ex.getMissingOptions().toString(), true);
+      List<String> missingOptions = new ArrayList<>();
+      for (String option : (List<String>) ex.getMissingOptions()) {
+        missingOptions.add(String.format("--%s (-%s)", options.getOption(option).getLongOpt(), option));
+      }
+      formatter.printHelp(appName, appHeader, options, "ERROR\nMissing options: \n  " + StringUtils.join(missingOptions, "\n  "), true);
       System.exit(1);
     } catch (MissingArgumentException ex) {
-      formatter.printHelp(appName, appHeader, options, "Missing arguments: " + ex.getOption().getArgName(), true);
+      Option missingOption = ex.getOption();
+      String err = String.format("%s for option --%s (-%s)", missingOption.getArgName(), missingOption.getLongOpt(), missingOption.getOpt());
+      formatter.printHelp(appName, appHeader, options, "ERROR\nMissing arguments: " + err, true);
       System.exit(1);
     } catch (Exception ex) {
       formatter.printHelp(appName, appHeader, options, "Error: " + ex.getMessage(), true);
@@ -149,48 +156,55 @@ private static Options buildOptions() {
 
     Option inputOption = Option.builder("i")
       .numberOfArgs(1)
+      .argName("input file")
       .required(true)
       .longOpt(INPUT_FILE)
       .desc("Input file.")
       .build();
 
     Option outputOption = Option.builder("o")
       .numberOfArgs(1)
+      .argName("output file")
       .required(false)
       .longOpt(OUTPUT_FILE)
       .desc("Output file.")
       .build();
 
     Option outputFormatOption = Option.builder("f")
       .numberOfArgs(1)
+      .argName("output format")
       .required(false)
       .longOpt(OUTPUT_FORMAT)
       .desc("Format of the output: json, ndjson (new line delimited JSON), csv, csvjson (json encoded in csv; useful for RDB bulk loading). Default: ndjson.")
       .build();
 
     Option schemaConfigOption = Option.builder("s")
       .numberOfArgs(1)
+      .argName("schema configuration")
       .required(true)
       .longOpt(SCHEMA_CONFIG)
       .desc("Schema file to run assessment against.")
       .build();
 
     Option schemaFormatOption = Option.builder("v")
       .numberOfArgs(1)
+      .argName("schema format")
       .required(false)
       .longOpt(SCHEMA_FORMAT)
       .desc("Format of schema file: json, yaml. Default: based on file extension, else json.")
       .build();
 
     Option measurementsConfigOption = Option.builder("m")
       .numberOfArgs(1)
+      .argName("measurement configuration")
       .required(true)
       .longOpt(MEASUREMENTS_CONFIG)
-      .desc("Config file for measurements.")
+      .desc("Configuration file for measurements.")
       .build();
 
     Option measurementsFormatOption = Option.builder("w")
       .numberOfArgs(1)
+      .argName("measurement format")
       .required(false)
       .longOpt(MEASUREMENTS_FORMAT)
       .desc("Format of measurements config file: json, yaml. Default: based on file extension, else json.")
@@ -212,6 +226,7 @@ private static Options buildOptions() {
 
     Option recordAddressOption = Option.builder("r")
       .numberOfArgs(1)
+      .argName("record address")
       .required(false)
       .longOpt(RECORD_ADDRESS)
       .desc("An XPath or JSONPath expression to separate individual records in an XML or JSON files.")

src/test/java/de/gwdg/metadataqa/api/cli/AppTest.java

@@ -1,5 +1,6 @@
 package de.gwdg.metadataqa.api.cli;
 
+import com.github.stefanbirkner.systemlambda.SystemLambda;
 import de.gwdg.metadataqa.api.util.FileUtils;
 import org.junit.Before;
 import org.junit.Test;
@@ -8,7 +9,9 @@
 import java.io.IOException;
 import java.util.List;
 
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 
 public class AppTest {
 
@@ -64,4 +67,32 @@ public void good_json() throws IOException {
     assertEquals("\"https://neurovault.org/images/384958/\",\"massivea uditory lexical decision\"", output.get(1).trim());
     assertEquals("\"https://neurovault.org/images/93390/\",\"Language in the aging brain\"", output.get(2).trim());
   }
+
+  @Test
+  public void missingOptions() throws Exception {
+    int status = SystemLambda.catchSystemExit(() -> {
+        App.main(new String[]{
+          "--input", BASE_DIR + "csv/meemoo-simple.csv",
+          "--schema", BASE_DIR + "configuration/schema/simple-meemoo.yaml"
+        });
+      });
+    assertEquals(1, status);
+
+    assertFalse(outputFile.exists());
+  }
+
+  @Test
+  public void missingArguments() throws Exception {
+    int status = SystemLambda.catchSystemExit(() -> {
+      App.main(new String[]{
+        "--input", BASE_DIR + "csv/meemoo-simple.csv",
+        "--schema", BASE_DIR + "configuration/schema/simple-meemoo.yaml",
+        "--measurements", BASE_DIR + "configuration/measurement/simple-meemoo.yaml",
+        "--outputFormat"
+      });
+    });
+    assertEquals(1, status);
+
+    assertFalse(outputFile.exists());
+  }
 }