From 4652da6caf2dec8405cdec46f2528e09490437fc Mon Sep 17 00:00:00 2001
From: Tom Krizek <tkrizek@isc.org>
Date: Fri, 14 Oct 2022 11:12:53 +0200
Subject: [PATCH 1/3] Use common name convention for pytest files

It is better to use consistent file names to avoid issue with sorting
etc.

Using underscore in filenames as opposed to dash was chosen because it
seems more common in pytest/python to use underscore for filenames.

Also rename the bin/tests/system/timeouts/tests-tcp.py file to
bin/tests/system/timeouts/tests_tcp_timeouts.py to avoid pytest name
collision (there can't be two files named tests_tcp.py).

(cherry picked from commit f6409ee6ac5913c6f90545a44c4346945d911162)
---
 bin/tests/system/checkds/{tests-checkds.py => tests_checkds.py}   | 0
 .../system/dispatch/{tests-connreset.py => tests_connreset.py}    | 0
 ...ests-rpz-passthru-logging.py => tests_rpz_passthru_logging.py} | 0
 .../system/shutdown/{tests-shutdown.py => tests_shutdown.py}      | 0
 bin/tests/system/statschannel/{tests-json.py => tests_json.py}    | 0
 bin/tests/system/statschannel/{tests-xml.py => tests_xml.py}      | 0
 bin/tests/system/tcp/{tests-tcp.py => tests_tcp.py}               | 0
 bin/tests/system/timeouts/{tests-tcp.py => tests_tcp_timeouts.py} | 0
 .../system/wildcard/{tests-wildcard.py => tests_wildcard.py}      | 0
 9 files changed, 0 insertions(+), 0 deletions(-)
 rename bin/tests/system/checkds/{tests-checkds.py => tests_checkds.py} (100%)
 rename bin/tests/system/dispatch/{tests-connreset.py => tests_connreset.py} (100%)
 rename bin/tests/system/rpzextra/{tests-rpz-passthru-logging.py => tests_rpz_passthru_logging.py} (100%)
 rename bin/tests/system/shutdown/{tests-shutdown.py => tests_shutdown.py} (100%)
 rename bin/tests/system/statschannel/{tests-json.py => tests_json.py} (100%)
 rename bin/tests/system/statschannel/{tests-xml.py => tests_xml.py} (100%)
 rename bin/tests/system/tcp/{tests-tcp.py => tests_tcp.py} (100%)
 rename bin/tests/system/timeouts/{tests-tcp.py => tests_tcp_timeouts.py} (100%)
 rename bin/tests/system/wildcard/{tests-wildcard.py => tests_wildcard.py} (100%)

