mirror of
https://github.com/oskar456/dzonegit.git
synced 2024-05-11 05:55:41 +00:00
Compare commits
35 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
17cbd099de | ||
|
|
d809e24172 | ||
|
|
35d01a796e | ||
|
|
2f7776c0d1 | ||
|
|
498d4a8b82 | ||
|
|
a96597decb | ||
|
|
8f952086aa | ||
|
|
83a4049821 | ||
|
|
15cdae67ee | ||
|
|
12fb932711 | ||
|
|
cb543514ac | ||
|
|
f9c6a52357 | ||
|
|
24d992d999 | ||
|
|
7cb7c42d76 | ||
|
|
3dd346294a | ||
|
|
03fde74ede | ||
|
|
3769dd22fb | ||
|
|
8d15bb531c | ||
|
|
e2e4a3daf7 | ||
|
|
4efef8be9e | ||
|
|
ef059861b7 | ||
|
|
94461383e8 | ||
|
|
3e09833ec1 | ||
|
|
9ad1e74a88 | ||
|
|
a7d693253d | ||
|
|
3777453d2f | ||
|
|
023906177a | ||
|
|
e79bb901f3 | ||
|
|
f07c84aa32 | ||
|
|
62e35c59d0 | ||
|
|
806976ca6e | ||
|
|
17f771bca6 | ||
|
|
03cf26bbbe | ||
|
|
9923df14b7 | ||
|
|
8d99e86222 |
42
.github/workflows/python-test.yml
vendored
Normal file
42
.github/workflows/python-test.yml
vendored
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
|
||||||
|
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
|
||||||
|
|
||||||
|
name: Python package
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ master ]
|
||||||
|
pull_request:
|
||||||
|
branches: [ master ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
python-version: [3.6, 3.7, 3.8, 3.9]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Instal BIND 9 utils
|
||||||
|
run: sudo apt-get install -y bind9utils
|
||||||
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python-version }}
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
python -m pip install flake8 pytest
|
||||||
|
python -m pip install -e .
|
||||||
|
- name: Lint with flake8
|
||||||
|
run: |
|
||||||
|
# stop the build if there are Python syntax errors or undefined names
|
||||||
|
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
|
||||||
|
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
|
||||||
|
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
|
||||||
|
- name: Test with pytest
|
||||||
|
run: |
|
||||||
|
pytest
|
||||||
13
.travis.yml
13
.travis.yml
@@ -1,13 +0,0 @@
|
|||||||
before_install:
|
|
||||||
- sudo apt-get install -y bind9utils
|
|
||||||
language: python
|
|
||||||
python:
|
|
||||||
- "3.5"
|
|
||||||
- "3.6"
|
|
||||||
- "nightly"
|
|
||||||
install:
|
|
||||||
- pip install -e .
|
|
||||||
- pip install pytest
|
|
||||||
script:
|
|
||||||
- pytest
|
|
||||||
sudo: false
|
|
||||||
36
README.rst
36
README.rst
@@ -1,3 +1,6 @@
|
|||||||
|
.. image:: https://travis-ci.org/oskar456/dzonegit.svg?branch=master
|
||||||
|
:target: https://travis-ci.org/oskar456/dzonegit
|
||||||
|
|
||||||
Git hooks to manage a repository of DNS zones
|
Git hooks to manage a repository of DNS zones
|
||||||
=============================================
|
=============================================
|
||||||
|
|
||||||
@@ -15,6 +18,7 @@ Main features
|
|||||||
- check if zone file compiles properly using `named-compilezone(8)`_
|
- check if zone file compiles properly using `named-compilezone(8)`_
|
||||||
- autodetect zone name from file name or ``$ORIGIN`` directive
|
- autodetect zone name from file name or ``$ORIGIN`` directive
|
||||||
- enforce updating serial number when zone content is changed
|
- enforce updating serial number when zone content is changed
|
||||||
|
- optional ``smudge`` filter to replace ``$UNIXTIME`` directive with current UNIX time
|
||||||
- both ``pre-commit`` and ``pre-receive``/``update`` hooks to enforce similar checks in the remote repository
|
- 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
|
- ``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 3.5+ standard library is used
|
- only Python 3.5+ standard library is used
|
||||||
@@ -53,6 +57,27 @@ Full instalation and usage
|
|||||||
documentation on how to add custom hooks`_
|
documentation on how to add custom hooks`_
|
||||||
- on the server, set up the configuration options for each repository
|
- on the server, set up the configuration options for each repository
|
||||||
|
|
||||||
|
Support for $UNIXTIME directive
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
If you want to use ``$UNIXTIME`` in your zone files instead of serial number,
|
||||||
|
you have to install a `smudge` filter on the server, that will replace the
|
||||||
|
directive with current unix time on every checkout. First, set up the filter
|
||||||
|
in the Git configuration:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
$ git config --global filter.dzonegit.smudge $(which dzonegit-smudge-serial)
|
||||||
|
|
||||||
|
|
||||||
|
Then, apply the filter on all zone files using either ``.git/info/attributes``
|
||||||
|
or directly ``.gitattributes`` file inside the repository:
|
||||||
|
|
||||||
|
.. code-block::
|
||||||
|
|
||||||
|
*.zone filter=dzonegit
|
||||||
|
|
||||||
|
|
||||||
Configuration options
|
Configuration options
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
@@ -63,10 +88,18 @@ named ``dzonegit``. All boolean options default to *False*.
|
|||||||
*dzonegit.ignorewhitespaceerrors*
|
*dzonegit.ignorewhitespaceerrors*
|
||||||
Ignore white space errors in ``pre-commit`` and ``pre-receive``/``update`` hooks.
|
Ignore white space errors in ``pre-commit`` and ``pre-receive``/``update`` hooks.
|
||||||
|
|
||||||
|
*dzonegit.allowfancynames*
|
||||||
|
In ``pre-commit`` and ``pre-receive``/``update`` hooks, do not enforce zone
|
||||||
|
file name to be similar to the name of the zone.
|
||||||
|
|
||||||
*dzonegit.noserialupdate*
|
*dzonegit.noserialupdate*
|
||||||
Do not try to automatically update zone serial number if necessary.
|
Do not try to automatically update zone serial number if necessary.
|
||||||
Valid only in the ``pre-commit`` hook.
|
Valid only in the ``pre-commit`` hook.
|
||||||
|
|
||||||
|
*dzonegit.nomissingdotcheck*
|
||||||
|
Do not check for forgotten final dot on the right-hand side of PTR records.
|
||||||
|
Valid only in the ``pre-commit`` hook.
|
||||||
|
|
||||||
*dzonegit.checkoutpath*
|
*dzonegit.checkoutpath*
|
||||||
Path to a writable directory, to which ``post-receive`` hook checks out
|
Path to a writable directory, to which ``post-receive`` hook checks out
|
||||||
current *HEAD* after each update.
|
current *HEAD* after each update.
|
||||||
@@ -150,6 +183,9 @@ In the template strings, these placeholders are supported:
|
|||||||
``$zonefile``
|
``$zonefile``
|
||||||
Full path to the zone file
|
Full path to the zone file
|
||||||
|
|
||||||
|
``$zonerelfile``
|
||||||
|
Path to the zone file, relative to checkout path (useful for chroot environments)
|
||||||
|
|
||||||
``$zonevar``
|
``$zonevar``
|
||||||
Per-zone specific variable, see above
|
Per-zone specific variable, see above
|
||||||
|
|
||||||
|
|||||||
136
dzonegit.py
136
dzonegit.py
@@ -41,24 +41,24 @@ class HookException(ValueError):
|
|||||||
return "".join(r)
|
return "".join(r)
|
||||||
|
|
||||||
|
|
||||||
def get_head():
|
def get_head(empty=False):
|
||||||
r = subprocess.run(
|
if not empty:
|
||||||
["git", "rev-parse", "--verify", "HEAD"],
|
r = subprocess.run(
|
||||||
stdout=subprocess.PIPE,
|
["git", "rev-parse", "--verify", "HEAD"],
|
||||||
stderr=subprocess.DEVNULL,
|
stdout=subprocess.PIPE,
|
||||||
)
|
stderr=subprocess.DEVNULL,
|
||||||
if r.returncode == 0:
|
)
|
||||||
return r.stdout.decode("utf-8").strip()
|
if r.returncode == 0:
|
||||||
else:
|
return r.stdout.decode("ascii").strip()
|
||||||
# Initial commit: diff against an empty tree object
|
# Initial commit: diff against an empty tree object
|
||||||
return "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
|
return "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
|
||||||
|
|
||||||
|
|
||||||
def check_whitespace_errors(against, revision=None):
|
def check_whitespace_errors(against, revision=None):
|
||||||
if revision:
|
if revision:
|
||||||
cmd = ["git", "diff-tree", "--check", against, revision]
|
cmd = ["git", "diff-tree", "--check", against, revision, "*.zone"]
|
||||||
else:
|
else:
|
||||||
cmd = ["git", "diff-index", "--check", "--cached", against]
|
cmd = ["git", "diff-index", "--check", "--cached", against, "*.zone"]
|
||||||
r = subprocess.run(
|
r = subprocess.run(
|
||||||
cmd,
|
cmd,
|
||||||
stdout=subprocess.PIPE,
|
stdout=subprocess.PIPE,
|
||||||
@@ -83,14 +83,44 @@ def get_file_contents(path, revision=None):
|
|||||||
return r.stdout
|
return r.stdout
|
||||||
|
|
||||||
|
|
||||||
def compile_zone(zonename, zonedata):
|
def unixtime_directive(zonedata, unixtime=None):
|
||||||
|
""" Filter binary zone data. Replace $UNIXTIME with current unix time. """
|
||||||
|
if unixtime is None:
|
||||||
|
unixtime = int(time.time())
|
||||||
|
return re.sub(
|
||||||
|
br'\$UNIXTIME\b',
|
||||||
|
str(unixtime).encode("ascii"),
|
||||||
|
zonedata,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def check_missing_trailing_dot(zonename, compiled_zonedata):
|
||||||
|
badlines = []
|
||||||
|
for line in compiled_zonedata.splitlines():
|
||||||
|
if re.search(
|
||||||
|
r"\sPTR\s+[^\s]*\.{}.$".format(zonename).encode("ascii"),
|
||||||
|
line,
|
||||||
|
re.I,
|
||||||
|
):
|
||||||
|
badlines.append(line.decode("utf-8"))
|
||||||
|
if badlines:
|
||||||
|
raise HookException(
|
||||||
|
"Possibly missing trailing dot after PTR records:\n{}".format(
|
||||||
|
"\n".join(badlines),
|
||||||
|
),
|
||||||
|
fname=zonename,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def compile_zone(zonename, zonedata, unixtime=None, missing_dot=False):
|
||||||
""" Compile the zone. Return tuple with results."""
|
""" Compile the zone. Return tuple with results."""
|
||||||
CompileResults = namedtuple(
|
CompileResults = namedtuple(
|
||||||
"CompileResults", "success, serial, zonehash, stderr",
|
"CompileResults", "success, serial, zonehash, stderr",
|
||||||
)
|
)
|
||||||
r = subprocess.run(
|
r = subprocess.run(
|
||||||
["/usr/sbin/named-compilezone", "-o", "-", zonename, "/dev/stdin"],
|
["/usr/bin/env", "named-compilezone", "-o", "-", zonename, "/dev/stdin"],
|
||||||
input=zonedata,
|
input=unixtime_directive(zonedata, unixtime),
|
||||||
stdout=subprocess.PIPE,
|
stdout=subprocess.PIPE,
|
||||||
stderr=subprocess.PIPE,
|
stderr=subprocess.PIPE,
|
||||||
)
|
)
|
||||||
@@ -98,6 +128,8 @@ def compile_zone(zonename, zonedata):
|
|||||||
m = re.search(r"^zone.*loaded serial ([0-9]*)$", stderr, re.MULTILINE)
|
m = re.search(r"^zone.*loaded serial ([0-9]*)$", stderr, re.MULTILINE)
|
||||||
if r.returncode == 0 and m:
|
if r.returncode == 0 and m:
|
||||||
serial = m.group(1)
|
serial = m.group(1)
|
||||||
|
if missing_dot:
|
||||||
|
check_missing_trailing_dot(zonename, r.stdout)
|
||||||
zonehash = sha256(r.stdout).hexdigest()
|
zonehash = sha256(r.stdout).hexdigest()
|
||||||
return CompileResults(True, serial, zonehash, stderr)
|
return CompileResults(True, serial, zonehash, stderr)
|
||||||
else:
|
else:
|
||||||
@@ -134,7 +166,7 @@ def get_altered_files(against, diff_filter=None, revision=None):
|
|||||||
If revision is None, list changes between staging area and
|
If revision is None, list changes between staging area and
|
||||||
revision. Otherwise differences between two revisions are computed.
|
revision. Otherwise differences between two revisions are computed.
|
||||||
"""
|
"""
|
||||||
cmd = ["git", "diff", "--name-only", "-z"]
|
cmd = ["git", "diff", "--name-only", "-z", "--no-renames"]
|
||||||
if diff_filter:
|
if diff_filter:
|
||||||
cmd.append("--diff-filter={}".format(diff_filter))
|
cmd.append("--diff-filter={}".format(diff_filter))
|
||||||
if revision:
|
if revision:
|
||||||
@@ -173,15 +205,15 @@ def get_zone_origin(zonedata):
|
|||||||
def get_zone_name(path, zonedata):
|
def get_zone_name(path, zonedata):
|
||||||
"""
|
"""
|
||||||
Try to guess zone name from either filename or the first $ORIGIN.
|
Try to guess zone name from either filename or the first $ORIGIN.
|
||||||
Throw a HookException if filename and zone ORIGIN differ more than
|
Unless disabled, throw a HookException if filename and zone ORIGIN differ
|
||||||
in slashes.
|
more than in slashes.
|
||||||
"""
|
"""
|
||||||
stemname = Path(path).stem.lower()
|
stemname = Path(path).stem.lower()
|
||||||
originname = get_zone_origin(zonedata)
|
originname = get_zone_origin(zonedata)
|
||||||
if originname:
|
if originname:
|
||||||
tt = str.maketrans("", "", "/_,:-+*%^&#$")
|
tt = str.maketrans("", "", "/_,:-+*%^&#$")
|
||||||
sn, on = [s.translate(tt) for s in [stemname, originname]]
|
sn, on = [s.translate(tt) for s in [stemname, originname]]
|
||||||
if sn != on:
|
if sn != on and not get_config("dzonegit.allowfancynames", bool):
|
||||||
raise HookException(
|
raise HookException(
|
||||||
"Zone origin {o} differs from zone file.".format(o=originname),
|
"Zone origin {o} differs from zone file.".format(o=originname),
|
||||||
fname=path,
|
fname=path,
|
||||||
@@ -191,15 +223,21 @@ def get_zone_name(path, zonedata):
|
|||||||
return stemname
|
return stemname
|
||||||
|
|
||||||
|
|
||||||
def check_updated_zones(against, revision=None, autoupdate_serial=False):
|
def check_updated_zones(
|
||||||
|
against,
|
||||||
|
revision=None,
|
||||||
|
autoupdate_serial=False,
|
||||||
|
missing_dot=False,
|
||||||
|
):
|
||||||
""" Check whether all updated zone files compile. """
|
""" Check whether all updated zone files compile. """
|
||||||
|
unixtime = int(time.time())
|
||||||
for f in get_altered_files(against, "AMCR", revision):
|
for f in get_altered_files(against, "AMCR", revision):
|
||||||
if not f.suffix == ".zone":
|
if not f.suffix == ".zone":
|
||||||
continue
|
continue
|
||||||
print("Checking file {f}".format(f=f))
|
print("Checking file {f}".format(f=f))
|
||||||
zonedata = get_file_contents(f, revision)
|
zonedata = get_file_contents(f, revision)
|
||||||
zname = get_zone_name(f, zonedata)
|
zname = get_zone_name(f, zonedata)
|
||||||
rnew = compile_zone(zname, zonedata)
|
rnew = compile_zone(zname, zonedata, unixtime, missing_dot)
|
||||||
if not rnew.success:
|
if not rnew.success:
|
||||||
raise HookException(
|
raise HookException(
|
||||||
"New zone version does not compile",
|
"New zone version does not compile",
|
||||||
@@ -208,7 +246,7 @@ def check_updated_zones(against, revision=None, autoupdate_serial=False):
|
|||||||
try:
|
try:
|
||||||
zonedata = get_file_contents(f, against)
|
zonedata = get_file_contents(f, against)
|
||||||
zname = get_zone_name(f, zonedata)
|
zname = get_zone_name(f, zonedata)
|
||||||
rold = compile_zone(zname, zonedata)
|
rold = compile_zone(zname, zonedata, unixtime-1)
|
||||||
|
|
||||||
if (rold.success and rold.zonehash != rnew.zonehash and not
|
if (rold.success and rold.zonehash != rnew.zonehash and not
|
||||||
is_serial_increased(rold.serial, rnew.serial)):
|
is_serial_increased(rold.serial, rnew.serial)):
|
||||||
@@ -219,9 +257,11 @@ def check_updated_zones(against, revision=None, autoupdate_serial=False):
|
|||||||
|
|
||||||
if autoupdate_serial:
|
if autoupdate_serial:
|
||||||
newserial = get_increased_serial(rnew.serial)
|
newserial = get_increased_serial(rnew.serial)
|
||||||
replace_serial(f, rnew.serial, newserial)
|
if replace_serial(f, rnew.serial, newserial):
|
||||||
errmsg += " Serial has been automatically increased."
|
errmsg += " Serial has been automatically increased."
|
||||||
errmsg += " Check and recommit."
|
errmsg += " Check and recommit."
|
||||||
|
else:
|
||||||
|
errmsg += " Autoupdate of serial number failed."
|
||||||
raise HookException(
|
raise HookException(
|
||||||
errmsg,
|
errmsg,
|
||||||
fname=f,
|
fname=f,
|
||||||
@@ -264,8 +304,9 @@ def replace_serial(path, oldserial, newserial):
|
|||||||
flags=re.DOTALL | re.IGNORECASE | re.MULTILINE,
|
flags=re.DOTALL | re.IGNORECASE | re.MULTILINE,
|
||||||
)
|
)
|
||||||
if count != 1:
|
if count != 1:
|
||||||
raise HookException("Cannot update zone serial number")
|
return False
|
||||||
path.write_text(updated)
|
path.write_text(updated)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
def get_zone_wildcards(name):
|
def get_zone_wildcards(name):
|
||||||
@@ -317,7 +358,8 @@ def template_config(checkoutpath, template, blacklist=set(), whitelist=set()):
|
|||||||
out = list()
|
out = list()
|
||||||
zones = dict()
|
zones = dict()
|
||||||
mapping = {"datetime": datetime.datetime.now().strftime("%c")}
|
mapping = {"datetime": datetime.datetime.now().strftime("%c")}
|
||||||
out.append(headertpl.substitute(mapping))
|
if headertpl.template:
|
||||||
|
out.append(headertpl.substitute(mapping))
|
||||||
for f in sorted(Path(checkoutpath).glob("**/*.zone")):
|
for f in sorted(Path(checkoutpath).glob("**/*.zone")):
|
||||||
zonename = get_zone_name(f, f.read_bytes())
|
zonename = get_zone_name(f, f.read_bytes())
|
||||||
if whitelist and not any(
|
if whitelist and not any(
|
||||||
@@ -353,9 +395,10 @@ def template_config(checkoutpath, template, blacklist=set(), whitelist=set()):
|
|||||||
zonevar = defaultvar
|
zonevar = defaultvar
|
||||||
out.append(itemtpl.substitute(
|
out.append(itemtpl.substitute(
|
||||||
mapping, zonename=zonename,
|
mapping, zonename=zonename,
|
||||||
zonefile=str(f), zonevar=zonevar,
|
zonefile=str(f), zonerelfile=str(f.relative_to(checkoutpath)), zonevar=zonevar,
|
||||||
))
|
))
|
||||||
out.append(footertpl.substitute(mapping))
|
if footertpl.template:
|
||||||
|
out.append(footertpl.substitute(mapping))
|
||||||
return "\n".join(out)
|
return "\n".join(out)
|
||||||
|
|
||||||
|
|
||||||
@@ -369,13 +412,19 @@ def load_set_file(path):
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def do_commit_checks(against, revision=None, autoupdate_serial=False):
|
def do_commit_checks(
|
||||||
|
against,
|
||||||
|
revision=None,
|
||||||
|
autoupdate_serial=False,
|
||||||
|
missing_dot=False,
|
||||||
|
):
|
||||||
try:
|
try:
|
||||||
if not get_config("dzonegit.ignorewhitespaceerrors", bool):
|
if not get_config("dzonegit.ignorewhitespaceerrors", bool):
|
||||||
check_whitespace_errors(against, revision=revision)
|
check_whitespace_errors(against, revision=revision)
|
||||||
check_updated_zones(
|
check_updated_zones(
|
||||||
against, revision=revision,
|
against, revision=revision,
|
||||||
autoupdate_serial=autoupdate_serial,
|
autoupdate_serial=autoupdate_serial,
|
||||||
|
missing_dot=missing_dot,
|
||||||
)
|
)
|
||||||
except HookException as e:
|
except HookException as e:
|
||||||
print(e)
|
print(e)
|
||||||
@@ -385,7 +434,12 @@ def do_commit_checks(against, revision=None, autoupdate_serial=False):
|
|||||||
def pre_commit():
|
def pre_commit():
|
||||||
against = get_head()
|
against = get_head()
|
||||||
autoupdate_serial = not get_config("dzonegit.noserialupdate", bool)
|
autoupdate_serial = not get_config("dzonegit.noserialupdate", bool)
|
||||||
do_commit_checks(against, autoupdate_serial=autoupdate_serial)
|
missing_dot = not get_config("dzonegit.nomissingdotcheck", bool)
|
||||||
|
do_commit_checks(
|
||||||
|
against,
|
||||||
|
autoupdate_serial=autoupdate_serial,
|
||||||
|
missing_dot=missing_dot,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def update(argv=sys.argv):
|
def update(argv=sys.argv):
|
||||||
@@ -398,7 +452,7 @@ def update(argv=sys.argv):
|
|||||||
refname, against, revision = argv[1:4]
|
refname, against, revision = argv[1:4]
|
||||||
|
|
||||||
if against == "0000000000000000000000000000000000000000":
|
if against == "0000000000000000000000000000000000000000":
|
||||||
against = get_head() # Empty commit
|
against = get_head(True) # Empty commit
|
||||||
|
|
||||||
if refname != "refs/heads/master":
|
if refname != "refs/heads/master":
|
||||||
raise SystemExit("Nothing else than master branch is accepted here")
|
raise SystemExit("Nothing else than master branch is accepted here")
|
||||||
@@ -416,7 +470,7 @@ def pre_receive(stdin=sys.stdin):
|
|||||||
"is accepted here",
|
"is accepted here",
|
||||||
)
|
)
|
||||||
if against == "0000000000000000000000000000000000000000":
|
if against == "0000000000000000000000000000000000000000":
|
||||||
against = get_head() # Empty commit
|
against = get_head(True) # Empty commit
|
||||||
do_commit_checks(against, revision)
|
do_commit_checks(against, revision)
|
||||||
|
|
||||||
|
|
||||||
@@ -434,6 +488,7 @@ def post_receive(stdin=sys.stdin):
|
|||||||
raise SystemExit("Checkout path not defined. Nothing to do.")
|
raise SystemExit("Checkout path not defined. Nothing to do.")
|
||||||
|
|
||||||
print("Checking out repository into {}…".format(checkoutpath))
|
print("Checking out repository into {}…".format(checkoutpath))
|
||||||
|
Path(checkoutpath).mkdir(parents=True, exist_ok=True)
|
||||||
subprocess.run(
|
subprocess.run(
|
||||||
["git", "checkout", "-f", "master"],
|
["git", "checkout", "-f", "master"],
|
||||||
check=True,
|
check=True,
|
||||||
@@ -465,7 +520,7 @@ def post_receive(stdin=sys.stdin):
|
|||||||
if refname != "refs/heads/master":
|
if refname != "refs/heads/master":
|
||||||
continue
|
continue
|
||||||
if against == "0000000000000000000000000000000000000000":
|
if against == "0000000000000000000000000000000000000000":
|
||||||
against = get_head() # Empty commit
|
against = get_head(True) # Empty commit
|
||||||
should_reconfig = [
|
should_reconfig = [
|
||||||
f for f in get_altered_files(against, "ACDRU", revision)
|
f for f in get_altered_files(against, "ACDRU", revision)
|
||||||
if f.suffix == ".zone"
|
if f.suffix == ".zone"
|
||||||
@@ -495,6 +550,15 @@ def post_receive(stdin=sys.stdin):
|
|||||||
subprocess.run(cmd)
|
subprocess.run(cmd)
|
||||||
|
|
||||||
|
|
||||||
|
def smudge_serial(
|
||||||
|
bstdin=sys.stdin.buffer,
|
||||||
|
bstdout=sys.stdout.buffer,
|
||||||
|
unixtime=None,
|
||||||
|
):
|
||||||
|
"""Replace all $UNIXTIME directives with current unix time."""
|
||||||
|
bstdout.write(unixtime_directive(bstdin.read(), unixtime))
|
||||||
|
|
||||||
|
|
||||||
def get_action(argv=sys.argv):
|
def get_action(argv=sys.argv):
|
||||||
name = Path(argv[0]).name
|
name = Path(argv[0]).name
|
||||||
if "pre-commit" in name:
|
if "pre-commit" in name:
|
||||||
@@ -505,6 +569,8 @@ def get_action(argv=sys.argv):
|
|||||||
return pre_receive
|
return pre_receive
|
||||||
if "post-receive" in name:
|
if "post-receive" in name:
|
||||||
return post_receive
|
return post_receive
|
||||||
|
if "smudge" in name:
|
||||||
|
return smudge_serial
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
|
|||||||
5
setup.py
5
setup.py
@@ -5,7 +5,7 @@ readme = Path(__file__).with_name("README.rst").read_text()
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="dzonegit",
|
name="dzonegit",
|
||||||
version="0.4",
|
version="0.15",
|
||||||
description="Git hooks to manage a repository of DNS zones",
|
description="Git hooks to manage a repository of DNS zones",
|
||||||
long_description=readme,
|
long_description=readme,
|
||||||
long_description_content_type="text/x-rst",
|
long_description_content_type="text/x-rst",
|
||||||
@@ -23,10 +23,11 @@ setup(
|
|||||||
"dzonegit-pre-receive = dzonegit:pre_receive",
|
"dzonegit-pre-receive = dzonegit:pre_receive",
|
||||||
"dzonegit-post-receive = dzonegit:post_receive",
|
"dzonegit-post-receive = dzonegit:post_receive",
|
||||||
"dzonegit-update = dzonegit:update",
|
"dzonegit-update = dzonegit:update",
|
||||||
|
"dzonegit-smudge-serial = dzonegit:smudge_serial",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
classifiers=[
|
classifiers=[
|
||||||
"Development Status :: 3 - Alpha",
|
"Development Status :: 4 - Beta",
|
||||||
"Environment :: Console",
|
"Environment :: Console",
|
||||||
"Intended Audience :: System Administrators",
|
"Intended Audience :: System Administrators",
|
||||||
"License :: OSI Approved :: MIT License",
|
"License :: OSI Approved :: MIT License",
|
||||||
|
|||||||
104
test_dzonegit.py
104
test_dzonegit.py
@@ -4,7 +4,7 @@ import subprocess
|
|||||||
import time
|
import time
|
||||||
import datetime
|
import datetime
|
||||||
import os
|
import os
|
||||||
from io import StringIO
|
from io import StringIO, BytesIO
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import dzonegit
|
import dzonegit
|
||||||
@@ -15,6 +15,8 @@ def git_dir(tmpdir_factory):
|
|||||||
d = tmpdir_factory.getbasetemp()
|
d = tmpdir_factory.getbasetemp()
|
||||||
d.chdir()
|
d.chdir()
|
||||||
subprocess.call(["git", "init"])
|
subprocess.call(["git", "init"])
|
||||||
|
subprocess.call(["git", "config", "user.name", "dzonegit pytest"])
|
||||||
|
subprocess.call(["git", "config", "user.email", "nonexistent@example.com"])
|
||||||
return d
|
return d
|
||||||
|
|
||||||
|
|
||||||
@@ -25,18 +27,22 @@ def test_get_head(git_dir):
|
|||||||
subprocess.call(["git", "add", "dummy"])
|
subprocess.call(["git", "add", "dummy"])
|
||||||
subprocess.call(["git", "commit", "-m", "dummy"])
|
subprocess.call(["git", "commit", "-m", "dummy"])
|
||||||
assert dzonegit.get_head() != "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
|
assert dzonegit.get_head() != "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
|
||||||
|
subprocess.call(["git", "update-ref", "-d", "HEAD"])
|
||||||
|
|
||||||
|
|
||||||
def test_check_whitespace_errors(git_dir):
|
def test_check_whitespace_errors(git_dir):
|
||||||
git_dir.chdir()
|
git_dir.chdir()
|
||||||
git_dir.join("whitespace").write(" ")
|
git_dir.join("whitespace").write(" ")
|
||||||
subprocess.call(["git", "add", "whitespace"])
|
subprocess.call(["git", "add", "whitespace"])
|
||||||
|
dzonegit.check_whitespace_errors(dzonegit.get_head())
|
||||||
|
git_dir.join("whitespace.zone").write(" ")
|
||||||
|
subprocess.call(["git", "add", "whitespace.zone"])
|
||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
dzonegit.check_whitespace_errors(dzonegit.get_head())
|
dzonegit.check_whitespace_errors(dzonegit.get_head())
|
||||||
subprocess.call(["git", "commit", "-m", "whitespace"])
|
subprocess.call(["git", "commit", "-m", "whitespace"])
|
||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
dzonegit.check_whitespace_errors("HEAD~", dzonegit.get_head())
|
dzonegit.check_whitespace_errors("HEAD~", dzonegit.get_head())
|
||||||
subprocess.call(["git", "rm", "-f", "whitespace"])
|
subprocess.call(["git", "rm", "-f", "whitespace*"])
|
||||||
subprocess.call(["git", "commit", "-m", "rm whitespace"])
|
subprocess.call(["git", "commit", "-m", "rm whitespace"])
|
||||||
dzonegit.check_whitespace_errors(dzonegit.get_head())
|
dzonegit.check_whitespace_errors(dzonegit.get_head())
|
||||||
dzonegit.check_whitespace_errors("HEAD~", dzonegit.get_head())
|
dzonegit.check_whitespace_errors("HEAD~", dzonegit.get_head())
|
||||||
@@ -62,16 +68,47 @@ $ORIGIN example.com.
|
|||||||
60 IN NS ns
|
60 IN NS ns
|
||||||
ns.example.com. 60 IN A 192.0.2.1
|
ns.example.com. 60 IN A 192.0.2.1
|
||||||
"""
|
"""
|
||||||
r = dzonegit.compile_zone("example.org", testzone)
|
r = dzonegit.compile_zone("example.org", testzone, missing_dot=True)
|
||||||
assert not r.success
|
assert not r.success
|
||||||
assert r.zonehash is None
|
assert r.zonehash is None
|
||||||
assert r.stderr
|
assert r.stderr
|
||||||
r = dzonegit.compile_zone("example.com", testzone)
|
r = dzonegit.compile_zone("example.com", testzone, missing_dot=True)
|
||||||
assert r.success
|
assert r.success
|
||||||
assert r.serial == "1234567890"
|
assert r.serial == "1234567890"
|
||||||
assert r.zonehash
|
assert r.zonehash
|
||||||
r2 = dzonegit.compile_zone("example.com", testzone + b"\n\n; some comment")
|
r2 = dzonegit.compile_zone("example.com", testzone + b"\n\n; some comment")
|
||||||
assert r.zonehash == r2.zonehash
|
assert r.zonehash == r2.zonehash
|
||||||
|
testzone += b"1 60 IN PTR www\n"
|
||||||
|
dzonegit.compile_zone("example.com", testzone, missing_dot=False)
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
dzonegit.compile_zone("example.com", testzone, missing_dot=True)
|
||||||
|
|
||||||
|
|
||||||
|
def test_compile_unsmudged_zone():
|
||||||
|
testzone = b"""
|
||||||
|
$ORIGIN example.com.
|
||||||
|
@ 60 IN SOA ns hostmaster (
|
||||||
|
$UNIXTIME ; serial
|
||||||
|
3600 ; refresh (1 hour)
|
||||||
|
900 ; retry (15 minutes)
|
||||||
|
1814400 ; expire (3 weeks)
|
||||||
|
60 ; minimum (1 minute)
|
||||||
|
)
|
||||||
|
60 IN NS ns
|
||||||
|
ns.example.com. 60 IN A 192.0.2.1
|
||||||
|
"""
|
||||||
|
replaced = dzonegit.unixtime_directive(testzone)
|
||||||
|
assert b"$UNIXTIME" not in replaced
|
||||||
|
r = dzonegit.compile_zone("example.com", testzone, 123456)
|
||||||
|
assert r.success
|
||||||
|
assert r.serial == str(123456)
|
||||||
|
|
||||||
|
|
||||||
|
def test_smudge_serial():
|
||||||
|
bstdin = BytesIO(b"something $UNIXTIME something")
|
||||||
|
bstdout = BytesIO()
|
||||||
|
dzonegit.smudge_serial(bstdin, bstdout, 123456)
|
||||||
|
assert b"something 123456 something" == bstdout.getvalue()
|
||||||
|
|
||||||
|
|
||||||
def test_is_serial_increased():
|
def test_is_serial_increased():
|
||||||
@@ -91,7 +128,7 @@ def test_get_altered_files(git_dir):
|
|||||||
assert files == {Path("dummy"), Path("new")}
|
assert files == {Path("dummy"), Path("new")}
|
||||||
# Refers to test_check_whitespace_errors
|
# Refers to test_check_whitespace_errors
|
||||||
files = set(dzonegit.get_altered_files("HEAD~", "D", "HEAD"))
|
files = set(dzonegit.get_altered_files("HEAD~", "D", "HEAD"))
|
||||||
assert files == {Path("whitespace")}
|
assert files == {Path("whitespace"), Path("whitespace.zone")}
|
||||||
subprocess.call(["git", "checkout", "-f", "HEAD"])
|
subprocess.call(["git", "checkout", "-f", "HEAD"])
|
||||||
assert set(dzonegit.get_altered_files("HEAD", "AM")) == set()
|
assert set(dzonegit.get_altered_files("HEAD", "AM")) == set()
|
||||||
|
|
||||||
@@ -123,6 +160,7 @@ $ORIGIN eXample.com. ;coment
|
|||||||
60 IN NS ns
|
60 IN NS ns
|
||||||
ns.example.com. 60 IN A 192.0.2.1
|
ns.example.com. 60 IN A 192.0.2.1
|
||||||
"""
|
"""
|
||||||
|
subprocess.call(["git", "config", "dzonegit.allowfancynames", "FALSE"])
|
||||||
assert "example.com" == dzonegit.get_zone_name(
|
assert "example.com" == dzonegit.get_zone_name(
|
||||||
"zones/example.com.zone", "",
|
"zones/example.com.zone", "",
|
||||||
)
|
)
|
||||||
@@ -131,6 +169,8 @@ ns.example.com. 60 IN A 192.0.2.1
|
|||||||
)
|
)
|
||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
dzonegit.get_zone_name("zones/example.org.zone", testzone)
|
dzonegit.get_zone_name("zones/example.org.zone", testzone)
|
||||||
|
subprocess.call(["git", "config", "dzonegit.allowfancynames", "TRUE"])
|
||||||
|
dzonegit.get_zone_name("zones/example.org.zone", testzone)
|
||||||
testzone = b"""
|
testzone = b"""
|
||||||
$ORIGIN 240/28.2.0.192.in-addr.arpa.
|
$ORIGIN 240/28.2.0.192.in-addr.arpa.
|
||||||
@ 60 IN SOA ns hostmaster 1 60 60 60 60
|
@ 60 IN SOA ns hostmaster 1 60 60 60 60
|
||||||
@@ -148,12 +188,12 @@ def test_replace_serial(git_dir):
|
|||||||
@ 60 IN SOA ns hm 1 61 60 60 60
|
@ 60 IN SOA ns hm 1 61 60 60 60
|
||||||
60 NS ns.example.org.
|
60 NS ns.example.org.
|
||||||
""")
|
""")
|
||||||
dzonegit.replace_serial(Path("dummy.zone"), "1", "60")
|
assert dzonegit.replace_serial(Path("dummy.zone"), "1", "60")
|
||||||
assert git_dir.join("dummy.zone").read() == """
|
assert git_dir.join("dummy.zone").read() == """
|
||||||
@ 60 IN SOA ns hm 60 61 60 60 60
|
@ 60 IN SOA ns hm 60 61 60 60 60
|
||||||
60 NS ns.example.org.
|
60 NS ns.example.org.
|
||||||
"""
|
"""
|
||||||
dzonegit.replace_serial(Path("dummy.zone"), "60", "61")
|
assert dzonegit.replace_serial(Path("dummy.zone"), "60", "61")
|
||||||
assert git_dir.join("dummy.zone").read() == """
|
assert git_dir.join("dummy.zone").read() == """
|
||||||
@ 60 IN SOA ns hm 61 61 60 60 60
|
@ 60 IN SOA ns hm 61 61 60 60 60
|
||||||
60 NS ns.example.org.
|
60 NS ns.example.org.
|
||||||
@@ -168,7 +208,7 @@ def test_replace_serial(git_dir):
|
|||||||
)
|
)
|
||||||
60 NS ns.example.org.
|
60 NS ns.example.org.
|
||||||
""")
|
""")
|
||||||
dzonegit.replace_serial(Path("dummy.zone"), "60", "6000000")
|
assert dzonegit.replace_serial(Path("dummy.zone"), "60", "6000000")
|
||||||
assert git_dir.join("dummy.zone").read() == """
|
assert git_dir.join("dummy.zone").read() == """
|
||||||
@ 60 IN SOA ns hm (
|
@ 60 IN SOA ns hm (
|
||||||
6000000 ; serial
|
6000000 ; serial
|
||||||
@@ -179,6 +219,7 @@ def test_replace_serial(git_dir):
|
|||||||
)
|
)
|
||||||
60 NS ns.example.org.
|
60 NS ns.example.org.
|
||||||
"""
|
"""
|
||||||
|
assert not dzonegit.replace_serial(Path("dummy.zone"), "0", "60")
|
||||||
|
|
||||||
|
|
||||||
def test_check_updated_zones(git_dir):
|
def test_check_updated_zones(git_dir):
|
||||||
@@ -226,6 +267,29 @@ $ORIGIN dummy.
|
|||||||
dzonegit.check_updated_zones("HEAD", autoupdate_serial=True)
|
dzonegit.check_updated_zones("HEAD", autoupdate_serial=True)
|
||||||
subprocess.call(["git", "add", "dummy.zone"])
|
subprocess.call(["git", "add", "dummy.zone"])
|
||||||
dzonegit.check_updated_zones(dzonegit.get_head())
|
dzonegit.check_updated_zones(dzonegit.get_head())
|
||||||
|
git_dir.join("dummy.zone").write("""
|
||||||
|
$ORIGIN dummy.
|
||||||
|
@ 60 IN SOA ns hm $UNIXTIME 61 60 60 60
|
||||||
|
60 NS ns.example.org.
|
||||||
|
""")
|
||||||
|
subprocess.call(["git", "add", "dummy.zone"])
|
||||||
|
dzonegit.check_updated_zones(dzonegit.get_head())
|
||||||
|
subprocess.call(["git", "commit", "-m", "dummy.zone with $UNIXTIME"])
|
||||||
|
git_dir.join("dummy.zone").write("""
|
||||||
|
$ORIGIN dummy.
|
||||||
|
@ 60 IN SOA ns hm 1 60 60 60 60
|
||||||
|
60 NS ns.example.org.
|
||||||
|
""")
|
||||||
|
subprocess.call(["git", "add", "dummy.zone"])
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
dzonegit.check_updated_zones(dzonegit.get_head())
|
||||||
|
git_dir.join("dummy.zone").write("""
|
||||||
|
$ORIGIN dummy.
|
||||||
|
@ 60 IN SOA ns hm $UNIXTIME 60 60 60 60
|
||||||
|
60 NS ns.example.org.
|
||||||
|
""")
|
||||||
|
subprocess.call(["git", "add", "dummy.zone"])
|
||||||
|
dzonegit.check_updated_zones(dzonegit.get_head())
|
||||||
subprocess.call(["git", "commit", "-m", "final dummy.zone"])
|
subprocess.call(["git", "commit", "-m", "final dummy.zone"])
|
||||||
dzonegit.check_updated_zones("HEAD~", "HEAD")
|
dzonegit.check_updated_zones("HEAD~", "HEAD")
|
||||||
|
|
||||||
@@ -276,11 +340,11 @@ def test_post_receive(git_dir):
|
|||||||
git_dir.chdir()
|
git_dir.chdir()
|
||||||
head = dzonegit.get_head()
|
head = dzonegit.get_head()
|
||||||
revisions = "{} {} refs/heads/master\n".format(
|
revisions = "{} {} refs/heads/master\n".format(
|
||||||
"4b825dc642cb6eb9a060e54bf8d69288fbee4904",
|
"0000000000000000000000000000000000000000",
|
||||||
head,
|
head,
|
||||||
)
|
)
|
||||||
stdin = StringIO(revisions)
|
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.checkoutpath", str(codir)])
|
||||||
subprocess.call([
|
subprocess.call([
|
||||||
"git", "config", "dzonegit.reconfigcmd",
|
"git", "config", "dzonegit.reconfigcmd",
|
||||||
@@ -289,6 +353,17 @@ def test_post_receive(git_dir):
|
|||||||
dzonegit.post_receive(stdin)
|
dzonegit.post_receive(stdin)
|
||||||
assert codir.join("dummy.zone").check()
|
assert codir.join("dummy.zone").check()
|
||||||
assert codir.join("test").read() == "TEST\n"
|
assert codir.join("test").read() == "TEST\n"
|
||||||
|
# Test reconfig after renaming the file
|
||||||
|
codir.join("test").write("")
|
||||||
|
subprocess.call(["git", "mv", "dummy.zone", "dummy.zone.old"])
|
||||||
|
subprocess.call(["git", "commit", "-m", "rename dummy zone"])
|
||||||
|
revisions = "{} {} refs/heads/master\n".format(
|
||||||
|
head,
|
||||||
|
dzonegit.get_head(),
|
||||||
|
)
|
||||||
|
stdin = StringIO(revisions)
|
||||||
|
dzonegit.post_receive(stdin)
|
||||||
|
assert codir.join("test").read() == "TEST\n"
|
||||||
|
|
||||||
|
|
||||||
def test_template_config(git_dir):
|
def test_template_config(git_dir):
|
||||||
@@ -319,6 +394,8 @@ def test_template_config(git_dir):
|
|||||||
blacklist=set("*"),
|
blacklist=set("*"),
|
||||||
)
|
)
|
||||||
assert " - zone: \"dummy\"\n file: \"" not in output
|
assert " - zone: \"dummy\"\n file: \"" not in output
|
||||||
|
output = dzonegit.template_config(str(git_dir), "{}")
|
||||||
|
assert len(output) == 0
|
||||||
|
|
||||||
|
|
||||||
def test_load_set_file(git_dir):
|
def test_load_set_file(git_dir):
|
||||||
@@ -332,3 +409,10 @@ def test_get_zone_wildcards():
|
|||||||
"a.long.zone.name", "*.long.zone.name",
|
"a.long.zone.name", "*.long.zone.name",
|
||||||
"*.zone.name", "*.name", "*",
|
"*.zone.name", "*.name", "*",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_missing_trailing_dot():
|
||||||
|
zonename = "example.com"
|
||||||
|
zonedata = b"something.example.com. IN PTR s.example.com."
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
dzonegit.check_missing_trailing_dot(zonename, zonedata)
|
||||||
|
|||||||
Reference in New Issue
Block a user