.gitlab-ci.yml

image: "python:3.9"

before_script:
  - python --version
  # Adding this because furo gets a wheel validation error for the 1.4.1 install
  - export POETRY_VERSION=1.4.0
  - curl -sSkL https://install.python-poetry.org | python -
  - export PATH=$PATH:$HOME/.local/bin
  - poetry --version
  - DEBIAN_FRONTEND=noninteractive apt update
  - DEBIAN_FRONTEND=noninteractive apt -y install libgl1-mesa-dev

.install_dev:
  script:
    - poetry install --without docs

stages:
  - Static Analysis
  - Security
  - Tests
  - Documentation
  - Release

###################
# Static Analysis #
###################
flake8:
  stage: Static Analysis
  tags:
    - lslab2
  script:
    - poetry install --only dev
    - poetry run flake8 .
  needs: []
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - poetry.lock
      - .flake8

black:
  stage: Static Analysis
  tags:
    - lslab2
  script:
    - poetry install --only dev
    - poetry run black --check ./
  needs: []
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - poetry.lock

mypy:
  stage: Static Analysis
  tags:
    - lslab2
  script:
    - poetry install --only dev
    - poetry run mypy --config-file pyproject.toml .
  needs: []
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - poetry.lock

isort:
  stage: Static Analysis
  tags:
    - lslab2
  script:
    - poetry install --only dev
    - poetry run isort --check --profile black --trailing-comma -m=3 .
  needs: []
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - poetry.lock


############
# Security #
############
bandit:
  stage: Security
  tags:
    - lslab2
  script:
    - poetry install --only dev
    - poetry run bandit -r .
  needs: []
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - poetry.lock


#########
# Tests #
#########
coverage:
  stage: Tests
  tags:
  - lslab2
  script:
    - poetry install --with coverage
    - SDL_VIDEODRIVER=dummy poetry run python -m coverage run -m pytest
    - SDL_VIDEODRIVER=dummy poetry run python -m coverage report -i
    - SDL_VIDEODRIVER=dummy poetry run python -m coverage xml -i
  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
  artifacts:
    reports:
      coverage_report:
        coverage_format: cobertura
        path: coverage.xml
  needs: []
  timeout: 20m
  only:
    refs:
      - merge_requests
      - main
    changes:
      - "**/*.py"
      - poetry.lock

################
# GitLab Pages #
################
.pages:
  script:
    - poetry install --only docs
    - poetry run sphinx-build -d docs/build/doctrees docs/source docs/build/html
    - mv docs/build/html public/

test-pages:
  stage: Documentation
  tags:
    - lslab2
  extends: .pages
  needs: []
  artifacts:
    expose_as: 'HTML Documentation'
    paths:
      - public/
    expire_in: 1 week
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - docs/**/*
      - poetry.lock

pages:
  stage: Documentation
  tags:
    - lslab2
  extends: .pages
  artifacts:
    paths:
      - public
  only:
    - tags

###########################
# Packaging and Releasing #
###########################
.commit_version:
  script:
    - git remote remove origin
    - git remote add origin https://oauth2:${CI_TAG_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git
    - git config --global user.email "fireline-ci-bot@mitre.org"
    - git config --global user.name "fiReLine CI Bot"
    - git add pyproject.toml CITATION.cff
    - git commit -m "Change pyproject.toml and CITATION.cff version to $VERSION"
    - git push -o ci.skip origin HEAD:main

.check_version_and_commit:
  script:
    - POETRY_VERSION=$(poetry version -s)
    - >
      if [ $POETRY_VERSION != $CI_COMMIT_TAG ]; then
        VERSION=$CI_COMMIT_TAG
        poetry version $VERSION
        git remote remove origin
        git remote add origin https://oauth2:${CI_TAG_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git
        git config --global user.email "fireline-ci-bot@mitre.org"
        git config --global user.name "fiReLine CI Bot"
        git add pyproject.toml
        git commit -m "Change pyproject.toml version to $VERSION"
        git push -o ci.skip origin HEAD:main
      fi

test_release:
  stage: Release
  tags:
    - lslab2
  script:
    - poetry build
    - poetry run pip install -U dist/*.whl
    # Remove the directory so that it's not using the directory to run the code and it uses the installed package
    - rm -rf simfire
    - poetry run python tests/package.py
    - SDL_VIDEODRIVER=dummy poetry run python tests/sim.py
  needs: []
  only:
    refs:
      - merge_requests
    changes:
      - "**/*.py"
      - poetry.lock
      - pyproject.toml

tag:
  stage: Release
  tags:
    - lslab2
  before_script:
    - python --version
    - curl -sSkL https://install.python-poetry.org | python -
    - export PATH=$PATH:$HOME/.local/bin
    - poetry --version
    - DEBIAN_FRONTEND=noninteractive apt update
    - DEBIAN_FRONTEND=noninteractive apt -y install php php-json git curl wget
    - wget --no-check-certificate https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/bin/yq
    - chmod +x /usr/bin/yq
    - git --version
  script:
    - poetry version patch
    - VERSION=$(poetry version -s)
    - LOG=$(git log -1 | grep -Po '(?<=Resolve ")(.*?)(?=")')
    - ISSUE=$(git log -1 | grep -Po '(?<=Closes )(.*?).*')
    - MR=$(git log -1 | grep -Po '(?<=fireline/simulators/simfire)(.*?).*')
    - echo -e "# Version ${VERSION}\n\nThis version includes:\n\n* ${LOG} (closed ${ISSUE} with merge request ${MR})" > RELEASE.md
    - MESSAGE="$(php -r "echo json_encode(['name' => '$VERSION', 'tag_name' => '$VERSION', 'description' => file_get_contents('RELEASE.md')]);")"
    - yq e -i '.version="'${VERSION}'" | .date-released="'$(date +'%Y-%m-%d')'"' CITATION.cff
    - !reference [.commit_version, script]
    - git tag -a $VERSION -m "$VERSION"
    - git push origin $VERSION
    - >
      curl --header 'Content-Type: application/json' \
           --header "PRIVATE-TOKEN: ${CI_TAG_TOKEN}" \
           --data "$MESSAGE" \
           --request POST https://gitlab.mitre.org/api/v4/projects/${CI_PROJECT_ID}/releases
  only:
    refs:
      - main
    changes:
      - "simfire/**/*"
      - poetry.lock
      - pyproject.toml

release_gitlab:
  stage: Release
  tags:
    - lslab2
  script:
    - !reference [.check_version_and_commit, script]
    - poetry build
    - poetry config repositories.mitre-gitlab https://gitlab.mitre.org/api/v4/projects/${CI_PROJECT_ID}/packages/pypi
    - poetry publish --repository mitre-gitlab -u gitlab-ci-token -p ${CI_JOB_TOKEN}
  only:
    - tags

release_artifactory:
  stage: Release
  tags:
    - lslab2
  script:
    - !reference [.check_version_and_commit, script]
    - poetry build
    - poetry config repositories.mitre-artifactory https://artifacts.mitre.org/artifactory/api/pypi/python
    - poetry publish --repository mitre-artifactory -u fireline-ci-bot -p ${CI_ARTIFACTORY_TOKEN}
  only:
    - tags

################
# Dummy CI Job #
################
# This is so if there is no functional pipeline for a particular MR,
# it will still run a pipeline
dummy:
  stage: Static Analysis
  tags:
    - lslab2
  script:
    - echo "Dummy CI Job"
  needs: []
  only:
    refs:
      - merge_requests