From cfe36123647e5d81d35bcec764d64bfa98747421 Mon Sep 17 00:00:00 2001
From: Douglas Raillard <douglas.raillard@arm.com>
Date: Thu, 14 Jul 2022 14:36:24 +0100
Subject: [PATCH] shell/lisa_shell: Allow lisa-install to upgrade venv

FEATURE

Setting LISA_UPGRADE_VENV=1 env var will make lisa-install upgrade any
existing venv that would have been setup with LISA_USE_VENV=1 and
LISA_VENV_PATH=... instead of destroying it and creating it afresh.
---
 doc/man1/lisa.1  |  9 +++++++++
 shell/lisa_shell | 24 +++++++++++++++++++-----
 2 files changed, 28 insertions(+), 5 deletions(-)

diff --git a/doc/man1/lisa.1 b/doc/man1/lisa.1
index 48c9c6416..d18315d0f 100644
--- a/doc/man1/lisa.1
+++ b/doc/man1/lisa.1
@@ -254,6 +254,15 @@ results
 T}
 _
 T{
+LISA_UPGRADE_VENV
+T}	T{
+1 to make lisa\-install upgrade the venv specified in LISA_VENV_PATH.
+If 0, lisa\-install will destroy the venv and re\-create anew
+T}	T{
+0
+T}
+_
+T{
 LISA_USE_SYSTEM_BIN
 T}	T{
 Use the system binaries if 1, will use the ones shipped with LISA if 0
diff --git a/shell/lisa_shell b/shell/lisa_shell
index 0b3ebb5d7..5e9e61130 100755
--- a/shell/lisa_shell
+++ b/shell/lisa_shell
@@ -105,12 +105,18 @@ function lisa-help {
 
 # major.minor version number
 PYTHON_VERSION=$(_lisa-python -c 'import sys; print("{}.{}".format(*sys.version_info))')
+
 export _DOC_LISA_USE_VENV="1 to make lisa-install use a venv specified in
 LISA_VENV_PATH, 0 otherwise"
 export LISA_USE_VENV=${LISA_USE_VENV:-1}
+
 export _DOC_LISA_VENV_PATH="Path to venv to be used by lisa-install"
 export LISA_VENV_PATH=${LISA_VENV_PATH:-"$LISA_HOME/.lisa-venv-$PYTHON_VERSION"}
 
+export _DOC_LISA_UPGRADE_VENV="1 to make lisa-install upgrade the venv specified in
+LISA_VENV_PATH. If 0, lisa-install will destroy the venv and re-create anew"
+export LISA_UPGRADE_VENV=${LISA_UPGRADE_VENV:-0}
+
 
 # Force the shell to rescan the folders listed in $PATH
 function _lisa-reload-PATH {
@@ -124,9 +130,13 @@ function _lisa-venv-create {
         # otherwise it will fail with a symlink levels errors
         lisa-venv-deactivate || return 1
 
-        echo "Creating LISA venv from scratch ($LISA_VENV_PATH) ..."
+        local venv_options=()
+        if [[ "$LISA_UPGRADE_VENV" != 1 ]]; then
+            echo "Creating LISA venv from scratch ($LISA_VENV_PATH) ..."
+            venv_options+=(--clear)
+        fi
         # With --clear, the folder is emptied to create a fresh environment
-        _lisa-python -m venv --clear "$LISA_VENV_PATH"
+        _lisa-python -m venv "${venv_options[@]}" "$LISA_VENV_PATH"
     fi
 }
 
@@ -165,7 +175,6 @@ function _lisa-upgrade-pip {
     # Only upgrade pip when using the venv, so we don't touch the system-wide
     # install
     if [[ "$LISA_USE_VENV" == 1 ]]; then
-        lisa-venv-activate || return 1
         echo "Upgrading pip ..."
         _lisa-python -m pip install --upgrade pip setuptools wheel
     fi
@@ -209,8 +218,9 @@ function _lisa-install-git-hooks {
 function lisa-install {
     _lisa-install-system-check
 
-    _lisa-venv-create &&
-    _lisa-upgrade-pip || return 1
+    _lisa-venv-create || return 1
+    lisa-venv-activate || return 1
+    _lisa-upgrade-pip
 
     # Record the point in time when we ran that install command
     (cd "$LISA_HOME" && check-setuppy --update-recorded-commit HEAD)
@@ -248,6 +258,10 @@ function lisa-install {
         [[ -e "$f" ]] && pip_options+=(-r "$f")
     done
 
+    if [[ "$LISA_UPGRADE_VENV" == 1 ]]; then
+        pip_options+=(--upgrade --upgrade-strategy eager)
+    fi
+
     echo
     echo "Installing LISA packages ..."
     echo
-- 
GitLab