added test cases for UC1-4 and made input a required argument

Author: yucongalicechen

src/diffpy/labpdfproc/labpdfprocapp.py

@@ -17,7 +17,7 @@
 def get_args(override_cli_inputs=None):
     p = ArgumentParser()
     p.add_argument("mud", help="Value of mu*D for your " "sample. Required.", type=float)
-    p.add_argument("-i", "--input-file", help="The filename of the " "datafile to load.")
+    p.add_argument("input", help="The filename or directory of the " "datafile to load.")
     p.add_argument(
         "-a",
         "--anode-type",

src/diffpy/labpdfproc/tests/test_tools.py

@@ -13,21 +13,36 @@
 )
 from diffpy.utils.parsers.loaddata import loadData
 
-params1 = [
+# Use cases can be found here: https://github.com/diffpy/diffpy.labpdfproc/issues/48
+params_input = [
+    (["good_data.chi"], [".", "good_data.chi"]),
+    (["input_dir/good_data.chi"], ["input_dir", "good_data.chi"]),
+    (["./input_dir/good_data.chi"], ["input_dir", "good_data.chi"]),
     (
-        ["--input-file", "."],
+        ["."],
         [
             ".",
             ["good_data.chi", "good_data.xy", "good_data.txt", "unreadable_file.txt", "binary.pkl"],
         ],
     ),
-    (["--input-file", "good_data.chi"], [".", "good_data.chi"]),
-    (["--input-file", "input_dir/unreadable_file.txt"], ["input_dir", "unreadable_file.txt"]),
-    # ([Path.cwd()], [Path.cwd()]),
+    (
+        ["./input_dir"],
+        [
+            "input_dir",
+            ["good_data.chi", "good_data.xy", "good_data.txt", "unreadable_file.txt", "binary.pkl"],
+        ],
+    ),
+    (
+        ["input_dir"],
+        [
+            "input_dir",
+            ["good_data.chi", "good_data.xy", "good_data.txt", "unreadable_file.txt", "binary.pkl"],
+        ],
+    ),
 ]
 
 
-@pytest.mark.parametrize("inputs, expected", params1)
+@pytest.mark.parametrize("inputs, expected", params_input)
 def test_set_input_files(inputs, expected, user_filesystem):
     expected_input_directory = Path(user_filesystem) / expected[0]
     expected_input_files = expected[1]
@@ -39,6 +54,21 @@ def test_set_input_files(inputs, expected, user_filesystem):
     assert set(actual_args.input_file) == set(expected_input_files)
 
 
+params_input_bad = [
+    (["new_file.xy"]),
+    (["./input_dir/new_file.xy"]),
+    (["./new_dir"]),
+]
+
+
+@pytest.mark.parametrize("inputs", params_input_bad)
+def test_set_input_files_bad(inputs, user_filesystem):
+    cli_inputs = ["2.5"] + inputs
+    actual_args = get_args(cli_inputs)
+    with pytest.raises(ValueError):
+        actual_args = set_input_files(actual_args)
+
+
 def test_loadData_with_input_files(user_filesystem):
     xarray_chi, yarray_chi = loadData("good_data.chi", unpack=True)
     xarray_xy, yarray_xy = loadData("good_data.xy", unpack=True)
@@ -60,7 +90,7 @@ def test_loadData_with_input_files(user_filesystem):
 @pytest.mark.parametrize("inputs, expected", params1)
 def test_set_output_directory(inputs, expected, user_filesystem):
     expected_output_directory = Path(user_filesystem) / expected[0]
-    cli_inputs = ["2.5"] + inputs
+    cli_inputs = ["2.5", "data.xy"] + inputs
     actual_args = get_args(cli_inputs)
     actual_args.output_directory = set_output_directory(actual_args)
     assert actual_args.output_directory == expected_output_directory
@@ -69,7 +99,7 @@ def test_set_output_directory(inputs, expected, user_filesystem):
 
 
 def test_set_output_directory_bad(user_filesystem):
-    cli_inputs = ["2.5", "--output-directory", "good_data.chi"]
+    cli_inputs = ["2.5", "data.xy", "--output-directory", "good_data.chi"]
     actual_args = get_args(cli_inputs)
     with pytest.raises(FileExistsError):
         actual_args.output_directory = set_output_directory(actual_args)
@@ -88,7 +118,7 @@ def test_set_output_directory_bad(user_filesystem):
 @pytest.mark.parametrize("inputs, expected", params2)
 def test_set_wavelength(inputs, expected):
     expected_wavelength = expected[0]
-    cli_inputs = ["2.5"] + inputs
+    cli_inputs = ["2.5", "data.xy"] + inputs
     actual_args = get_args(cli_inputs)
     actual_args.wavelength = set_wavelength(actual_args)
     assert actual_args.wavelength == expected_wavelength
@@ -112,7 +142,7 @@ def test_set_wavelength(inputs, expected):
 
 @pytest.mark.parametrize("inputs, msg", params3)
 def test_set_wavelength_bad(inputs, msg):
-    cli_inputs = ["2.5"] + inputs
+    cli_inputs = ["2.5", "data.xy"] + inputs
     actual_args = get_args(cli_inputs)
     with pytest.raises(ValueError, match=re.escape(msg[0])):
         actual_args.wavelength = set_wavelength(actual_args)
@@ -130,12 +160,12 @@ def test_set_wavelength_bad(inputs, msg):
 
 @pytest.mark.parametrize("inputs, expected", params5)
 def test_load_user_metadata(inputs, expected):
-    expected_args = get_args(["2.5"])
+    expected_args = get_args(["2.5", "data.xy"])
     for expected_pair in expected:
         setattr(expected_args, expected_pair[0], expected_pair[1])
     delattr(expected_args, "user_metadata")
 
-    cli_inputs = ["2.5"] + inputs
+    cli_inputs = ["2.5", "data.xy"] + inputs
     actual_args = get_args(cli_inputs)
     actual_args = load_user_metadata(actual_args)
     assert actual_args == expected_args
@@ -172,7 +202,7 @@ def test_load_user_metadata(inputs, expected):
 
 @pytest.mark.parametrize("inputs, msg", params6)
 def test_load_user_metadata_bad(inputs, msg):
-    cli_inputs = ["2.5"] + inputs
+    cli_inputs = ["2.5", "data.xy"] + inputs
     actual_args = get_args(cli_inputs)
     with pytest.raises(ValueError, match=msg[0]):
         actual_args = load_user_metadata(actual_args)

src/diffpy/labpdfproc/tools.py

@@ -20,19 +20,18 @@ def set_input_files(args):
     args argparse.Namespace
 
     """
-    if not args.input_file or not Path(args.input_file).exists():
+    if not Path(args.input).exists():
         raise ValueError("Please specify valid input file or directory.")
 
-    if not Path(args.input_file).is_dir():
-        input_dir = Path.cwd() / Path(args.input_file).parent
-        input_file_name = Path(args.input_file).name
-        args.input_file = input_file_name
+    if not Path(args.input).is_dir():
+        input_dir = Path.cwd() / Path(args.input).parent
+        input_file_name = Path(args.input).name
     else:
-        input_dir = Path(args.input_file).resolve()
+        input_dir = Path(args.input).resolve()
         input_files = [file for file in glob.glob(str(input_dir) + "/*", recursive=True) if os.path.isfile(file)]
-        input_file_names = [os.path.basename(input_file_path) for input_file_path in input_files]
-        args.input_file = input_file_names
+        input_file_name = [os.path.basename(input_file_path) for input_file_path in input_files]
     setattr(args, "input_directory", input_dir)
+    setattr(args, "input_file", input_file_name)
     return args