.gitlab-ci.yml

stages:
  - image-pixi
  - pixi
  - image
  - lint
  - test
  - report
  - test-release
  - doc
  - build
  - release

variables:
  COVERAGE_DIR: .coverage_$CI_COMMIT_SHA
  DOCKER_IMAGE_PATH: registry.heptapod.net:443/fluiddyn/fluidsim/ci/default

image: $DOCKER_IMAGE_PATH:stable

# ugly workaround https://gitlab.com/gitlab-org/gitlab/-/issues/370052#note_1207556577
workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
      when: never
    - if: $CI_COMMIT_BRANCH
    - if: $CI_COMMIT_TAG

# check_bug:
#   image: fluiddyn/python3-stable:lastest
#   script:
#     - pip index versions flit-core
#     - pip install requests
#     - python3.9 tmp_bug_unearth.py


image-pixi:build:
  stage: image-pixi
  tags:
    - container-registry-push
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$CI_BUILD_IMAGES == "1"'
  image:
    name: gcr.io/kaniko-project/executor:debug
    entrypoint: [ "" ]
  before_script:
    - ""
  script:
    - |
      cat > /kaniko/.docker/config.json <<EOF
      {
        "auths": {
          "$CI_REGISTRY": {
            "username": "$CI_REGISTRY_USER",
            "password": "$CI_REGISTRY_PASSWORD"
          }
        }
      }
      EOF
    - >
      /kaniko/executor --context $CI_PROJECT_DIR
      --dockerfile $CI_PROJECT_DIR/docker/Dockerfile_pixi
      --single-snapshot
      --cleanup
      --destination $DOCKER_IMAGE_PATH:pixi

pixi-test:
  stage: pixi
  image: $DOCKER_IMAGE_PATH:pixi
  needs:
    - job: "image-pixi:build"
      optional: true
  script:
    - pixi info
    # - rm -rf ../transonic
    # - hg clone https://foss.heptapod.net/fluiddyn/transonic ../transonic
    - pixi run install-dependencies
    - pixi run pip install -e . -v --no-build-isolation --no-deps -C compile-args=-j2
    - pixi run pytest -v lib
    - pixi run fluidsim-test -v
    # currently broken because of fluidfft conda issues
    # - pixi run mpirun -np 2 fluidsim-test -v --exitfirst


# Build an image for the other tasks; this should be a scheduled job, as
# it is quite unnecessary to run on every invocation.
image:build:
  stage: image
  needs: []
  tags:
    - container-registry-push
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$CI_BUILD_IMAGES == "1"'
  image:
    name: gcr.io/kaniko-project/executor:debug
    entrypoint: [ "" ]
  before_script:
    - ""
  script:
    - |
      cat > /kaniko/.docker/config.json <<EOF
      {
        "auths": {
          "$CI_REGISTRY": {
            "username": "$CI_REGISTRY_USER",
            "password": "$CI_REGISTRY_PASSWORD"
          }
        }
      }
      EOF
    - >
      /kaniko/executor --context $CI_PROJECT_DIR
      --dockerfile $CI_PROJECT_DIR/docker/Dockerfile
      --single-snapshot
      --cleanup
      --destination $DOCKER_IMAGE_PATH:stable

validate_code:
  stage: lint
  needs:
    - job: "image:build"
      optional: true
  script:
    - nox -s validate_code


test_without_fft_and_pythran:
  stage: test
  needs:
    - job: "image:build"
      optional: true
  script:
    - nox -s test_without_fft_and_pythran
    - mkdir $COVERAGE_DIR
    - cp -r .coverage/* $COVERAGE_DIR
  artifacts:
    paths:
      - $COVERAGE_DIR/*
    expire_in: 60 mins

test_with_fft_and_pythran:
  stage: test
  timeout: 2 hours
  needs:
    - job: "image:build"
      optional: true
  script:
    - nox -s test_with_fft_and_pythran
    - mkdir $COVERAGE_DIR
    - cp -r .coverage/* $COVERAGE_DIR
  artifacts:
    paths:
      - $COVERAGE_DIR/*
    expire_in: 60 mins


report_coverage:
  stage: report
  rules:
    - when: on_success
  script:
    - mv $COVERAGE_DIR .coverage
    - pip install coverage
    - coverage report


test-release:examples:
  stage: test-release
  needs:
    - job: "image:build"
      optional: true
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$CI_TEST_RELEASE == "1"'
  script:
    - nox -s test-examples


pages:
  stage: doc
  needs:
    - job: "image:build"
      optional: true
  script:
    - pdm sync -G doc -G fft -G test -G dev --no-self
    - pdm run pip install . --config-settings=setup-args=-Dtransonic-backend=python --no-deps
    - pdm run xvfb-run --auto-servernum sphinx-build -W -b html -d doc/_build/doctrees doc doc/_build/html
    - mkdir -p public/$CI_COMMIT_REF_NAME
    - rsync -rvc --delete doc/_build/html/* public/$CI_COMMIT_REF_NAME/
    # This directory can become too large leading to error.
    # It can be purged with the botton "Clear runner caches"
    # in https://foss.heptapod.net/fluiddyn/fluidsim/-/pipelines
    - ls public
    - echo "CI_COMMIT_REF_NAME="$CI_COMMIT_REF_NAME
    - echo See https://fluiddyn.pages.heptapod.net/fluidsim/$CI_COMMIT_REF_NAME
  artifacts:
    name: "$CI_COMMIT_REF_NAME"
    paths:
      - public
    expire_in: 5 days
  when: always


build:package:
  stage: build
  before_script:
    - pip install build twine
  script:
    - cd lib
    - rm -rf dist
    - python -m build
    - ls dist
    - twine check --strict dist/*
  needs: []
  artifacts:
    when: always
    paths:
      - lib/dist
    expire_in: 24 hrs


# manually set TWINE_PASSWORD in web interface to your PyPI API token
release:package:
  stage: release
  rules:
    - if: '$CI_MERGE_REQUEST_ID'
      when: never
    - if: '$CI_COMMIT_TAG'
      when: on_success
  variables:
    TWINE_USERNAME: __token__
  script:
    - pip install twine -U
    - twine upload lib/dist/*
  needs: [ "build:package" ]