Add ircu2/snircd/irc2 controllers + fix tests to support them (#89)

.github/workflows/test-stable.yml

@@ -334,6 +334,7 @@ jobs:
     - test-inspircd
     - test-inspircd-anope
     - test-inspircd-atheme
+    - test-irc2
     - test-limnoria
     - test-plexus4
     - test-solanum
@@ -658,6 +659,60 @@ jobs:
       with:
         name: pytest results inspircd-atheme (stable)
         path: pytest.xml
+  test-irc2:
+    needs: []
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.7
+    - name: Get source code
+      run: curl http://ftp.irc.org/ftp/irc/server/irc2.11.2p3.tgz | tar -zx
+    - name: Configure
+      run: 'cd $GITHUB_WORKSPACE/irc2.11.2p3
+
+        ./configure --prefix=$HOME/.local/
+
+        cd x86*
+
+        echo "#define CMDLINE_CONFIG/" >> config.h
+
+        echo "#define DEFAULT_SPLIT_USERS 0" >> config.h
+
+        echo "#define DEFAULT_SPLIT_SERVERS 0" >> config.h
+
+        #echo "#undef LIST_ALIS_NOTE" >> config.h
+
+        # TODO: find a better way to make it not fork...
+
+        echo "#define fork() (0)" >> config.h'
+    - name: Compile and install
+      run: 'cd $GITHUB_WORKSPACE/irc2.11.2p3/x86*
+
+        make -j 4 all
+
+        make install
+
+        mkdir -p $HOME/.local/bin
+
+        cp $HOME/.local/sbin/ircd $HOME/.local/bin/ircd'
+    - name: Install Atheme
+      run: sudo apt-get install atheme-services
+    - name: Install irctest dependencies
+      run: |-
+        python -m pip install --upgrade pip
+        pip install pytest pytest-xdist -r requirements.txt
+    - name: Test with pytest
+      run: PYTEST_ARGS='--junit-xml pytest.xml' PATH=$HOME/.local/bin:$PATH  make
+        irc2
+    - if: always()
+      name: Publish results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pytest results irc2 (stable)
+        path: pytest.xml
   test-limnoria:
     needs: []
     runs-on: ubuntu-latest

Makefile

@@ -52,6 +52,39 @@ INSPIRCD_SELECTORS := \
 	and not testNamesInvalidChannel and not testNamesNonexistingChannel \
 	$(EXTRA_SELECTORS)
 
+# buffering tests fail because ircu2 discards the whole buffer on long lines (TODO: refine how we exclude these tests)
+# testQuit and testQuitErrors fail because ircu2 does not send ERROR or QUIT
+# lusers tests fail because they depend on Modern behavior, not just RFC2812 (TODO: update lusers tests to accept RFC2812-compliant implementations)
+# statusmsg tests fail because STATUSMSG is present in ISUPPORT, but it not actually supported as PRIVMSG target
+IRCU2_SELECTORS := \
+	not Ergo \
+	and not deprecated \
+	and not strict \
+	and not buffering \
+	and not testQuit \
+	and not lusers \
+	and not statusmsg \
+	$(EXTRA_SELECTORS)
+
+# same justification as ircu2
+SNIRCD_SELECTORS := \
+	not Ergo \
+	and not deprecated \
+	and not strict \
+	and not buffering \
+	and not testQuit \
+	and not lusers \
+	and not statusmsg \
+	$(EXTRA_SELECTORS)
+
+# testListEmpty and testListOne fails because irc2 deprecated LIST
+IRC2_SELECTORS := \
+	not Ergo \
+	and not deprecated \
+	and not strict \
+	and not testListEmpty and not testListOne \
+	$(EXTRA_SELECTORS)
+
 MAMMON_SELECTORS := \
 	not Ergo \
 	and not deprecated \
@@ -102,9 +135,9 @@ UNREALIRCD_SELECTORS := \
 	and not (testChathistory and (between or around)) \
 	$(EXTRA_SELECTORS)
 
-.PHONY: all flakes bahamut charybdis ergo inspircd mammon limnoria sopel solanum unrealircd
+.PHONY: all flakes bahamut charybdis ergo inspircd ircu2 snircd irc2 mammon limnoria sopel solanum unrealircd
 
-all: flakes bahamut charybdis ergo inspircd mammon limnoria sopel solanum unrealircd
+all: flakes bahamut charybdis ergo inspircd ircu2 snircd irc2 mammon limnoria sopel solanum unrealircd
 
 flakes:
 	find irctest/ -name "*.py" -not -path "irctest/scram/*" -print0 | xargs -0 pyflakes3
@@ -169,6 +202,27 @@ inspircd-anope:
 		-m 'services' \
 		-k '$(INSPIRCD_SELECTORS) $(ANOPE_SELECTORS)'
 
+ircu2:
+	$(PYTEST) $(PYTEST_ARGS) \
+		--controller=irctest.controllers.ircu2 \
+		-m 'not services and not IRCv3' \
+		-n 10 \
+		-k '$(IRCU2_SELECTORS)'
+
+snircd:
+	$(PYTEST) $(PYTEST_ARGS) \
+		--controller=irctest.controllers.snircd \
+		-m 'not services and not IRCv3' \
+		-n 10 \
+		-k '$(SNIRCD_SELECTORS)'
+
+irc2:
+	$(PYTEST) $(PYTEST_ARGS) \
+		--controller=irctest.controllers.irc2 \
+		-m 'not services and not IRCv3' \
+		-n 10 \
+		-k '$(IRC2_SELECTORS)'
+
 limnoria:
 	$(PYTEST) $(PYTEST_ARGS) \
 		--controller=irctest.controllers.limnoria \

irctest/basecontrollers.py

@@ -229,8 +229,16 @@ class BaseServerController(_BaseController):
                 # test_lusers.py (eg. this happens with Charybdis 3.5.0)
                 c.send(b"QUIT :chkport\r\n")
                 data = b""
-                while b"chkport" not in data and b"ERROR" not in data:
+                try:
-                    data += c.recv(1024)
+                    while b"chkport" not in data and b"ERROR" not in data:
+                        data += c.recv(4096)
+                        time.sleep(0.01)
+
+                        c.send(b" ")  # Triggers BrokenPipeError
+                except BrokenPipeError:
+                    # ircu2 cuts the connection without a message if registration
+                    # is not complete.
+                    pass
 
                 c.close()
                 self.port_open = True

irctest/controllers/irc2.py

@@ -0,0 +1,90 @@
+import os
+import subprocess
+from typing import Optional, Set, Type
+
+from irctest.basecontrollers import (
+    BaseServerController,
+    DirectoryBasedController,
+    NotImplementedByController,
+)
+
+TEMPLATE_CONFIG = """
+# M:<Server NAME>:<YOUR Internet IP#>:<Geographic Location>:<Port>:<SID>:
+M:My.Little.Server:{hostname}:Somewhere:{port}:0042:
+
+# A:<Your Name/Location>:<Your E-Mail Addr>:<other info>::<network name>:
+A:Organization, IRC dept.:Daemon <ircd@example.irc.org>:Client Server::IRCnet:
+
+# P:<YOUR Internet IP#>:<*>::<Port>:<Flags>
+P::::{port}::
+
+# Y:<Class>:<Ping Frequency>::<Max Links>:<SendQ>:<Local Limit>:<Global Limit>:
+Y:10:90::100:512000:100.100:100.100:
+
+# I:<TARGET Host Addr>:<Password>:<TARGET Hosts NAME>:<Port>:<Class>:<Flags>:
+I::{password_field}:::10::
+"""
+
+
+class Ircu2Controller(BaseServerController, DirectoryBasedController):
+    binary_name: str
+    services_protocol: str
+
+    supports_sts = False
+    extban_mute_char = None
+
+    def create_config(self) -> None:
+        super().create_config()
+        with self.open_file("server.conf"):
+            pass
+
+    def run(
+        self,
+        hostname: str,
+        port: int,
+        *,
+        password: Optional[str],
+        ssl: bool,
+        run_services: bool,
+        valid_metadata_keys: Optional[Set[str]] = None,
+        invalid_metadata_keys: Optional[Set[str]] = None,
+    ) -> None:
+        if valid_metadata_keys or invalid_metadata_keys:
+            raise NotImplementedByController(
+                "Defining valid and invalid METADATA keys."
+            )
+        if ssl:
+            raise NotImplementedByController("TLS")
+        if run_services:
+            raise NotImplementedByController("Services")
+        assert self.proc is None
+        self.port = port
+        self.hostname = hostname
+        self.create_config()
+        password_field = password if password else ""
+        assert self.directory
+        pidfile = os.path.join(self.directory, "ircd.pid")
+        with self.open_file("server.conf") as fd:
+            fd.write(
+                TEMPLATE_CONFIG.format(
+                    hostname=hostname,
+                    port=port,
+                    password_field=password_field,
+                    pidfile=pidfile,
+                )
+            )
+        self.proc = subprocess.Popen(
+            [
+                "ircd",
+                "-s",  # no iauth
+                "-p",
+                "on",
+                "-f",
+                os.path.join(self.directory, "server.conf"),
+            ],
+            # stderr=subprocess.DEVNULL,
+        )
+
+
+def get_irctest_controller_class() -> Type[Ircu2Controller]:
+    return Ircu2Controller

irctest/controllers/ircu2.py

@@ -0,0 +1,100 @@
+import os
+import subprocess
+from typing import Optional, Set, Type
+
+from irctest.basecontrollers import (
+    BaseServerController,
+    DirectoryBasedController,
+    NotImplementedByController,
+)
+
+TEMPLATE_CONFIG = """
+General {{
+    name = "My.Little.Server";
+    numeric = 42;
+    description = "test server";
+}};
+
+Port {{
+    vhost = "{hostname}";
+    port = {port};
+}};
+
+Class {{
+    name = "Client";
+    pingfreq = 5 minutes;
+    sendq = 160000;
+    maxlinks = 1024;
+}};
+
+Client {{
+    username = "*";
+    class = "Client";
+    {password_field}
+}};
+
+features {{
+    "PPATH" = "{pidfile}";
+}};
+"""
+
+
+class Ircu2Controller(BaseServerController, DirectoryBasedController):
+    supports_sts = False
+    extban_mute_char = None
+
+    def create_config(self) -> None:
+        super().create_config()
+        with self.open_file("server.conf"):
+            pass
+
+    def run(
+        self,
+        hostname: str,
+        port: int,
+        *,
+        password: Optional[str],
+        ssl: bool,
+        run_services: bool,
+        valid_metadata_keys: Optional[Set[str]] = None,
+        invalid_metadata_keys: Optional[Set[str]] = None,
+    ) -> None:
+        if valid_metadata_keys or invalid_metadata_keys:
+            raise NotImplementedByController(
+                "Defining valid and invalid METADATA keys."
+            )
+        if ssl:
+            raise NotImplementedByController("TLS")
+        if run_services:
+            raise NotImplementedByController("Services")
+        assert self.proc is None
+        self.port = port
+        self.hostname = hostname
+        self.create_config()
+        password_field = 'password = "{}";'.format(password) if password else ""
+        assert self.directory
+        pidfile = os.path.join(self.directory, "ircd.pid")
+        with self.open_file("server.conf") as fd:
+            fd.write(
+                TEMPLATE_CONFIG.format(
+                    hostname=hostname,
+                    port=port,
+                    password_field=password_field,
+                    pidfile=pidfile,
+                )
+            )
+        self.proc = subprocess.Popen(
+            [
+                "ircd",
+                "-n",  # don't detach
+                "-f",
+                os.path.join(self.directory, "server.conf"),
+                "-x",
+                "DEBUG",
+            ],
+            # stderr=subprocess.DEVNULL,
+        )
+
+
+def get_irctest_controller_class() -> Type[Ircu2Controller]:
+    return Ircu2Controller

irctest/controllers/snircd.py

@@ -0,0 +1,103 @@
+import os
+import subprocess
+from typing import Optional, Set, Type
+
+from irctest.basecontrollers import (
+    BaseServerController,
+    DirectoryBasedController,
+    NotImplementedByController,
+)
+
+TEMPLATE_CONFIG = """
+General {{
+    name = "My.Little.Server";
+    numeric = 42;
+    description = "test server";
+}};
+
+Port {{
+    vhost = "{hostname}";
+    port = {port};
+}};
+
+Class {{
+    name = "Client";
+    pingfreq = 5 minutes;
+    sendq = 160000;
+    maxlinks = 1024;
+}};
+
+Client {{
+    username = "*";
+    class = "Client";
+    {password_field}
+}};
+
+features {{
+    "PPATH" = "{pidfile}";
+
+    # don't block notices by default, wtf
+    "AUTOCHANMODES_LIST" = "+tnC";
+}};
+"""
+
+
+class SnircdController(BaseServerController, DirectoryBasedController):
+    supports_sts = False
+    extban_mute_char = None
+
+    def create_config(self) -> None:
+        super().create_config()
+        with self.open_file("server.conf"):
+            pass
+
+    def run(
+        self,
+        hostname: str,
+        port: int,
+        *,
+        password: Optional[str],
+        ssl: bool,
+        run_services: bool,
+        valid_metadata_keys: Optional[Set[str]] = None,
+        invalid_metadata_keys: Optional[Set[str]] = None,
+    ) -> None:
+        if valid_metadata_keys or invalid_metadata_keys:
+            raise NotImplementedByController(
+                "Defining valid and invalid METADATA keys."
+            )
+        if ssl:
+            raise NotImplementedByController("TLS")
+        if run_services:
+            raise NotImplementedByController("Services")
+        assert self.proc is None
+        self.port = port
+        self.hostname = hostname
+        self.create_config()
+        password_field = 'password = "{}";'.format(password) if password else ""
+        assert self.directory
+        pidfile = os.path.join(self.directory, "ircd.pid")
+        with self.open_file("server.conf") as fd:
+            fd.write(
+                TEMPLATE_CONFIG.format(
+                    hostname=hostname,
+                    port=port,
+                    password_field=password_field,
+                    pidfile=pidfile,
+                )
+            )
+        self.proc = subprocess.Popen(
+            [
+                "ircd",
+                "-n",  # don't detach
+                "-f",
+                os.path.join(self.directory, "server.conf"),
+                "-x",
+                "DEBUG",
+            ],
+            # stderr=subprocess.DEVNULL,
+        )
+
+
+def get_irctest_controller_class() -> Type[SnircdController]:
+    return SnircdController

irctest/numerics.py

@@ -164,6 +164,7 @@ ERR_NOOPERHOST = "491"
 ERR_UMODEUNKNOWNFLAG = "501"
 ERR_USERSDONTMATCH = "502"
 ERR_HELPNOTFOUND = "524"
+ERR_INVALIDKEY = "525"
 ERR_CANNOTSENDRP = "573"
 RPL_WHOISSECURE = "671"
 RPL_YOURLANGUAGESARE = "687"

irctest/server_tests/test_channel_operations.py

@@ -16,6 +16,7 @@ from irctest.numerics import (
     ERR_BANNEDFROMCHAN,
     ERR_CANNOTSENDTOCHAN,
     ERR_CHANOPRIVSNEEDED,
+    ERR_INVALIDKEY,
     ERR_INVALIDMODEPARAM,
     ERR_INVITEONLYCHAN,
     ERR_NOSUCHCHANNEL,
@@ -918,7 +919,7 @@ class KeyTestCase(cases.BaseServerTestCase):
           was valid.
         "
         -- https://modern.ircdocs.horse/#key-channel-mode
-        -- https://github.com/ircdocs/modern-irc/pull/107
+        -- https://github.com/ircdocs/modern-irc/pull/111
         """
         self.connectClient("bar")
         self.joinChannel(1, "#chan")
@@ -937,8 +938,9 @@ class KeyTestCase(cases.BaseServerTestCase):
             "(eg. ERR_INVALIDMODEPARAM or truncation): {msg}",
         )
 
-        if ERR_INVALIDMODEPARAM in {msg.command for msg in replies}:
+        if {ERR_INVALIDMODEPARAM, ERR_INVALIDKEY} & {msg.command for msg in replies}:
-            # First option: ERR_INVALIDMODEPARAM (eg. Ergo)
+            # First option: ERR_INVALIDMODEPARAM (eg. Ergo) or ERR_INVALIDKEY
+            # (eg. ircu2)
             return
 
         if not replies:
@@ -957,8 +959,8 @@ class KeyTestCase(cases.BaseServerTestCase):
             len(mode_commands),
             1,
             fail_msg="Sending an invalid key (with a space) triggered "
-            "neither ERR_UNKNOWNERROR, ERR_INVALIDMODEPARAM, or a MODE. "
+            "neither ERR_UNKNOWNERROR, ERR_INVALIDMODEPARAM, ERR_INVALIDKEY, "
-            "Only these: {}",
+            " or a MODE. Only these: {}",
             extra_format=(replies,),
         )
         self.assertLessEqual(

irctest/server_tests/test_lusers.py

@@ -18,7 +18,7 @@ from irctest.numerics import (
 # 3 numbers, delimited by spaces, possibly negative (eek)
 LUSERCLIENT_REGEX = re.compile(r"^.*( [-0-9]* ).*( [-0-9]* ).*( [-0-9]* ).*$")
 # 2 numbers
-LUSERME_REGEX = re.compile(r"^.*( [-0-9]* ).*( [-0-9]* ).*$")
+LUSERME_REGEX = re.compile(r"^.*?( [-0-9]* ).*( [-0-9]* ).*$")
 
 
 @dataclass
@@ -79,6 +79,7 @@ class LusersTestCase(cases.BaseServerTestCase):
         if RPL_LUSERCHANNELS in by_numeric:
             result.Channels = int(by_numeric[RPL_LUSERCHANNELS].params[1])
 
+        # FIXME: RPL_LOCALUSERS and RPL_GLOBALUSERS are only in Modern, not in RFC2812
         localusers = by_numeric[RPL_LOCALUSERS]
         globalusers = by_numeric[RPL_GLOBALUSERS]
         if len(localusers.params) == 4:

irctest/server_tests/test_register_verify.py

@@ -105,7 +105,7 @@ class TestRegisterEmailVerified(cases.BaseServerTestCase):
         )
 
 
-@cases.mark_specifications("IRCv3")
+@cases.mark_specifications("IRCv3", "Ergo")
 class TestRegisterNoLandGrabs(cases.BaseServerTestCase):
     @staticmethod
     def config() -> cases.TestCaseControllerConfig:

irctest/server_tests/test_regressions.py

@@ -2,6 +2,8 @@
 Regression tests for bugs in oragono.
 """
 
+import time
+
 from irctest import cases
 from irctest.numerics import ERR_ERRONEUSNICKNAME, ERR_NICKNAMEINUSE, RPL_WELCOME
 from irctest.patma import ANYDICT
@@ -102,6 +104,7 @@ class RegressionsTestCase(cases.BaseServerTestCase):
         self.sendLine(1, "NICK *")
         self.sendLine(1, "USER u s e r")
         replies = {"NOTICE"}
+        time.sleep(2)  # give time to slow servers, like irc2 to reply
         while replies == {"NOTICE"}:
             replies = set(msg.command for msg in self.getMessages(1, synchronize=False))
         self.assertIn(ERR_ERRONEUSNICKNAME, replies)

workflows.yml

@@ -155,6 +155,76 @@ software:
             ./configure --prefix=$HOME/.local/inspircd --development
             make -j 4
             make install
+    irc2:
+        name: irc2
+        separate_build_job: false
+        install_steps:
+            stable:
+                - name: Get source code
+                  run: |-
+                      curl http://ftp.irc.org/ftp/irc/server/irc2.11.2p3.tgz | tar -zx
+                - name: Configure
+                  run: |-
+                      cd $GITHUB_WORKSPACE/irc2.11.2p3
+                      ./configure --prefix=$HOME/.local/
+                      cd x86*
+                      echo "#define CMDLINE_CONFIG/" >> config.h
+                      echo "#define DEFAULT_SPLIT_USERS 0" >> config.h
+                      echo "#define DEFAULT_SPLIT_SERVERS 0" >> config.h
+                      #echo "#undef LIST_ALIS_NOTE" >> config.h
+                      # TODO: find a better way to make it not fork...
+                      echo "#define fork() (0)" >> config.h
+                - name: Compile and install
+                  run: |-
+                      cd $GITHUB_WORKSPACE/irc2.11.2p3/x86*
+                      make -j 4 all
+                      make install
+                      mkdir -p $HOME/.local/bin
+                      cp $HOME/.local/sbin/ircd $HOME/.local/bin/ircd
+            release: null
+            devel: null
+            devel_release: null
+
+    ircu2:
+        name: ircu2
+        repository: undernetirc/ircu2
+        refs:
+            stable: "u2.10.12.19"
+            release: null
+            devel: "u2_10_12_branch"
+            devel_release: null
+        path: ircu2
+        separate_build_job: false
+        build_script: |
+            cd $GITHUB_WORKSPACE/ircu2
+            # We need --with-maxcon, to set MAXCONNECTIONS so that it's much lower than
+            # NN_MAX_CLIENT, or ircu2 crashes with a somewhat cryptic error on startup.
+            ./configure --prefix=$HOME/.local/ --with-maxcon=1024 --enable-debug
+            make -j 4
+            make install
+
+    snircd:
+        name: snircd
+        repository: quakenet/snircd
+        refs:
+            stable: "u2.10.12.10+snircd(1.3.4a)"
+            release: null
+            devel: null  # no update in master since 2013...
+            devel_release: null
+        path: snircd
+        separate_build_job: false
+        build_script: |
+            cd $GITHUB_WORKSPACE/snircd
+
+            # Work around an issue with liblex detection
+            rm configure
+            autoconf
+
+            # We need --with-maxcon, to set MAXCONNECTIONS so that it's much lower than
+            # NN_MAX_CLIENT, or ircu2 crashes with a somewhat cryptic error on startup.
+            ./configure --prefix=$HOME/.local/ --with-maxcon=1024 --enable-debug
+            make -j 4
+            make install
 
     unrealircd:
         name: UnrealIRCd
@@ -246,6 +316,13 @@ tests:
     plexus4:
         software: [plexus4, anope]
 
+    # doesn't build because it can't find liblex for some reason
+    #snircd:
+    #    software: [snircd]
+
+    irc2:
+        software: [irc2]
+
     unrealircd:
         software: [unrealircd]
 
@@ -255,6 +332,7 @@ tests:
     unrealircd-anope:
         software: [unrealircd, anope]
 
+
     limnoria:
         software: [limnoria]