Source code for tests.test_cli_restore

# Copyright Kevin Deldycke <kevin@deldycke.com> 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

import pytest

from meta_package_manager.capabilities import Operations
from meta_package_manager.pool import pool

from .conftest import default_manager_ids
from .test_cli import CLISubCommandTests




@pytest.fixture
def subcmd(create_config):
    """Seed common subcommand tests with a dummy file and content to allow the CLI to
    not fail on required file input."""
    toml_path = create_config(
        "dummy.toml",
        """
        [dummy_manager]
        fancy_package = "0.0.1"
        """,
    )
    return "restore", str(toml_path)





class TestRestore(CLISubCommandTests):


    @staticmethod
    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}: Restore packages..." in stderr,
            f":{mid}: Skipped:" in stderr,
        )




    @pytest.mark.destructive()
    def test_default_all_managers(self, 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
        self.check_manager_selection(result)




    @pytest.mark.destructive()
    @default_manager_ids
    def test_single_manager(self, 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:
            self.assert_no_manager_selected(result)
        else:
            # Accept exit code 1: the bogus "blah" package fails to install.
            assert result.exit_code in (0, 1)
            self.check_manager_selection(result, {manager_id})




    def test_ignore_unrecognized_manager(self, 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




    @pytest.mark.destructive()
    def test_restore_single_manager(self, 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: Restore packages..." not in result.stderr
        assert ":npm: Restore packages..." in result.stderr




    @pytest.mark.destructive()
    def test_restore_excluded_manager(self, 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: Restore packages..." in result.stderr
        assert ":npm: Restore packages..." not in result.stderr




    def test_empty_manager(self, 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: Restore packages..." in result.stderr