RustPython/.github/workflows/ci.yaml

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

name: CI

# Cancel previous workflows if they are the same workflow on same ref (branch/tags)
# with the same event (push/pull_request) even they are in progress.
# This setting will help reduce the number of duplicated workflows.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
  cancel-in-progress: true

env:
  CARGO_ARGS: --no-default-features --features stdlib,zlib,importlib,encodings,ssl,jit
  NON_WASM_PACKAGES: >-
    -p rustpython-bytecode
    -p rustpython-common
    -p rustpython-compiler
    -p rustpython-parser
    -p rustpython-vm
    -p rustpython-stdlib
    -p rustpython-jit
    -p rustpython-derive
    -p rustpython
  PLATFORM_INDEPENDENT_TESTS: >-
    test_argparse
    test_array
    test_asyncgen
    test_binop
    test_bisect
    test_bool
    test_bytes
    test_call
    test_class
    test_cmath
    test_collections
    test_complex
    test_contains
    test_copy
    test_dataclasses
    test_decimal
    test_decorators
    test_defaultdict
    test_deque
    test_dict
    test_dictcomps
    test_dictviews
    test_dis
    test_enumerate
    test_exception_variations
    test_exceptions
    test_float
    test_format
    test_fractions
    test_genericalias
    test_genericclass
    test_grammar
    test_range
    test_index
    test_int
    test_int_literal
    test_isinstance
    test_iter
    test_iterlen
    test_itertools
    test_json
    test_keyword
    test_keywordonlyarg
    test_list
    test_long
    test_longexp
    test_math
    test_operator
    test_ordered_dict
    test_pow
    test_raise
    test_richcmp
    test_scope
    test_set
    test_slice
    test_sort
    test_string
    test_string_literals
    test_strtod
    test_structseq
    test_subclassinit
    test_super
    test_syntax
    test_tuple
    test_types
    test_unary
    test_unicode
    test_unpack
    test_weakref
    test_yield_from

