image: "rust:latest"

variables:
  CARGO_HOME: $CI_PROJECT_DIR/.cargo

cache:
  paths:
    - target
    - .cargo

default:
  before_script:
    - rustc --version
    - cargo version

stages:
  - lint
  - cache-cleanup
  - build-base
  - build
  - test

# TEMPLATES

# this step uses cargo-sweep to clean up unneeded cruft that accumulates over time in the target dir. cargo clean is
# not used because it simply rm -rf's the entire target directory (and thus prevents build caching). i would really like
# to either replace this with a bash script, or to install cargo-sweep as a binary instead of building it from source
# like this. i'd also like to add a step that checks to see whether the target dir exists, and exits early if not.
.cargo-cleanup:
  stage: cache-cleanup
  allow_failure: true
  script:
    - cargo install cargo-sweep
    - cargo sweep -i

# this builds a "base" version of fif with default features enabled. this is done separately from the main build step
# for the purposes of caching - by building once *before* executing the parallel cargo-build step, we ensure that
# cargo-build can reuse some cached stuff, rather than building from scratch every time.
.cargo-build-base:
  stage: build-base
  script:
    cargo build --locked

# build with various features on and off.
.cargo-build:
  extends: .cargo-build-base
  stage: build
  parallel:
    matrix:
      - FEATURES:
        - xdg-mime-backend
        - infer-backend
        - multi-threaded xdg-mime-backend
        - multi-threaded infer-backend

  script:
    cargo build --no-default-features --locked --features="json $FEATURES"

# test with various features on and off.
.cargo-test:
  extends: .cargo-build
  stage: test
  script:
    cargo test --no-default-features --locked --verbose --features="json $FEATURES"

# LINT

# run the included clippy.sh with "ci" mode on - clippy will exit with code 1 if anything at all is amiss. this is just
# here to make sure i remember to run clippy.sh locally myself and fix/ignore all the warnings before committing, as i
# should be.
clippy:
  stage: lint
  script:
    - rustup component add clippy
    - cargo clippy --version
    - ./clippy.sh ci

# CACHE CLEANUP
cleanup-stable:
  extends: .cargo-cleanup

cleanup-msrv:
  extends: cleanup-stable
  image: "rust:1.43.0"
  cache:
    key: msrv
    paths:
      - target
      - .cargo

cleanup-nightly:
  extends: cleanup-stable
  image: "rustlang/rust:nightly"
  cache:
    key: nightly
    paths:
      - target
      - .cargo

# BUILD BASE
build-base-stable:
  extends: .cargo-build-base
  needs: ["cleanup-stable"]

build-base-msrv:
  extends: build-base-stable
  needs: ["cleanup-msrv"]
  image: "rust:1.43.0"
  cache:
    key: msrv
    paths:
      - target
      - .cargo

build-base-nightly:
  extends: build-base-stable
  needs: ["cleanup-nightly"]
  image: "rustlang/rust:nightly"
  cache:
    key: nightly
    paths:
      - target
      - .cargo

# BUILD

build-stable:
  extends: .cargo-build
  needs: ["build-base-stable"]

build-msrv:
  extends: build-stable
  needs: ["build-base-msrv"]
  image: "rust:1.43.0"
  cache:
    key: msrv
    paths:
      - target
      - .cargo

build-nightly:
  extends: build-stable
  needs: ["build-base-nightly"]
  image: "rustlang/rust:nightly"
  cache:
    key: nightly
    paths:
      - target
      - .cargo

# TEST

test-stable:
  extends: .cargo-test
  needs: ["build-stable"]

test-msrv:
  extends: test-stable
  image: "rust:1.43.0"
  needs: ["build-msrv"]
  cache:
    key: msrv
    paths:
      - target
      - .cargo

test-nightly:
  extends: test-stable
  image: "rustlang/rust:nightly"
  needs: ["build-nightly"]
  cache:
    key: nightly
    paths:
      - target
      - .cargo