diff --git a/bin/tests/system/checkds/tests-checkds.py b/bin/tests/system/checkds/tests_checkds.py
similarity index 100%
rename from bin/tests/system/checkds/tests-checkds.py
rename to bin/tests/system/checkds/tests_checkds.py
diff --git a/bin/tests/system/dispatch/tests-connreset.py b/bin/tests/system/dispatch/tests_connreset.py
similarity index 100%
rename from bin/tests/system/dispatch/tests-connreset.py
rename to bin/tests/system/dispatch/tests_connreset.py
diff --git a/bin/tests/system/rpzextra/tests-rpz-passthru-logging.py b/bin/tests/system/rpzextra/tests_rpz_passthru_logging.py
similarity index 100%
rename from bin/tests/system/rpzextra/tests-rpz-passthru-logging.py
rename to bin/tests/system/rpzextra/tests_rpz_passthru_logging.py
diff --git a/bin/tests/system/shutdown/tests-shutdown.py b/bin/tests/system/shutdown/tests_shutdown.py
similarity index 100%
rename from bin/tests/system/shutdown/tests-shutdown.py
rename to bin/tests/system/shutdown/tests_shutdown.py
diff --git a/bin/tests/system/statschannel/tests-json.py b/bin/tests/system/statschannel/tests_json.py
similarity index 100%
rename from bin/tests/system/statschannel/tests-json.py
rename to bin/tests/system/statschannel/tests_json.py
diff --git a/bin/tests/system/statschannel/tests-xml.py b/bin/tests/system/statschannel/tests_xml.py
similarity index 100%
rename from bin/tests/system/statschannel/tests-xml.py
rename to bin/tests/system/statschannel/tests_xml.py
diff --git a/bin/tests/system/tcp/tests-tcp.py b/bin/tests/system/tcp/tests_tcp.py
similarity index 100%
rename from bin/tests/system/tcp/tests-tcp.py
rename to bin/tests/system/tcp/tests_tcp.py
diff --git a/bin/tests/system/timeouts/tests-tcp.py b/bin/tests/system/timeouts/tests_tcp_timeouts.py
similarity index 100%
rename from bin/tests/system/timeouts/tests-tcp.py
rename to bin/tests/system/timeouts/tests_tcp_timeouts.py
diff --git a/bin/tests/system/wildcard/tests-wildcard.py b/bin/tests/system/wildcard/tests_wildcard.py
similarity index 100%
rename from bin/tests/system/wildcard/tests-wildcard.py
rename to bin/tests/system/wildcard/tests_wildcard.py

From 873feb0c531472baac294387879fbd5ac7af07b8 Mon Sep 17 00:00:00 2001
From: Tom Krizek <tkrizek@isc.org>
Date: Fri, 2 Dec 2022 16:51:36 +0100
Subject: [PATCH 2/3] Rename engine_pkcs11 system test

In order to have a common naming convention for system tests, rename the
only outlier "engine_pkcs11" to "enginepkcs11", which was the only
system test using an underscore in its name.

The only allowed word separators for system test names are either dash
or no separator.

(cherry picked from commit 62eea511dbd162bbef95f85f874038ec4bcb3814)
---
 bin/tests/system/Makefile.am                                | 2 +-
 bin/tests/system/conf.sh.in                                 | 2 +-
 bin/tests/system/engine_pkcs11/ns1/named.args               | 1 -
 .../2037-pk11_numbits-crash-test.pkt                        | 0
 bin/tests/system/{engine_pkcs11 => enginepkcs11}/clean.sh   | 2 +-
 bin/tests/system/enginepkcs11/ns1/named.args                | 1 +
 .../{engine_pkcs11 => enginepkcs11}/ns1/named.conf.in       | 0
 .../{engine_pkcs11 => enginepkcs11}/ns1/template.db.in      | 0
 bin/tests/system/{engine_pkcs11 => enginepkcs11}/prereq.sh  | 0
 bin/tests/system/{engine_pkcs11 => enginepkcs11}/setup.sh   | 6 +++---
 bin/tests/system/{engine_pkcs11 => enginepkcs11}/tests.sh   | 0
 11 files changed, 7 insertions(+), 7 deletions(-)
 delete mode 100644 bin/tests/system/engine_pkcs11/ns1/named.args
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/2037-pk11_numbits-crash-test.pkt (100%)
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/clean.sh (86%)
 create mode 100644 bin/tests/system/enginepkcs11/ns1/named.args
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/ns1/named.conf.in (100%)
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/ns1/template.db.in (100%)
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/prereq.sh (100%)
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/setup.sh (87%)
 rename bin/tests/system/{engine_pkcs11 => enginepkcs11}/tests.sh (100%)

diff --git a/bin/tests/system/Makefile.am b/bin/tests/system/Makefile.am
index b7c8551465..3daff8b316 100644
--- a/bin/tests/system/Makefile.am
+++ b/bin/tests/system/Makefile.am
@@ -116,7 +116,7 @@ TESTS +=			\
 	eddsa			\
 	ednscompliance		\
 	emptyzones		\
-	engine_pkcs11		\
+	enginepkcs11		\
 	filter-aaaa		\
 	formerr			\
 	geoip2			\
