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
|
from __future__ import annotations
import re
import shutil
from typing import TYPE_CHECKING
from typing import ClassVar
from typing import cast
import pytest
from cleo.testers.application_tester import ApplicationTester
from poetry.console.application import Application
from poetry.console.commands.command import Command
from poetry.plugins.application_plugin import ApplicationPlugin
from poetry.plugins.plugin_manager import ProjectPluginCache
from poetry.repositories.cached_repository import CachedRepository
from poetry.utils.authenticator import Authenticator
from poetry.utils.env import EnvManager
from poetry.utils.env import MockEnv
from tests.helpers import mock_metadata_entry_points
if TYPE_CHECKING:
from pathlib import Path
from cleo.io.inputs.argv_input import ArgvInput
from pytest_mock import MockerFixture
from tests.helpers import PoetryTestApplication
from tests.types import FixtureDirGetter
from tests.types import SetProjectContext
class FooCommand(Command):
name = "foo"
description = "Foo Command"
def handle(self) -> int:
self.line("foo called")
return 0
class AddCommandPlugin(ApplicationPlugin):
commands: ClassVar[list[type[Command]]] = [FooCommand]
@pytest.fixture
def with_add_command_plugin(mocker: MockerFixture) -> None:
mock_metadata_entry_points(mocker, AddCommandPlugin)
def test_application_with_plugins(with_add_command_plugin: None) -> None:
app = Application()
tester = ApplicationTester(app)
tester.execute("")
assert re.search(r"\s+foo\s+Foo Command", tester.io.fetch_output()) is not None
assert tester.status_code == 0
def test_application_with_plugins_disabled(with_add_command_plugin: None) -> None:
app = Application()
tester = ApplicationTester(app)
tester.execute("--no-plugins")
assert re.search(r"\s+foo\s+Foo Command", tester.io.fetch_output()) is None
assert tester.status_code == 0
def test_application_execute_plugin_command(with_add_command_plugin: None) -> None:
app = Application()
tester = ApplicationTester(app)
tester.execute("foo")
assert tester.io.fetch_output() == "foo called\n"
assert tester.status_code == 0
def test_application_execute_plugin_command_with_plugins_disabled(
with_add_command_plugin: None,
) -> None:
app = Application()
tester = ApplicationTester(app)
tester.execute("foo --no-plugins")
assert tester.io.fetch_output() == ""
assert "The requested command foo does not exist." in tester.io.fetch_error()
assert tester.status_code == 1
@pytest.mark.parametrize("with_project_plugins", [False, True])
@pytest.mark.parametrize("no_plugins", [False, True])
def test_application_project_plugins(
fixture_dir: FixtureDirGetter,
tmp_path: Path,
no_plugins: bool,
with_project_plugins: bool,
mocker: MockerFixture,
set_project_context: SetProjectContext,
) -> None:
env = MockEnv(
path=tmp_path / "env", version_info=(3, 8, 0), sys_path=[str(tmp_path / "env")]
)
mocker.patch.object(EnvManager, "get_system_env", return_value=env)
orig_dir = fixture_dir("project_plugins")
project_path = tmp_path / "project"
project_path.mkdir()
shutil.copy(orig_dir / "pyproject.toml", project_path / "pyproject.toml")
project_plugin_path = project_path / ProjectPluginCache.PATH
if with_project_plugins:
project_plugin_path.mkdir(parents=True)
with set_project_context(project_path, in_place=True):
app = Application()
tester = ApplicationTester(app)
tester.execute("--no-plugins" if no_plugins else "")
assert tester.status_code == 0
sys_path = EnvManager.get_system_env(naive=True).sys_path
if with_project_plugins and not no_plugins:
assert sys_path[0] == str(project_plugin_path)
else:
assert sys_path[0] != str(project_plugin_path)
@pytest.mark.parametrize("disable_cache", [True, False])
def test_application_verify_source_cache_flag(
disable_cache: bool, set_project_context: SetProjectContext
) -> None:
with set_project_context("sample_project"):
app = Application()
tester = ApplicationTester(app)
command = "debug info"
if disable_cache:
command = f"{command} --no-cache"
assert not app._poetry
tester.execute(command)
assert app.poetry.pool.repositories
for repo in app.poetry.pool.repositories:
assert isinstance(repo, CachedRepository)
assert repo._disable_cache == disable_cache
@pytest.mark.parametrize("disable_cache", [True, False])
def test_application_verify_cache_flag_at_install(
mocker: MockerFixture,
disable_cache: bool,
set_project_context: SetProjectContext,
) -> None:
import poetry.utils.authenticator
# Set default authenticator to None so that it is recreated for each test
# and we get a consistent call_count.
poetry.utils.authenticator._authenticator = None
with set_project_context("sample_project"):
app = Application()
tester = ApplicationTester(app)
command = "install --dry-run"
if disable_cache:
command = f"{command} --no-cache"
spy = mocker.spy(Authenticator, "__init__")
tester.execute(command)
# The third call is the default authenticator, which ignores the cache flag.
assert spy.call_count == 3
for call in spy.mock_calls[:2]:
(_name, _args, kwargs) = call
assert "disable_cache" in kwargs
assert disable_cache is kwargs["disable_cache"]
@pytest.mark.parametrize(
("tokens", "result"),
[
(
["-C", "/path/working/dir", "env", "list"],
["--directory", "/path/working/dir", "env", "list"],
),
(
["-P", "/path/project/dir", "env", "list"],
["--project", "/path/project/dir", "env", "list"],
),
(
["-P/path/project/dir", "env", "list"],
["--project", "/path/project/dir", "env", "list"],
),
(
["-P/path/project/dir", "env", "list"],
["--project", "/path/project/dir", "env", "list"],
),
(
["-v", "run", "-P/path/project/dir", "echo", "--help"],
[
"--verbose",
"--project",
"/path/project/dir",
"run",
"--",
"echo",
"--help",
],
),
(
["--no-ansi", "run", "-V", "python", "-V"],
["--version", "--no-ansi", "run", "--", "python", "-V"],
),
(
["--no-ansi", "run", "-V", "--", "python", "-V"],
["--version", "--no-ansi", "run", "--", "python", "-V"],
),
],
)
def test_application_input_configuration_and_sorting(
tokens: list[str], result: list[str], app: PoetryTestApplication
) -> None:
app.create_io()
assert app._io is not None
io_input = cast("ArgvInput", app._io.input)
io_input._tokens = tokens
app._configure_io(app._io)
app._sort_global_options(app._io)
io_input = cast("ArgvInput", app._io.input)
assert io_input._tokens == result
|