From 79c65cf248ca4a21ae3df4d13a09c43a9a7fa04e Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <progval+git@progval.net>
Date: Sat, 11 Dec 2021 13:02:47 +0100
Subject: [PATCH] Generalize ANYSTR to ListRemainder

So it can match specific strings and have a minimum length.
This can be used to match ISUPPORT-like messages.
---
 irctest/patma.py            | 23 ++++++++++----
 irctest/self_tests/cases.py | 63 ++++++++++++++++++++++++++++++++++++-
 2 files changed, 79 insertions(+), 7 deletions(-)

diff --git a/irctest/patma.py b/irctest/patma.py
index 1717417..5fc99df 100644
--- a/irctest/patma.py
+++ b/irctest/patma.py
@@ -70,12 +70,19 @@ ANYDICT = {RemainingKeys(ANYSTR): AnyOptStr()}
 `match_dict(got_tags, {"label": "foo", **ANYDICT})`"""
 
 
-class _AnyListRemainder:
+@dataclasses.dataclass(frozen=True)
+class ListRemainder:
+    item: Operator
+    min_length: int = 0
+
     def __repr__(self) -> str:
-        return "*ANYLIST"
+        if self.min_length:
+            return f"*ListRemainder({self.item!r}, min_length={self.min_length})"
+        else:
+            return f"*ListRemainder({self.item!r})"
 
 
-ANYLIST = [_AnyListRemainder()]
+ANYLIST = [ListRemainder(ANYSTR)]
 """Matches any list remainder"""
 
 
@@ -109,9 +116,13 @@ def match_list(
     The ANYSTR operator can be used on the 'expected' side as a wildcard,
     matching any *single* value; and StrRe("<regexp>") can be used to match regular
     expressions"""
-    if expected[-1] is ANYLIST[0]:
-        expected = expected[0:-1]
-        got = got[0 : len(expected)]  # Ignore remaining
+    if expected and isinstance(expected[-1], ListRemainder):
+        # Expand the 'expected' list to have as many items as the 'got' list
+        expected = list(expected)  # copy
+        remainder = expected.pop()
+        nb_remaining_items = len(got) - len(expected)
+        expected += [remainder.item] * max(nb_remaining_items, remainder.min_length)
+
     if len(got) != len(expected):
         return False
     return all(
diff --git a/irctest/self_tests/cases.py b/irctest/self_tests/cases.py
index 2681987..9279bdb 100644
--- a/irctest/self_tests/cases.py
+++ b/irctest/self_tests/cases.py
@@ -4,7 +4,16 @@ import pytest
 
 from irctest import cases
 from irctest.irc_utils.message_parser import parse_message
-from irctest.patma import ANYDICT, ANYSTR, AnyOptStr, NotStrRe, RemainingKeys, StrRe
+from irctest.patma import (
+    ANYDICT,
+    ANYLIST,
+    ANYSTR,
+    AnyOptStr,
+    ListRemainder,
+    NotStrRe,
+    RemainingKeys,
+    StrRe,
+)
 
 # fmt: off
 MESSAGE_SPECS: List[Tuple[Dict, List[str], List[str]]] = [
@@ -152,6 +161,58 @@ MESSAGE_SPECS: List[Tuple[Dict, List[str], List[str]]] = [
             "@tag1=bar;tag2=baz PRIVMSG #chan :hello",
         ]
     ),
+    (
+        # the specification:
+        dict(
+            command="005",
+            params=["nick", "FOO=1", *ANYLIST],
+        ),
+        # matches:
+        [
+            "005 nick FOO=1",
+            "005 nick FOO=1 BAR=2",
+        ],
+        # and does not match:
+        [
+            "005 nick",
+            "005 nick BAR=2",
+        ]
+    ),
+    (
+        # the specification:
+        dict(
+            command="005",
+            params=["nick", ListRemainder(ANYSTR, min_length=1)],
+        ),
+        # matches:
+        [
+            "005 nick FOO=1",
+            "005 nick FOO=1 BAR=2",
+            "005 nick BAR=2",
+        ],
+        # and does not match:
+        [
+            "005 nick",
+        ]
+    ),
+    (
+        # the specification:
+        dict(
+            command="005",
+            params=["nick", ListRemainder(StrRe("[A-Z]+=.*"), min_length=1)],
+        ),
+        # matches:
+        [
+            "005 nick FOO=1",
+            "005 nick FOO=1 BAR=2",
+            "005 nick BAR=2",
+        ],
+        # and does not match:
+        [
+            "005 nick",
+            "005 nick foo=1",
+        ]
+    ),
 ]
 # fmt: on