diff --git a/bin/tests/system/conf.sh.in b/bin/tests/system/conf.sh.in
index e1549b3701..0ef94436e3 100644
--- a/bin/tests/system/conf.sh.in
+++ b/bin/tests/system/conf.sh.in
@@ -108,7 +108,7 @@ cookie
 dlzexternal
 dnssec
 dyndb
-engine_pkcs11
+enginepkcs11
 filter-aaaa
 kasp
 keyfromlabel
diff --git a/bin/tests/system/engine_pkcs11/ns1/named.args b/bin/tests/system/engine_pkcs11/ns1/named.args
deleted file mode 100644
index 0382a63ccd..0000000000
--- a/bin/tests/system/engine_pkcs11/ns1/named.args
+++ /dev/null
@@ -1 +0,0 @@
--E pkcs11 -D engine_pkcs11-ns1 -X named.lock -m record -c named.conf -d 99 -U 4 -T maxcachesize=2097152
diff --git a/bin/tests/system/engine_pkcs11/2037-pk11_numbits-crash-test.pkt b/bin/tests/system/enginepkcs11/2037-pk11_numbits-crash-test.pkt
similarity index 100%
rename from bin/tests/system/engine_pkcs11/2037-pk11_numbits-crash-test.pkt
rename to bin/tests/system/enginepkcs11/2037-pk11_numbits-crash-test.pkt
diff --git a/bin/tests/system/engine_pkcs11/clean.sh b/bin/tests/system/enginepkcs11/clean.sh
similarity index 86%
rename from bin/tests/system/engine_pkcs11/clean.sh
rename to bin/tests/system/enginepkcs11/clean.sh
index 6190bd2ebb..789666e7c9 100644
--- a/bin/tests/system/engine_pkcs11/clean.sh
+++ b/bin/tests/system/enginepkcs11/clean.sh
@@ -32,4 +32,4 @@ rm -f ns1/update.log.*
 rm -f ns1/verify.out.*
 rm -f ns1/zone.*.signed.jnl ns1/zone.*.signed.jbk
 
-softhsm2-util --delete-token --token "softhsm2-engine_pkcs11" >/dev/null 2>&1 || echo_i "softhsm2-engine_pkcs11 token not found for cleaning"
+softhsm2-util --delete-token --token "softhsm2-enginepkcs11" >/dev/null 2>&1 || echo_i "softhsm2-enginepkcs11 token not found for cleaning"
diff --git a/bin/tests/system/enginepkcs11/ns1/named.args b/bin/tests/system/enginepkcs11/ns1/named.args
new file mode 100644
index 0000000000..0568fa981c
--- /dev/null
+++ b/bin/tests/system/enginepkcs11/ns1/named.args
@@ -0,0 +1 @@
+-E pkcs11 -D enginepkcs11-ns1 -X named.lock -m record -c named.conf -d 99 -U 4 -T maxcachesize=2097152
diff --git a/bin/tests/system/engine_pkcs11/ns1/named.conf.in b/bin/tests/system/enginepkcs11/ns1/named.conf.in
similarity index 100%
rename from bin/tests/system/engine_pkcs11/ns1/named.conf.in
rename to bin/tests/system/enginepkcs11/ns1/named.conf.in
diff --git a/bin/tests/system/engine_pkcs11/ns1/template.db.in b/bin/tests/system/enginepkcs11/ns1/template.db.in
similarity index 100%
rename from bin/tests/system/engine_pkcs11/ns1/template.db.in
rename to bin/tests/system/enginepkcs11/ns1/template.db.in
diff --git a/bin/tests/system/engine_pkcs11/prereq.sh b/bin/tests/system/enginepkcs11/prereq.sh
similarity index 100%
rename from bin/tests/system/engine_pkcs11/prereq.sh
rename to bin/tests/system/enginepkcs11/prereq.sh
diff --git a/bin/tests/system/engine_pkcs11/setup.sh b/bin/tests/system/enginepkcs11/setup.sh
similarity index 87%
rename from bin/tests/system/engine_pkcs11/setup.sh
rename to bin/tests/system/enginepkcs11/setup.sh
index 5c764746c2..49988ad66c 100644
--- a/bin/tests/system/engine_pkcs11/setup.sh
+++ b/bin/tests/system/enginepkcs11/setup.sh
@@ -16,7 +16,7 @@
 
 set -e
 
