fix: replace invalid config key scriv.user_nick with scriv.user-nick #130

Author: nedbat

README.rst

@@ -66,6 +66,7 @@ Contributions are very welcome.  Thanks to all the contributors so far:
 | James Gerity
 | Javier Sagredo
 | Kurt McKee
+| Mark Dickinson
 | Matias Guijarro
 | Michael Makukha
 | Rodrigo Girão Serrão

changelog.d/20240608_184756_dickinsm.rst

@@ -0,0 +1,9 @@
+Fixed
+.....
+
+- Replaced the invalid GitHub config key ``scriv.user_nick`` with
+  ``scriv.user-nick``.  Fixes `issue 130`_.
+  Thanks, `Mark Dickinson <pull 131_>`_.
+
+.. _issue 130: https://github.com/nedbat/scriv/issues/130
+.. _pull 131: https://github.com/nedbat/scriv/pull/131/files

docs/index.rst

@@ -88,12 +88,13 @@ Thanks to all the contributors so far:
 | James Gerity
 | Javier Sagredo
 | Kurt McKee
+| Mark Dickinson
 | Matias Guijarro
 | Michael Makukha
 | Rodrigo Girão Serrão
 | Ronny Pfannschmidt
 
-.. [[[end]]] (checksum: 69c390284832f0854ceb4ef0a1f1042c)
+.. [[[end]]] (checksum: 38a9f227f719032ff5b67bcc50bb7276)
 
 .. _repo: https://github.com/nedbat/scriv
 

src/scriv/gitinfo.py

@@ -18,7 +18,7 @@ def user_nick() -> str:
     """
     Get a short name for the current user.
     """
-    nick = git_config("scriv.user_nick")
+    nick = git_config("scriv.user-nick")
     if nick:
         return nick
 

tests/faker.py

@@ -1,5 +1,6 @@
 """Fake implementations of some of our external information sources."""
 
+import re
 import shlex
 from collections.abc import Iterable
 from typing import Callable, Optional
@@ -10,6 +11,11 @@
 CmdHandler = Callable[[list[str]], CmdResult]
 
 
+# A regex to help with catching some (but not all) invalid Git config keys.
+WORD = r"[a-zA-Z][a-zA-Z0-9-]*"
+GIT_CONFIG_KEY = rf"{WORD}(\..*)?\.{WORD}"
+
+
 class FakeRunCommand:
     """
     A fake implementation of run_command.
@@ -88,6 +94,8 @@ def run_command(self, argv: list[str]) -> CmdResult:
 
     def set_config(self, name: str, value: str) -> None:
         """Set a fake Git configuration value."""
+        if re.fullmatch(GIT_CONFIG_KEY, name) is None:
+            raise ValueError(f"invalid key: {name!r}")
         self.config[name] = value
 
     def set_branch(self, branch_name: str) -> None:

tests/test_faker.py

@@ -4,6 +4,10 @@
 Mostly error paths, since the happy paths are covered by other tests.
 """
 
+import re
+
+import pytest
+
 from scriv import shell
 
 
@@ -23,3 +27,36 @@ def test_no_such_git_command(fake_git):
         False,
         "no fake git command: ['git', 'config', '--wut']",
     )
+
+
+@pytest.mark.parametrize(
+    "name",
+    [
+        "foo.bar",
+        "foo.bar12",
+        "foo.bar-",
+        "foo.bar-bar",
+        "foo-foo.bar",
+        "section.subsection.bar",
+        "section.some/sub_section!ok.bar",
+    ],
+)
+def test_git_set_config_good_names(name, fake_git):
+    val = "xyzzy plugh!?"
+    fake_git.set_config(name, val)
+    result = shell.run_command(f"git config --get {name}")
+    assert result == (True, val + "\n")
+
+
+@pytest.mark.parametrize(
+    "name",
+    [
+        "bar",
+        "foo.12bar",
+        "foo.bar_bar",
+        "foo_foo.bar",
+    ],
+)
+def test_git_set_config_bad_names(name, fake_git):
+    with pytest.raises(ValueError, match=re.escape(f"invalid key: {name!r}")):
+        fake_git.set_config(name, "hello there")

tests/test_gitinfo.py

@@ -6,7 +6,7 @@
 
 
 def test_user_nick_from_scriv_user_nick(fake_git):
-    fake_git.set_config("scriv.user_nick", "joedev")
+    fake_git.set_config("scriv.user-nick", "joedev")
     assert user_nick() == "joedev"