jobs:
  rust_tests:
    env:
      RUST_BACKTRACE: full
    name: Run rust tests
    needs: lalrpop
    runs-on:  ${{ matrix.os }}
    strategy:
      matrix:
        os: [macos-latest, ubuntu-latest, windows-latest]
      fail-fast: false
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}
      - uses: dtolnay/rust-toolchain@stable
      - name: Set up the Windows environment
        shell: bash
        run: |
          choco install llvm openssl
          echo "OPENSSL_DIR=C:\Program Files\OpenSSL-Win64" >>$GITHUB_ENV
        if: runner.os == 'Windows'
      - name: Set up the Mac environment
        run: brew install autoconf automake libtool
        if: runner.os == 'macOS'
      - uses: Swatinem/rust-cache@v1
      - name: run rust tests
        run: cargo test --workspace --exclude rustpython_wasm --verbose --features threading ${{ env.CARGO_ARGS }} ${{ env.NON_WASM_PACKAGES }}
      - name: check compilation without threading
        run: cargo check ${{ env.CARGO_ARGS }}

      - name: prepare AppleSilicon build
        uses: dtolnay/rust-toolchain@stable
        with:
          target: aarch64-apple-darwin
        if: runner.os == 'macOS'
      - name: Check compilation for Apple Silicon
        run: cargo check --target aarch64-apple-darwin
        if: runner.os == 'macOS'
      - name: prepare iOS build
        uses: dtolnay/rust-toolchain@stable
        with:
          target: aarch64-apple-ios
        if: runner.os == 'macOS'
      - name: Check compilation for iOS
        run: cargo check --target aarch64-apple-ios
        if: runner.os == 'macOS'

  exotic_targets:
    name: Ensure compilation on various targets
    needs: lalrpop
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}

      - uses: dtolnay/rust-toolchain@stable
        with:
          target: i686-unknown-linux-gnu

      - name: Install gcc-multilib and musl-tools
        run: sudo apt-get update && sudo apt-get install gcc-multilib musl-tools
      - name: Check compilation for x86 32bit
        run: cargo check --target i686-unknown-linux-gnu

      - uses: dtolnay/rust-toolchain@stable
        with:
          target: aarch64-linux-android

      - name: Check compilation for android
        run: cargo check --target aarch64-linux-android

      - uses: dtolnay/rust-toolchain@stable
        with:
          target: i686-unknown-linux-musl

      - name: Check compilation for musl
        run: cargo check --target i686-unknown-linux-musl

      - uses: dtolnay/rust-toolchain@stable
        with:
          target: x86_64-unknown-freebsd

      - name: Check compilation for freebsd
        run: cargo check --target x86_64-unknown-freebsd

      - uses: dtolnay/rust-toolchain@stable
        with:
          target: wasm32-unknown-unknown

      - name: Check compilation for wasm32
        run: cargo check --target wasm32-unknown-unknown --no-default-features

      - uses: dtolnay/rust-toolchain@stable
        with:
          target: x86_64-unknown-freebsd

      - name: Check compilation for freeBSD
        run: cargo check --target x86_64-unknown-freebsd

      - name: Prepare repository for redox compilation
        run: bash scripts/redox/uncomment-cargo.sh
      - name: Check compilation for Redox
        if: false # FIXME: redoxer toolchain is from ~july 2021, edition2021 isn't stabilized
        uses: coolreader18/redoxer-action@v1
        with:
          command: check

  snippets_cpython:
    needs: lalrpop
    env:
      RUST_BACKTRACE: full
    name: Run snippets and cpython tests
    runs-on:  ${{ matrix.os }}
    strategy:
      matrix:
        os: [macos-latest, ubuntu-latest, windows-latest]
      fail-fast: false
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}

      - uses: dtolnay/rust-toolchain@stable
      - uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - name: Set up the Windows environment
        shell: bash
        run: |
          choco install llvm openssl
          echo "OPENSSL_DIR=C:\Program Files\OpenSSL-Win64" >>$GITHUB_ENV
        if: runner.os == 'Windows'
      - name: Set up the Mac environment
        run: brew install autoconf automake libtool
        if: runner.os == 'macOS'
      - uses: Swatinem/rust-cache@v1
      - name: build rustpython
        run: cargo build --release --verbose --features=threading ${{ env.CARGO_ARGS }}
      - uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - name: run snippets
        run: python -m pip install -r requirements.txt && pytest -v
        working-directory: ./extra_tests
      - if: runner.os == 'Linux'
        name: run cpython platform-independent tests
        run:
          target/release/rustpython -m test -j 1 -u all --slowest --fail-env-changed -v ${{ env.PLATFORM_INDEPENDENT_TESTS }}
      - if: runner.os != 'Windows'
        name: run cpython platform-dependent tests
        run: target/release/rustpython -m test -j 1 -u all --slowest --fail-env-changed -v -x ${{ env.PLATFORM_INDEPENDENT_TESTS }}
      - if: runner.os == 'Windows'
        name: run cpython platform-dependent tests (windows partial - fixme)
        run:
          target/release/rustpython -m test -j 1 -u all --slowest --fail-env-changed -v -x ${{ env.PLATFORM_INDEPENDENT_TESTS }}
            test_glob
            test_importlib
            test_io
            test_iter
            test_os
            test_pathlib
            test_posixpath
            test_shutil
            test_venv
      - if: runner.os != 'Windows'
        name: check that --install-pip succeeds
        run: |
          mkdir site-packages
          target/release/rustpython --install-pip ensurepip --user

  lalrpop:
    name: Generate parser with lalrpop
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]
    runs-on:  ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}
      - name: Check if cached generated parser exists
        id: generated_parser
        uses: andstor/file-existence-action@v1
        with:
          files: "compiler/parser/python.rs"
      - if: runner.os == 'Windows'
        name: Force python.lalrpop to be lf  # actions@checkout ignore .gitattributes
        run: |
          set file compiler/parser/python.lalrpop; ((Get-Content $file) -join "`n") + "`n" | Set-Content -NoNewline $file
      - name: Install lalrpop
        if: steps.generated_parser.outputs.files_exists == 'false'
        uses: baptiste0928/cargo-install@v1
        with:
          crate: lalrpop
          version: "0.19.8"
      - name: Run lalrpop
        if: steps.generated_parser.outputs.files_exists == 'false'
        run: lalrpop compiler/parser/python.lalrpop

  lint:
    name: Check Rust code with rustfmt and clippy
    needs: lalrpop
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}
      - uses: dtolnay/rust-toolchain@stable
        with:
            components: rustfmt, clippy
      - name: run rustfmt
        run: cargo fmt --all -- --check
      - name: run clippy
        run: cargo clippy ${{ env.CARGO_ARGS }} ${{ env.NON_WASM_PACKAGES }} -- -Dwarnings
      - name: run clippy on wasm
        run: cargo clippy --manifest-path=wasm/lib/Cargo.toml -- -Dwarnings
      - uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - name: install flake8
        run: python -m pip install flake8
      - name: run lint
        run: flake8 . --count --exclude=./.*,./Lib,./vm/Lib,./benches/  --select=E9,F63,F7,F82 --show-source --statistics
      - name: install prettier
        run: yarn global add prettier && echo "$(yarn global bin)" >>$GITHUB_PATH
      - name: check wasm code with prettier
        # prettier doesn't handle ignore files very well: https://github.com/prettier/prettier/issues/8506
        run: cd wasm && git ls-files -z | xargs -0 prettier --check -u

  miri:
    name: Run tests under miri
    needs: lalrpop
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}
      - uses: dtolnay/rust-toolchain@master
        with:
            toolchain: nightly
            components: miri
      - uses: Swatinem/rust-cache@v1
      - name: Run tests under miri
        # miri-ignore-leaks because the type-object circular reference means that there will always be
        # a memory leak, at least until we have proper cyclic gc
        run: MIRIFLAGS='-Zmiri-ignore-leaks' cargo +nightly miri test -p rustpython-vm -- miri_test

  wasm:
    name: Check the WASM package and demo
    needs: lalrpop
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v1
      - name: install wasm-pack
        run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
      - name: install geckodriver
        run: |
          wget https://github.com/mozilla/geckodriver/releases/download/v0.30.0/geckodriver-v0.30.0-linux64.tar.gz
          mkdir geckodriver
          tar -xzf geckodriver-v0.30.0-linux64.tar.gz -C geckodriver
      - uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - run: python -m pip install -r requirements.txt
        working-directory: ./wasm/tests
      - uses: actions/setup-node@v1
      - name: run test
        run: |
          export PATH=$PATH:`pwd`/../../geckodriver
          npm install
          npm run test
        working-directory: ./wasm/demo
      - name: build notebook demo
        if: github.ref == 'refs/heads/release'
        run: |
          npm install
          npm run dist
          mv dist ../demo/dist/notebook
        working-directory: ./wasm/notebook
      - name: Deploy demo to Github Pages
        if: success() && github.ref == 'refs/heads/release'
        uses: peaceiris/actions-gh-pages@v2
        env:
          ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEMO_DEPLOY_KEY }}
          PUBLISH_DIR: ./wasm/demo/dist
          EXTERNAL_REPOSITORY: RustPython/demo
          PUBLISH_BRANCH: master

  wasm-wasi:
    name: Run snippets and cpython tests on wasm-wasi
    needs: lalrpop
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Cache generated parser
        uses: actions/cache@v2
        with:
          path: compiler/parser/python.rs
          key: lalrpop-${{ hashFiles('compiler/parser/python.lalrpop') }}
      - uses: dtolnay/rust-toolchain@stable
        with:
          target: wasm32-wasi
      - uses: Swatinem/rust-cache@v1
      - name: Setup Wasmer
        uses: wasmerio/setup-wasmer@v1
      - name: Install clang
        run: sudo apt-get update && sudo apt-get install clang -y
      - name: build rustpython
        run: cargo build --release --target wasm32-wasi --features freeze-stdlib,stdlib --verbose
      - name: run snippets
        run: wasmer run --dir . target/wasm32-wasi/release/rustpython.wasm -- extra_tests/snippets/stdlib_random.py