test_version_option.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_cli/test_version_option.py
 
"""
Purpose
-------
OI-524 regression tests — ``oct --version`` / ``-V`` must surface the OCT
version, and ``oct --help`` must show the version at the top of its output.
This closes the HIGH-priority developer note in V5.0 Phase 2 requiring the
version to be visible without a dedicated command.
 
Responsibilities
----------------
- ``oct --version`` prints ``oct <version>`` and exits 0.
- ``-V`` shortcut behaves identically.
- ``oct --help`` output begins with the version line.
- ``__version__`` resolves to a non-empty, non-"unknown" value in the
  installed editable environment.
 
Diagnostics
-----------
Domain: CLI-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- Must never regress: any future change to ``OctGroup.format_help`` or the
  ``@click.version_option`` decorator must keep the version on the first
  non-empty line of ``--help``.
"""
 
from click.testing import CliRunner
 
from oct import __version__
from oct.cli import cli
 
 
def test_version_long_flag_prints_version():
    runner = CliRunner()
    result = runner.invoke(cli, ["--version"])
    assert result.exit_code == 0
    assert f"oct {__version__}" in result.output
 
 
def test_version_short_flag_prints_version():
    runner = CliRunner()
    result = runner.invoke(cli, ["-V"])
    assert result.exit_code == 0
    assert f"oct {__version__}" in result.output
 
 
def test_help_output_starts_with_version():
    runner = CliRunner()
    result = runner.invoke(cli, ["--help"])
    assert result.exit_code == 0
    first_line = result.output.splitlines()[0].strip()
    assert first_line == f"oct {__version__}", (
        f"expected version on first line of --help, got: {first_line!r}"
    )
 
 
def test_version_is_resolved_from_metadata():
    assert __version__, "__version__ must be non-empty"
    assert __version__ != "unknown", (
        "importlib.metadata could not resolve oct version — "
        "package likely not installed in editable mode"
    )