Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(charm_builder): de-duplicate installed pkgs #1750

Merged
merged 2 commits into from
Jul 22, 2024
Merged

fix(charm_builder): de-duplicate installed pkgs #1750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c0d2b3
fix(charm_builder): de-duplicate installed pkgs
lengau Jul 22, 2024
e0bdd5e
style: autoformat
lengau Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion charmcraft/charm_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
make_executable,
validate_strict_dependencies,
)
from charmcraft.utils.package import exclude_packages

MINIMUM_PIP_VERSION = (24, 1)
KNOWN_GOOD_PIP_URL = "https://files.pythonhosted.org/packages/c0/d0/9641dc7b05877874c6418f8034ddefc809495e65caa14d38c7551cd114bb/pip-24.1.1.tar.gz"
Expand Down Expand Up @@ -273,13 +274,19 @@ def _install_dependencies(self, staging_venv_dir):
_process_run([pip_cmd, "install", "--no-binary=:all:", *self.python_packages])
if self.requirement_paths or self.charmlib_deps:
print("Installing packages from requirements files and charm lib dependencies.")
requirements_packages = get_requirements_file_package_names(
*self.requirement_paths
)
new_libs_deps = exclude_packages(
set(self.charmlib_deps), excluded=requirements_packages
)
_process_run(
[
pip_cmd,
"install",
"--no-binary=:all:",
*(f"--requirement={path}" for path in self.requirement_paths),
*self.charmlib_deps,
*new_libs_deps,
]
)

Expand Down
257 changes: 129 additions & 128 deletions tests/test_charm_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import socket
import subprocess
import sys
from collections.abc import Callable
from unittest.mock import call, patch

