Tooling (#491)

* Tooling updates (#15572) Co-authored-by: TiviPlus <[email protected]> Co-authored-by: Barnet <[email protected]> * 3213 * somesome * ahh * som_ert * mm * sounds * fuck you * back it * no cam * no max * bruuuh * EMPTY_BLOCK_GUARD * EMPTY_BLOCK_GUARD_2 * oscarnorthvar1 * oscarnorthvar2 * deltastation * orionoutpost * stand * whiskey * end * lock_flags * /area/barren/cave * oscar * slum * icy * ughh * slam * lavanka * icu 222 * again * /area/barren * stand * delta * ... * ... * ... * final? * ... * ... * ... * nahu * aaaaaaaaa * stone * FEEDBACK_TEXT --------- Signed-off-by: homexp13 <[email protected]> Co-authored-by: TiviPlus <[email protected]> Co-authored-by: TiviPlus <[email protected]> Co-authored-by: Barnet <[email protected]> Co-authored-by: Xander3359 <[email protected]>
PMC-Unga-Marines · Oct 10, 2024 · f77cbfe · f77cbfe
1 parent 5c87137
commit f77cbfe
Show file tree

Hide file tree

Showing 126 changed files with 4,677 additions and 225,077 deletions.
diff --git a/.github/alternate_byond_versions.txt b/.github/alternate_byond_versions.txt
@@ -0,0 +1,7 @@
+# This file contains extra tests to run for specific BYOND versions.
+# This is useful for making sure we maintain compatibility with both older and newer versions,
+# while still having our main tests run on a guaranteed pinned version.
+
+# Format is version: map
+# Example:
+# 500.1337: runtimestation
diff --git a/.github/max_required_byond_client.txt b/.github/max_required_byond_client.txt
@@ -0,0 +1,8 @@
+# Highest byond client version allowed to be required by the byond world. Set to 9999 to disable the check flat out.
+# If the compiled world requires clients use a version higher than this, ci will fail.
+#   for instance: if this is set to 514, and a pr uses a 515 client feature, an alert will trigger
+# If you have to update this number for your pr, you should make it VERY CLEAR in the pr body that you did so.
+#   (Requiring clients update to connect to the game server is not something we like to spring on them with no notice, 
+#   especially for beta builds where the pager/updater won't let them update without additional configuration.)
+
+514
diff --git a/.github/workflows/ci_suite.yml b/.github/workflows/ci_suite.yml
@@ -3,129 +3,236 @@ on:
   push:
     branches:
     - master
+    - 'project/**'
+    - 'gh-readonly-queue/master/**'
+    - 'gh-readonly-queue/project/**'
   pull_request:
     branches:
     - master
+    - 'project/**'
+  merge_group:
+    branches:
+    - master
 jobs:
   run_linters:
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') )
     name: Run Linters
     runs-on: ubuntu-22.04
+    concurrency:
+      group: run_linters-${{ github.head_ref || github.run_id }}
+      cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Restore SpacemanDMM cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: $HOME/SpacemanDMM
-          key: ${{ runner.os }}-spacemandmm
+          path: ~/SpacemanDMM
+          key: ${{ runner.os }}-spacemandmm-${{ hashFiles('dependencies.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-spacemandmm-
       - name: Restore Yarn cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: tgui/.yarn/cache
-          key: ${{ runner.os }}-yarn-${{ secrets.CACHE_PURGE_KEY }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('tgui/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Restore Node cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.nvm
+          key: ${{ runner.os }}-node-${{ hashFiles('dependencies.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Restore Bootstrap cache
+        uses: actions/cache@v4
+        with:
+          path: tools/bootstrap/.cache
+          key: ${{ runner.os }}-bootstrap-${{ hashFiles('tools/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-bootstrap-
+      - name: Restore Rust cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo
+          key: ${{ runner.os }}-rust-${{ hashFiles('tools/ci/ci_dependencies.sh')}}
+          restore-keys: |
+            ${{ runner.os }}-rust-
+      - name: Install OpenDream
+        uses: robinraju/[email protected]
+        with:
+          repository: "OpenDreamProject/OpenDream"
+          tag: "latest"
+          fileName: "DMCompiler_linux-x64.tar.gz"
+          extract: true
       - name: Install Tools
         run: |
           pip3 install setuptools
-          bash tools/ci/install_pcregrep.sh
           bash tools/ci/install_node.sh
           bash tools/ci/install_spaceman_dmm.sh dreamchecker
+          bash tools/ci/install_ripgrep.sh
           tools/bootstrap/python -c ''
-      - name: Run Linters
+      - name: Give Linters A Go
+        id: linter-setup
+        run: ':'
+      - name: Run Grep Checks
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: bash tools/ci/check_grep.sh
+      - name: Ticked File Enforcement
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: |
+          tools/bootstrap/python tools/ticked_file_enforcement/ticked_file_enforcement.py < tools/ticked_file_enforcement/schemas/tgmc_dme.json
+          tools/bootstrap/python tools/ticked_file_enforcement/ticked_file_enforcement.py < tools/ticked_file_enforcement/schemas/unit_tests.json
+      - name: Run DreamChecker
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        shell: bash
+        run: ~/dreamchecker 2>&1 | bash tools/ci/annotate_dm.sh
+      - name: Run OpenDream
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: ./DMCompiler_linux-x64/DMCompiler tgmc.dme --suppress-unimplemented --define=CIBUILDING | bash tools/ci/annotate_od.sh
+      - name: Run Map Checks
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
         run: |
-          bash tools/ci/check_filedirs.sh tgmc.dme
-          bash tools/ci/check_changelogs.sh
-          bash tools/ci/check_grep.sh
-          bash tools/ci/check_misc.sh
-          tools/bootstrap/python -m tools.maplint.source
-          tools/build/build --ci lint tgui-test
-          tools/bootstrap/python -m dmi.test
           tools/bootstrap/python -m mapmerge2.dmm_test
-          ~/dreamchecker > ${GITHUB_WORKSPACE}/output-annotations.txt 2>&1
-      - name: Annotate Lints
-        uses: yogstation13/DreamAnnotate@v2
-        if: always()
-        with:
-          outputFile: output-annotations.txt
+          tools/bootstrap/python -m tools.maplint.source
+      - name: Run DMI Tests
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: tools/bootstrap/python -m dmi.test
+      - name: Check File Directories
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: bash tools/ci/check_filedirs.sh tgmc.dme
+      - name: Check Changelogs
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: bash tools/ci/check_changelogs.sh
+      - name: Check Miscellaneous Files
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: bash tools/ci/check_misc.sh
+      - name: Run TGUI Checks
+        if: steps.linter-setup.conclusion == 'success' && !cancelled()
+        run: tools/build/build --ci lint tgui-test
 
   compile_all_maps:
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') )
     name: Compile Maps
-    runs-on: ubuntu-20.04
+    needs: [collect_data]
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: compile_all_maps-${{ github.head_ref || github.run_id }}
+      cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Restore BYOND cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: $HOME/BYOND
-          key: ${{ runner.os }}-byond
+          path: ~/BYOND
+          key: ${{ runner.os }}-byond-${{ hashFiles('dependencies.sh') }}
       - name: Compile All Maps
         run: |
           bash tools/ci/install_byond.sh
           source $HOME/BYOND/byond/bin/byondsetup
           tools/build/build --ci dm -DCIBUILDING -DCITESTING -DALL_MAPS
+      - name: Check client Compatibility
+        uses: tgstation/byond-client-compatibility-check@v3
+        with:
+          dmb-location: tgmc.dmb
+          max-required-client-version: ${{needs.collect_data.outputs.max_required_byond_client}}
 
-  run_all_tests:
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
-    name: Integration Tests
-    runs-on: ubuntu-20.04
-    services:
-      mysql:
-        image: mysql:latest
-        env:
-          MYSQL_ROOT_PASSWORD: root
-        ports:
-          - 3306
-        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+  collect_data:
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') )
+    name: Collect data for other tasks
+    runs-on: ubuntu-22.04
+    outputs:
+      maps: ${{ steps.map_finder.outputs.maps }}
+      alternate_tests: ${{ steps.alternate_test_finder.outputs.alternate_tests }}
+      max_required_byond_client: ${{ steps.max_required_byond_client.outputs.max_required_byond_client }}
+    concurrency:
+      group: find_all_maps-${{ github.head_ref || github.run_id }}
+      cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v3
-      - name: Setup cache
-        uses: actions/cache@v3
-        with:
-          path: $HOME/BYOND
-          key: ${{ runner.os }}-byond
-      - name: Setup database
+      - uses: actions/checkout@v4
+      - name: Find Maps
+        id: map_finder
         run: |
-          sudo systemctl start mysql
-          mysql -u root -proot -e 'CREATE DATABASE tg_ci;'
-          mysql -u root -proot tg_ci < SQL/tgmc-schema.sql
-          mysql -u root -proot -e 'CREATE DATABASE tg_ci_prefixed;'
-      - name: Install rust-g
+          echo "$(ls -mw0 _maps/*.json)" > maps_output.txt
+          sed -i -e s+_maps/+\"+g -e s+.json+\"+g maps_output.txt
+          echo "Maps: $(cat maps_output.txt)"
+          echo "maps={\"paths\":[$(cat maps_output.txt)]}" >> $GITHUB_OUTPUT
+      - name: Find Alternate Tests
+        id: alternate_test_finder
         run: |
-          bash tools/ci/install_rust_g.sh
-      - name: Compile and run tests
+          ALTERNATE_TESTS_JSON=$(jq -nRc '[inputs | capture("^(?<major>[0-9]+)\\.(?<minor>[0-9]+): (?<map>.+)$")]' .github/alternate_byond_versions.txt)
+          echo "alternate_tests=$ALTERNATE_TESTS_JSON" >> $GITHUB_OUTPUT
+      - name: Collect byond client version configuration
+        id: max_required_byond_client
+        #the regex here does not filter out non-numbers because error messages about no input are less helpful then error messages about bad input (which includes the bad input)
         run: |
-          bash tools/ci/install_byond.sh
-          source $HOME/BYOND/byond/bin/byondsetup
-          tools/build/build --ci -DCIBUILDING
-          bash tools/ci/run_server.sh
+          echo "max_required_byond_client=$(grep -Ev '^[[:blank:]]{0,}#{1,}|^[[:blank:]]{0,}$' .github/max_required_byond_client.txt | tail -n1)" >> $GITHUB_OUTPUT
+
+  run_all_tests:
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') )
+    name: Integration Tests
+    needs: [collect_data]
+    strategy:
+      fail-fast: false
+      matrix:
+        map: ${{ fromJSON(needs.collect_data.outputs.maps).paths }}
+    concurrency:
+      group: run_all_tests-${{ github.head_ref || github.run_id }}-${{ matrix.map }}
+      cancel-in-progress: true
+    uses: ./.github/workflows/run_integration_tests.yml
+    with:
+      map: ${{ matrix.map }}
+      max_required_byond_client: ${{needs.collect_data.outputs.max_required_byond_client}}
+
+  run_alternate_tests:
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') && needs.collect_data.outputs.alternate_tests != '[]' )
+    name: Alternate Tests
+    needs: [collect_data]
+    strategy:
+      fail-fast: false
+      matrix:
+        setup: ${{ fromJSON(needs.collect_data.outputs.alternate_tests) }}
+    concurrency:
+      group: run_all_tests-${{ github.head_ref || github.run_id }}-${{ matrix.setup.major }}.${{ matrix.setup.minor }}-${{ matrix.setup.map }}
+      cancel-in-progress: true
+    uses: ./.github/workflows/run_integration_tests.yml
+    with:
+      map: ${{ matrix.setup.map }}
+      major: ${{ matrix.setup.major }}
+      minor: ${{ matrix.setup.minor }}
+      max_required_byond_client: ${{needs.collect_data.outputs.max_required_byond_client}}
+
+  check_alternate_tests:
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') && needs.collect_data.outputs.alternate_tests != '[]' )
+    name: Check Alternate Tests
+    needs: [run_alternate_tests]
+    runs-on: ubuntu-22.04
+    steps:
+      - run: echo Alternate tests passed.
 
   test_windows:
-    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    if: ( !contains(github.event.head_commit.message, '[ci skip]') )
     name: Windows Build
+    needs: [collect_data]
     runs-on: windows-latest
     concurrency:
       group: test_windows-${{ github.head_ref || github.run_id }}
       cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Restore Yarn cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: tgui/.yarn/cache
           key: ${{ runner.os }}-yarn-${{ hashFiles('tgui/yarn.lock') }}
           restore-keys: |
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
+            ${{ runner.os }}-yarn-
       - name: Compile
         run: pwsh tools/ci/build.ps1
         env:
           DM_EXE: "C:\\byond\\bin\\dm.exe"
-      - name: Create artifact
-        run: |
-          md deploy
-          bash tools/deploy.sh ./deploy
-      - name: Deploy artifact
-        uses: actions/upload-artifact@v3
+      - name: Check client Compatibility
+        uses: tgstation/byond-client-compatibility-check@v3
         with:
-          name: deploy
-          path: deploy
+          dmb-location: tgmc.dmb
+          max-required-client-version: ${{needs.collect_data.outputs.max_required_byond_client}}
diff --git a/.github/workflows/run_integration_tests.yml b/.github/workflows/run_integration_tests.yml
@@ -0,0 +1,72 @@
+# This is a reusable workflow to run integration tests on a single map.
+# This is run for every single map in ci_suite.yml. You might want to edit that instead.
+name: Run Integration Tests
+on:
+  workflow_call:
+    inputs:
+      map:
+        required: true
+        type: string
+      major:
+        required: false
+        type: string
+      minor:
+        required: false
+        type: string
+      max_required_byond_client:
+        required: true
+        type: string
+jobs:
+  run_integration_tests:
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:latest
+        env:
+          MYSQL_ROOT_PASSWORD: root
+        ports:
+          - 3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+    steps:
+      - uses: actions/checkout@v4
+      - name: Restore BYOND cache
+        uses: actions/cache@v4
+        with:
+          path: ~/BYOND
+          key: ${{ runner.os }}-byond-${{ hashFiles('dependencies.sh') }}
+      - name: Setup database
+        run: |
+          sudo systemctl start mysql
+          mysql -u root -proot -e 'CREATE DATABASE tg_ci;'
+          mysql -u root -proot tg_ci < SQL/tgmc-schema.sql
+      - name: Install rust-g
+        run: |
+          bash tools/ci/install_rust_g.sh
+      - name: Configure version
+        run: |
+          echo "BYOND_MAJOR=${{ inputs.major }}" >> $GITHUB_ENV
+          echo "BYOND_MINOR=${{ inputs.minor }}" >> $GITHUB_ENV
+        if: ${{ inputs.major }}
+      - name: Compile Tests
+        id: compile_tests
+        run: |
+          bash tools/ci/install_byond.sh
+          source $HOME/BYOND/byond/bin/byondsetup
+          tools/build/build --ci dm -DCIBUILDING -DANSICOLORS -WError -NWTG0001
+      - name: Run Tests
+        run: |
+          source $HOME/BYOND/byond/bin/byondsetup
+          bash tools/ci/run_server.sh ${{ inputs.map }}
+      - name: Upload screenshot tests
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test_artifacts_${{ inputs.map }}_${{ inputs.major }}_${{ inputs.minor }}
+          path: data/screenshots_new/
+          retention-days: 1
+      - name: Check client Compatibility
+        if: always() && steps.compile_tests.outcome == 'success'
+        uses: tgstation/byond-client-compatibility-check@v3
+        with:
+          dmb-location: tgmc.dmb
+          max-required-client-version: ${{inputs.max_required_byond_client}}