From a637ae392782b497d8ec0e41e0b5520c1d6643e7 Mon Sep 17 00:00:00 2001 From: Val Lorentz Date: Wed, 7 Jul 2021 15:06:00 +0200 Subject: [PATCH] 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 | 107 +++++++++++++++++++- .github/workflows/test-devel_release.yml | 49 ++++++++++ .github/workflows/test-stable.yml | 107 +++++++++++++++++++- Makefile | 18 ++++ data/anope/config.cache | 8 ++ {unreal => data/unreal}/README | 0 {unreal => data/unreal}/config.settings | 0 {unreal => data/unreal}/server.cert.pem | 0 {unreal => data/unreal}/server.key.pem | 0 {unreal => data/unreal}/server.req.pem | 0 irctest/controllers/anope_services.py | 118 +++++++++++++++++++++++ irctest/controllers/inspircd.py | 3 + make_workflows.py | 25 +++++ workflows.yml | 29 +++++- 14 files changed, 457 insertions(+), 7 deletions(-) create mode 100644 data/anope/config.cache rename {unreal => data/unreal}/README (100%) rename {unreal => data/unreal}/config.settings (100%) rename {unreal => data/unreal}/server.cert.pem (100%) rename {unreal => data/unreal}/server.key.pem (100%) rename {unreal => data/unreal}/server.req.pem (100%) create mode 100644 irctest/controllers/anope_services.py diff --git a/.github/workflows/test-devel.yml b/.github/workflows/test-devel.yml index f6cd88c..636f7cf 100644 --- a/.github/workflows/test-devel.yml +++ b/.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: diff --git a/.github/workflows/test-devel_release.yml b/.github/workflows/test-devel_release.yml index 86ac408..f080c59 100644 --- a/.github/workflows/test-devel_release.yml +++ b/.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: diff --git a/.github/workflows/test-stable.yml b/.github/workflows/test-stable.yml index 71f7ead..a9adb6f 100644 --- a/.github/workflows/test-stable.yml +++ b/.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 diff --git a/Makefile b/Makefile index fb3de4a..da994f5 100644 --- a/Makefile +++ b/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)' diff --git a/data/anope/config.cache b/data/anope/config.cache new file mode 100644 index 0000000..71f30cd --- /dev/null +++ b/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="" diff --git a/unreal/README b/data/unreal/README similarity index 100% rename from unreal/README rename to data/unreal/README diff --git a/unreal/config.settings b/data/unreal/config.settings similarity index 100% rename from unreal/config.settings rename to data/unreal/config.settings diff --git a/unreal/server.cert.pem b/data/unreal/server.cert.pem similarity index 100% rename from unreal/server.cert.pem rename to data/unreal/server.cert.pem diff --git a/unreal/server.key.pem b/data/unreal/server.key.pem similarity index 100% rename from unreal/server.key.pem rename to data/unreal/server.key.pem diff --git a/unreal/server.req.pem b/data/unreal/server.req.pem similarity index 100% rename from unreal/server.req.pem rename to data/unreal/server.req.pem diff --git a/irctest/controllers/anope_services.py b/irctest/controllers/anope_services.py new file mode 100644 index 0000000..025d98d --- /dev/null +++ b/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 diff --git a/irctest/controllers/inspircd.py b/irctest/controllers/inspircd.py index 76bf194..1dfab8b 100644 --- a/irctest/controllers/inspircd.py +++ b/irctest/controllers/inspircd.py @@ -19,6 +19,8 @@ TEMPLATE_CONFIG = """ timeout="10" # So tests don't hang too long {password_field}> + + # Services: + # Anope errors when missing # Atheme raises a warning when missing diff --git a/make_workflows.py b/make_workflows.py index 3d38489..be59173 100644 --- a/make_workflows.py +++ b/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 += " " diff --git a/workflows.yml b/workflows.yml index 4797a91..b507187 100644 --- a/workflows.yml +++ b/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: