Add Anope controller, and use it with inspircd and unreal (#75)

* Add Anope controller, and use it with inspircd and unreal

* Build Anope before running it, duh

* Fix Anope build script

* Consistently use ascii casemapping instead of rfc1459

* Skip failing test with Anope

.github/workflows/test-devel.yml

@@ -9,7 +9,9 @@ jobs:
     - test-solanum
     - test-ergo
     - test-inspircd
+    - test-inspircd-anope
     - test-unrealircd
+    - test-unrealircd-anope
     - test-limnoria
     - test-sopel
     runs-on: ubuntu-latest
@@ -100,6 +102,54 @@ jobs:
       with:
         name: pytest results InspIRCd (devel)
         path: pytest.xml
+  test-inspircd-anope:
+    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: Install dependencies
+      run: |-
+        sudo apt-get install atheme-services
+        python -m pip install --upgrade pip
+        pip install pytest -r requirements.txt
+    - name: Checkout InspIRCd
+      uses: actions/checkout@v2
+      with:
+        path: inspircd
+        ref: master
+        repository: inspircd/inspircd
+    - name: Build InspIRCd
+      run: |
+        cd $GITHUB_WORKSPACE/inspircd/
+        patch src/inspircd.cpp < $GITHUB_WORKSPACE/inspircd_mainloop.patch
+        ./configure --prefix=$HOME/.local/inspircd --development
+        make -j 4
+        make install
+    - name: Checkout Anope
+      uses: actions/checkout@v2
+      with:
+        path: anope
+        ref: 2.0.9
+        repository: anope/anope
+    - name: Build Anope
+      run: |-
+        cd $GITHUB_WORKSPACE/anope/
+        cp $GITHUB_WORKSPACE/data/anope/* .
+        CFLAGS=-O0 ./Config -quick
+        make -C build -j 4
+        make -C build install
+    - name: Test with pytest
+      run: PYTEST_ARGS='--junit-xml pytest.xml' PATH=~/.local/inspircd/bin:$PATH make
+        inspircd-anope
+    - if: always()
+      name: Publish results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pytest results InspIRCd (devel)
+        path: pytest.xml
   test-limnoria:
     runs-on: ubuntu-latest
     steps:
@@ -230,7 +280,7 @@ jobs:
     - name: Build UnrealIRCd
       run: |
         cd $GITHUB_WORKSPACE/unrealircd/
-        cp $GITHUB_WORKSPACE/unreal/* .
+        cp $GITHUB_WORKSPACE/data/unreal/* .
         CFLAGS=-O0 ./Config -quick
         make -j 4
         make install
@@ -243,6 +293,61 @@ jobs:
       with:
         name: pytest results UnrealIRCd (devel)
         path: pytest.xml
+  test-unrealircd-anope:
+    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: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        key: ${{ runner.os }}-unrealircd-anope-devel
+        path: |-
+          ~/.cache
+          $GITHUB_WORKSPACE/unrealircd
+    - name: Install dependencies
+      run: |-
+        sudo apt-get install atheme-services
+        python -m pip install --upgrade pip
+        pip install pytest -r requirements.txt
+    - name: Checkout UnrealIRCd
+      uses: actions/checkout@v2
+      with:
+        path: unrealircd
+        ref: unreal52
+        repository: unrealircd/unrealircd
+    - name: Build UnrealIRCd
+      run: |
+        cd $GITHUB_WORKSPACE/unrealircd/
+        cp $GITHUB_WORKSPACE/data/unreal/* .
+        CFLAGS=-O0 ./Config -quick
+        make -j 4
+        make install
+    - name: Checkout Anope
+      uses: actions/checkout@v2
+      with:
+        path: anope
+        ref: 2.0.9
+        repository: anope/anope
+    - name: Build Anope
+      run: |-
+        cd $GITHUB_WORKSPACE/anope/
+        cp $GITHUB_WORKSPACE/data/anope/* .
+        CFLAGS=-O0 ./Config -quick
+        make -C build -j 4
+        make -C build install
+    - name: Test with pytest
+      run: PYTEST_ARGS='--junit-xml pytest.xml' PATH=~/.local/unrealircd/bin:$PATH
+        make unrealircd-anope
+    - if: always()
+      name: Publish results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pytest results UnrealIRCd (devel)
+        path: pytest.xml
 name: irctest with devel versions
 'on':
   schedule:

.github/workflows/test-devel_release.yml

@@ -7,6 +7,7 @@ jobs:
     name: Publish Unit Tests Results
     needs:
     - test-inspircd
+    - test-inspircd-anope
     runs-on: ubuntu-latest
     steps:
     - name: Download Artifacts
@@ -52,6 +53,54 @@ jobs:
       with:
         name: pytest results InspIRCd (devel_release)
         path: pytest.xml
+  test-inspircd-anope:
+    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: Install dependencies
+      run: |-
+        sudo apt-get install atheme-services
+        python -m pip install --upgrade pip
+        pip install pytest -r requirements.txt
+    - name: Checkout InspIRCd
+      uses: actions/checkout@v2
+      with:
+        path: inspircd
+        ref: insp3
+        repository: inspircd/inspircd
+    - name: Build InspIRCd
+      run: |
+        cd $GITHUB_WORKSPACE/inspircd/
+        patch src/inspircd.cpp < $GITHUB_WORKSPACE/inspircd_mainloop.patch
+        ./configure --prefix=$HOME/.local/inspircd --development
+        make -j 4
+        make install
+    - name: Checkout Anope
+      uses: actions/checkout@v2
+      with:
+        path: anope
+        ref: 2.0.9
+        repository: anope/anope
+    - name: Build Anope
+      run: |-
+        cd $GITHUB_WORKSPACE/anope/
+        cp $GITHUB_WORKSPACE/data/anope/* .
+        CFLAGS=-O0 ./Config -quick
+        make -C build -j 4
+        make -C build install
+    - name: Test with pytest
+      run: PYTEST_ARGS='--junit-xml pytest.xml' PATH=~/.local/inspircd/bin:$PATH make
+        inspircd-anope
+    - if: always()
+      name: Publish results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pytest results InspIRCd (devel_release)
+        path: pytest.xml
 name: irctest with devel_release versions
 'on':
   schedule:

.github/workflows/test-stable.yml

@@ -10,7 +10,9 @@ jobs:
     - test-solanum
     - test-ergo
     - test-inspircd
+    - test-inspircd-anope
     - test-unrealircd
+    - test-unrealircd-anope
     - test-limnoria
     - test-sopel
     runs-on: ubuntu-latest
@@ -142,6 +144,54 @@ jobs:
       with:
         name: pytest results InspIRCd (stable)
         path: pytest.xml
+  test-inspircd-anope:
+    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: Install dependencies
+      run: |-
+        sudo apt-get install atheme-services
+        python -m pip install --upgrade pip
+        pip install pytest -r requirements.txt
+    - name: Checkout InspIRCd
+      uses: actions/checkout@v2
+      with:
+        path: inspircd
+        ref: v3.10.0
+        repository: inspircd/inspircd
+    - name: Build InspIRCd
+      run: |
+        cd $GITHUB_WORKSPACE/inspircd/
+        patch src/inspircd.cpp < $GITHUB_WORKSPACE/inspircd_mainloop.patch
+        ./configure --prefix=$HOME/.local/inspircd --development
+        make -j 4
+        make install
+    - name: Checkout Anope
+      uses: actions/checkout@v2
+      with:
+        path: anope
+        ref: 2.0.9
+        repository: anope/anope
+    - name: Build Anope
+      run: |-
+        cd $GITHUB_WORKSPACE/anope/
+        cp $GITHUB_WORKSPACE/data/anope/* .
+        CFLAGS=-O0 ./Config -quick
+        make -C build -j 4
+        make -C build install
+    - name: Test with pytest
+      run: PYTEST_ARGS='--junit-xml pytest.xml' PATH=~/.local/inspircd/bin:$PATH make
+        inspircd-anope
+    - if: always()
+      name: Publish results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pytest results InspIRCd (stable)
+        path: pytest.xml
   test-limnoria:
     runs-on: ubuntu-latest
     steps:
@@ -272,7 +322,7 @@ jobs:
     - name: Build UnrealIRCd
       run: |
         cd $GITHUB_WORKSPACE/unrealircd/
-        cp $GITHUB_WORKSPACE/unreal/* .
+        cp $GITHUB_WORKSPACE/data/unreal/* .
         CFLAGS=-O0 ./Config -quick
         make -j 4
         make install
@@ -285,6 +335,61 @@ jobs:
       with:
         name: pytest results UnrealIRCd (stable)
         path: pytest.xml
+  test-unrealircd-anope:
+    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: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        key: ${{ runner.os }}-unrealircd-anope-stable
+        path: |-
+          ~/.cache
+          $GITHUB_WORKSPACE/unrealircd
+    - name: Install dependencies
+      run: |-
+        sudo apt-get install atheme-services
+        python -m pip install --upgrade pip
+        pip install pytest -r requirements.txt
+    - name: Checkout UnrealIRCd
+      uses: actions/checkout@v2
+      with:
+        path: unrealircd
+        ref: 94993a03ca8d3c193c0295c33af39270c3f9d27d
+        repository: unrealircd/unrealircd
+    - name: Build UnrealIRCd
+      run: |
+        cd $GITHUB_WORKSPACE/unrealircd/
+        cp $GITHUB_WORKSPACE/data/unreal/* .
+        CFLAGS=-O0 ./Config -quick
+        make -j 4
+        make install
+    - name: Checkout Anope
+      uses: actions/checkout@v2
+      with:
+        path: anope
+        ref: 2.0.9
+        repository: anope/anope
+    - name: Build Anope
+      run: |-
+        cd $GITHUB_WORKSPACE/anope/
+        cp $GITHUB_WORKSPACE/data/anope/* .
+        CFLAGS=-O0 ./Config -quick
+        make -C build -j 4
+        make -C build install
+    - name: Test with pytest
+      run: PYTEST_ARGS='--junit-xml pytest.xml' PATH=~/.local/unrealircd/bin:$PATH
+        make unrealircd-anope
+    - if: always()
+      name: Publish results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pytest results UnrealIRCd (stable)
+        path: pytest.xml
 name: irctest with stable versions
 'on':
   pull_request: null

Makefile

@@ -7,6 +7,10 @@ PYTEST_ARGS ?=
 # Will be appended at the end of the -k argument to pytest
 EXTRA_SELECTORS ?=
 
+# testPlainLarge fails because it doesn't handle split AUTHENTICATE (reported on IRC)
+ANOPE_SELECTORS := \
+	and not testPlainLarge
+
 # testQuitErrors is very flaky
 # AccountTagTestCase.testInvite fails because https://github.com/solanum-ircd/solanum/issues/166
 CHARYBDIS_SELECTORS := \
@@ -110,6 +114,13 @@ inspircd:
 		--services-controller=irctest.controllers.atheme_services \
 		-k '$(INSPIRCD_SELECTORS)'
 
+inspircd-anope:
+	$(PYTEST) $(PYTEST_ARGS) \
+		--controller=irctest.controllers.inspircd \
+		--services-controller=irctest.controllers.anope_services \
+		-m 'services' \
+		-k '$(INSPIRCD_SELECTORS) $(ANOPE_SELECTORS)'
+
 limnoria:
 	$(PYTEST) $(PYTEST_ARGS) \
 		--controller=irctest.controllers.limnoria \
@@ -136,3 +147,10 @@ unrealircd:
 		--controller=irctest.controllers.unrealircd \
 		--services-controller=irctest.controllers.atheme_services \
 		-k '$(UNREALIRCD_SELECTORS)'
+
+unrealircd-anope:
+	$(PYTEST) $(PYTEST_ARGS) \
+		--controller=irctest.controllers.unrealircd \
+		--services-controller=irctest.controllers.anope_services \
+		-m 'services' \
+		-k '$(UNREALIRCD_SELECTORS) $(ANOPE_SELECTORS)'

data/anope/config.cache

@@ -0,0 +1,8 @@
+INSTDIR="$HOME/.local/"
+RUNGROUP=""
+UMASK=077
+DEBUG="yes"
+USE_PCH="yes"
+EXTRA_INCLUDE_DIRS=""
+EXTRA_LIB_DIRS=""
+EXTRA_CONFIG_ARGS=""

irctest/controllers/anope_services.py

@@ -0,0 +1,118 @@
+import os
+import shutil
+import subprocess
+from typing import Type
+
+from irctest.basecontrollers import BaseServicesController, DirectoryBasedController
+
+TEMPLATE_CONFIG = """
+serverinfo {{
+    name = "services.example.org"
+    description = "Anope IRC Services"
+    numeric = "00A"
+    pid = "services.pid"
+    motd = "conf/empty_file"
+}}
+
+uplink  {{
+    host = "{server_hostname}"
+    port = {server_port}
+    password = "password"
+}}
+
+module {{
+    name = "{protocol}"
+}}
+
+networkinfo {{
+    networkname = "testnet"
+    nicklen = 31
+    userlen = 10
+    hostlen = 64
+    chanlen = 32
+}}
+
+mail {{
+    usemail = no
+}}
+
+service {{
+    nick = "NickServ"
+    user = "services"
+    host = "services.host"
+    gecos = "Nickname Registration Service"
+}}
+
+module {{
+    name = "nickserv"
+    client = "NickServ"
+    forceemail = no
+    passlen = 1000  # Some tests need long passwords
+}}
+command {{ service = "NickServ"; name = "HELP"; command = "generic/help"; }}
+
+module {{
+    name = "ns_register"
+    registration = "none"
+}}
+command {{ service = "NickServ"; name = "REGISTER"; command = "nickserv/register"; }}
+
+options {{
+    casemap = "ascii"
+    readtimeout = 5s
+    warningtimeout = 4h
+}}
+
+module {{ name = "m_sasl" }}
+module {{ name = "enc_sha256" }}
+module {{ name = "ns_cert" }}
+
+"""
+
+
+class AnopeController(BaseServicesController, DirectoryBasedController):
+    """Collaborator for server controllers that rely on Anope"""
+
+    def run(self, protocol: str, server_hostname: str, server_port: int) -> None:
+        self.create_config()
+
+        assert protocol in ("inspircd3", "charybdis", "unreal4")
+
+        with self.open_file("conf/services.conf") as fd:
+            fd.write(
+                TEMPLATE_CONFIG.format(
+                    protocol=protocol,
+                    server_hostname=server_hostname,
+                    server_port=server_port,
+                )
+            )
+
+        with self.open_file("conf/empty_file") as fd:
+            pass
+
+        assert self.directory
+
+        # Config and code need to be in the same directory, *obviously*
+        os.symlink(
+            os.path.join(
+                os.path.dirname(shutil.which("services")), "..", "lib"  # type: ignore
+            ),
+            os.path.join(self.directory, "lib"),
+        )
+
+        self.proc = subprocess.Popen(
+            [
+                "services",
+                "-n",  # don't fork
+                "--config=services.conf",  # can't be an absolute path
+                # "--logdir",
+                # f"/tmp/services-{server_port}.log",
+            ],
+            cwd=self.directory,
+            # stdout=subprocess.DEVNULL,
+            # stderr=subprocess.DEVNULL,
+        )
+
+
+def get_irctest_controller_class() -> Type[AnopeController]:
+    return AnopeController

irctest/controllers/inspircd.py

@@ -19,6 +19,8 @@ TEMPLATE_CONFIG = """
     timeout="10"  # So tests don't hang too long
     {password_field}>
 
+<options casemapping="ascii">
+
 # Services:
 <bind address="{services_hostname}" port="{services_port}" type="servers">
 <link name="services.example.org"
@@ -30,6 +32,7 @@ TEMPLATE_CONFIG = """
     >
 <module name="spanningtree">
 <module name="services_account">
+<module name="hidechans">  # Anope errors when missing
 <module name="svshold">  # Atheme raises a warning when missing
 <sasl requiressl="no"
       target="services.example.org">

make_workflows.py

@@ -80,6 +80,31 @@ def get_build_job(*, software_config, software_id, version_flavor):
             },
         ]
 
+    if software_config.get("build_anope", False):
+        install_steps.append(
+            {
+                "name": "Checkout Anope",
+                "uses": "actions/checkout@v2",
+                "with": {
+                    "repository": "anope/anope",
+                    "ref": "2.0.9",
+                    "path": "anope",
+                },
+            }
+        )
+        install_steps.append(
+            {
+                "name": "Build Anope",
+                "run": script(
+                    "cd $GITHUB_WORKSPACE/anope/",
+                    "cp $GITHUB_WORKSPACE/data/anope/* .",
+                    "CFLAGS=-O0 ./Config -quick",
+                    "make -C build -j 4",
+                    "make -C build install",
+                ),
+            }
+        )
+
     env = software_config.get("env", {}).get(version_flavor.value, "")
     if env:
         env += " "

workflows.yml

@@ -65,7 +65,7 @@ software:
     inspircd:
         name: InspIRCd
         repository: inspircd/inspircd
-        refs:
+        refs: &inspircd_refs
             stable: v3.10.0
             release: null
             devel: master
@@ -76,30 +76,49 @@ software:
         path: inspircd
         prefix: ~/.local/inspircd
         cache: false  # incremental compilation is frequently broken
-        build_script: |
+        build_script: &inspircd_build_script |
             cd $GITHUB_WORKSPACE/inspircd/
             patch src/inspircd.cpp < $GITHUB_WORKSPACE/inspircd_mainloop.patch
             ./configure --prefix=$HOME/.local/inspircd --development
             make -j 4
             make install
 
+    inspircd-anope:
+        name: InspIRCd
+        repository: inspircd/inspircd
+        refs: *inspircd_refs
+        path: inspircd
+        prefix: ~/.local/inspircd
+        cache: false  # incremental compilation is frequently broken
+        build_anope: true
+        build_script: *inspircd_build_script
+
     unrealircd:
         name: UnrealIRCd
         repository: unrealircd/unrealircd
-        refs:
+        refs: &unrealircd_refs
             stable: 94993a03ca8d3c193c0295c33af39270c3f9d27d  # 5.2.1-rc1
             release: null
             devel: unreal52
             devel_release: null
         path: unrealircd
         prefix: ~/.local/unrealircd
-        build_script: |
+        build_script: &unrealircd_build_script |
             cd $GITHUB_WORKSPACE/unrealircd/
-            cp $GITHUB_WORKSPACE/unreal/* .
+            cp $GITHUB_WORKSPACE/data/unreal/* .
             CFLAGS=-O0 ./Config -quick
             make -j 4
             make install
 
+    unrealircd-anope:
+        name: UnrealIRCd
+        repository: unrealircd/unrealircd
+        refs: *unrealircd_refs
+        path: unrealircd
+        prefix: ~/.local/unrealircd
+        build_anope: true
+        build_script: *unrealircd_build_script
+
     #############################
     # Clients: