Значок покрытия в Gitlab CI с покрытием Python всегда неизвестно

Я наконец-то получил значок покрытия, отображающий процент вместо неизвестного сегодня для моего проекта python. Вот соответствующий контент из моего .gitlab-ci.yml:

job:
 script:
  - 'python -m venv venv'
  - '.\venv\Scripts\activate'
  - 'python -m pip install -r requirements.txt'
  - 'coverage run --source=python_project -m unittest discover ./tests'
  - 'coverage report --omit=things_that_arent_mine/*'
  - 'coverage xml'
 artifacts:
  reports:
   cobertura: 'coverage.xml'

Я также использую регулярное выражение для gcovr, указанное в настройках CI / CD репозитория ›Общие конвейеры› Анализ тестового покрытия, который я обнаружил после прочтения this, а также предпоследний комментарий к это:

^TOTAL.*\s+(\d+\%)$

В репозитории Общие настройки ›Значки моя ссылка на значок:

http://gitlab-server/%{project_path}/-/jobs

а URL моего изображения значка:

http://gitlab-server/%{project_path}/badges/%{default_branch}/coverage.svg

Я не совсем понимаю, для чего нужен артефакт отчета Cobertura (я думаю, что он конкретно связан с запросы на слияние), но он у меня там, потому что обучающие программы повели меня по этому пути. Я подтвердил, что удаление следующего из .gitlab-ci.yml не нарушает значок или номер покрытия на странице вакансий:

  - 'coverage xml'
 artifacts:
  reports:
   cobertura: 'coverage.xml'

При удалении или комментировании:

- 'coverage report --omit=things_that_arent_mine/*'

не повреждает значок, а также номер покрытия, отображаемый на странице заданий CI / CD репозитория. Я также пробовал несколько вариантов регулярных выражений, которые я тестировал в rubular, но единственный, который не вызывал gitlab для barf, был gcovr один.

Надеюсь, это поможет, было довольно сложно собрать воедино то, что было необходимо для того, чтобы этот значок работал над проектом на Python.

РЕДАКТИРОВАТЬ: Также только что выяснил, как добавить некоторую сексуальную точность к числу процента покрытия. Если вы измените строку отчета о покрытии файла .gitlab-ci.yml на:

- 'coverage report --omit=things_that_arent_mine/* --precision=2'

И регулярное выражение в настройках CI / CD ›Общие конвейеры› Анализ покрытия тестирования для:

^TOTAL.+?(\d+.\d+\%)$

Это должно дать вам очень точный номер страхового покрытия, о котором никто, кроме вас и меня, не позаботится. Но, черт возьми, мы будем знать наверняка, 99,99% или 100% покрытие.

Я тоже немного вникнул в это. Как вы и сказали: команда coverage report выводит примерно такой результат:

[...]
tests/__init__.py              0      0   100%
tests/test_ml_squarer.py       4      0   100%
tests/test_squarer.py          4      0   100%
----------------------------------------------
TOTAL                         17      2    88%
test_service run-test: commands[4] | coverage xml

и в зависимости от сохраненного regex-выражения, он просто ищет 88% рядом с TOTAL. Я использовал рекомендацию для pytest-cov (Python), т.е. ^TOTAL.+?(\d+\%)$

Так что запуск coverage xml в настоящий момент кажется мне необязательным. Однако у меня это не работает при использовании: GitLab Community Edition 12.10.11

Я потратил три дня на решение указанной выше проблемы, поэтому решил опубликовать свою рабочую конфигурацию. Мой проект представляет собой проект pyscaffolding, использует tox, конвейер срабатывает, когда вы отправляете фиксацию в ветку, и он отправляет пакет pip в библиотеку пакетов github.

1. Ссылка на значок: http://gitlab.XXXX.com/XXmeXX/python-template/-/commit/develop

2. Изображение значка: http://gitlab.XXXX.com/XXmeXX/python-template/badges/develop/coverage.svg.

3. Регулярное выражение такое же, как указано выше.

4. PYPIRC - это установленная переменная среды, которая выглядит как файл .pypirc и указывает на мой внутренний реестр пакетов.

5. Я использовал это руководство

Мой gitlab-ci.yml:

build-package:
  stage: deploy
  image: python:3.7
  script:
   - set
   - cat $PYPIRC > /tmp/.pypirc
   - pip3 install twine setuptools setuptools_scm wheel tox coverage
   # build the pip package
   - python3 setup.py bdist_wheel
   # $CI_COMMIT_TAG only works with the tagging pipeline, if you want to test a branch push directly, pull from fs
   - VERSION=$(python setup.py --version)
   # You can issue ls -al commands if you want, like to see variables or your published packages
   # - echo $VERSION
   # - ls -al ./dist |grep whl
   - tox
   - coverage xml -o coverage.xml
   # If you want to put artifacts up for storage, ...
   # - mkdir public
   - python3 -m twine upload --repository pythontemplate ./dist/nbcuas_python_template-${VERSION}-py2.py3-none-any.whl --config-file /tmp/.pypirc
 artifacts:
   reports:
     cobertura : 'coverage.xml'
   when: always
#   If you were copying artifacts up for later.
#  paths:
#     - public
 only:
  - branches

Самым большим, что я узнал, было то, что сначала он отображается как столбец «Покрытие» в списке вакансий, а затем вы знаете, что все правильно разбираете и регулярные выражения работают. Оттуда вы работаете над xml покрытия и ссылками на значок.