Release v1.5.1 (#33)

v1.5.1

Author: connesy

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v1.5.1](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.5.1) (2024-01-10)
+
+### Minor changes
+* `venv install` now fails early and with a more descriptve error message when run outside of a virtual environment. [#30](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/30)
+
+### Bug fixes
+* `venv clear` is now able to clear virtual environments that contain editable installs. [#30](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/30)
+
 ## [v1.5.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.5.0) (2024-01-04)
 
 ### Major changes

src/venv-cli/venv.sh

@@ -9,7 +9,7 @@ _yellow="\033[01;33m"
 _red="\033[31m"
 
 # Version number has to follow pattern "^v\d+\.\d+\.\d+.*$"
-_version="v1.5.0"
+_version="v1.5.1"
 
 # Valid VCS URL environment variable pattern
 # https://peps.python.org/pep-0610/#specification
@@ -34,6 +34,14 @@ venv::raise() {
   return "${_fail}"
 }
 
+venv::_check_venv_activated() {
+  if [ -z "${VIRTUAL_ENV}" ]; then
+    venv::raise "No virtual environment activated. Please activate the virtual environment first"
+    return "${_fail}"
+  fi
+  return "${_success}"
+}
+
 venv::_check_if_help_requested() {
   if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
     return "${_success}"
@@ -258,7 +266,9 @@ venv::install() {
 
   # Clear the environment before running pip install to avoid orphaned packages
   # https://github.com/SallingGroup-AI-and-ML/venv-cli/issues/9
-  venv::clear
+  if ! venv::clear; then
+    return "${_fail}"
+  fi
 
   venv::color_echo "${_green}" "Installing requirements from ${requirements_file}"
   if ! pip install --require-virtualenv --use-pep517 -r "${requirements_file}" "$@"; then
@@ -339,9 +349,16 @@ venv::clear() {
     return "${_success}"
   fi
 
+  if ! venv::_check_venv_activated; then
+    return "${_fail}"
+  fi
+
   venv::color_echo "${_yellow}" "Removing all packages from virtual environment ..."
-  pip freeze --require-virtualenv \
-    | cut -d "@" -f1 \
+  pip list --format freeze \
+    --exclude pip \
+    --exclude setuptools \
+    --exclude wheel \
+    | cut -d "=" -f1 \
     | xargs --no-run-if-empty pip uninstall --require-virtualenv -y
   venv::color_echo "${_green}" "All packages removed!"
 }

tests/test_venv_install.py

@@ -1,4 +1,5 @@
 import re
+import subprocess
 from itertools import chain
 from pathlib import Path
 
@@ -22,6 +23,12 @@ def _check_package_was_installed(requirement: str, installed_line: str) -> None:
     assert package_name in installed_line, f"Package {package_name} was not installed succesfully"
 
 
+def test_venv_install_not_activated(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    with pytest.raises(subprocess.CalledProcessError), monkeypatch.context() as m:
+        m.delenv("VIRTUAL_ENV", raising=False)
+        run_command(["venv install"], cwd=tmp_path, activated=False)
+
+
 @pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
 @parametrize_with_cases(argnames=["files", "requirements_base"], cases=CasesVenvInstallRequirementstxt)
 @pytest.mark.parametrize("use_file_name", [True, False])

tests/test_venv_internals.py

@@ -1,10 +1,22 @@
 import subprocess
+from pathlib import Path
 
 import pytest
 
 from tests.helpers import run_command
 
 
+def test_check_venv_activated_no_env(monkeypatch: pytest.MonkeyPatch, tmp_path: Path):
+    with pytest.raises(subprocess.CalledProcessError), monkeypatch.context() as m:
+        m.delenv("VIRTUAL_ENV", raising=False)
+        run_command(["venv::_check_venv_activated"], cwd=tmp_path, activated=False)
+
+
+@pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
+def test_check_venv_activated_yes_env(tmp_path: Path):
+    run_command("venv::_check_venv_activated", cwd=tmp_path, activated=True)
+
+
 @pytest.mark.order("first")
 @pytest.mark.parametrize(
     ["filename", "expected"],