CI.yaml

# SPDX-FileCopyrightText: 2022 Shun Sakai
#
# SPDX-License-Identifier: Apache-2.0 OR MIT

name: CI

on:
  pull_request:
  push:
    branches:
      - "develop"
      - "master"
  schedule:
    - cron: "0 0 * * 0"

jobs:
  test:
    name: Test
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        target:
          - x86_64-unknown-linux-gnu
          - aarch64-apple-darwin
          - x86_64-pc-windows-msvc
        toolchain:
          - 1.74.0 # MSRV
          - stable
        include:
          - target: x86_64-unknown-linux-gnu
            os: ubuntu-22.04
          - target: aarch64-apple-darwin
            os: macos-14
          - target: x86_64-pc-windows-msvc
            os: windows-2022
    steps:
      - name: Set Git to use LF
        if: matrix.os == 'windows-2022'
        run: |
          git config --global core.autocrlf false
          git config --global core.eol lf
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: ${{ matrix.toolchain }}
          targets: ${{ matrix.target }}
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
        with:
          key: ${{ matrix.target }}
      - name: Run tests
        run: cargo test --target ${{ matrix.target }}
      - name: Run tests (no default features)
        run: cargo test -p abcrypt -p abcrypt-cli --target ${{ matrix.target }} --no-default-features
      - name: Run tests (`alloc` feature)
        run: cargo test -p abcrypt --target ${{ matrix.target }} --no-default-features -F alloc
      - name: Run tests (`serde` feature)
        run: cargo test -p abcrypt --target ${{ matrix.target }} -F serde
      - name: Run tests (`serde` feature with no default features)
        run: cargo test -p abcrypt --target ${{ matrix.target }} --no-default-features -F serde
      - name: Check if the header file is up-to-date
        run: git diff --exit-code

  wasm-test:
    name: Test Wasm bindings
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        toolchain:
          - 1.74.0 # MSRV
          - stable
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: ${{ matrix.toolchain }}
      - name: Install wasm-pack
        uses: jetli/wasm-pack-action@v0.4.0
        with:
          version: "latest"
      - name: Setup Node.js environment
        uses: actions/setup-node@v4
        with:
          node-version: 20
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Run tests
        run: wasm-pack test --node crates/wasm

  python-test:
    name: Test Python bindings
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os:
          - ubuntu-22.04
          - macos-14
          - windows-2022
        rust-version:
          - 1.74.0 # MSRV
          - stable
        python-version:
          - "3.12" # latest version
        include:
          - os: ubuntu-22.04
            rust-version: 1.74.0 # MSRV
            python-version: "3.8"
          - os: ubuntu-22.04
            rust-version: stable
            python-version: "3.8"
          - os: macos-14
            rust-version: 1.74.0 # MSRV
            python-version: "3.10"
          - os: macos-14
            rust-version: stable
            python-version: "3.10"
          - os: windows-2022
            rust-version: 1.74.0 # MSRV
            python-version: "3.8"
          - os: windows-2022
            rust-version: stable
            python-version: "3.8"
    steps:
      - name: Set Git to use LF
        if: matrix.os == 'windows-2022'
        run: |
          git config --global core.autocrlf false
          git config --global core.eol lf
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: ${{ matrix.rust-version }}
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: "pip"
      - name: Install dependencies
        run: pip install "crates/python[test]"
      - name: Run tests
        run: pytest crates/python

  rustfmt:
    name: Rustfmt
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: stable
          components: rustfmt
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Check code formatted
        run: cargo fmt --all -- --check

  clippy:
    name: Clippy
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: stable
          components: clippy
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Check no lint warnings
        run: cargo clippy --workspace -- -D warnings
      - name: Check no lint warnings (no default features)
        run: cargo clippy --workspace --no-default-features -- -D warnings

  doc:
    name: Documentation
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: stable
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Check no `rustdoc` lint warnings
        run: RUSTDOCFLAGS="-D warnings" cargo doc --workspace --exclude abcrypt-cli --no-deps --document-private-items

  benchmark:
    name: Benchmark
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: nightly
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Run benchmarks
        run: cargo bench -p abcrypt

  python-lint:
    name: Lint Python bindings
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: stable
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12" # latest version
          cache: "pip"
      - name: Install dependencies
        run: pip install "crates/python[dev,test]"
      - name: Check code formatted
        run: ruff format --check crates/python
      - name: Check no lint warnings
        run: ruff check crates/python
      - name: Type-check
        run: mypy crates/python

  capi-examples:
    name: Examples for the C API
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        toolchain:
          - 1.74.0 # MSRV
          - stable
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: ${{ matrix.toolchain }}
      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install libcli11-dev libfmt-dev meson
          meson -v
      - name: Setup just
        uses: extractions/setup-just@v2
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Build examples for the C API
        run: just build-capi-examples
      - name: Check code formatted
        run: |
          just clang-format
          git diff --exit-code
      - name: Check no lint warnings
        run: just clang-tidy

  wasm-examples:
    name: Examples for the Wasm bindings
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: stable
      - name: Setup Deno
        uses: denoland/setup-deno@v1.1.4
        with:
          deno-version: v1.x
      - name: Install wasm-pack
        uses: jetli/wasm-pack-action@v0.4.0
        with:
          version: "latest"
      - name: Cache build artifacts
        uses: Swatinem/rust-cache@v2.7.3
      - name: Check code formatted
        run: deno fmt --check crates/wasm/examples/*.ts
      - name: Check no lint warnings
        run: deno lint crates/wasm/examples/*.ts
      - name: Type-check
        run: |
          wasm-pack build -t deno crates/wasm
          deno check crates/wasm/examples/*.ts

  semver:
    name: Semantic Versioning
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Check Semantic Versioning
        uses: obi1kenobi/cargo-semver-checks-action@v2.4
        with:
          package: abcrypt