ci.yml

# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

name: CI
on:
  pull_request:

# Allow one instance of this workflow per pull request, and cancel older runs when new changes are pushed
concurrency:
  group: ci-yaml-${{ github.ref }}
  cancel-in-progress: true

env:
  RUSTFLAGS: -Dwarnings
  RUSTDOCFLAGS: -Dwarnings
  RUST_BACKTRACE: 1
  rust_version: nightly-2024-10-29

jobs:
  fmt:
    name: Code formatting
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-rs/toolchain@v1
        name: Install Rust
        with:
          toolchain: ${{ env.rust_version }}
          override: true
          components: rustfmt
      - name: Check code formatting
        run: |
          if ! rustfmt --check --edition 2021 $(git ls-files '*.rs'); then
            echo "Please run 'cargo fmt' to fix rustfmt errors."
            exit 1
          fi

  clippy:
    name: Clippy
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-rs/toolchain@v1
        name: Install Rust
        with:
          toolchain: ${{ env.rust_version }}
          override: true
          components: clippy
      # Pinned to the commit hash of v1.3.0
      - uses: Swatinem/rust-cache@842ef286fff290e445b90b4002cc9807c3669641
      - name: Clippy
        run: cargo clippy --all-features
        env:
          RUSTFLAGS: ${{ env.RUSTFLAGS }}

  test:
    name: Tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-rs/toolchain@v1
        name: Install Rust
        with:
          toolchain: ${{ env.rust_version }}
          override: true
      # Pinned to the commit hash of v1.3.0
      - uses: Swatinem/rust-cache@842ef286fff290e445b90b4002cc9807c3669641
      - name: Tests
        run: cargo test --all-features
        env:
          RUSTFLAGS: ${{ env.RUSTFLAGS }}
          RUST_BACKTRACE: ${{ env.RUST_BACKTRACE }}

  doc:
    name: Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-rs/toolchain@v1
        name: Install Rust
        with:
          toolchain: ${{ env.rust_version }}
          override: true
      # Pinned to the commit hash of v1.3.0
      - uses: Swatinem/rust-cache@842ef286fff290e445b90b4002cc9807c3669641
      - name: Check Docs
        run: cargo doc --all-features --document-private-items
        env:
          RUSTDOCFLAGS: ${{ env.RUSTDOCFLAGS }}

  smoketest-aws-sdk:
    name: Smoketest against the AWS Rust SDK
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          path: cargo-check-external-types
      - uses: actions/checkout@v3
        with:
          repository: awslabs/aws-sdk-rust
          path: aws-sdk-rust
      - uses: actions-rs/toolchain@v1
        name: Install Rust
        with:
          toolchain: ${{ env.rust_version }}
          override: true
      # Pinned to the commit hash of v1.3.0
      - uses: Swatinem/rust-cache@842ef286fff290e445b90b4002cc9807c3669641
      - name: Run
        run: |
          cargo install --locked --path cargo-check-external-types
          cd aws-sdk-rust/sdk
          cargo check-external-types --all-features --config aws-config/external-types.toml --manifest-path aws-config/Cargo.toml
          cargo check-external-types --all-features --config aws-endpoint/external-types.toml --manifest-path aws-endpoint/Cargo.toml
          cargo check-external-types --all-features --config aws-http/external-types.toml --manifest-path aws-http/Cargo.toml
          cargo check-external-types --all-features --config aws-runtime/external-types.toml --manifest-path aws-runtime/Cargo.toml
          cargo check-external-types --all-features --config aws-sig-auth/external-types.toml --manifest-path aws-sig-auth/Cargo.toml
          cargo check-external-types --all-features --config aws-sigv4/external-types.toml --manifest-path aws-sigv4/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-async/external-types.toml --manifest-path aws-smithy-async/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-checksums/external-types.toml --manifest-path aws-smithy-checksums/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-client/external-types.toml --manifest-path aws-smithy-client/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-eventstream/external-types.toml --manifest-path aws-smithy-eventstream/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-http-tower/external-types.toml --manifest-path aws-smithy-http-tower/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-http/external-types.toml --manifest-path aws-smithy-http/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-json/external-types.toml --manifest-path aws-smithy-json/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-query/external-types.toml --manifest-path aws-smithy-query/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-runtime-api/external-types.toml --manifest-path aws-smithy-runtime-api/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-runtime/external-types.toml --manifest-path aws-smithy-runtime/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-types-convert/external-types.toml --manifest-path aws-smithy-types-convert/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-types/external-types.toml --manifest-path aws-smithy-types/Cargo.toml
          cargo check-external-types --all-features --config aws-smithy-xml/external-types.toml --manifest-path aws-smithy-xml/Cargo.toml
          cargo check-external-types --all-features --config aws-types/external-types.toml --manifest-path aws-types/Cargo.toml
        env:
          # Intentionally don't set flags
          RUSTFLAGS:
          RUSTDOCFLAGS:

  smoketest-tokio:
    name: Smoketest against Tokio
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          path: cargo-check-external-types
      - uses: actions/checkout@v3
        with:
          repository: tokio-rs/tokio
          path: tokio
      - uses: actions-rs/toolchain@v1
        name: Install Rust
        with:
          toolchain: ${{ env.rust_version }}
          override: true
      # Pinned to the commit hash of v1.3.0
      - uses: Swatinem/rust-cache@842ef286fff290e445b90b4002cc9807c3669641
      - name: Run
        run: |
          cargo install --locked --path cargo-check-external-types
          cargo check-external-types --all-features --manifest-path tokio/tokio/Cargo.toml
        env:
          # Intentionally don't set flags
          RUSTDOCFLAGS:

  require-all:
    name: All checks pass
    needs:
      - fmt
      - clippy
      - test
      - doc
      - smoketest-aws-sdk
      - smoketest-tokio
    # Run this job even if its dependency jobs fail
    if: always()
    runs-on: ubuntu-latest
    steps:
      - name: Verify jobs succeeded
        uses: re-actors/alls-green@3a2de129f0713010a71314c74e33c0e3ef90e696
        with:
          jobs: ${{ toJSON(needs) }}