updated tests and functions according to workflow

Author: yucongalicechen

src/diffpy/labpdfproc/tests/conftest.py

@@ -48,9 +48,7 @@ def user_filesystem(tmp_path):
         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:
+    with open(conf_dir / "diffpyconfig.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

@@ -245,63 +245,99 @@ def test_load_user_metadata_bad(inputs, msg):
         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]"]),
+    # No config file, check username and email are properly loaded and config file in ~ is created and written
+    (
+        ["new_username", "[email protected]"],
+        ["input_dir", "input_dir/diffpyconfig.json", "diffpyconfig.json", "diffpyconfig.json"],
+        ["new_username", "[email protected]", "new_username", "[email protected]"],
+    ),
+    # Config file in cwd, check username and email are properly loaded and config file is unchanged
+    (
+        ["", ""],
+        ["conf_dir", "conf_dir/diffpyconfig.json", "diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["good_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    (
+        ["new_username", ""],
+        ["conf_dir", "conf_dir/diffpyconfig.json", "diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["new_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    (
+        ["", "[email protected]"],
+        ["conf_dir", "conf_dir/diffpyconfig.json", "diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["good_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    (
+        ["new_username", "[email protected]"],
+        ["conf_dir", "conf_dir/diffpyconfig.json", "diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["new_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    # Config file in home dir not in cwd, check username and email are properly loaded and config file is unchanged
+    (
+        ["", ""],
+        ["input_dir", "input_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["good_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    (
+        ["new_username", ""],
+        ["input_dir", "input_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["new_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    (
+        ["", "[email protected]"],
+        ["input_dir", "input_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["good_username", "[email protected]", "good_username", "[email protected]"],
+    ),
+    (
+        ["new_username", "[email protected]"],
+        ["input_dir", "input_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json", "conf_dir/diffpyconfig.json"],
+        ["new_username", "[email protected]", "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])
+@pytest.mark.parametrize("inputs, paths, expected", params_user_info)
+def test_load_user_info(monkeypatch, inputs, paths, expected, user_filesystem):
+    os.chdir(user_filesystem / paths[0])
+    expected_args_username, expected_args_email, expected_conf_username, expected_conf_email = expected
+    mock_prompt_user_info = iter(inputs)
     monkeypatch.setattr("builtins.input", lambda _: next(mock_prompt_user_info))
+    monkeypatch.setattr("diffpy.labpdfproc.user_config.CWD_CONFIG_PATH", user_filesystem / paths[1])
+    monkeypatch.setattr("diffpy.labpdfproc.user_config.HOME_CONFIG_PATH", user_filesystem / paths[2])
 
     cli_inputs = ["2.5", "data.xy"]
     actual_args = get_args(cli_inputs)
-    actual_args = load_user_info(actual_args, input_config_file)
+    actual_args = load_user_info(actual_args)
 
-    assert actual_args.username == expected_username
-    assert actual_args.email == expected_email
-    with open(input_config_file, "r") as f:
+    assert actual_args.username == expected_args_username
+    assert actual_args.email == expected_args_email
+    with open(user_filesystem / paths[3], "r") as f:
         config_data = json.load(f)
-        assert config_data == {"username": expected_username, "email": expected_email}
+        assert config_data == {"username": expected_conf_username, "email": expected_conf_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."),
+    (["", ""], "Please rerun the program and provide a username and email."),
+    (["", "[email protected]"], "Please rerun the program and provide a username."),
+    (["good_username", ""], "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."),
+    (["good_username", "bad_email"], "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 / "conf_dir")
-    input_username, input_email, input_config_file = inputs
+    os.chdir(user_filesystem)
+    input_username, input_email = inputs
     mock_prompt_user_info = iter([input_username, input_email])
     monkeypatch.setattr("builtins.input", lambda _: next(mock_prompt_user_info))
+    monkeypatch.setattr("diffpy.labpdfproc.user_config.CWD_CONFIG_PATH", Path.cwd() / "diffpyconfig.json")
+    monkeypatch.setattr("diffpy.labpdfproc.user_config.HOME_CONFIG_PATH", user_filesystem / "diffpyconfig.json")
 
     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)
+        actual_args = load_user_info(actual_args)

src/diffpy/labpdfproc/tools.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from diffpy.labpdfproc.user_config import CONFIG_FILE, prompt_user_info, read_conf_file, write_conf_file
+from diffpy.labpdfproc.user_config import 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,13 +175,14 @@ def load_user_metadata(args):
     return args
 
 
-def load_user_info(args, config_file=CONFIG_FILE):
+def load_user_info(args):
     """
     Load username and email into args.
 
-    Prompt the user to enter username and email. If not provided, read from the config file.
+    Prompt the user to enter username and email.
+    If not provided, read from the config file (first from cwd, and then from home directory).
     If neither are available, raise a ValueError.
-    Save provided values to the config file (overwriting existing values if needed).
+    Save provided values to the config file if a config file doesn't exist.
 
     Parameters
     ----------
@@ -194,7 +195,7 @@ def load_user_info(args, config_file=CONFIG_FILE):
 
     """
     input_username, input_email = prompt_user_info()
-    conf_username, conf_email = read_conf_file(config_file)
+    conf_username, conf_email = read_conf_file()
 
     no_username = not input_username and not conf_username
     no_email = not input_email and not conf_email
@@ -212,5 +213,7 @@ def load_user_info(args, config_file=CONFIG_FILE):
 
     setattr(args, "username", username)
     setattr(args, "email", email)
-    write_conf_file(username, email, config_file)
+
+    if not conf_username and not conf_email:
+        write_conf_file(username, email)
     return args

src/diffpy/labpdfproc/user_config.py

@@ -2,6 +2,8 @@
 from pathlib import Path
 
 CONFIG_FILE = "diffpyconfig.json"
+CWD_CONFIG_PATH = Path.cwd() / CONFIG_FILE
+HOME_CONFIG_PATH = Path.home() / CONFIG_FILE
 
 
 def prompt_user_info():
@@ -10,15 +12,23 @@ def prompt_user_info():
     return username, email
 
 
-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:
+def find_conf_file():
+    if CWD_CONFIG_PATH.exists() and CWD_CONFIG_PATH.is_file():
+        return CWD_CONFIG_PATH
+    elif HOME_CONFIG_PATH.exists() and HOME_CONFIG_PATH.is_file():
+        return HOME_CONFIG_PATH
+    return None
+
+
+def read_conf_file():
+    conf_file = find_conf_file()
+    if conf_file:
+        with open(conf_file, "r") as f:
             config = json.load(f)
             return config.get("username"), config.get("email")
     return None, None
 
 
-def write_conf_file(username, email, config_file=CONFIG_FILE):
-    with open(config_file, "w") as f:
+def write_conf_file(username, email):
+    with open(HOME_CONFIG_PATH, "w") as f:
         json.dump({"username": username, "email": email}, f)