Merge branch 'release/v1.5.0' into release/2.0

Author: connesy

CHANGELOG.md

@@ -1,10 +1,28 @@
 # Changelog
 
-## [v2.0.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/tree/release/2.0)
+## [v2.0.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v2.0.0)
 
 ### Major changes
 * `venv sync` has been removed. Use `venv install <requirements>.lock` instead. [#17](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/17)
 
+## [v1.5.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.5.0) (2024-01-04)
+
+### Major changes
+* Added `venv delete` command. [#25](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/25)
+
+  Running `venv delete` completely removes the virtual environment located in the current folder.
+
+### Minor changes
+* Added `-s` alias for `--skip-lock` when running `venv install`. [#24](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/24)
+
+### Internal changes
+* The `run_command` test helper function can now pass through inputs to the command that is being run.
+
+## [v1.4.1](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.4.1) (2023-10-30)
+
+### Bugfixes
+* Fixed `venv lock` failing to lock when called as part of `venv install`. [#21](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/21)
+
 ## [v1.4.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.4.0) (2023-10-30)
 
 ### Minor changes

src/venv-cli/completions/bash/venv_completion.sh

@@ -5,7 +5,7 @@ _venv() {
     cur_word="${COMP_WORDS[COMP_CWORD]}"
     prev_word="${COMP_WORDS[COMP_CWORD-1]}"
 
-    _subcommands="activate clear create deactivate install lock"
+    _subcommands="activate clear create deactivate delete install lock"
     subcommands=( $(compgen -W "${_subcommands}" -- "${cur_word}") )
     help_options=( $(compgen -W "-h --help" -- "${cur_word}") )
 
@@ -39,6 +39,11 @@ _venv() {
             COMPREPLY+=( ${python_versions[*]} )
             COMPREPLY+=( ${help_options[*]} )
             ;;
+        "delete")
+            # Generate completion for help_options plus the '-y' option
+            COMPREPLY+=( ${help_options[*]} )
+            COMPREPLY+=( $(compgen -W "-y" -- "${cur_word}") )
+            ;;
         "install")
             # Generate completions for requirement and lock file paths
             COMPREPLY+=( $(compgen -f -X '!(*.txt|*.lock)' -- "${cur_word}" | sort) )

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.4.0"
+_version="v1.5.0"
 
 # Valid VCS URL environment variable pattern
 # https://peps.python.org/pep-0610/#specification
@@ -163,15 +163,60 @@ venv::deactivate() {
 }
 
 
+venv::delete() {
+  if venv::_check_if_help_requested "$1"; then
+    echo "venv delete [-y]"
+    echo
+    echo "Delete the virtual environment located in the current folder."
+    echo "If the environment is currently active, it will be deactivated first."
+    echo
+    echo "Examples:"
+    echo "$ venv delete"
+    echo "Are you sure you want to delete the virtual environment in .venv? [y/N]"
+    echo "y"
+    echo "$ Virtual environment deleted!"
+    return "${_success}"
+  fi
+
+  if [ ! -d .venv ]; then
+    venv::color_echo "${_yellow}" "No virtual environment found, nothing to delete."
+    return "${_success}"
+  fi
+
+  # If -y is not supplied as input argument, prompt the user for confirmation
+  if [ "$1" != "-y" ]; then
+    echo "Are you sure you want to delete the virtual environment in .venv? [y/N]"
+    read -r response
+
+    local accept_pattern="^([yY][eE][sS]|[yY])$"
+    if [[ ! "${response}" =~ $accept_pattern ]]; then
+      venv::color_echo "${_yellow}" "Aborting."
+      return "${_success}"
+    fi
+  fi
+
+  venv::color_echo "${_yellow}" "Deleting virtual environment in .venv ..."
+  if [ ! -z "${VIRTUAL_ENV}" ]; then
+    venv::deactivate
+  fi
+
+  if ! rm -rf .venv; then
+    # If the virtual environment could not be deleted
+    return "${_fail}"
+  fi
+  venv::color_echo "${_green}" "Virtual environment deleted!"
+}
+
+
 venv::install() {
   if venv::_check_if_help_requested "$1"; then
-    echo "venv install [<requirements file>] [--skip-lock] [<install args>]"
+    echo "venv install [<requirements file>] [--skip-lock|-s] [<install args>]"
     echo
     echo "Clear the environment, then install requirements from <requirements file>,"
     echo "like 'requirements.txt' or 'requirements.lock'."
     echo "Installed packages are then locked into the corresponding .lock-file,"
     echo "e.g. 'venv install requirements.txt' will lock packages into 'requirements.lock'."
-    echo "This step is skipped if '--skip-lock' is specified, or when installing"
+    echo "This step is skipped if '--skip-lock' or '-s' is specified, or when installing"
     echo "directly from a .lock-file."
     echo
     echo "The <requirements file> must be in the form '*requirements.[txt|lock]'."
@@ -185,12 +230,12 @@ venv::install() {
     echo
     echo "$ venv install dev-requirements.txt"
     echo
-    echo "$ venv install requirements.txt --skip-lock --no-cache"
+    echo "$ venv install requirements.txt --skip-lock|-s --no-cache"
     return "${_success}"
   fi
 
   local requirements_file
-  if [ -z "$1" ] || [ "$1" = "--skip-lock" ]; then
+  if [ -z "$1" ] || [ "$1" = "--skip-lock" ] || [ "$1" = "-s" ]; then
     # If no filename was passed
     requirements_file="requirements.txt"
 
@@ -206,7 +251,7 @@ venv::install() {
   fi
 
   local skip_lock=false
-  if [ "$1" = "--skip-lock" ]; then
+  if [ "$1" = "--skip-lock" ] || [ "$1" = "-s" ]; then
     skip_lock=true
     shift
   fi
@@ -226,7 +271,7 @@ venv::install() {
     return "${_success}"
   fi
 
-  venv::lock "${requirements_file}" "${lock_file}"
+  venv::lock "${lock_file}"
   return "$?"  # Return exit status from venv::lock command
 }
 
@@ -312,6 +357,7 @@ venv::help() {
   echo
   echo "create         Create a new virtual environment in the current folder"
   echo "activate       Activate the virtual environment in the current folder"
+  echo "delete         Delete the virtual environment in the current folder"
   echo "install        Install requirements from a requirements file in the current environment"
   echo "lock           Lock installed requirements in a '.lock'-file"
   echo "clear          Remove all installed packages in the current environment"
@@ -337,6 +383,7 @@ venv::main() {
 
     create \
     | activate \
+    | delete \
     | install \
     | lock \
     | clear \

tests/helpers.py

@@ -3,7 +3,7 @@
 import sys
 from functools import wraps
 from pathlib import Path
-from typing import Callable
+from typing import Callable, Optional
 
 from tests.types import P, RawFilesDict, RequirementsBase, RequirementsDict
 
@@ -27,13 +27,29 @@ def _command_setup(venv_cli_path: Path, activate: bool = False) -> list[str]:
     return [*bash, full_command]
 
 
-def run_command(commands: str | list[str], cwd: Path = Path.cwd(), activated: bool = False) -> None:
+def run_command(
+    commands: str | list[str],
+    cwd: Path = Path.cwd(),
+    activated: bool = False,
+    command_input: Optional[str] = None,
+) -> None:
+    """Run a command in a subprocess, optionally activating the virtual environment first
+
+    Args:
+        commands: The command(s) to run.
+        cwd: The directory to run the command in. Defaults to the current working directory.
+        activated: Whether to activate the virtual environment before running the command.
+        command_input: The input to pass to the command. Defaults to None.
+
+    Raises:
+        subprocess.CalledProcessError: If the command returns a non-zero exit code.
+    """
     input_commands = [commands] if isinstance(commands, str) else commands
 
     setup_commands = _command_setup(venv_cli_path=_venv_cli_path, activate=activated)
     all_commands = [*setup_commands[:-1], setup_commands[-1] + "; ".join(input_commands)]
 
-    result = subprocess.run(all_commands, cwd=cwd)
+    result = subprocess.run(all_commands, cwd=cwd, input=command_input, text=True)
     result.check_returncode()
 
 

tests/test_venv_delete.py

@@ -0,0 +1,51 @@
+from pathlib import Path
+
+import pytest
+import pytest_cases
+
+from tests.helpers import run_command
+
+
+@pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
+@pytest_cases.parametrize("yes", ["y", "yes", "Y", "Yes", "YES"])
+@pytest_cases.parametrize("activated", [False, True])
+def test_venv_delete_ask_confirmation_yes(activated: bool, yes: str, tmp_path: Path):
+    venv_path = tmp_path / ".venv"
+
+    # Execute: Create, then delete, the virtual environment
+    run_command("venv delete", command_input=yes, cwd=tmp_path, activated=activated)
+
+    # Verify: check that the virtual environment directory no longer exists
+    assert not venv_path.is_dir()
+
+    # Test that trying to delete again doesn't cause an error
+    run_command("venv delete", command_input=yes, cwd=tmp_path, activated=activated)
+
+
+@pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
+@pytest_cases.parametrize("no", ["", "n", "N", "No", "NO", "asd"])
+@pytest_cases.parametrize("activated", [False, True])
+def test_venv_delete_ask_confirmation_no(activated: bool, no: str, tmp_path: Path):
+    venv_path = tmp_path / ".venv"
+
+    # Execute: Create, then try to delete, the virtual environment, but say no
+    run_command("venv delete", command_input=no, cwd=tmp_path, activated=activated)
+
+    if activated:
+        # Verify: check that the virtual environment directory still exists (if it was created)
+        assert venv_path.is_dir()
+
+
+@pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
+@pytest_cases.parametrize("activated", [False, True])
+def test_venv_delete_no_confirmation(activated: bool, tmp_path: Path):
+    venv_path = tmp_path / ".venv"
+
+    # Execute: Create, then delete, the virtual environment
+    run_command("venv delete -y", cwd=tmp_path, activated=activated)
+
+    # Verify: check that the virtual environment directory no longer exists
+    assert not venv_path.is_dir()
+
+    # Test that trying to delete again doesn't cause an error
+    run_command("venv delete -y", cwd=tmp_path, activated=activated)

tests/test_venv_install.py

@@ -6,7 +6,7 @@
 from pytest_cases import parametrize_with_cases
 
 from tests.helpers import run_command, write_files
-from tests.test_venv_install_cases import CasesVenvInstallRequirementstxt
+from tests.test_venv_install_cases import CasesVenvInstallRequirementstxt, CasesVenvInstallWithLock
 from tests.types import RequirementsBase, RequirementsDict
 
 _package_name_regex = re.compile(r"^([a-zA-Z0-9_-]+)\b")
@@ -60,3 +60,19 @@ def test_venv_install_requirements(
             continue
 
         _check_package_was_installed(requirement=requirement, installed_line=installed_line)
+
+
+@pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
+@parametrize_with_cases(argnames=["files", "requirements_base"], cases=CasesVenvInstallWithLock)
+def test_venv_install_with_lock(
+    files: RequirementsDict,
+    requirements_base: RequirementsBase,
+    tmp_path: Path,
+):
+    write_files(files=files, dir=tmp_path)
+
+    run_command(
+        f"venv install {requirements_base}.txt",
+        cwd=tmp_path,
+        activated=True,
+    )

tests/test_venv_install_cases.py

@@ -54,3 +54,14 @@ def case_git_dev(self) -> tuple[RawFilesDict, RequirementsBase]:
             "dev-requirements.txt": dev_requirements_txt,
         }
         return files, RequirementsBase.dev_requirements
+
+
+class CasesVenvInstallWithLock:
+    @collect_requirements
+    def case_pypi(self) -> tuple[RawFilesDict, RequirementsBase]:
+        requirements_txt = [
+            "python-json-logger==2.0.7",
+        ]
+
+        files = {"requirements.txt": requirements_txt}
+        return files, RequirementsBase.requirements