From 7a063a91b844b54a940be3f50ded62287d9a6f17 Mon Sep 17 00:00:00 2001
From: "Piotr F. Mieszkowski" <pfm@disroot.org>
Date: Tue, 9 Nov 2021 21:25:41 +0100
Subject: [PATCH] Polish E2E testing script and make it configurable

---
 Makefile                    |  6 ++++++
 gpg-mailgate.py             |  7 ++++++-
 test/e2e.ini                | 10 ++++++++++
 test/e2e_test.py            | 32 +++++++++++++++++++++-----------
 test/msgin/clear2clear.msg  |  5 +++++
 test/msgout/clear2clear.msg |  5 +++++
 6 files changed, 53 insertions(+), 12 deletions(-)
 create mode 100644 Makefile
 create mode 100644 test/e2e.ini
 create mode 100644 test/msgin/clear2clear.msg
 create mode 100644 test/msgout/clear2clear.msg

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..1a4bc8a
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,6 @@
+PYTHON = python2.7
+
+.PHONY: test
+
+test:
+	$(PYTHON) test/e2e_test.py
diff --git a/gpg-mailgate.py b/gpg-mailgate.py
index 9830262..b39c786 100755
--- a/gpg-mailgate.py
+++ b/gpg-mailgate.py
@@ -39,9 +39,14 @@ import traceback
 from M2Crypto import BIO, Rand, SMIME, X509
 from email.mime.message import MIMEMessage
 
+# Environment variable name we read to retrieve configuration path.  This is to
+# enable non-root users to set up and run GPG Mailgate and to make the software
+# testable.
+CONFIG_PATH_ENV = "GPG_MAILGATE_CONFIG"
+
 # Read configuration from /etc/gpg-mailgate.conf
 _cfg = RawConfigParser()
-_cfg.read('/etc/gpg-mailgate.conf')
+_cfg.read(os.getenv(CONFIG_PATH_ENV, '/etc/gpg-mailgate.conf'))
 cfg = dict()
 for sect in _cfg.sections():
 	cfg[sect] = dict()
diff --git a/test/e2e.ini b/test/e2e.ini
new file mode 100644
index 0000000..6f3574d
--- /dev/null
+++ b/test/e2e.ini
@@ -0,0 +1,10 @@
+[relay]
+port = 2500
+
+[tests]
+cases = 1
+
+[case-1]
+from = alice@localhost
+in = test/msgin/clear2clear.msg
+out = test/msgout/clear2clear.msg
diff --git a/test/e2e_test.py b/test/e2e_test.py
index e37f7ff..40964ad 100644
--- a/test/e2e_test.py
+++ b/test/e2e_test.py
@@ -8,8 +8,6 @@ import difflib
 import ConfigParser
 import logging
 
-TEST_PORT = 2500
-
 EOL = "\n"
 
 RELAY_SCRIPT = "test/relay.py"
@@ -66,17 +64,17 @@ def compare(result, expected):
                                 fromfile='expected',
                                 tofile='output')
 
-def report_result(message_file, test_output):
-    expected = load_file(message_file)
+def report_result(message_file, expected_file, test_output):
+    expected = load_file(expected_file)
     diff = compare(test_output, expected)
     if len(list(diff)) > 0:
-        print "Output and the expected message don't match:"
+        print "Output and the expected message (%s) don't match:" % (expected_file)
     else:
         print "Message %s processed properly" % (message_file)
     for diff_line in diff:
         print diff_line
 
-def execute_e2e_test(message_file, **kwargs):
+def execute_e2e_test(message_file, expected_file, **kwargs):
     test_command = "%s gpg-mailgate.py %s < %s" % (PYTHON_BIN, kwargs["from_addr"], message_file)
     result_command = "%s %s %d" % (PYTHON_BIN, RELAY_SCRIPT, kwargs["port"])
 
@@ -93,18 +91,30 @@ def execute_e2e_test(message_file, **kwargs):
 
     logging.debug("Read %d characters of test output: '%s'" % (len(testout), testout))
 
-    report_result(message_file, testout)
+    report_result(message_file, expected_file, testout)
 
+def load_config():
+    cp = ConfigParser.ConfigParser()
+    cp.read("test/e2e.ini")
+
+    return cp
+
+
+config = load_config()
 
 logging.basicConfig(filename	= "e2e_test.log",
+                    format		= "%(pathname)s:%(lineno)d %(levelname)s [%(funcName)s] %(message)s",
                     datefmt		= "%Y-%m-%d %H:%M:%S",
                     level		= logging.DEBUG)
 
 write_test_config(os.getcwd() + "/" + CONFIG_FILE,
-                  port				= TEST_PORT,
+                  port				= config.getint("relay", "port"),
                   gpg_keyhome		= "test/keyhome",
                   smime_certpath	= "test/certs")
 
-execute_e2e_test("test.msg",
-                 from_addr	= "alice@localhost",
-                 port			= TEST_PORT)
+for case_no in range(1, config.getint("tests", "cases")+1):
+    case_name = "case-%d" % (case_no)
+
+    execute_e2e_test(config.get(case_name, "in"), config.get(case_name, "out"),
+                    from_addr	= config.get(case_name, "from"),
+                    port		= config.getint("relay", "port"))
diff --git a/test/msgin/clear2clear.msg b/test/msgin/clear2clear.msg
new file mode 100644
index 0000000..5fe7ff7
--- /dev/null
+++ b/test/msgin/clear2clear.msg
@@ -0,0 +1,5 @@
+From: Bob <bob@localhost>
+To: Alice <alice@localhost>
+Subject: Test
+
+Body of the message.
diff --git a/test/msgout/clear2clear.msg b/test/msgout/clear2clear.msg
new file mode 100644
index 0000000..5fe7ff7
--- /dev/null
+++ b/test/msgout/clear2clear.msg
@@ -0,0 +1,5 @@
+From: Bob <bob@localhost>
+To: Alice <alice@localhost>
+Subject: Test
+
+Body of the message.