Fix pylint's 'invalid-name' errors

Where possible comply with the naming rules. Add exceptions for the
function names used in KASP tests.

(cherry picked from commit 50ed74197cee16ff9df55175a251c341a191b0b3)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index d97bc7c5f47693aee1554c17b0d1632e54207ae4..95b87b0233a345b137b8c7004dfbe9aa094f3c5c 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -600,7 +600,7 @@ stages:
     - cd "$CI_PROJECT_DIR"
     - *find_python
     - >
-      "$PYTHON" bin/tests/convert-trs-to-junit.py . > "$CI_PROJECT_DIR"/junit_system.xml
+      "$PYTHON" bin/tests/convert_trs_to_junit.py . > "$CI_PROJECT_DIR"/junit_system.xml
     - *git_clone_bind9-qa
     - >
       "$PYTHON" "$CI_PROJECT_DIR"/bind9-qa/ci/postprocess_junit_files.py "$CI_PROJECT_DIR"/junit_system.xml --output "$CI_PROJECT_DIR"/junit.xml
@@ -632,7 +632,7 @@ stages:
     - *find_python
     - *git_clone_bind9-qa
     - >
-      "$PYTHON" "$CI_PROJECT_DIR"/bin/tests/convert-trs-to-junit.py . > "$CI_PROJECT_DIR"/junit_unit.xml
+      "$PYTHON" "$CI_PROJECT_DIR"/bin/tests/convert_trs_to_junit.py . > "$CI_PROJECT_DIR"/junit_unit.xml
     - >
       "$PYTHON" "$CI_PROJECT_DIR"/bind9-qa/ci/postprocess_junit_files.py "$CI_PROJECT_DIR"/junit_unit.xml --output "$CI_PROJECT_DIR"/junit.xml
     - (exit $RET)

diff --git a/bin/tests/Makefile.am b/bin/tests/Makefile.am
index 56e81b118a1c5cd35ccb016d44c5457d6871c0e1..2dd2067ba6206320bb985bf79bdb41d76fdde45a 100644 (file)
--- a/bin/tests/Makefile.am
+++ b/bin/tests/Makefile.am
@@ -1,6 +1,6 @@
 include $(top_srcdir)/Makefile.top
 
-EXTRA_DIST = convert-trs-to-junit.py
+EXTRA_DIST = convert_trs_to_junit.py
 
 SUBDIRS = system
 

diff --git a/bin/tests/convert-trs-to-junit.py b/bin/tests/convert_trs_to_junit.py
similarity index 100%
rename from bin/tests/convert-trs-to-junit.py
rename to bin/tests/convert_trs_to_junit.py

diff --git a/bin/tests/system/convert-junit-to-trs.py b/bin/tests/system/convert_junit_to_trs.py
similarity index 96%
rename from bin/tests/system/convert-junit-to-trs.py
rename to bin/tests/system/convert_junit_to_trs.py
index 3726e19fb56b370eec7802865a17b1ab1da2744b..83cf630274638c9b372cff07090f667cdae0f63e 100755 (executable)
--- a/bin/tests/system/convert-junit-to-trs.py
+++ b/bin/tests/system/convert_junit_to_trs.py
@@ -17,7 +17,7 @@ def junit_to_trs(junit_xml):
     testcases = root.findall(".//testcase")
 
     if len(testcases) < 1:
-        print(":test-result: ERROR convert-junit-to-trs.py")
+        print(":test-result: ERROR convert_junit_to_trs.py")
         return 99
 
     has_fail = False

diff --git a/bin/tests/system/custom-test-driver b/bin/tests/system/custom-test-driver
index 278cb377e2bf0a67ade759caf411b9b42e0c1571..a2f76910b1aeed75be9ace8b2bedab44446fff99 100755 (executable)
--- a/bin/tests/system/custom-test-driver
+++ b/bin/tests/system/custom-test-driver
@@ -146,7 +146,7 @@ else
 fi
 
 # Run junit to trs converter script.
-./convert-junit-to-trs.py $junit_file >$trs_file
+./convert_junit_to_trs.py $junit_file >$trs_file
 estatus=$?
 
 if test $enable_hard_errors = no && test $estatus -eq 99; then