import pytest
Expand Down Expand Up @@ -581,22 +582,140 @@ def test_build_dispatcher_classic_hooks_linking_charm_replaced(tmp_path, assert_
# -- tests about dependencies handling


def test_build_dependencies_virtualenv_simple(tmp_path, assert_output):
@pytest.mark.parametrize(
("python_packages", "binary_packages", "reqs_contents", "charmlibs", "expected_call_params"),
[
pytest.param(
[],
[],
[],
[],
[["install", "--no-binary=:all:", "--requirement={reqs_file}"]],
id="simple",
),
pytest.param(
["pkg1", "pkg2"],
[],
[],
[],
[
["install", "--no-binary=:all:", "pkg1", "pkg2"],
["install", "--no-binary=:all:", "--requirement={reqs_file}"],
],
id="packages-only",
),
pytest.param(
[],
["bin-pkg1", "bin-pkg2"],
[],
[],
[
["install", "bin-pkg1", "bin-pkg2"],
["install", "--no-binary=:all:", "--requirement={reqs_file}"],
],
id="binary-packages-only",
),
pytest.param(
["pkg1", "pkg2"],
["bin-pkg1", "bin-pkg2"],
[],
[],
[
["install", "bin-pkg1", "bin-pkg2"],
["install", "--no-binary=:all:", "pkg1", "pkg2"],
["install", "--no-binary=:all:", "--requirement={reqs_file}"],
],
id="binary-and-source-packages",
),
pytest.param(
[],
[],
["req1", "req2"],
[],
[
["install", "--no-binary=:all:", "--requirement={reqs_file}"],
],
id="requirements-only",
),
pytest.param(
["req1"],
["req2"],
["req1", "req2"],
[],
[
["install", "req2"],
["install", "--no-binary=:all:", "req1"],
["install", "--no-binary=:all:", "--requirement={reqs_file}"],
],
id="requirements-duplicated-in-charmcraft_yaml",
),
pytest.param(
[],
[],
[],
["charmlib-dep"],
[["install", "--no-binary=:all:", "--requirement={reqs_file}", "charmlib-dep"]],
id="charmlib-dep-only",
),
pytest.param(
[],
[],
["charmlib-dep==0.1", "req1"],
["charmlib-dep"],
[["install", "--no-binary=:all:", "--requirement={reqs_file}"]],
id="charmlib-dep-in-requirements",
),
pytest.param(
["duplicate"],
["duplicate"],
["duplicate"],
["duplicate"],
[
["install", "duplicate"],
["install", "--no-binary=:all:", "duplicate"],
["install", "--no-binary=:all:", "--requirement={reqs_file}"],
],
id="all-same",
),
pytest.param(
["duplicate", "pkg1"],
["duplicate", "bin-pkg1"],
["duplicate", "req1"],
["duplicate", "lib-dep"],
[
["install", "bin-pkg1", "duplicate"],
["install", "--no-binary=:all:", "duplicate", "pkg1"],
["install", "--no-binary=:all:", "--requirement={reqs_file}", "lib-dep"],
],
id="all-overlap",
),
],
)
def test_build_dependencies_virtualenv(
tmp_path: pathlib.Path,
assert_output: Callable,
python_packages: list[str],
binary_packages: list[str],
reqs_contents: list[str],
charmlibs: list[str],
expected_call_params,
):
"""A virtualenv is created with the specified requirements file."""
build_dir = tmp_path / const.BUILD_DIRNAME
build_dir.mkdir()

reqs_file = tmp_path / "reqs.txt"
reqs_file.touch()
reqs_file.write_text("\n".join(reqs_contents))

builder = CharmBuilder(
builddir=tmp_path,
installdir=build_dir,
entrypoint=pathlib.Path("whatever"),
binary_python_packages=[],
python_packages=[],
binary_python_packages=binary_packages,
python_packages=python_packages,
requirements=[reqs_file],
)
builder.charmlib_deps = set(charmlibs)

with patch("charmcraft.charm_builder.get_pip_version") as mock_pip_version:
mock_pip_version.return_value = (22, 0)
Expand All @@ -606,10 +725,15 @@ def test_build_dependencies_virtualenv_simple(tmp_path, assert_output):

pip_cmd = str(charm_builder._find_venv_bin(tmp_path / const.STAGING_VENV_DIRNAME, "pip"))

formatted_calls = [
[param.format(reqs_file=str(reqs_file)) for param in call] for call in expected_call_params
]
extra_pip_calls = [call([pip_cmd, *params]) for params in formatted_calls]

assert mock.mock_calls == [
call(["python3", "-m", "venv", str(tmp_path / const.STAGING_VENV_DIRNAME)]),
call([pip_cmd, "install", f"pip@{KNOWN_GOOD_PIP_URL}"]),
call([pip_cmd, "install", "--no-binary=:all:", f"--requirement={reqs_file}"]),
*extra_pip_calls,
]

site_packages_dir = charm_builder._find_venv_site_packages(
Expand Down Expand Up @@ -687,129 +811,6 @@ def test_build_dependencies_virtualenv_none(tmp_path, assert_output):
assert_output("Handling dependencies", "No dependencies to handle")


def test_build_dependencies_virtualenv_packages(tmp_path, assert_output):
"""A virtualenv is created with the specified packages."""
build_dir = tmp_path / const.BUILD_DIRNAME
build_dir.mkdir()

builder = CharmBuilder(
builddir=tmp_path,
installdir=build_dir,
entrypoint=pathlib.Path("whatever"),
binary_python_packages=[],
python_packages=["pkg1", "pkg2"],
requirements=[],
)

with patch("charmcraft.charm_builder.get_pip_version") as mock_pip_version:
mock_pip_version.return_value = (22, 0)
with patch("charmcraft.charm_builder._process_run") as mock:
with patch("shutil.copytree") as mock_copytree:
builder.handle_dependencies()

pip_cmd = str(charm_builder._find_venv_bin(tmp_path / const.STAGING_VENV_DIRNAME, "pip"))

assert mock.mock_calls == [
call(["python3", "-m", "venv", str(tmp_path / const.STAGING_VENV_DIRNAME)]),
call([pip_cmd, "install", f"pip@{KNOWN_GOOD_PIP_URL}"]),
call([pip_cmd, "install", "--no-binary=:all:", "pkg1", "pkg2"]),
]

site_packages_dir = charm_builder._find_venv_site_packages(
pathlib.Path(const.STAGING_VENV_DIRNAME)
)
assert mock_copytree.mock_calls == [call(site_packages_dir, build_dir / const.VENV_DIRNAME)]
assert_output("Handling dependencies", "Installing dependencies")


def test_build_dependencies_virtualenv_binary_packages(tmp_path, assert_output):
"""A virtualenv is created with the specified packages."""
build_dir = tmp_path / const.BUILD_DIRNAME
build_dir.mkdir()

builder = CharmBuilder(
builddir=tmp_path,
installdir=build_dir,
entrypoint=pathlib.Path("whatever"),
binary_python_packages=["pkg1", "pkg2"],
python_packages=[],
requirements=[],
)

with patch("charmcraft.charm_builder.get_pip_version") as mock_pip_version:
mock_pip_version.return_value = (22, 0)
with patch("charmcraft.charm_builder._process_run") as mock:
with patch("shutil.copytree") as mock_copytree:
builder.handle_dependencies()

pip_cmd = str(charm_builder._find_venv_bin(tmp_path / const.STAGING_VENV_DIRNAME, "pip"))

assert mock.mock_calls == [
call(["python3", "-m", "venv", str(tmp_path / const.STAGING_VENV_DIRNAME)]),
call([pip_cmd, "install", f"pip@{KNOWN_GOOD_PIP_URL}"]),
call([pip_cmd, "install", "pkg1", "pkg2"]),
]

site_packages_dir = charm_builder._find_venv_site_packages(
pathlib.Path(const.STAGING_VENV_DIRNAME)
)
assert mock_copytree.mock_calls == [call(site_packages_dir, build_dir / const.VENV_DIRNAME)]
assert_output("Handling dependencies", "Installing dependencies")


def test_build_dependencies_virtualenv_all(tmp_path, assert_output):
"""A virtualenv is created with the specified packages."""
build_dir = tmp_path / const.BUILD_DIRNAME
build_dir.mkdir()

reqs_file_1 = tmp_path / "reqs.txt"
reqs_file_1.touch()
reqs_file_2 = tmp_path / "reqs.txt"
reqs_file_1.touch()

builder = CharmBuilder(
builddir=tmp_path,
installdir=build_dir,
entrypoint=pathlib.Path("whatever"),
binary_python_packages=["pkg1", "pkg2"],
python_packages=["pkg3", "pkg4"],
requirements=[reqs_file_1, reqs_file_2],
)
builder.charmlib_deps = ["pkg5", "pkg6"]

with patch("charmcraft.charm_builder.get_pip_version") as mock_pip_version:
mock_pip_version.return_value = (22, 0)
with patch("charmcraft.charm_builder._process_run") as mock:
with patch("shutil.copytree") as mock_copytree:
builder.handle_dependencies()

pip_cmd = str(charm_builder._find_venv_bin(tmp_path / const.STAGING_VENV_DIRNAME, "pip"))

assert mock.mock_calls == [
call(["python3", "-m", "venv", str(tmp_path / const.STAGING_VENV_DIRNAME)]),
call([pip_cmd, "install", f"pip@{KNOWN_GOOD_PIP_URL}"]),
call([pip_cmd, "install", "pkg1", "pkg2"]),
call([pip_cmd, "install", "--no-binary=:all:", "pkg3", "pkg4"]),
call(
[
pip_cmd,
"install",
"--no-binary=:all:",
f"--requirement={reqs_file_1}",
f"--requirement={reqs_file_2}",
"pkg5",
"pkg6",
]
),
]

site_packages_dir = charm_builder._find_venv_site_packages(
pathlib.Path(const.STAGING_VENV_DIRNAME)
)
assert mock_copytree.mock_calls == [call(site_packages_dir, build_dir / const.VENV_DIRNAME)]
assert_output("Handling dependencies", "Installing dependencies")


def test_build_dependencies_no_reused_missing_venv(tmp_path, assert_output):
"""Dependencies are built again because installation dir was not found."""
build_dir = tmp_path / const.BUILD_DIRNAME
Expand Down
Loading