Как пройти тест Travis CI для декоратора python click.version_option?

Question

Я пытался пройти следующий тест в Travis CI для моего click приложения:

@pytest.fixture
def runner():
    return CliRunner()  # from click.testing import CliRunner
    enter code here


def test_cli_with_version(runner):
    result = runner.invoke(cli.main, ['--version'])
    assert result.exit_code == 0
    assert not result.exception
    assert result.output.strip()

Целевая функция была стандартной click групповой функцией.

@click.group(invoke_without_command=True)
@click.help_option(help='Show help index and exit')
@click.version_option(message='%(prog)s v%(version)s', help='Show the version and exit')
@click.option('-p', '--profile', default='dev', help='Set configuration profile')
@click.pass_context
def main(ctx, profile='dev'):
    if ctx.invoked_subcommand is None:
        click.echo(click.style(title, fg='green'))

    ctx.obj = ContextConfig().load_for(profile)

Целью теста было имитировать команду, которая выглядела как main --version.

Когда я запускал этот тест в своей локальной среде, он прошел (вместе с другими). ​​

$ pytest
============================ test session starts ============================
platform linux -- Python 3.8.3, pytest-5.4.3, py-1.8.1, pluggy-0.13.1
rootdir: /path/to/root/dir
collected 15 items                                                          

tests/test_cli.py ..........                                          [ 66%]
tests/test_contexts.py .                                              [ 73%]
tests/test_models.py .                                                [ 80%]
tests/test_utils.py ...                                               [100%]

============================ 15 passed in 0.30s =============================

Однако, когда Трэвис попытался построить его, этот конкретный тест не удался. Вот журнал отладки от Travis

$ pytest
============================= test session starts ==============================
platform linux -- Python 3.6.7, pytest-5.4.3, py-1.8.1, pluggy-0.13.1
rootdir: /path/to/root/dir
collected 15 items                                                             
tests/test_cli.py ..F.......                                             [ 66%]
tests/test_contexts.py .                                                 [ 73%]
tests/test_models.py .                                                   [ 80%]
tests/test_utils.py ...                                                  [100%]
=================================== FAILURES ===================================
____________________________ test_cli_with_version _____________________________
runner = <click.testing.CliRunner object at 0x7fe288f596a0>
    def test_cli_with_version(runner):
        result = runner.invoke(cli.main, ['--version'])
>       assert result.exit_code == 0
E       AssertionError: assert 1 == 0
E        +  where 1 = <Result RuntimeError('Could not determine version',)>.exit_code
tests/test_cli.py:35: AssertionError
=========================== short test summary info ============================
FAILED tests/test_cli.py::test_cli_with_version - AssertionError: assert 1 == 0
========================= 1 failed, 14 passed in 0.34s =========================
The command "pytest" exited with 1.
Done. Your build exited with 1.

Похоже, декоратору click.version_option не удавалось прочитать строку версии в среде Travis CI. Управление версиями репо поддерживалось библиотекой setuptools-scm. Однако я еще не добавил тегов в главную ветку.

Вот как выглядит .travis.yml файл:

language: python
# target python versions
python:
  - "3.6"
  - "3.7"
  - "3.8"
# operating systems
os:
  - linux
  - osx
  - windows
# configure jobs
jobs:
  allow_failures:
    - os: windows
    - os: osx
# install dependencies
install:
  - pip install --upgrade pip
  - pip install -r requirements.txt
# run tests
script:
  - pytest
# target branches for builds
branches:
  only:
    - master

Как я могу это исправить?

Answer 1

Превращение комментария в ответ:

Вам необходимо сгенерировать метаданные пакета, чтобы можно было прочитать версию. Это можно сделать по-разному, минимальным является

$ python setup.py egg_info

Однако гораздо лучше установить пакет в редактируемом режиме:

$ pip install --editable .

Для Трэвиса просто добавьте еще одну команду в install раздел:

install:
  - pip install --upgrade pip
  - pip install -r requirements.txt
  - pip install --editable .

Вы даже можете объединить все три команды в одну:

- pip install --upgrade pip -r requirements.txt --editable .