From 86b210ed741c7de4cc9ca59f26839102619e0516 Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Thu, 1 Feb 2024 09:05:04 +0100
Subject: [PATCH] add venv activation to tests

---
 .githooks/post-merge                        |  1 +
 .github/workflows/codeql-analysis_v3.yml    |  5 ++++-
 .github/workflows/pythonpackage_future3.yml |  6 ++++--
 run_docgeneration.sh                        | 10 +++++++---
 run_flake8.sh                               | 11 +++++++----
 run_pytest.sh                               | 11 +++++++----
 6 files changed, 30 insertions(+), 14 deletions(-)

diff --git a/.githooks/post-merge b/.githooks/post-merge
index 6fc6e4f54..07b81db41 100755
--- a/.githooks/post-merge
+++ b/.githooks/post-merge
@@ -43,6 +43,7 @@ warn_python_requirements() {
   echo "ATTENTION: Python requirements have changed since last pull!"
   echo ""
   echo "To update python requirements on the RPi run"
+  echo "$ source .venv/bin/activate"
   echo "$ python -m pip install --upgrade -r requirements.txt"
   echo "************************************************************"
   echo -e "\n"
diff --git a/.github/workflows/codeql-analysis_v3.yml b/.github/workflows/codeql-analysis_v3.yml
index 1c1c68ba3..b63be3a80 100644
--- a/.github/workflows/codeql-analysis_v3.yml
+++ b/.github/workflows/codeql-analysis_v3.yml
@@ -44,7 +44,10 @@ jobs:
     - name: Install dependencies
       run: |
         # Install necessary packages
-        sudo apt-get install libasound2-dev pulseaudio
+        sudo apt-get install libasound2-dev pulseaudio python3-venv
+        python3 -m venv .venv
+        source ".venv/bin/activate"
+
         python -m pip install --upgrade pip
         pip install -r requirements.txt
         # Set the `CODEQL-PYTHON` environment variable to the Python executable
diff --git a/.github/workflows/pythonpackage_future3.yml b/.github/workflows/pythonpackage_future3.yml
index f2174d0c0..dbaae25ee 100644
--- a/.github/workflows/pythonpackage_future3.yml
+++ b/.github/workflows/pythonpackage_future3.yml
@@ -30,7 +30,10 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y libasound2-dev pulseaudio
+        sudo apt-get install -y libasound2-dev pulseaudio python3-venv
+        python3 -m venv .venv
+        source ".venv/bin/activate"
+
         python3 -m pip install --upgrade pip
         pip3 install -r requirements.txt
         # For operation of the Jukebox, ZMQ must be compiled from sources due to Websocket support
@@ -51,7 +54,6 @@ jobs:
         parallel: true
     - name: Lint with flake8
       run: |
-        pip3 install flake8
         # Stop the build if linting fails
         ./run_flake8.sh
 
diff --git a/run_docgeneration.sh b/run_docgeneration.sh
index 53b18ed57..4fb5f1dc9 100755
--- a/run_docgeneration.sh
+++ b/run_docgeneration.sh
@@ -1,12 +1,16 @@
 #!/usr/bin/env bash
 
-# Runner script for pydoc-markdown to ensure
+# Runner script to ensure
+# - correct venv activation
 # - independent from working directory
 
-# Change working directory to location of script
+# Change working directory to project root
 SOURCE=${BASH_SOURCE[0]}
 SCRIPT_DIR="$(dirname "$SOURCE")"
-cd "$SCRIPT_DIR" || { echo "Could not change to top-level project directory"; exit 1; }
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
 
 # Run pydoc-markdown
 # make sure, directory exists
diff --git a/run_flake8.sh b/run_flake8.sh
index 8fd6dcb53..f6603dc0a 100755
--- a/run_flake8.sh
+++ b/run_flake8.sh
@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
-# Runner script for flak8 to ensure
-# - correct config file
+# Runner script to ensure
+# - correct venv activation
 # - independent from working directory
 
-# Change working directory to location of script
+# Change working directory to project root
 SOURCE=${BASH_SOURCE[0]}
 SCRIPT_DIR="$(dirname "$SOURCE")"
-cd "$SCRIPT_DIR" || { echo "Could not change to top-level project directory"; exit 1; }
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
 
 # Run flake8
 flake8 --config .flake8 "$@"
diff --git a/run_pytest.sh b/run_pytest.sh
index 91c56f46c..c944419ae 100755
--- a/run_pytest.sh
+++ b/run_pytest.sh
@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
-# Runner script for pytest to ensure
-# - correct config file
+# Runner script to ensure
+# - correct venv activation
 # - independent from working directory
 
-# Change working directory to location of script
+# Change working directory to project root
 SOURCE=${BASH_SOURCE[0]}
 SCRIPT_DIR="$(dirname "$SOURCE")"
-cd "$SCRIPT_DIR" || { echo "Could not change to top-level project directory"; exit 1; }
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
 
 # Run pytest
 pytest -c pytest.ini $@