From ee8f60d6c2de43067d26bd6334165958ad26cdbe Mon Sep 17 00:00:00 2001
From: Val Lorentz <progval+git@progval.net>
Date: Wed, 9 Mar 2022 20:01:34 +0100
Subject: [PATCH] Add test for ISUPPORT PREFIX. (#128)

---
 irctest/server_tests/isupport.py | 58 ++++++++++++++++++++++++++++++++
 irctest/specifications.py        |  1 +
 pytest.ini                       |  1 +
 3 files changed, 60 insertions(+)

diff --git a/irctest/server_tests/isupport.py b/irctest/server_tests/isupport.py
index 4a68a1a..40f087d 100644
--- a/irctest/server_tests/isupport.py
+++ b/irctest/server_tests/isupport.py
@@ -4,6 +4,64 @@ from irctest import cases, runner
 
 
 class IsupportTestCase(cases.BaseServerTestCase):
+    @cases.mark_specifications("Modern")
+    @cases.mark_isupport("PREFIX")
+    def testPrefix(self):
+        """https://modern.ircdocs.horse/#prefix-parameter"""
+        self.connectClient("foo")
+
+        if "PREFIX" not in self.server_support:
+            raise runner.NotImplementedByController("PREFIX")
+
+        if self.server_support["PREFIX"] == "":
+            # "The value is OPTIONAL and when it is not specified indicates that no
+            # prefixes are supported."
+            return
+
+        m = re.match(
+            r"\((?P<modes>[a-zA-Z]+)\)(?P<prefixes>\S+)", self.server_support["PREFIX"]
+        )
+        self.assertTrue(
+            m,
+            f"PREFIX={self.server_support['PREFIX']} does not have the expected "
+            f"format.",
+        )
+
+        modes = m.group("modes")
+        prefixes = m.group("prefixes")
+
+        # "There is a one-to-one mapping between prefixes and channel modes."
+        self.assertEqual(
+            len(modes), len(prefixes), "Mismatched length of prefix and channel modes."
+        )
+
+        # "The prefixes in this parameter are in descending order, from the prefix
+        # that gives the most privileges to the prefix that gives the least."
+        self.assertLess(modes.index("o"), modes.index("v"), "'o' is not before 'v'")
+        if "h" in modes:
+            self.assertLess(modes.index("o"), modes.index("h"), "'o' is not before 'h'")
+            self.assertLess(modes.index("h"), modes.index("v"), "'h' is not before 'v'")
+        if "q" in modes:
+            self.assertLess(modes.index("q"), modes.index("o"), "'q' is not before 'o'")
+
+        # Not technically in the spec, but it would be very confusing not to follow
+        # these conventions.
+        mode_to_prefix = dict(zip(modes, prefixes))
+        self.assertEqual(mode_to_prefix["o"], "@", "Prefix char for mode +o is not @")
+        self.assertEqual(mode_to_prefix["v"], "+", "Prefix char for mode +v is not +")
+        if "h" in modes:
+            self.assertEqual(
+                mode_to_prefix["h"], "%", "Prefix char for mode +h is not %"
+            )
+        if "q" in modes:
+            self.assertEqual(
+                mode_to_prefix["q"], "~", "Prefix char for mode +q is not ~"
+            )
+        if "a" in modes:
+            self.assertEqual(
+                mode_to_prefix["a"], "&", "Prefix char for mode +a is not &"
+            )
+
     @cases.mark_specifications("Modern", "ircdocs")
     @cases.mark_isupport("TARGMAX")
     def testTargmax(self):
diff --git a/irctest/specifications.py b/irctest/specifications.py
index 745895a..8a629c7 100644
--- a/irctest/specifications.py
+++ b/irctest/specifications.py
@@ -50,6 +50,7 @@ class Capabilities(enum.Enum):
 @enum.unique
 class IsupportTokens(enum.Enum):
     BOT = "BOT"
+    PREFIX = "PREFIX"
     MONITOR = "MONITOR"
     STATUSMSG = "STATUSMSG"
     TARGMAX = "TARGMAX"
diff --git a/pytest.ini b/pytest.ini
index 6774b93..19518e3 100644
--- a/pytest.ini
+++ b/pytest.ini
@@ -33,6 +33,7 @@ markers =
     # isupport tokens
     BOT
     MONITOR
+    PREFIX
     STATUSMSG
     TARGMAX
     WHOX