Fix crash of post-receive when checkout directory does not exist

Also supports calling by secondary argument (kind-of busybox
stylekind-of). Drop support for multicall setuptools wrapper – when
installed using setuptools, the user should call explicit function
instead.

.travis.yml

@@ -5,6 +5,9 @@ python:
  - "3.5"
  - "3.6"
  - "nightly"
+matrix:
+  allow_failures:
+    - python: "nightly"
 install:
  - pip install -e .
  - pip install pytest

README.rst

@@ -17,7 +17,7 @@ Main features
 - enforce updating serial number when zone content is changed
 - both ``pre-commit`` and ``pre-receive``/``update`` hooks to enforce similar checks in the remote repository
 - ``post-receive`` hook to checkout the working copy from a bare repository, generate config snippets for various DNS server software and reload them
-- only Python standard library is used
+- only Python 3.5+ standard library is used
 
 
 Requirements
@@ -28,25 +28,36 @@ Requirements
 - git
 
 
-Instalation and usage
----------------------
+Simple instalation (especially for workstations)
+------------------------------------------------
 
-- install required dependencies
-- install ``dzonegit`` package using your favourite tool (``virtualenvwrapper``,
-  ``venv``, ``pipenv``, etc.)
+Since there is no other Python dependency than the standard library, you can
+simply download the `dzonegit.py` file, make it executable and rename/symlink
+it to an appropriate hook location inside the Git repository
+`.git/hooks/pre-commit`. This is especially handy for the end users not
+experienced with Python packaging ecosystem.
+
+
+Full instalation and usage
+--------------------------
+
+- install all the requirements
+- install ``dzonegit`` Python package using your
+  favourite tool (``virtualenvwrapper``, ``venv``, ``pipenv``, etc.)
 - in the local repository, create a symlink for the ``pre-commit`` hook:
-
   ``$ ln -s $(which dzonegit-pre-commit) /path/to/repo/.git/hooks/pre-commit``
-- on the server, install some git repository management software, preferrably Gitolite_
-- on the server, install either ``pre-receive`` or ``update`` hook (both do the same) as
-  well as ``post-receive`` hook. See `Gitolite documentation on how to add custom hooks`_
-- on the server set up the configuration options for each repository
+- on the server, install some git repository management software,
+  preferably Gitolite_
+- on the server, install either ``pre-receive`` or ``update`` hook
+  (both do the same) as  well as the ``post-receive`` hook. See `Gitolite
+  documentation on how to add custom hooks`_
+- on the server, set up the configuration options for each repository
 
 Configuration options
 ---------------------
 
-All configuration options are stored in `git-config(1)`_ in section named ``dzonegit``.
-All boolean options default to *False*.
+All configuration options are stored in `git-config(1)`_ in the section
+named ``dzonegit``.  All boolean options default to *False*.
 
 
 *dzonegit.ignorewhitespaceerrors*
@@ -76,7 +87,7 @@ All boolean options default to *False*.
   can be provided by appending single digit from 1 to 9 to this option.
 
 *dzonegit.zonereloadcmd*
-  A command to run for each zone, whose zone file has been modified. Zone
+  A command to run for each zone, where zone file has been modified. Zone
   name is automatically appended as the last argument. Should do something
   like ``rndc reload``. More commands can be provided by appending single digit
   from 1 to 9 to this option.
@@ -84,12 +95,14 @@ All boolean options default to *False*.
 *dzonegit.zoneblacklist*
   Path to a text file containing list of zone names without trailing dots,
   one per line. If zone is found on the blacklist, it is ignored when
-  ``post-receive`` hook generates configuration.
+  ``post-receive`` hook generates configuration. Wildcards can be used as
+  well, see `JSON template`_ below.
 
 *dzonegit.zonewhitelist*
   Path to a text file containing list of zone names without trailing dots,
   one per line. If not empty and zone is not found on the whitelist,
-  it is ignored when ``post-receive`` hook generates configuration.
+  it is ignored when ``post-receive`` hook generates configuration. Wildcards
+  can be used as well, see `JSON template`_ below.
 
 JSON template
 -------------
@@ -98,7 +111,7 @@ The DNS server configuration snippets are generated using a simple JSON-based
 template. All keys are optional but please make sure the file is a valid JSON
 file. It is possible to define a zone-specific options, for instance for
 changing DNSSEC parameters per zone. Those zone-specific options allow usage of
