Generate .github/workflows/ from a single compact file (#65)

It's easier to read and maintain

.github/workflows/charybdis.yml

@@ -1,44 +1,33 @@
-name: irctest with Charybdis
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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:
-        path: |
+        key: ${{ runner.os }}-charybdis
+        path: |-
           ~/.cache
           $GITHUB_WORKSPACE/charybdis
-        key: ${{ runner.os }}-charybdis
-
     - name: Install dependencies
-      run: |
+      run: |-
         sudo apt-get install atheme-services
         python -m pip install --upgrade pip
         pip install pytest -r requirements.txt
-
     - name: Checkout Charybdis
       uses: actions/checkout@v2
       with:
-        repository: charybdis-ircd/charybdis
-        ref: charybdis-4.1.2
         path: charybdis
-
+        ref: charybdis-4.1.2
+        repository: charybdis-ircd/charybdis
     - name: Build Charybdis
       run: |
         cd $GITHUB_WORKSPACE/charybdis/
@@ -46,8 +35,9 @@ jobs:
         ./configure --prefix=$HOME/.local/
         make -j 4
         make install
-
     - name: Test with pytest
-      run: |
+      run: PATH=~/.local/bin:$PATH make charybdis
-        PATH=~/.local/bin:$PATH make charybdis
+name: irctest with Charybdis
-
+'on':
+  pull_request: null
+  push: null

.github/workflows/ergo.yml

@@ -1,54 +1,45 @@
-name: irctest with Ergo
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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
-
     - uses: actions/setup-go@v2
       with:
-        go-version: '~1.16'
+        go-version: ~1.16
     - run: go version
-
     - name: Cache dependencies
       uses: actions/cache@v2
       with:
-        path: |
+        key: ${{ runner.os }}-ergo
+        path: |-
           ~/.cache
           $GITHUB_WORKSPACE/ergo
-        key: ${{ runner.os }}-ergo
-
     - name: Install dependencies
-      run: |
+      run: |-
+        sudo apt-get install atheme-services
         python -m pip install --upgrade pip
         pip install pytest -r requirements.txt
-
     - name: Checkout Ergo
       uses: actions/checkout@v2
       with:
-        repository: ergochat/ergo
-        ref: irctest_stable
         path: ergo
-
+        ref: irctest_stable
+        repository: ergochat/ergo
     - name: Build Ergo
       run: |
         cd $GITHUB_WORKSPACE/ergo/
         make build
         make install
-
     - name: Test with pytest
-      run: |
+      run: PATH=~/go/bin:$PATH make ergo
-        PATH=~/go/bin:$PATH make ergo
+name: irctest with Ergo
+'on':
+  pull_request: null
+  push: null

.github/workflows/inspircd.yml

@@ -1,53 +1,43 @@
-name: irctest with InspIRCd
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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:
-        path: |
+        key: ${{ runner.os }}-inspircd
+        path: |-
           ~/.cache
           $GITHUB_WORKSPACE/inspircd
-        key: ${{ runner.os }}-inspircd
-
     - name: Install dependencies
-      run: |
+      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:
-        repository: inspircd/inspircd
-        ref: v3.8.1
         path: inspircd
-
+        ref: v3.8.1
+        repository: inspircd/inspircd
     - name: Build InspIRCd
       run: |
         cd $GITHUB_WORKSPACE/inspircd/
         patch src/inspircd.cpp < $GITHUB_WORKSPACE/inspircd_mainloop.patch
-        ./configure --prefix=$HOME/.local/ --development
+        ./configure --prefix=$HOME/.local/inspircd --development
         make -j 4
         make install
-
     - name: Test with pytest
-      run: |
+      run: PATH=~/.local/inspircd/bin:$PATH make inspircd
-        PATH=~/.local/bin:$PATH make inspircd
+name: irctest with InspIRCd
-
+'on':
+  pull_request: null
+  push: null

.github/workflows/limnoria.yml

@@ -1,37 +1,32 @@
-name: irctest with Limnoria
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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:
-        path: |
-          ~/.cache
         key: ${{ runner.os }}-limnoria
-
+        path: |-
+          ~/.cache
+          $GITHUB_WORKSPACE/placeholder
     - name: Install dependencies
-      run: |
+      run: |-
+        sudo apt-get install atheme-services
         python -m pip install --upgrade pip
-        pip install pytest limnoria==2021.01.15 cryptography -r requirements.txt
+        pip install pytest -r requirements.txt
-
+    - name: Install dependencies
+      run: pip install limnoria==2021.01.15 cryptography
     - name: Test with pytest
-      run: |
+      run: PATH=~/.local/bin:$PATH make limnoria
-        PATH=~/.local/bin:$PATH make limnoria
+name: irctest with Limnoria
-
+'on':
-
+  pull_request: null
+  push: null

.github/workflows/lint.yml

@@ -34,3 +34,8 @@ jobs:
     - name: Lint
       run: |
         pre-commit run -a
+
+    - name: Check generated workflows are in sync
+      run: |
+        python make_workflows.py
+        git diff --exit-code

.github/workflows/solanum.yml

@@ -1,44 +1,33 @@
-name: irctest with Solanum
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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:
-        path: |
+        key: ${{ runner.os }}-solanum
+        path: |-
           ~/.cache
           $GITHUB_WORKSPACE/solanum
-        key: ${{ runner.os }}-solanum
-
     - name: Install dependencies
-      run: |
+      run: |-
         sudo apt-get install atheme-services
         python -m pip install --upgrade pip
         pip install pytest -r requirements.txt
-
     - name: Checkout Solanum
       uses: actions/checkout@v2
       with:
-        repository: solanum-ircd/solanum
-        ref: e370888264da666a1bd9faac86cd5f2aa06084f4
         path: solanum
-
+        ref: e370888264da666a1bd9faac86cd5f2aa06084f4
+        repository: solanum-ircd/solanum
     - name: Build Solanum
       run: |
         cd $GITHUB_WORKSPACE/solanum/
@@ -46,10 +35,9 @@ jobs:
         ./configure --prefix=$HOME/.local/
         make -j 4
         make install
-
     - name: Test with pytest
-      run: |
+      run: PATH=~/.local/bin:$PATH make solanum
-        PATH=~/.local/bin:$PATH make solanum
+name: irctest with Solanum
-
+'on':
-
+  pull_request: null
-
+  push: null

.github/workflows/sopel.yml

@@ -1,37 +1,32 @@
-name: irctest with Sopel
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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:
-        path: |
-          ~/.cache
         key: ${{ runner.os }}-sopel
-
+        path: |-
+          ~/.cache
+          $GITHUB_WORKSPACE/placeholder
     - name: Install dependencies
-      run: |
+      run: |-
+        sudo apt-get install atheme-services
         python -m pip install --upgrade pip
-        pip install pytest sopel==7.0.7 -r requirements.txt
+        pip install pytest -r requirements.txt
-
+    - name: Install dependencies
+      run: pip install sopel==7.0.7
     - name: Test with pytest
-      run: |
+      run: PATH=~/.local/bin:$PATH make sopel
-        PATH=~/.local/bin:$PATH make sopel
+name: irctest with Sopel
-
+'on':
-
+  pull_request: null
+  push: null

.github/workflows/unrealircd.yml

@@ -1,44 +1,33 @@
-name: irctest with UnrealIRCd
+# This file was auto-generated by make_workflows.py.
-
+# Do not edit it manually, modifications will be lost.
-on:
-  push:
-  pull_request:
 
 jobs:
   build:
-
     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:
-        path: |
+        key: ${{ runner.os }}-unrealircd
+        path: |-
           ~/.cache
           $GITHUB_WORKSPACE/unrealircd
-        key: ${{ runner.os }}-unrealircd
-
     - name: Install dependencies
-      run: |
+      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:
-        repository: unrealircd/unrealircd
-        ref: unreal52
         path: unrealircd
-
+        ref: unreal52
+        repository: unrealircd/unrealircd
     - name: Build UnrealIRCd
       run: |
         cd $GITHUB_WORKSPACE/unrealircd/
@@ -46,9 +35,9 @@ jobs:
         CFLAGS=-O0 ./Config -quick
         make -j 4
         make install
-
     - name: Test with pytest
-      run: |
+      run: PATH=~/.local/unrealircd/bin:$PATH make unrealircd
-        PATH=~/.local/unrealircd/bin:$PATH make unrealircd
+name: irctest with UnrealIRCd
-
+'on':
-
+  pull_request: null
+  push: null

CONTRIBUTING.md

@@ -82,8 +82,11 @@ All tests should be tagged with
 
 We run automated tests on all commits and pull requests, to check that tests
 accept existing implementations.
+Scripts to run the tests are defined in `workflows.yml`, and the
+`make_workflows.py` script reads this configuration to generate files
+in `.github/workflows/` that are used by the CI.
 
-If an implementation cannot pass a test, that test should be excluded using
+If an implementation cannot pass a test, that test should be excluded via
-the `-k` argument of pytest, in both `README.md` and `.github/workflows/`.
+a definition in the Makefile.
 If it is a bug, please open a bug report to the affected software if possible,
 and link to the bug report in a comment.

make_workflows.py

@@ -0,0 +1,122 @@
+"""
+This script reads the compact workflows.yml file, and and generates files in
+.github/workflows/ suitable for the limited expressivity of GitHub's workflow
+definition language.
+
+The point is that we had/have a lot of duplications between files in
+.github/workflows/, so we use this script to make it easier to update them
+and keep them in sync.
+"""
+
+import pathlib
+
+import yaml
+
+ROOT_PATH = pathlib.Path(__file__).parent
+DEFINITION_PATH = ROOT_PATH / "workflows.yml"
+GH_WORKFLOW_DIR = ROOT_PATH / ".github" / "workflows"
+
+
+class script:
+    def __init__(self, *lines):
+        self.data = "\n".join(lines)
+
+
+def script_representer(dumper, data: script):
+    return dumper.represent_scalar("tag:yaml.org,2002:str", data.data, style="|")
+
+
+class Dumper(yaml.Dumper):
+    pass
+
+
+Dumper.add_representer(script, script_representer)
+
+
+def generate_workflow(config, software_id):
+    software_config = config["software"][software_id]
+    name = software_config["name"]
+    prefix = software_config.get("prefix", "~/.local")
+
+    if "install_steps" in software_config:
+        path = "placeholder"  # TODO: remove this
+        install_steps = software_config["install_steps"]
+    else:
+        path = software_config["path"]
+        install_steps = [
+            {
+                "name": f"Checkout {name}",
+                "uses": "actions/checkout@v2",
+                "with": {
+                    "repository": software_config["repository"],
+                    "ref": software_config["ref"],
+                    "path": path,
+                },
+            },
+            {
+                "name": f"Build {name}",
+                "run": script(software_config["build_script"]),
+            },
+        ]
+
+    workflow = {
+        "name": f"irctest with {name}",
+        "on": {"push": None, "pull_request": None},
+        "jobs": {
+            "build": {
+                "runs-on": "ubuntu-latest",
+                "steps": [
+                    {"uses": "actions/checkout@v2"},
+                    {
+                        "name": "Set up Python 3.7",  # for irctest itself
+                        "uses": "actions/setup-python@v2",
+                        "with": {"python-version": 3.7},
+                    },
+                    *software_config.get("pre_deps", []),
+                    {
+                        "name": "Cache dependencies",
+                        "uses": "actions/cache@v2",
+                        "with": {
+                            "path": script("~/.cache", f"$GITHUB_WORKSPACE/{path}"),
+                            "key": "${{ runner.os }}-" + software_id,
+                        },
+                    },
+                    {
+                        "name": "Install dependencies",
+                        "run": script(
+                            "sudo apt-get install atheme-services",
+                            "python -m pip install --upgrade pip",
+                            "pip install pytest -r requirements.txt",
+                            *(
+                                software_config["extra_deps"]
+                                if "extra_deps" in software_config
+                                else []
+                            ),
+                        ),
+                    },
+                    *install_steps,
+                    {
+                        "name": "Test with pytest",
+                        "run": f"PATH={prefix}/bin:$PATH make {software_id}",
+                    },
+                ],
+            }
+        },
+    }
+
+    with open(GH_WORKFLOW_DIR / f"{software_id}.yml", "wt") as fd:
+        fd.write("# This file was auto-generated by make_workflows.py.\n")
+        fd.write("# Do not edit it manually, modifications will be lost.\n\n")
+        fd.write(yaml.dump(workflow, Dumper=Dumper))
+
+
+def main():
+    with open(DEFINITION_PATH) as fd:
+        config = yaml.load(fd, Loader=yaml.Loader)
+
+    for software_id in config["software"]:
+        generate_workflow(config, software_id)
+
+
+if __name__ == "__main__":
+    main()

workflows.yml

@@ -0,0 +1,87 @@
+# Input used by make_workflows.py to generate .github/workflows/
+
+software:
+    #############################
+    # Charybdis family:
+    charybdis:
+        name: Charybdis
+        repository: charybdis-ircd/charybdis
+        ref: charybdis-4.1.2
+        path: charybdis
+        build_script: |
+            cd $GITHUB_WORKSPACE/charybdis/
+            ./autogen.sh
+            ./configure --prefix=$HOME/.local/
+            make -j 4
+            make install
+
+    solanum:
+        name: Solanum
+        repository: solanum-ircd/solanum
+        ref: e370888264da666a1bd9faac86cd5f2aa06084f4
+        path: solanum
+        build_script: |
+            cd $GITHUB_WORKSPACE/solanum/
+            ./autogen.sh
+            ./configure --prefix=$HOME/.local/
+            make -j 4
+            make install
+
+    #############################
+    # Other servers:
+    ergo:
+        name: Ergo
+        repository: ergochat/ergo
+        ref: irctest_stable
+        path: ergo
+        prefix: ~/go
+        pre_deps:
+            - uses: actions/setup-go@v2
+              with:
+                  go-version: '~1.16'
+            - run: go version
+        build_script: |
+            cd $GITHUB_WORKSPACE/ergo/
+            make build
+            make install
+
+    inspircd:
+        name: InspIRCd
+        repository: inspircd/inspircd
+        ref: v3.8.1
+        path: inspircd
+        prefix: ~/.local/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
+
+    unrealircd:
+        name: UnrealIRCd
+        repository: unrealircd/unrealircd
+        ref: unreal52
+        path: unrealircd
+        prefix: ~/.local/unrealircd
+        build_script: |
+            cd $GITHUB_WORKSPACE/unrealircd/
+            cp $GITHUB_WORKSPACE/unreal/* .
+            CFLAGS=-O0 ./Config -quick
+            make -j 4
+            make install
+
+    #############################
+    # Clients:
+
+    limnoria:
+        name: Limnoria
+        install_steps:
+            - name: Install dependencies
+              run: pip install limnoria==2021.01.15 cryptography
+
+    sopel:
+        name: Sopel
+        install_steps:
+            - name: Install dependencies
+              run: pip install sopel==7.0.7