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
          - 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: aarch64-apple-darwin
            os: macos-latest
          - host_target: i686-pc-windows-msvc
            os: windows-latest
    runs-on: ${{ matrix.os }}
    env:
      HOST_TARGET: ${{ matrix.host_target }}
    steps:
      - uses: actions/checkout@v4
      - name: install qemu
        if: ${{ matrix.qemu }}
        run: sudo apt install qemu-user qemu-user-binfmt
      - name: install multiarch
        if: ${{ matrix.multiarch != '' }}
        run: |
          # s390x, ppc64el 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-proxy
        run: cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r24.10.04
      - 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: get changes from rustc
        run: ./miri rustc-pull
      - name: Install rustup-toolchain-install-master
        run: cargo install -f rustup-toolchain-install-master
      - name: format changes (if any)
        run: |
          ./miri toolchain
          ./miri fmt --check || (./miri fmt && git commit -am "fmt")
      - name: Push changes to a branch and create PR
        run: |
          # `git diff --exit-code` "succeeds" if the diff is empty.
          if git diff --exit-code HEAD^; then echo "Nothing changed in rustc, skipping PR"; exit 0; fi
          # The diff is non-empty, 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 'Please close and re-open this PR to trigger CI, then enable auto-merge.'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          ZULIP_BOT_EMAIL: ${{ secrets.ZULIP_BOT_EMAIL }}
          ZULIP_API_TOKEN: ${{ secrets.ZULIP_API_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 [`./miri rustc-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'