-softhsm2-util --init-token --free --pin 1234 --so-pin 1234 --label "softhsm2-engine_pkcs11" | awk '/^The token has been initialized and is reassigned to slot/ { print $NF }'
+softhsm2-util --init-token --free --pin 1234 --so-pin 1234 --label "softhsm2-enginepkcs11" | awk '/^The token has been initialized and is reassigned to slot/ { print $NF }'
 
 printf '%s' "${HSMPIN:-1234}" > pin
 PWD=$(pwd)
@@ -31,7 +31,7 @@ keygen() {
 
 	label="${id}-${zone}"
 	p11id=$(echo "${label}" | openssl sha1 -r | awk '{print $1}')
-	pkcs11-tool --module $SOFTHSM2_MODULE --token-label "softhsm2-engine_pkcs11" -l -k --key-type $type:$bits --label "${label}" --id "${p11id}" --pin $(cat $PWD/pin) > pkcs11-tool.out.$zone.$id 2> pkcs11-tool.err.$zone.$id || return 1
+	pkcs11-tool --module $SOFTHSM2_MODULE --token-label "softhsm2-enginepkcs11" -l -k --key-type $type:$bits --label "${label}" --id "${p11id}" --pin $(cat $PWD/pin) > pkcs11-tool.out.$zone.$id 2> pkcs11-tool.err.$zone.$id || return 1
 }
 
 keyfromlabel() {
@@ -41,7 +41,7 @@ keyfromlabel() {
 	dir="$4"
         shift 4
 
-	$KEYFRLAB -K $dir -E pkcs11 -a $alg -l "token=softhsm2-engine_pkcs11;object=${id}-${zone};pin-source=$PWD/pin" "$@" $zone >> keyfromlabel.out.$zone.$id 2> keyfromlabel.err.$zone.$id || return 1
+	$KEYFRLAB -K $dir -E pkcs11 -a $alg -l "token=softhsm2-enginepkcs11;object=${id}-${zone};pin-source=$PWD/pin" "$@" $zone >> keyfromlabel.out.$zone.$id 2> keyfromlabel.err.$zone.$id || return 1
 	cat keyfromlabel.out.$zone.$id
 }
 
diff --git a/bin/tests/system/engine_pkcs11/tests.sh b/bin/tests/system/enginepkcs11/tests.sh
similarity index 100%
rename from bin/tests/system/engine_pkcs11/tests.sh
rename to bin/tests/system/enginepkcs11/tests.sh

From 3c29317ad3a9a9c78abbecd8800977974b4042f9 Mon Sep 17 00:00:00 2001
From: Tom Krizek <tkrizek@isc.org>
Date: Wed, 21 Dec 2022 12:52:08 +0100
Subject: [PATCH 3/3] Update tests gitignore file

The .mypy_cache was added to the system test dir gitignore, since it
should be ignored.

(cherry picked from commit 4145068bfab68c60e71b2a174292a6282bf97a86)
---
 bin/tests/system/.gitignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/bin/tests/system/.gitignore b/bin/tests/system/.gitignore
index 3cde7cdb6b..70e4df15e2 100644
--- a/bin/tests/system/.gitignore
+++ b/bin/tests/system/.gitignore
@@ -1,5 +1,6 @@
 .cache
 .hypothesis
+.mypy_cache
 __pycache__
 dig.out*
 rndc.out*