-wildcards; if exact match of zone name is not found, the leftmost label is
+wildcards; if an exact match of zone name is not found, the leftmost label is
 substituted with `*`. If still no match is found, the leftmost label is dropped
 and the second one is again substituted with `*`. In the end, a single `*` is
 checked. Only if even this key is not found, the value of *defaultvar* is used
@@ -129,10 +142,10 @@ Valid keys are:
 In the template strings, these placeholders are supported:
 
 ``$datetime``
-  Current timestamp
+  Current date and time in human readable format
 
 ``$zonename``
-  Zone name, without trailing dot
+  Zone name, without the trailing dot
 
 ``$zonefile``
   Full path to the zone file

dzonegit.py

@@ -320,13 +320,16 @@ def template_config(checkoutpath, template, blacklist=set(), whitelist=set()):
     out.append(headertpl.substitute(mapping))
     for f in sorted(Path(checkoutpath).glob("**/*.zone")):
         zonename = get_zone_name(f, f.read_bytes())
-        if whitelist and zonename not in whitelist:
+        if whitelist and not any(
+                n in whitelist
+                for n in get_zone_wildcards(zonename)
+        ):
             print(
                 "WARNING: Ignoring zone {} - not whitelisted for "
                 "this repository.".format(zonename),
             )
             continue
-        if zonename in blacklist:
+        if any(n in blacklist for n in get_zone_wildcards(zonename)):
             print(
                 "WARNING: Ignoring zone {} - blacklisted for "
                 "this repository.".format(zonename),
@@ -431,6 +434,7 @@ def post_receive(stdin=sys.stdin):
         raise SystemExit("Checkout path not defined. Nothing to do.")
 
     print("Checking out repository into {}…".format(checkoutpath))
+    Path(checkoutpath).mkdir(parents=True, exist_ok=True)
     subprocess.run(
         ["git", "checkout", "-f", "master"],
         check=True,
@@ -492,17 +496,25 @@ def post_receive(stdin=sys.stdin):
                     subprocess.run(cmd)
 
 
+def get_action(argv=sys.argv):
+    name = Path(argv[0]).name
+    if "pre-commit" in name:
+        return pre_commit
+    if "update" in name:
+        return update
+    if "pre-receive" in name:
+        return pre_receive
+    if "post-receive" in name:
+        return post_receive
+
+
 def main():
-    name = Path(sys.argv[0]).name
-    print(name)
-    if name == "pre-commit":
-        pre_commit()
-    elif name == "update":
-        update()
-    elif name == "pre-receive":
-        pre_receive()
-    elif name == "post-receive":
-        post_receive()
+    action = get_action()
+    if action is None and len(sys.argv) > 1:
+        sys.argv.pop(0)
+        action = get_action()
+    if action:
+        action()
     else:
         sys.exit("No valid command found")
 

setup.py

@@ -5,7 +5,7 @@ readme = Path(__file__).with_name("README.rst").read_text()
 
 setup(
     name="dzonegit",
-    version="0.2",
+    version="0.5",
     description="Git hooks to manage a repository of DNS zones",
     long_description=readme,
     long_description_content_type="text/x-rst",
@@ -19,7 +19,6 @@ setup(
     tests_require=["pytest"],
     entry_points={
             "console_scripts": [
-                "dzonegit = dzonegit:main",
                 "dzonegit-pre-commit = dzonegit:pre_commit",
                 "dzonegit-pre-receive = dzonegit:pre_receive",
                 "dzonegit-post-receive = dzonegit:post_receive",

test_dzonegit.py

@@ -280,13 +280,14 @@ def test_post_receive(git_dir):
         head,
     )
     stdin = StringIO(revisions)
-    codir = git_dir.mkdir("co")
+    codir = git_dir.join("co")
     subprocess.call(["git", "config", "dzonegit.checkoutpath", str(codir)])
     subprocess.call([
         "git", "config", "dzonegit.reconfigcmd",
         "echo TEST >{}/test".format(codir),
     ])
     dzonegit.post_receive(stdin)
+    dzonegit.post_receive(stdin)  # Check coping with existing codir
     assert codir.join("dummy.zone").check()
     assert codir.join("test").read() == "TEST\n"
 
@@ -313,6 +314,12 @@ def test_template_config(git_dir):
         whitelist=set("a"),
     )
     assert " - zone: \"dummy\"\n   file: \"" not in output
+    output = dzonegit.template_config(
+        str(git_dir),
+        template,
+        blacklist=set("*"),
+    )
+    assert " - zone: \"dummy\"\n   file: \"" not in output
 
 
 def test_load_set_file(git_dir):