added tests for UC1 and UC4, rewrite function to overwrite config file data with user inputs

Author: yucongalicechen

src/diffpy/labpdfproc/tests/conftest.py

@@ -1,3 +1,4 @@
+import json
 from pathlib import Path
 
 import pytest
@@ -8,6 +9,8 @@ def user_filesystem(tmp_path):
     base_dir = Path(tmp_path)
     input_dir = base_dir / "input_dir"
     input_dir.mkdir(parents=True, exist_ok=True)
+    conf_dir = base_dir / "conf_dir"
+    conf_dir.mkdir(parents=True, exist_ok=True)
 
     chi_data = "dataformat = twotheta\n mode = xray\n # chi_Q chi_I\n 1 2\n 3 4\n 5 6\n 7 8\n"
     xy_data = "1 2\n 3 4\n 5 6\n 7 8"
@@ -44,4 +47,10 @@ def user_filesystem(tmp_path):
         f.write("good_data.xy \n")
         f.write(f"{str(input_dir.resolve() / 'good_data.txt')}\n")
 
+    user_config_data = {"username": "good_username", "email": "[email protected]"}
+    with open(conf_dir / "test.json", "w") as f:
+        json.dump(user_config_data, f)
+    with open(conf_dir / "test2.json", "w") as f:
+        json.dump({}, f)
+
     yield tmp_path

src/diffpy/labpdfproc/tests/test_tools.py

@@ -1,3 +1,4 @@
+import json
 import os
 import re
 from pathlib import Path
