Merge pull request #2875 from lunkwill42/bugfix/test-scripts

Fix broken `navclean` and `navsynctypes`  scripts

python/nav/bin/navclean.py

@@ -34,7 +34,7 @@
 import nav.db
 
 
-def main(args):
+def main():
     """Main execution function."""
     parser = make_argparser()
     args = parser.parse_args()
@@ -210,7 +210,7 @@ class RadiusAcctDeleter(RecordDeleter):
     selector = """
         WHERE (acctstoptime < {expiry})
         OR ((acctstarttime + (acctsessiontime * interval '1 sec')) < {expiry})
-        OR (acctstarttime < {expiry} 
+        OR (acctstarttime < {expiry}
             AND (acctstarttime + (acctsessiontime * interval '1 sec')) IS NULL)
         """
 
@@ -245,4 +245,4 @@ def delete(self, expiry, dry_run=False):
 
 
 if __name__ == '__main__':
-    main(sys.argv[1:])
+    main()

python/nav/bin/navsynctypes.py

@@ -28,12 +28,12 @@
 
 
 VENDOR_INSERT_SQL_TEMPLATE = """
-INSERT INTO vendor 
+INSERT INTO vendor
 (SELECT {vendorid} AS vendorid
  WHERE NOT EXISTS (
   SELECT vendorid FROM vendor WHERE vendorid ILIKE {vendorid}
  )
-); 
+);
 """
 
 TYPE_UPSERT_SQL_TEMPLATE = """
@@ -43,7 +43,7 @@
   {typename},
   {sysobjectid},
   {descr}
-) ON CONFLICT (sysobjectid) DO UPDATE 
+) ON CONFLICT (sysobjectid) DO UPDATE
   SET
     vendorid=(SELECT vendorid FROM vendor WHERE vendorid ILIKE {vendorid}),
     typename={typename},
@@ -52,8 +52,9 @@
 """
 
 
-def main(_args):
+def main():
     """Main program"""
+    parse_args()
     types = NetboxType.objects.all().select_related("vendor")
     used_vendors = {t.vendor.id for t in types}
     if types:
@@ -109,4 +110,4 @@ def parse_args():
 
 
 if __name__ == "__main__":
-    main(parse_args())
+    main()

tests/integration/bin_test.py

@@ -6,9 +6,9 @@
 BINDIR = './python/nav/bin'
 
 
-def test_binary_runs(binary):
-    """Verifies that a command runs with a zero exit code"""
-    proc = subprocess.Popen(binary, stderr=subprocess.STDOUT, stdout=subprocess.PIPE)
+def test_script_runs(script):
+    """Verifies that a script defined in pyproject.toml runs with a zero exit code"""
+    proc = subprocess.Popen(script, stderr=subprocess.STDOUT, stdout=subprocess.PIPE)
     (done, fail) = proc.communicate()
     retcode = proc.wait()
 

tests/integration/conftest.py

@@ -1,13 +1,16 @@
 from __future__ import print_function
 import os
+import importlib.util
 import io
 import re
 import shlex
 from itertools import cycle
 from shutil import which
 import subprocess
 import time
+from typing import Dict
 
+import toml
 import pytest
 from django.test import Client
 
@@ -90,38 +93,44 @@ def stop_gunicorn():
 
 
 def pytest_generate_tests(metafunc):
-    if 'binary' in metafunc.fixturenames:
-        binaries = _nav_binary_tests()
-        ids = [b[0] for b in binaries]
-        metafunc.parametrize("binary", _nav_binary_tests(), ids=ids)
+    if 'script' in metafunc.fixturenames:
+        scripts = _nav_script_tests()
+        ids = [s[0] for s in scripts]
+        metafunc.parametrize("script", _nav_script_tests(), ids=ids)
     elif 'admin_navlet' in metafunc.fixturenames:
         from nav.models.profiles import AccountNavlet
 
         navlets = AccountNavlet.objects.filter(account__login='admin')
         metafunc.parametrize("admin_navlet", navlets)
 
 
-def _nav_binary_tests():
-    for binary in _nav_binary_list():
-        for args in _scan_testargs(binary):
-            if args:
-                yield args
-
+def _nav_script_tests():
+    """Generates a list of command lines to run to test all the NAV scripts defined
+    in pyproject.toml.
 
-def _nav_binary_list():
-    files = sorted(
-        os.path.join(BINDIR, f) for f in os.listdir(BINDIR) if not _is_excluded(f)
-    )
-    return (f for f in files if os.path.isfile(f))
+    Each NAV script can define 0 to many sets of test arguments that should be used
+    when executing the script, using comments at the top of the file.  This is because
+    some of the scripts are designed to require some arguments to be present in order
+    to run without exiting with an error.
+    """
+    for script, module_name in _nav_scripts_map().items():
+        spec = importlib.util.find_spec(module_name)
+        for args in _scan_testargs(spec.origin):
+            if args:
+                yield [script] + args[1:]
 
 
-def _is_excluded(filename):
-    return (
-        filename.endswith('~')
-        or filename.startswith('.')
-        or filename.startswith('__')
-        or filename.startswith('Makefile')
-    )
+def _nav_scripts_map() -> Dict[str, str]:
+    """Returns a map of installable script names to NAV module names from
+    pyproject.toml.
+    """
+    data = toml.load('pyproject.toml')
+    scripts: dict[str, str] = data.get('project', {}).get('scripts', {})
+    return {
+        script: module.split(':', maxsplit=1)[0]
+        for script, module in scripts.items()
+        if module.startswith('nav.')
+    }
 
 
 def _scan_testargs(filename):

tests/requirements.txt

@@ -12,6 +12,7 @@ pytest-timeout
 pytest-twisted~=1.13.0
 pytidylib==0.3.2
 selenium==3.141.0
+toml
 whisper>=0.9.9
 whitenoise==4.1.4
 # Our version of selenium breaks down if it is allowed to pull in the newest version of urllib3