1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
|
# stdlib
import inspect
from textwrap import dedent
from typing import Tuple
# 3rd party
import click
import pytest
from coincidence.regressions import AdvancedFileRegressionFixture
from coincidence.selectors import not_windows
# this package
import consolekit.commands
from consolekit import CONTEXT_SETTINGS, click_command, click_group
from consolekit.options import colour_option
from consolekit.terminal_colours import ColourTrilean
from consolekit.testing import CliRunner
@pytest.fixture()
def force_not_pycharm(monkeypatch) -> None:
# Pretend we aren't running in PyCharm, even if we are.
monkeypatch.setenv("PYCHARM_HOSTED", '0')
monkeypatch.setattr(consolekit.utils, "_pycharm_terminal", lambda: False)
@pytest.fixture()
def markdown_demo_command() -> click.Command:
@click_command(cls=consolekit.commands.MarkdownHelpCommand)
def demo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
* This
* That
* ~~The other~~ (deprecated)
A
multiline
paragraph
"""
return demo
@pytest.fixture()
def markdown_demo_command_numbered() -> click.Command:
@colour_option()
@click_command(cls=consolekit.commands.MarkdownHelpCommand, no_args_is_help=True)
def demo(colour: ColourTrilean = None) -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
1. This
2. That
3. ~~The other~~ (deprecated)
"""
return demo
@pytest.fixture()
def markdown_demo_group() -> Tuple[click.Command, click.Command]:
@click_group(cls=consolekit.commands.MarkdownHelpGroup)
def demo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
* This
* That
* ~~The other~~ (deprecated)
"""
@demo.command(cls=consolekit.commands.MarkdownHelpCommand)
def foo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
* This
* That
* ~~The other~~ (deprecated)
"""
return demo, foo
def test_raw_help_command(
advanced_file_regression: AdvancedFileRegressionFixture,
cli_runner: CliRunner,
):
@click_command(cls=consolekit.commands.RawHelpCommand)
def demo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
* This
* That
* ~~The other~~ (deprecated)
"""
@click_command(cls=consolekit.commands.RawHelpCommand)
def helpless_demo() -> None:
pass
result = cli_runner.invoke(demo, args=["--help"])
result.check_stdout(advanced_file_regression, extension=".md")
assert demo.callback.__doc__ is not None
expected = inspect.cleandoc(demo.callback.__doc__)
assert dedent('\n'.join(result.stdout.splitlines()[2:-3])) == expected
result = cli_runner.invoke(helpless_demo, args=["--help"])
result.check_stdout(advanced_file_regression, extension=".helpless.md")
assert helpless_demo.callback.__doc__ is None
assert dedent('\n'.join(result.stdout.splitlines()[2:-3])) == ''
def test_raw_help_group(
advanced_file_regression: AdvancedFileRegressionFixture,
cli_runner: CliRunner,
):
@click_group(cls=consolekit.commands.RawHelpGroup)
def demo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
* This
* That
* ~~The other~~ (deprecated)
"""
@demo.command(cls=consolekit.commands.RawHelpCommand)
def foo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
* This
* That
* ~~The other~~ (deprecated)
"""
result = cli_runner.invoke(demo, args=["--help"])
result.check_stdout(advanced_file_regression, extension="_group.md")
result = cli_runner.invoke(foo, args=["--help"])
result.check_stdout(advanced_file_regression, extension="_command.md")
@pytest.mark.usefixtures("force_not_pycharm")
@not_windows("Windows support for bold and italics is non-existent.")
def test_markdown_help_command(
advanced_file_regression: AdvancedFileRegressionFixture,
markdown_demo_command: click.Command,
cli_runner: CliRunner,
):
result = cli_runner.invoke(markdown_demo_command, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension=".md")
@pytest.mark.usefixtures("force_not_pycharm")
def test_markdown_help_command_no_help(
advanced_file_regression: AdvancedFileRegressionFixture,
cli_runner: CliRunner,
):
@click_command(cls=consolekit.commands.MarkdownHelpCommand)
def helpless_demo() -> None:
pass
result = cli_runner.invoke(helpless_demo, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension=".md")
@pytest.mark.usefixtures("force_not_pycharm")
@not_windows("Windows support for bold and italics is non-existent.")
def test_markdown_help_group(
advanced_file_regression: AdvancedFileRegressionFixture,
markdown_demo_group: Tuple[click.Command, click.Command],
cli_runner: CliRunner,
):
demo_group, demo_command = markdown_demo_group
result = cli_runner.invoke(demo_group, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension="_group.md")
result = cli_runner.invoke(demo_command, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension="_command.md")
@pytest.mark.usefixtures("force_not_pycharm")
@not_windows("Windows support for bold and italics is non-existent.")
def test_markdown_help_command_ordered_list(
advanced_file_regression: AdvancedFileRegressionFixture,
cli_runner: CliRunner,
):
@click_command(cls=consolekit.commands.MarkdownHelpCommand)
def demo() -> None:
"""
This is the summary line.
This **program** does *the* ``following``:
1. This
2. That
3. ~~The other~~ (deprecated)
"""
result = cli_runner.invoke(demo, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension=".md")
@not_windows("Windows support for bold and italics is non-existent.")
def test_markdown_help_command_pycharm(
advanced_file_regression: AdvancedFileRegressionFixture,
monkeypatch,
markdown_demo_command: click.Command,
cli_runner: CliRunner,
):
monkeypatch.setenv("PYCHARM_HOSTED", '1')
monkeypatch.setattr(consolekit.utils, "_pycharm_terminal", lambda: False)
result = cli_runner.invoke(markdown_demo_command, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension=".md")
def test_private_helper(monkeypatch):
monkeypatch.setenv("PYCHARM_HOSTED", '1')
assert not consolekit.utils._pycharm_terminal()
@pytest.mark.usefixtures("force_not_pycharm")
def test_markdown_help_command_no_colour(
advanced_file_regression: AdvancedFileRegressionFixture,
markdown_demo_command_numbered: click.Command,
cli_runner: CliRunner,
monkeypatch,
):
result = cli_runner.invoke(markdown_demo_command_numbered, args=["--help", "--no-colour"], color=True)
result.check_stdout(advanced_file_regression, extension=".md")
# Again with envvar
monkeypatch.setenv("NO_COLOR", '1')
result = cli_runner.invoke(markdown_demo_command_numbered, args=["--help"], color=True)
result.check_stdout(advanced_file_regression, extension=".md")
@pytest.mark.usefixtures("force_not_pycharm")
def test_markdown_help_no_args_is_help(
advanced_file_regression: AdvancedFileRegressionFixture,
markdown_demo_command_numbered: click.Command,
cli_runner: CliRunner,
):
result = cli_runner.invoke(markdown_demo_command_numbered)
result.check_stdout(advanced_file_regression, extension=".md")
assert result.exit_code == 0
@pytest.mark.usefixtures("force_not_pycharm")
def test_markdown_help_group_no_args_is_help(
advanced_file_regression: AdvancedFileRegressionFixture,
markdown_demo_group: Tuple[click.Command, click.Command],
cli_runner: CliRunner,
):
result = cli_runner.invoke(markdown_demo_group[0])
result.check_stdout(advanced_file_regression, extension=".md")
assert result.exit_code == 0
def test_suggestion_group(
advanced_file_regression: AdvancedFileRegressionFixture,
cli_runner: CliRunner,
):
@click_group(context_settings={**CONTEXT_SETTINGS, "token_normalize_func": lambda x: x.lower()})
def demo() -> None:
"""
A program.
"""
@demo.command() # skipcq
def search() -> None:
"""
Conduct a search.
"""
result = cli_runner.invoke(demo, args=["searh"])
result.check_stdout(advanced_file_regression, extension="_success.md")
assert result.exit_code == 2
result = cli_runner.invoke(demo, args=["list"])
result.check_stdout(advanced_file_regression, extension="_failure.md")
assert result.exit_code == 2
result = cli_runner.invoke(demo, args=["SEARCH"])
assert not result.stdout.rstrip()
assert result.exit_code == 0
def test_context_inheriting_group(
advanced_file_regression: AdvancedFileRegressionFixture,
cli_runner: CliRunner,
):
@click_group(cls=consolekit.commands.ContextInheritingGroup)
def demo() -> None:
"""
A program.
"""
@demo.command()
def search() -> None:
"""
Conduct a search.
"""
@demo.group()
def foo() -> None:
"""
Does bar.
"""
result = cli_runner.invoke(demo, args=["--help"])
assert result.exit_code == 0
result = cli_runner.invoke(demo, args=["-h"])
assert result.exit_code == 0
result.check_stdout(advanced_file_regression, extension=".md")
result = cli_runner.invoke(foo, args=["--help"])
assert result.exit_code == 0
result = cli_runner.invoke(foo, args=["-h"])
assert result.exit_code == 0
result.check_stdout(advanced_file_regression, extension="_foo.md")
result = cli_runner.invoke(search, args=["--help"])
assert result.exit_code == 0
result = cli_runner.invoke(search, args=["-h"])
assert result.exit_code == 0
result.check_stdout(advanced_file_regression, extension="_search.md")
|