@@ -7,6 +8,7 @@
 from diffpy.labpdfproc.labpdfprocapp import get_args
 from diffpy.labpdfproc.tools import (
     known_sources,
+    load_user_info,
     load_user_metadata,
     set_input_lists,
     set_output_directory,
@@ -241,3 +243,65 @@ def test_load_user_metadata_bad(inputs, msg):
     actual_args = get_args(cli_inputs)
     with pytest.raises(ValueError, match=msg[0]):
         actual_args = load_user_metadata(actual_args)
+
+
+# For each test case, check username and email are properly loaded and written into config file
+params_user_info = [
+    # No existing config file, user enters valid username and email
+    (["good_username", "[email protected]", "non_existing_file.json"], ["good_username", "[email protected]"]),
+    # There exists a config file, so we read it and fetch info, no user input is fine
+    (["", "", "test.json"], ["good_username", "[email protected]"]),
+    # There exists a config file, user input username/email overwrites the username/email in the file
+    (["new_username", "", "test.json"], ["new_username", "[email protected]"]),
+    (["", "[email protected]", "test.json"], ["good_username", "[email protected]"]),
+    (["new_username", "[email protected]", "test.json"], ["new_username", "[email protected]"]),
+    # There exists a config file that does not contain username/email, then we write user inputs into config file
+    (["good_username", "[email protected]", "test2.json"], ["good_username", "[email protected]"]),
+]
+
+
+@pytest.mark.parametrize("inputs, expected", params_user_info)
+def test_load_user_info(monkeypatch, inputs, expected, user_filesystem):
+    os.chdir(user_filesystem / "conf_dir")
+    expected_username, expected_email = expected
+    input_username, input_email, input_config_file = inputs
+    mock_prompt_user_info = iter([input_username, input_email])
+    monkeypatch.setattr("builtins.input", lambda _: next(mock_prompt_user_info))
+
+    cli_inputs = ["2.5", "data.xy"]
+    actual_args = get_args(cli_inputs)
+    actual_args = load_user_info(actual_args, input_config_file)
+
+    assert actual_args.username == expected_username
+    assert actual_args.email == expected_email
+    with open(input_config_file, "r") as f:
+        config_data = json.load(f)
+        assert config_data == {"username": expected_username, "email": expected_email}
+
+
+params_user_info_bad = [
+    # No valid username/email in config file (or no config file),
+    # and user didn't enter username/email the first time they were asked
+    (["", "", "non_existing_file.json"], "Please rerun the program and provide a username and email."),
+    (["", "[email protected]", "non_existing_file.json"], "Please rerun the program and provide a username."),
+    (["good_username", "", "non_existing_file.json"], "Please rerun the program and provide an email."),
+    # User entered an invalid email
+    (
+        ["good_username", "bad_email", "non_existing_file.json"],
+        "Please rerun the program and provide a valid email.",
+    ),
+    (["good_username", "bad_email", "test.json"], "Please rerun the program and provide a valid email."),
+]
+
+
+@pytest.mark.parametrize("inputs, msg", params_user_info_bad)
+def test_load_user_info_bad(monkeypatch, inputs, msg, user_filesystem):
+    os.chdir(user_filesystem)
+    input_username, input_email, input_config_file = inputs
+    mock_prompt_user_info = iter([input_username, input_email])
+    monkeypatch.setattr("builtins.input", lambda _: next(mock_prompt_user_info))
+
+    cli_inputs = ["2.5", "data.xy"]
+    actual_args = get_args(cli_inputs)
+    with pytest.raises(ValueError, match=msg[0]):
+        actual_args = load_user_info(actual_args, config_file=input_config_file)

src/diffpy/labpdfproc/tools.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from diffpy.labpdfproc.user_config import find_conf_file, read_conf_file, user_info_conf
+from diffpy.labpdfproc.user_config import CONFIG_FILE, prompt_user_info, read_conf_file, write_conf_file
 
 WAVELENGTHS = {"Mo": 0.71, "Ag": 0.59, "Cu": 1.54}
 known_sources = [key for key in WAVELENGTHS.keys()]
@@ -175,15 +175,42 @@ def load_user_metadata(args):
     return args
 
 
-def load_user_info(args):
-    conf_file_path = find_conf_file()
-    if conf_file_path is not None:
-        conf_file = read_conf_file(conf_file_path)
-        if "username" in conf_file and "useremail" in conf_file:
-            setattr(args, "username", conf_file["username"])
-            setattr(args, "useremail", conf_file["useremail"])
-            return args
-        else:
-            return user_info_conf(args)
-    else:
-        return user_info_conf(args)
+def load_user_info(args, config_file=CONFIG_FILE):
+    """
+    Load username and email into args.
+
+    Prompt the user to enter username and email. If not provided, read from the config file.
+    If neither are available, raise a ValueError.
+    Save provided values to the config file (overwriting existing values if needed).
+
+    Parameters
+    ----------
+    args argparse.Namespace
+        the arguments from the parser
+
+    Returns
+    -------
+    the updated argparse Namespace with username and email
+
+    """
+    input_username, input_email = prompt_user_info()
+    conf_username, conf_email = read_conf_file(config_file)
+
+    no_username = not input_username and not conf_username
+    no_email = not input_email and not conf_email
+    if no_username and no_email:
+        raise ValueError("Please rerun the program and provide a username and email.")
+    if no_username:
+        raise ValueError("Please rerun the program and provide a username.")
+    if no_email:
+        raise ValueError("Please rerun the program and provide an email.")
+
+    username = input_username or conf_username
+    email = input_email or conf_email
+    if "@" not in email:
+        raise ValueError("Please rerun the program and provide a valid email.")
+
+    setattr(args, "username", username)
+    setattr(args, "email", email)
+    write_conf_file(username, email, config_file)
+    return args

src/diffpy/labpdfproc/user_config.py

@@ -1,37 +1,24 @@
 import json
-import os
 from pathlib import Path
 
 CONFIG_FILE = "labpdfprocconfig.json"
 
 
-def find_conf_file():
-    # Return config file path if such a file exists
-    if os.path.exists(CONFIG_FILE):
-        return Path(CONFIG_FILE).resolve()
-    return None
-
-
-def read_conf_file(file_path):
-    with open(file_path, "r") as f:
-        return json.load(f)
-
-
-def write_conf_file(file_path, username, useremail):
-    config = {"username": username, "useremail": useremail}
-    with open(file_path, "w") as f:
-        json.dump(config, f)
+def prompt_user_info():
+    username = input("Please enter your username (or press Enter to skip if you already entered before): ")
+    email = input("Please enter your email (or press Enter to skip if you already entered before): ")
+    return username, email
 
 
-def prompt_user_info():
-    username = input("Please enter your username (or press Enter to skip): ")
-    useremail = input("Please enter your email (or press Enter to skip): ")
-    return username, useremail
+def read_conf_file(config_file=CONFIG_FILE):
+    config_path = Path(config_file).resolve()
+    if config_path.exists() and config_path.is_file():
+        with open(config_file, "r") as f:
+            config = json.load(f)
+            return config.get("username"), config.get("email")
+    return None, None
 
 
-def user_info_conf(args):
-    username, useremail = prompt_user_info()
-    write_conf_file(CONFIG_FILE, username, useremail)
-    setattr(args, "username", username)
-    setattr(args, "useremail", useremail)
-    return args
+def write_conf_file(username, email, config_file=CONFIG_FILE):
+    with open(config_file, "w") as f:
+        json.dump({"username": username, "email": email}, f)