Add tests for IRCv3 draft/metadata-2 (#228)

* Copy metadata.py to metadata2.py

* Adapt metadata_2 to stdreplies, and run it on Unreal

Passes on progval/unrealircd-contrib@3968354

* expect batches

* Improve testing for invalid UTF8, and add test for too-long values

* Test for nick instead of * as target

* Fix fail code

* Add untested 'before-connect' test

* Add a bunch of GetSet tests

* Add tests for KEY_NO_PERMISSION

* Use real metadata keys

* Add tests for SUB

* enable metadata in ergo

* rename deprecated test case

* fix race condition

* Fix failure on servers that don't implement draft/metadata-2

* accommodate UTF8ONLY spec

* fix race condition

* fix race condition

* consolidate redundant test code

* fix race condition

* Download Unreal's third/metadata2 module

* Don't install third/metadata2.c on Unreal 5

* Update third/metadata2.c so it builds on all Unreal versions

* Only load third/metadata2 on Unreal 6 (it doesn't support Unreal 5)

* confirm that friends do not receive updates for invalid values

---------

Co-authored-by: Shivaram Lingamneni <[email protected]>

Author: progval

.github/workflows/test-devel.yml

@@ -358,6 +358,7 @@ jobs:
       run: |
         cd $GITHUB_WORKSPACE/unrealircd/
         cp $GITHUB_WORKSPACE/data/unreal/* .
+        wget https://raw.githubusercontent.com/progval/unrealircd-contrib/50e839c2e2f1d8b9924126f34bc2f50965c0a557/files/metadata2.c -O src/modules/third/metadata2.c
         # Need to use a specific -march, because GitHub has inconsistent
         # architectures across workers, which result in random SIGILL with some
         # worker combinations

.github/workflows/test-stable.yml

@@ -399,6 +399,7 @@ jobs:
       run: |
         cd $GITHUB_WORKSPACE/unrealircd/
         cp $GITHUB_WORKSPACE/data/unreal/* .
+        wget https://raw.githubusercontent.com/progval/unrealircd-contrib/50e839c2e2f1d8b9924126f34bc2f50965c0a557/files/metadata2.c -O src/modules/third/metadata2.c
         # Need to use a specific -march, because GitHub has inconsistent
         # architectures across workers, which result in random SIGILL with some
         # worker combinations

irctest/client_mock.py

@@ -74,7 +74,19 @@ def getMessages(
                     continue
                 if not synchronize:
                     got_pong = True
-                for line in data.decode().split("\r\n"):
+                try:
+                    decoded_data = data.decode()
+                except UnicodeDecodeError:
+                    print(
+                        "{time:.3f}{ssl} S -> {client} - failed to decode: {data!r}".format(
+                            time=time.time(),
+                            ssl=" (ssl)" if self.ssl else "",
+                            client=self.name,
+                            data=data,
+                        )
+                    )
+                    raise
+                for line in decoded_data.split("\r\n"):
                     if line:
                         if self.show_io:
                             print(

irctest/controllers/ergo.py

@@ -118,6 +118,11 @@
             "password": "$2a$04$bKb6k5A6yuFA2wx.iJtxcuT2dojHQAjHd5ZPK/I2sjJml7p4spxjG",
         }
     },
+    "metadata": {
+        "enabled": True,
+        "max-subs": 100,
+        "max-keys": 1000,
+    },
 }
 
 LOGGING_CONFIG = {"logging": [{"method": "stderr", "level": "debug", "type": "*"}]}

irctest/controllers/unrealircd.py

@@ -211,6 +211,7 @@ def run(
                 """
                 include "snomasks.default.conf";
                 loadmodule "cloak_md5";
+                loadmodule "third/metadata2";
                 """
             )
             set_v6only = SET_V6ONLY

irctest/numerics.py

@@ -186,6 +186,13 @@
 RPL_MONLIST = "732"
 RPL_ENDOFMONLIST = "733"
 ERR_MONLISTFULL = "734"
+RPL_WHOISKEYVALUE = "760"
+RPL_KEYVALUE = "761"
+RPL_KEYNOTSET = "766"
+RPL_METADATASUBOK = "770"
+RPL_METADATAUNSUBOK = "771"
+RPL_METADATASUBS = "772"
+RPL_METADATASYNCLATER = "774"
 RPL_LOGGEDIN = "900"
 RPL_LOGGEDOUT = "901"
 ERR_NICKLOCKED = "902"

irctest/server_tests/metadata.py

@@ -5,7 +5,7 @@
 from irctest import cases
 
 
-class MetadataTestCase(cases.BaseServerTestCase):
+class MetadataDeprecatedTestCase(cases.BaseServerTestCase):
     valid_metadata_keys = {"display-name", "avatar"}
     invalid_metadata_keys = {"indisplay-name", "inavatar"}