shotover-proxy/.github/workflows/build_and_test.yaml at 6934c1cf36fa39f5cb20bd7a8cc5802ec7109a2e · rukai/shotover-proxy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
name: Build and Test

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

# Cancel already running jobs
concurrency:
  group: build_and_test_${{ github.head_ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1

jobs:
  build_check_and_upload:
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: Build Release
            runner: ubuntu-24.04
            cargo_flags: --release
            profile: release

          - name: Build Debug
            runner: ubuntu-24.04
            cargo_flags:
            profile: debug

    name: ${{ matrix.name }}
    runs-on: ${{ matrix.runner }}
    steps:
      - uses: actions/checkout@v4
      - uses: Swatinem/rust-cache@v2
        with:
          # rust-cache already handles all the sane defaults for caching rust builds.
          # However because we are running seperate debug/release builds in parallel,
          # we also need to add the runner and cargo_flags to the key so that a seperate cache is used.
          # Otherwise only the last build to finish would get saved to the cache.
          # We allow different test_flags to share a cache as they should have identical build outputs
          key: ${{ matrix.runner }} - ${{ matrix.cargo_flags }}

          # this line means that only the main branch writes to the cache
          # benefits:
          # * prevents main branch caches from being evicted in favor of a PR cache
          # * saves about 1min per workflow by skipping the actual cache write
          # downsides:
          # * PRs that update rust version or changes deps will be slow to iterate on due to changes not being cached.
          save-if: ${{ github.ref == 'refs/heads/main' }}
          # Additionally, the main builds should always run without cache to avoid accumulating unused build files across builds.
          # Usually, this isnt a problem because rust-cache only caches dependencies, not our project.
          # However, in this case we have enabled cache-all-crates, which forces rust-cache to cache our projects build files as well as the dependencies.
          lookup-only: ${{ github.ref == 'refs/heads/main' }}

          # Our workspace contains crates like test-helpers that are only changed sometimes,
          # so enabling this gives a nice speedup at the cost of extra cache storage.
          cache-all-crates: "true"
          cache-workspace-crates: "true"
      # If we cache the j4rs build as done above in the rust-cache action, we also need to cache the jassets directory created by j4rs.
      # Even though the rust-cache action caches the target directory, it ignores non-standard folders inside it, so we need to manually cache jassets seperately.
      #
      # Note that: evicting this cache without evicting the rust-cache will lead to CI failures, however as long as our caches are well within the 10GB limit we should be fine.
      - name: Cache jassets
        uses: actions/cache/restore@v5
        with:
          path: target/${{ matrix.profile }}/jassets
          # cache can be global as java assets work regardless of OS+arch
          key: jassets-${{ hashFiles('Cargo.lock') }}
          restore-keys: jassets-
      - name: cache custom ubuntu packages
        uses: actions/cache@v5
        with:
          path: shotover-proxy/build/packages
          key: ubuntu-24.04-packages
      - run: tree target
      - name: Install ubuntu packages
        run: shotover-proxy/build/install_ubuntu_packages.sh
      - name: Install nextest
        uses: taiki-e/install-action@v2
        with:
          tool: nextest@0.9.129
      - name: Build tests
        run: cargo nextest archive --archive-file nextest-${{ matrix.profile }}.tar.zst ${{ matrix.cargo_flags }} --all-features --all-targets
      - name: Upload built tests to workflow
        uses: actions/upload-artifact@v4
        with:
          name: nextest-${{ matrix.profile }}
          path: nextest-${{ matrix.profile }}.tar.zst
      - name: Report disk usage
        run: |
          df -h

          echo -e "\ntarget dir usage:"
          du -h $PWD/target

          echo -e "\n.cargo dir usage:"
          du -h ~/.cargo
      - name: Cleanup archive
        run: rm nextest-${{ matrix.profile }}.tar.zst
      - name: Ensure that tests did not create or modify any files that arent .gitignore'd
        run: |
          if [ -n "$(git status --porcelain)" ]; then
            git status
            exit 1
          fi
      - name: Save jassets cache
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: actions/cache/save@v5
        with:
          path: target/${{ matrix.profile }}/jassets
          key: jassets-${{ hashFiles('foo/Cargo.lock') }}

  run_tests_partitioned:
    strategy:
      fail-fast: false
      matrix:
        partition: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
        profile: [ "release", "debug" ]
    name: Test ${{ matrix.profile}} ${{ matrix.partition }}/15
    runs-on: ubuntu-24.04
    needs: build_check_and_upload
    steps:
      - uses: actions/checkout@v4
      - name: cache custom ubuntu packages
        uses: actions/cache@v4
        with:
          path: shotover-proxy/build/packages
          key: ubuntu-24.04-packages
      - name: Install ubuntu packages
        run: shotover-proxy/build/install_ubuntu_packages.sh
      - name: Install nextest
        uses: taiki-e/install-action@v2
        with:
          tool: nextest@0.9.70
      - run: mkdir -p ~/.cargo/bin
      - name: Download archive
        uses: actions/download-artifact@v4
        with:
          name: nextest-${{ matrix.profile }}
      - name: Run tests
        run: |
          ~/.cargo/bin/cargo-nextest nextest run --archive-file nextest-${{ matrix.profile }}.tar.zst \
            --partition count:${{ matrix.partition }}/15 --extract-to . --run-ignored all --success-output=immediate
      - name: Cleanup archive
        run: rm nextest-${{ matrix.profile }}.tar.zst
      - name: Ensure that tests did not create or modify any files that arent .gitignore'd
        run: |
          if [ -n "$(git status --porcelain)" ]; then
            git status
            exit 1
          fi