cleanup virtual environment creation and usage procedure

Author: Cerem Cem ASLAN

Makefile

@@ -1,13 +1,7 @@
 DIR:=$(strip $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))))
 
-include $(DIR)/venv-version.txt
-VENV_NAME := $(VENV_NAME)
-$(eval VENV_PATH := $(shell echo "$$$(VENV_VERSION)"))
 APP := main
-CONFIG := ../dcs-modules.txt
-
-__test_variables:
-	@echo $(VENV_VERSION) path is set to $(VENV_PATH)
+CONFIG := $(DIR)../dcs-modules.txt
 
 .PHONY: test-es6-compat update-deps update-app-version
 
@@ -63,13 +57,25 @@ freeze-venv: __c
 	freeze ./requirements.txt
 
 create-venv:
-	$(if $(VENV_PATH),$(error $(VENV_VERSION) variable is set, use it instead: $(VENV_PATH)))
+ifndef SCADAJS_VENV_PATH
+	$(error SCADAJS_VENV_PATH can not be empty. Please provide an installation path to create a venv.)
+endif
+ifneq ($(wildcard $(SCADAJS_VENV_PATH)/.*),)
+	$(error SCADAJS_VENV_PATH is already created, use that instead: $(SCADAJS_VENV_PATH)))
+endif
+	$(eval VENV_NAME := $(shell basename $(SCADAJS_VENV_PATH)))
 	$(eval NODE_VERSION := $(shell echo `grep "^#node@" nodeenv.txt | cut -d@ -f2` | sed 's/^$$/system/'))
-	nodeenv --requirement=./nodeenv.txt --node=$(NODE_VERSION) --prompt="($(VENV_NAME))" --jobs=4 nodeenv
+	nodeenv --requirement=./nodeenv.txt --node=$(NODE_VERSION) --prompt="($(VENV_NAME))" --jobs=4 $(SCADAJS_VENV_PATH)
 
 use-venv:
 	./venv
 
+update-venv:
+	@echo "Virtual environment should not be updated. Create a new virtual environment"
+	@echo "with the new dependency versions and use that venv instead. If there is no "
+	@echo "breaking changes, simply backup the old venv and replace the new venv with "
+	@echo "the old one. This is the safest path to follow."
+
 __prepare_release_dir:
 	@( if [ ! -d release/$(APP) ]; then \
 		 	mkdir -p release; \

doc/using-virtual-environment.md

@@ -18,7 +18,7 @@
 3. Create the virtual environment and activate it:
 
         $ cd ./scada.js
-        $ make create-venv
+        $ make create-venv SCADAJS_VENV_PATH=/path/to/somewhere/scadajs1
         $ ./venv
         (scadajs1) $ 
 

nodeenv.txt

@@ -1,4 +1,4 @@
-#node@12.18.2
+#node@16.15.1
 es-check@5.1.0
 gulp@4.0.2
 livescript@1.6.0

venv

@@ -11,46 +11,42 @@ set -e -o pipefail
 safe_source () { [[ ! -z ${1:-} ]] && source $1; _dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"; _sdir=$(dirname "$(readlink -f "$0")"); }; safe_source
 _sdir=$(dirname $(realpath ${BASH_SOURCE[0]}))
 
-source $_sdir/venv-version.txt
-
-ENV_VERSION="$VENV_VERSION"
-VENV_PATH=
 LOCAL_VENV="$_sdir/nodeenv"
 
-[[ -d "$LOCAL_VENV" ]] && VENV_PATH=$LOCAL_VENV
+[[ -d "$LOCAL_VENV" ]] && SCADAJS_VENV_PATH=$LOCAL_VENV
 
 _sourced=
 if [[ "${BASH_SOURCE[0]}" != "${0}" ]]; then
     #echo "script ${BASH_SOURCE[0]} is being sourced ..."
     _sourced="yes"
 else
-    [[ -n ${1:-} ]] && VENV_PATH=$1
+    [[ -n ${1:-} ]] && SCADAJS_VENV_PATH="$1"
 fi
 
-SCADAJS_VENV=${VENV_PATH:-$(eval echo "\$$ENV_VERSION")}
-
-if [[ ! -d "$SCADAJS_VENV" ]]; then
-    if [[ -n $SCADAJS_VENV ]]; then
-        echo "$ENV_VERSION variable is set but it's not a valid directory."
-        echo "Please check $SCADAJS_VENV is a valid virtual environment"
+if [[ ! -d "$SCADAJS_VENV_PATH" ]]; then
+    if [[ -n $SCADAJS_VENV_PATH ]]; then
+        echo "$SCADAJS_VENV_PATH variable is set but it's not a valid directory."
+        echo "Please ensure that $SCADAJS_VENV_PATH is a valid virtual environment"
     else
         cat <<EOL
 
-        Please set $ENV_VERSION variable (in your .bashrc file)
+    ERROR: We need a virtual environment to work. 
 
-        or
+    Please do one of the followings:
 
-        Pass the virtual environment path as the first argument
+    1. Create a virtual environment in THIS directory and name it "nodeenv".
+    2. Set \$SCADAJS_VENV_PATH variable in your startup script.
+    3. Pass the virtual environment path as the first argument to this script.
 
 EOL
     fi
     exit 1
 fi
 
-echo "Using nodeenv at ${SCADAJS_VENV}"
+echo "Using nodeenv at ${SCADAJS_VENV_PATH}"
 if [[ -z $_sourced ]]; then
-    bash --rcfile <(echo ". ~/.bashrc; . ${SCADAJS_VENV}/bin/activate")
+    bash --rcfile <(echo ". ~/.bashrc; . ${SCADAJS_VENV_PATH}/bin/activate")
 else
-    . ${SCADAJS_VENV}/bin/activate
+    . ${SCADAJS_VENV_PATH}/bin/activate
 fi