about summary refs log tree commit diff
path: root/src/tools/miri/.github/workflows/ci.yml
blob: e1a948c92faa4426bffd61246a2aa4fc75177c05 (plain)
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
name: CI

on:
  merge_group:
  pull_request:
    branches:
      - 'master'
  schedule:
    - cron: '44 4 * * *' # At 4:44 UTC every day.

defaults:
  run:
    shell: bash

jobs:
  test:
    name: test (${{ matrix.host_target }})
    strategy:
      fail-fast: false
      matrix:
        include:
          - host_target: x86_64-unknown-linux-gnu
            os: ubuntu-latest
          - host_target: i686-unknown-linux-gnu
            os: ubuntu-latest
            multiarch: i386
            gcc_cross: i686-linux-gnu
          - host_target: aarch64-unknown-linux-gnu
            os: ubuntu-24.04-arm
          - host_target: armv7-unknown-linux-gnueabihf
            os: ubuntu-24.04-arm
            multiarch: armhf
            gcc_cross: arm-linux-gnueabihf
          # Disabled due to Ubuntu repo trouble
          # - host_target: riscv64gc-unknown-linux-gnu
          #   os: ubuntu-latest
          #   multiarch: riscv64
          #   gcc_cross: riscv64-linux-gnu
          #   qemu: true
          # - host_target: s390x-unknown-linux-gnu
          #   os: ubuntu-latest
          #   multiarch: s390x
          #   gcc_cross: s390x-linux-gnu
          #   qemu: true
          # - host_target: powerpc64le-unknown-linux-gnu
          #   os: ubuntu-latest
          #   multiarch: ppc64el
          #   gcc_cross: powerpc64le-linux-gnu
          #   qemu: true
          - host_target: aarch64-apple-darwin
            os: macos-latest
          - host_target: i686-pc-windows-msvc
            os: windows-latest
          - host_target: aarch64-pc-windows-msvc
            os: windows-11-arm
    runs-on: ${{ matrix.os }}
    env:
      HOST_TARGET: ${{ matrix.host_target }}
    steps:
      - uses: actions/checkout@v4
      - name: apt update
        if: ${{ startsWith(matrix.os, 'ubuntu') }}
        # The runners seem to have outdated apt repos sometimes
        run: sudo apt update
      - name: install qemu
        if: ${{ matrix.qemu }}
        run: sudo apt install qemu-user qemu-user-binfmt
      - name: install multiarch
        if: ${{ matrix.multiarch != '' }}
        run: |
          # s390x, ppc64el, riscv64 need Ubuntu Ports to be in the mirror list
          sudo bash -c "echo 'https://ports.ubuntu.com/	priority:4' >> /etc/apt/apt-mirrors.txt"
          # Add architecture
          sudo dpkg --add-architecture ${{ matrix.multiarch }}
          sudo apt update
          # Install needed packages
          sudo apt install $(echo "libatomic1: zlib1g-dev:" | sed 's/:/:${{ matrix.multiarch }}/g')
      - uses: ./.github/workflows/setup
        with:
          toolchain_flags: "--host ${{ matrix.host_target }}"

      # We set up the cross-compiler *after* the basic setup as setting CC would otherwise
      # cause confusion.
      - name: install gcc-cross
        if: ${{ matrix.gcc_cross != '' }}
        run: |
          sudo apt install gcc-${{ matrix.gcc_cross }}
          echo "Setting environment variables:"
          echo "CC_${{ matrix.host_target }}=${{ matrix.gcc_cross }}-gcc" | tee -a $GITHUB_ENV
          TARGET_UPPERCASE=$(echo ${{ matrix.host_target }} | tr '[:lower:]-' '[:upper:]_')
          echo "CARGO_TARGET_${TARGET_UPPERCASE}_LINKER=${{ matrix.gcc_cross }}-gcc" | tee -a $GITHUB_ENV

      # The main test job! We don't run this in qemu as that is quite slow,
      # so those targets only get the clippy check below.
      - name: test Miri
        if: ${{ !matrix.qemu }}
        run: ./ci/ci.sh

      # The `style` job only runs on Linux; this makes sure the host-specific
      # code is also covered by clippy.
      - name: clippy
        run: ./miri clippy -- -D warnings

  style:
    name: style checks
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/workflows/setup

      - name: rustfmt
        run: ./miri fmt --check
      - name: clippy (no features)
        run: ./miri clippy --no-default-features -- -D warnings
      - name: clippy (all features)
        run: ./miri clippy --all-features -- -D warnings
      - name: rustdoc
        run: RUSTDOCFLAGS="-Dwarnings" ./miri doc --document-private-items

  coverage:
    name: coverage report
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/workflows/setup
      - name: coverage
        run: ./miri test --coverage

  # Summary job for the merge queue.
  # ALL THE PREVIOUS JOBS NEED TO BE ADDED TO THE `needs` SECTION OF THIS JOB!
  # And they should be added below in `cron-fail-notify` as well.
  conclusion:
    needs: [test, style, coverage]
    # We need to ensure this job does *not* get skipped if its dependencies fail,
    # because a skipped job is considered a success by GitHub. So we have to
    # overwrite `if:`. We use `!cancelled()` to ensure the job does still not get run
    # when the workflow is canceled manually.
    if: ${{ !cancelled() }}
    runs-on: ubuntu-latest
    steps:
      # Manually check the status of all dependencies. `if: failure()` does not work.
      - name: Conclusion
        run: |
            # Print the dependent jobs to see them in the CI log
            jq -C <<< '${{ toJson(needs) }}'
            # Check if all jobs that we depend on (in the needs array) were successful.
            jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'

  cron-rustc-pull:
    name: automatic pull from rustc
    runs-on: ubuntu-latest
    permissions:
        # The cronjob needs to be able to push to the repo...
        contents: write
        # ... and create a PR.
        pull-requests: write
    if: ${{ github.event_name == 'schedule' }}
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 256 # get a bit more of the history
      - name: install josh-sync
        run: cargo +stable install --locked --git https://github.com/rust-lang/josh-sync
      - name: setup bot git name and email
        run: |
          git config --global user.name 'The Miri Cronjob Bot'
          git config --global user.email 'miri@cron.bot'
      - name: Install nightly toolchain
        run: rustup toolchain install nightly --profile minimal
      - name: Install rustup-toolchain-install-master
        run: cargo install -f rustup-toolchain-install-master
      # Create a token for the next step so it can create a PR that actually runs CI.
      - uses: actions/create-github-app-token@v2
        id: app-token
        with:
          app-id: ${{ vars.APP_CLIENT_ID }}
          private-key: ${{ secrets.APP_PRIVATE_KEY }}
      - name: pull changes from rustc and create PR
        run: |
          # Make it easier to see what happens.
          set -x
          # Temporarily disable early exit to examine the status code of rustc-josh-sync
          set +e
          rustc-josh-sync pull
          exitcode=$?
          set -e

          # If there were no changes to pull, rustc-josh-sync returns status code 2.
          # In that case, skip the rest of the job.
          if [ $exitcode -eq 2 ]; then
            echo "Nothing changed in rustc, skipping PR"
            exit 0
          elif [ $exitcode -ne 0 ]; then
            # If return code was not 0 or 2, rustc-josh-sync actually failed
            echo "error: rustc-josh-sync failed"
            exit ${exitcode}
          fi

          # Format changes
          ./miri toolchain
          ./miri fmt --check || (./miri fmt && git commit -am "fmt")

          # Create a PR
          BRANCH="rustup-$(date -u +%Y-%m-%d)"
          git switch -c $BRANCH
          git push -u origin $BRANCH
          gh pr create -B master --title 'Automatic Rustup' --body "Update \`rustc\` to https://github.com/rust-lang/rust/commit/$(cat rust-version)."
        env:
          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}

  cron-fail-notify:
    name: cronjob failure notification
    runs-on: ubuntu-latest
    needs: [test, style, coverage]
    if: ${{ github.event_name == 'schedule' && failure() }}
    steps:
      # Send a Zulip notification
      - name: Install zulip-send
        run: pip3 install zulip
      - name: Send Zulip notification
        env:
          ZULIP_BOT_EMAIL: ${{ secrets.ZULIP_BOT_EMAIL }}
          ZULIP_API_TOKEN: ${{ secrets.ZULIP_API_TOKEN }}
        run: |
          ~/.local/bin/zulip-send --user $ZULIP_BOT_EMAIL --api-key $ZULIP_API_TOKEN --site https://rust-lang.zulipchat.com \
            --stream miri --subject "Miri Build Failure ($(date -u +%Y-%m))" \
            --message 'Dear @*T-miri*,

          It would appear that the [Miri cron job build]('"https://github.com/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"') failed.

          This likely means that rustc changed the miri directory and
          we now need to do a [`rustc-josh-sync pull`](https://github.com/rust-lang/miri/blob/master/CONTRIBUTING.md#importing-changes-from-the-rustc-repo).

          Would you mind investigating this issue?

          Thanks in advance!
          Sincerely,
          The Miri Cronjobs Bot'