diff --git a/bin/tests/system/isctest/kasp.py b/bin/tests/system/isctest/kasp.py
index 950a8d994f91914809733b647665e4b5534c2f0c..18682f3bd8ef750a24102e837670ee20adc3b77f 100644 (file)
--- a/bin/tests/system/isctest/kasp.py
+++ b/bin/tests/system/isctest/kasp.py
@@ -84,24 +84,24 @@ def Iret(config, zsk=True, ksk=False, rollover=True, smooth=True):
             sign_delay = config["signatures-validity"] - config["signatures-refresh"]
         safety_interval = config["retire-safety"]
 
-    iretKSK = timedelta(0)
+    iret_ksk = timedelta(0)
     if ksk:
         # KSK: Double-KSK Method: Iret = DprpP + TTLds
-        iretKSK = (
+        iret_ksk = (
             config["parent-propagation-delay"] + config["ds-ttl"] + safety_interval
         )
 
-    iretZSK = timedelta(0)
+    iret_zsk = timedelta(0)
     if zsk:
         # ZSK: Pre-Publication Method: Iret = Dsgn + Dprp + TTLsig
-        iretZSK = (
+        iret_zsk = (
             sign_delay
             + config["zone-propagation-delay"]
             + config["max-zone-ttl"]
             + safety_interval
         )
 
-    return max(iretKSK, iretZSK)
+    return max(iret_ksk, iret_zsk)
 
 
 @total_ordering

diff --git a/bin/tests/system/rndc/tests_cve-2023-3341.py b/bin/tests/system/rndc/tests_cve_2023_3341.py
similarity index 100%
rename from bin/tests/system/rndc/tests_cve-2023-3341.py
rename to bin/tests/system/rndc/tests_cve_2023_3341.py

diff --git a/bin/tests/system/statschannel/generic.py b/bin/tests/system/statschannel/generic.py
index e77f3fc37fa938b0b27fd1ce6bf44120ee2e1021..09a374e120798c66ce448fd67a6ec41bfb4537c5 100644 (file)
--- a/bin/tests/system/statschannel/generic.py
+++ b/bin/tests/system/statschannel/generic.py
@@ -21,7 +21,7 @@ import dns.rcode
 import isctest
 
 # ISO datetime format without msec
-fmt = "%Y-%m-%dT%H:%M:%SZ"
+FMT = "%Y-%m-%dT%H:%M:%SZ"
 
 # The constants were taken from BIND 9 source code (lib/dns/zone.c)
 max_refresh = timedelta(seconds=2419200)  # 4 weeks
@@ -29,7 +29,7 @@ max_expires = timedelta(seconds=14515200)  # 24 weeks
 dayzero = datetime.utcfromtimestamp(0).replace(microsecond=0)
 
 # Wait for the secondary zone files to appear to extract their mtime
-max_secondary_zone_waittime_sec = 5
+MAX_SECONDARY_ZONE_WAITTIME_SEC = 5
 
 
 # Generic helper functions
@@ -45,7 +45,7 @@ def check_refresh(refresh, min_time, max_time):
 
 def check_loaded(loaded, expected, now):
     # Sanity check the zone timers values
-    assert (loaded - expected).total_seconds() < max_secondary_zone_waittime_sec
+    assert (loaded - expected).total_seconds() < MAX_SECONDARY_ZONE_WAITTIME_SEC
     assert loaded <= now
 
 
@@ -97,7 +97,7 @@ def test_zone_timers_secondary(fetch_zones, load_timers, **kwargs):
     zonedir = kwargs["zonedir"]
 
     # If any one of the zone files isn't ready, then retry until timeout.
-    tries = max_secondary_zone_waittime_sec
+    tries = MAX_SECONDARY_ZONE_WAITTIME_SEC
     while tries >= 0:
         zones = fetch_zones(statsip, statsport)
         again = False

diff --git a/bin/tests/system/statschannel/tests_json.py b/bin/tests/system/statschannel/tests_json.py
index 72a6e41e1b0e637ca073171cee0ad1ea1b55a69b..30348f4e69f569ae91d6b92815316a8d6c47be7b 100755 (executable)
--- a/bin/tests/system/statschannel/tests_json.py
+++ b/bin/tests/system/statschannel/tests_json.py
@@ -67,7 +67,7 @@ def load_timers_json(zone, primary=True):
 
     # Check if the primary zone timer exists
     assert "loaded" in zone
-    loaded = datetime.strptime(zone["loaded"], generic.fmt)
+    loaded = datetime.strptime(zone["loaded"], generic.FMT)
 
     if primary:
         # Check if the secondary zone timers does not exist
@@ -78,8 +78,8 @@ def load_timers_json(zone, primary=True):
     else:
         assert "expires" in zone
         assert "refresh" in zone
-        expires = datetime.strptime(zone["expires"], generic.fmt)
-        refresh = datetime.strptime(zone["refresh"], generic.fmt)
+        expires = datetime.strptime(zone["expires"], generic.FMT)
+        refresh = datetime.strptime(zone["refresh"], generic.FMT)
 
     return (name, loaded, expires, refresh)
 

diff --git a/bin/tests/system/statschannel/tests_xml.py b/bin/tests/system/statschannel/tests_xml.py
index e0c8dd3425d525952a0e9cedabfd3ac62ad5dee1..1ceb46f9b4b68490c46311e801f644f93632e511 100755 (executable)
--- a/bin/tests/system/statschannel/tests_xml.py
+++ b/bin/tests/system/statschannel/tests_xml.py
@@ -95,7 +95,7 @@ def load_timers_xml(zone, primary=True):
 
     loaded_el = zone.find("loaded")
     assert loaded_el is not None
-    loaded = datetime.strptime(loaded_el.text, generic.fmt)
+    loaded = datetime.strptime(loaded_el.text, generic.FMT)
 
     expires_el = zone.find("expires")
     refresh_el = zone.find("refresh")
@@ -107,8 +107,8 @@ def load_timers_xml(zone, primary=True):
     else:
         assert expires_el is not None
         assert refresh_el is not None
-        expires = datetime.strptime(expires_el.text, generic.fmt)
-        refresh = datetime.strptime(refresh_el.text, generic.fmt)
+        expires = datetime.strptime(expires_el.text, generic.FMT)
+        refresh = datetime.strptime(refresh_el.text, generic.FMT)
 
     return (name, loaded, expires, refresh)
 

diff --git a/bin/tests/system/xferquota/setup.py b/bin/tests/system/xferquota/setup.py
index ec457bf171f3c88a424427752dc5200cac7312b3..bd8f96bc0ca28b33eb87455eb6ffd61d06083df3 100644 (file)
--- a/bin/tests/system/xferquota/setup.py
+++ b/bin/tests/system/xferquota/setup.py
@@ -15,9 +15,9 @@
 # Set up test data for zone transfer quota tests.
 #
 
-zones = 300
+ZONES = 300
 
-for z in range(zones):
+for z in range(ZONES):
     zn = f"zone{z:06d}.example"
     with open(f"ns1/{zn}.db", "w", encoding="utf-8") as f:
         f.write("""$TTL 300
@@ -35,7 +35,7 @@ xyzzy   A       10.0.0.2
 with open("ns1/zones.conf", "w", encoding="utf-8") as priconf, open(
     "ns2/zones.conf", "w", encoding="utf-8"
 ) as secconf:
-    for z in range(zones):
+    for z in range(ZONES):
         zn = f"zone{z:06d}.example"
         priconf.write(f'zone "{zn}" {{ type primary; file "{zn}.db"; }};\n')
         secconf.write(

diff --git a/pyproject.toml b/pyproject.toml
index 99ce2021e4bac7b71f3e772eeb7ee1c0ce2acc5e..9b6d430ec913e4498d77bb2f5088d5f86f020943 100644 (file)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -9,13 +9,18 @@
 # See the COPYRIGHT file distributed with this work for additional
 # information regarding copyright ownership.
 
+[tool.pylint.basic]
+good-names-rgxs = [
+  # Allow names from KASP tests
+  "I(pub|ret)C?",
+  "T(act|pub|ret|rem|sbm)N1?",
+]
 [tool.pylint.imports]
 deprecated-modules = [
   "dns.resolver",
 ]
 [tool.pylint.messages_control]
 disable = [
-  "C0103", # invalid-name
   "C0114", # missing-module-docstring
   "C0115", # missing-class-docstring
   "C0116", # missing-function-docstring