# Copyright Kevin Deldycke <[email protected]> and contributors.
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
from __future__ import annotations
from functools import partial
import pytest
from meta_package_manager.capabilities import Operations
from meta_package_manager.pool import pool
from meta_package_manager.tables import PackageOutcome
from .conftest import default_manager_ids
from .destructive_plan import destructive_group
from .test_cli import (
assert_no_manager_selected,
check_manager_selection,
check_report,
)
[docs]
@pytest.fixture
def subcmd(create_config):
"""Seed common subcommand tests with a dummy file and content.
So the CLI does not fail on its required file input.
"""
toml_path = create_config(
"dummy.toml",
"""
[dummy_manager]
fancy_package = "0.0.1"
""",
)
return "restore", str(toml_path)
[docs]
def evaluate_signals(mid, stdout, stderr):
yield from (
# The glued `:<mid>:` label form matches whatever level the
# message lands at: demoted to DEBUG for implicit selection,
# WARNING/INFO for explicit ones (`mpm --<mid> restore`).
f":{mid}: Does not implement {Operations.install}." in stderr,
f"No [{mid}] section found." in stderr,
f":{mid}.install: Restore packages." in stderr,
f":{mid}: Skipped:" in stderr,
)
check_selection = partial(check_manager_selection, signals=evaluate_signals)
"""Selection assertions reading this subcommand's own signals."""
[docs]
@pytest.mark.destructive()
@pytest.mark.destructive_all_managers()
def test_default_all_managers(invoke, create_config):
toml_path = create_config(
"all-managers.toml",
"".join(
f"""
[{m}]
blah = 123
"""
for m in pool.all_manager_ids
),
)
# `--verbosity DEBUG` surfaces the skip/does-not-implement messages
# for managers covered by the config but absent from the system.
result = invoke("--verbosity", "DEBUG", "restore", str(toml_path))
# Accept exit code 1: the bogus "blah" packages fail to install on any
# available manager, which now exits non-zero (restore is no longer
# best-effort).
assert result.exit_code in (0, 1)
assert "all-managers.toml" in result.stderr
check_selection(result)
[docs]
@pytest.mark.destructive()
@default_manager_ids
def test_single_manager(invoke, create_config, manager_id):
toml_path = create_config(
"all-managers.toml",
"".join(
f"""
[{m}]
blah = 123
"""
for m in pool.all_manager_ids
),
)
result = invoke("--verbosity", "INFO", f"--{manager_id}", "restore", str(toml_path))
if result.exit_code == 2:
assert_no_manager_selected(result)
else:
# Accept exit code 1: the bogus "blah" package fails to install.
assert result.exit_code in (0, 1)
check_selection(result, {manager_id})
[docs]
def test_ignore_unrecognized_manager(invoke, create_config):
toml_path = create_config(
"unrecognized.toml",
"""
[random_section]
blah = 123
""",
)
result = invoke("--verbosity", "INFO", "restore", str(toml_path))
assert result.exit_code == 0
assert "unrecognized.toml" in result.stderr
assert "Ignore [random_section] section" in result.stderr
[docs]
@pytest.mark.destructive()
# Only npm acts here, but nothing parametrizes it: hand it its group.
@pytest.mark.xdist_group(name=destructive_group("npm"))
def test_restore_single_manager(invoke, create_config):
toml_path = create_config(
"uv-npm-dummy.toml",
"""
[uv]
leftpad = "0.1.2"
[npm]
chance = "1.1.9"
""",
)
result = invoke(
"--verbosity", "INFO", "--npm", "restore", str(toml_path), color=False
)
# Accept exit code 1: an end-to-end install can fail on a flaky backend.
assert result.exit_code in (0, 1)
assert "uv-npm-dummy.toml" in result.stderr
assert ":uv.install: Restore packages." not in result.stderr
assert ":npm.install: Restore packages." in result.stderr
[docs]
@pytest.mark.destructive()
# `--no-npm` leaves uv as the acting manager: hand it uv's group.
@pytest.mark.xdist_group(name=destructive_group("uv"))
def test_restore_excluded_manager(invoke, create_config):
toml_path = create_config(
"uv-npm-dummy.toml",
"""
[uv]
leftpad = "0.1.2"
[npm]
chance = "1.1.9"
""",
)
result = invoke(
"--verbosity",
"INFO",
"--no-npm",
"restore",
str(toml_path),
color=False,
)
# Accept exit code 1: an end-to-end install can fail on a flaky backend.
assert result.exit_code in (0, 1)
assert "uv-npm-dummy.toml" in result.stderr
assert ":uv.install: Restore packages." in result.stderr
assert ":npm.install: Restore packages." not in result.stderr
[docs]
def test_empty_manager(invoke, create_config):
toml_path = create_config(
"uv-empty.toml",
"""
[uv]
""",
)
result = invoke("--verbosity", "INFO", "restore", str(toml_path), color=False)
assert result.exit_code == 0
assert "uv-empty.toml" in result.stderr
assert ":uv.install: Restore packages." in result.stderr
[docs]
@pytest.mark.parametrize("from_stdin", (False, True), ids=("file", "stdin"))
def test_restore_reports_what_moved(
invoke, create_config, changing_fake_pool, from_stdin
):
"""Restoring a snapshot reports each package installed, at its version.
The snapshot is read as UTF-8 from a file and from `<stdin>` alike: the `Á`
of its comment holds a byte that `cp1252`, the encoding of Windows, cannot
decode.
"""
mid = changing_fake_pool.id
snapshot = f"""
# Taken in Ávila.
[{mid}]
fake-pkg-theta = "2.0.0"
"""
if from_stdin:
result = invoke("restore", "-", input=snapshot)
else:
result = invoke("restore", str(create_config("snapshot.toml", snapshot)))
assert result.exit_code == 0
check_report(
result.stdout,
{
"fake-pkg-gamma": ("0.1.0", PackageOutcome.INSTALLED.label),
"fake-pkg-theta": ("2.0.0", PackageOutcome.INSTALLED.label),
},
)