Merge pull request #281 from AndreWohnsland/sqlalchemy

Convert plain SQL to Sqlalchemy

Author: AndreWohnsland

.github/workflows/linting.yml .github/workflows/code-check.yml.github/workflows/linting.yml renamed to .github/workflows/code-check.yml

@@ -1,4 +1,4 @@
-name: Linting
+name: Code Check
 on: [pull_request]
 jobs:
   ruff:
@@ -24,3 +24,13 @@ jobs:
           pip install -r mypy_requirements.txt
           pip install pyqt5==5.15.7 pyqt5-qt5==5.15.2
           mypy src
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v4
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+      - name: 🔍 Run PyTest
+        run: |
+          uv run pytest

.github/workflows/build-docker.yml .github/workflows/release-build.yml.github/workflows/build-docker.yml renamed to .github/workflows/release-build.yml

@@ -30,6 +30,10 @@ jobs:
         run: |
           sed -i "/^version = \".*\"$/s/version = \".*\"/version = \"${{ steps.get_version.outputs.version }}\"/" pyproject.toml
 
+      - name: Update version in uv.toml
+        run: |
+          sed -i "/^version = \".*\"$/s/version = \".*\"/version = \"${{ steps.get_version.outputs.version }}\"/" uv.lock
+
       - name: Commit changes
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-release-run.yml

@@ -1,4 +1,4 @@
-name: Test the setup script on the runner
+name: Smoke Test the setup script on the runner
 on:
   push:
     branches:
@@ -15,4 +15,23 @@ jobs:
       - name: Run setup.sh
         run: |
           chmod +x scripts/setup.sh
-          ./scripts/setup.sh
+          ./scripts/setup.sh cicd
+      - name: Start API
+        run: |
+          uv run api.py &
+          sleep 5
+      - name: Test API
+        run: |
+          for i in {1..6}; do
+            response=$(curl -s -X 'GET' 'http://localhost:8000/api/' -H 'accept: application/json')
+            echo "Response: $response"
+            if echo "$response" | grep -q '{"message":"Welcome to CocktailBerry, this API works!"}'; then
+              echo "API is working correctly"
+              pkill -f "uv run api.py"
+              exit 0
+            fi
+            sleep 5
+          done
+          echo "API did not respond correctly"
+          pkill -f "uv run api.py"
+          exit 1

.vscode/settings.json

@@ -23,5 +23,8 @@
   "[python]": {
     "editor.defaultFormatter": "charliermarsh.ruff"
   },
-  "python.analysis.autoImportCompletions": true
+  "python.analysis.autoImportCompletions": true,
+  "python.testing.pytestArgs": ["tests"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
 }

docs/commands.md

@@ -82,26 +82,6 @@ The main program will then be started as usual as an full windowed app.
 python runme.py switch-back
 ```
 
-## Updating Local Database
-
-You can use the CLI command to merge the latest recipes in your local database.
-To update run the command:
-
-```bash
-python runme.py update-database [OPTIONS]
-
-# Options:
-#   --help  Show help
-```
-
-This can be useful if your CocktailBerry has been running for quite a while and you want to get more recipes.
-The new recipes will be added to your database, including any missing ingredients.
-
-!!! warning "Made many Changes?"
-    Please take in consideration that if you made a lot of changes, especially renaming your ingredients, this may add existing ingredients under a different name.
-    It is best to make a backup before running the command, to have the possibility to restore the old state.
-    The script will also create a local backup, which you can use if you did not backup your data manually.
-
 ## Clearing Local Database
 
 There may be CocktailBerry owners, who want to create a complete new database.

docs/troubleshooting.md

@@ -89,9 +89,10 @@ In case the machine got a RTC build in and uses it, this option can usually be s
 ## Get the LED Working
 
 Getting the WS281x to work may be a little bit tricky.
-You MUST run the program as root/sudo (`sudo python runme.py`), so you also need to change this in `~/launcher.sh`.
+You can either run the program as root/sudo (`sudo python runme.py`), so you also need to change this in `~/launcher.sh`.
 If you are using the latest installer, there will be a virtual environment created, so you should use this as root.
-This also does not require to reinstall the python packages for the main program.
+This also does you require to reinstall the python packages for the main program.
+A better way would be to add the user to the gpio/other needed groups, so you can run the program as normal user.
 
 ```bash
 sudo ~/.env-cocktailberry/bin/python -E runme.py
@@ -315,23 +316,13 @@ Exec=/usr/bin/lxterminal -e /home/pi/launcher.sh
 
 ```bash
 #!/bin/bash
-# launcher.sh for dashboard
-# no need for sudo if there were no Numpy import errors
-cd /home/pi/CocktailBerry/dashboard/qt-app/
-sudo python main.py
+# code to start the application, see v1-launcher.sh
 ```
 
-```bash
-#!/bin/bash
-# launcher.sh for CocktailBerry
-cd /home/pi/CocktailBerry/
-python runme.py
-```
-
-If your setup is equal to mine (Raspberry Pi, CocktailBerry GitHub cloned to the home (`/home/pi/`) folder) you can also just copy the files and comment/uncomment within the launcher.sh to save some typing:
+If your setup is equal to mine (Raspberry Pi, CocktailBerry GitHub cloned to the home folder) you can also just copy the files and comment/uncomment within the launcher.sh to save some typing:
 
 ```bash
-cp ~/CocktailBerry/scripts/launcher.sh ~/
+cp ~/CocktailBerry/scripts/v1-launcher.sh ~/
 cp ~/CocktailBerry/scripts/cocktail.desktop /etc/xdg/autostart/
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "CocktailBerry"
-version = "2.1.1"
+version = "2.2.0"
 description = "A Python and Qt based App for a Cocktail Machine on a Raspberry Pi. Easily serve Cocktails with Raspberry Pi and Python"
 authors = [{ name= "Andre Wohnsland" , email =  "cocktailmakeraw@gmail.com" }]
 readme = "readme.md"
@@ -22,6 +22,8 @@ dependencies = [
     "rpi-ws281x>=5.0.0 ; sys_platform == 'linux'",
     "gpiozero>=2.0.1 ; sys_platform == 'linux'",
     "python-periphery>=2.4.1",
+    "sqlalchemy>=2.0.38",
+    "alembic>=1.14.1",
 ]
 requires-python = ">= 3.9"
 
@@ -41,6 +43,8 @@ dev-dependencies = [
     "mkdocs>=1.6.1",
     "mypy>=1.14.1",
     "ipykernel>=6.29.5",
+    "pytest>=8.3.4",
+    "pytest-cov>=6.0.0",
 ]
 # This is a workaround for the missing support of aarch64 in pyqt5, need to install this over apt +
 # include this with system site packages

scripts/setup.sh

@@ -3,7 +3,7 @@
 # Usage: bash setup.sh [options]
 # Options:
 # dashboard: set up dashboard, otherwise will set up CocktailBerry
-
+# cicd: skip some things for cicd
 is_raspberry_pi() {
   if grep -q "Raspberry Pi" /proc/device-tree/model 2>/dev/null; then
     return 0
@@ -21,8 +21,12 @@ is_raspberry_pi5() {
   fi
 }
 
-echo "> Installing updates, this may take a while..."
-sudo apt update && sudo sudo apt -y full-upgrade
+if [ "$1" = "cicd" ]; then
+  echo "> Skipping update process"
+else
+  echo "> Updating system, this may take a while..."
+  sudo apt update && sudo sudo apt -y full-upgrade
+fi
 
 echo "> Installing nmcli, this is needed for wifi setup"
 sudo apt install network-manager
@@ -52,10 +56,11 @@ sudo chmod +x /usr/share/applications/cocktail.desktop
 echo "> Giving write permission to /etc/wpa_supplicant/wpa_supplicant.conf"
 sudo chmod a+w /etc/wpa_supplicant/wpa_supplicant.conf
 
-cd ~/CocktailBerry/ || exit
+if [ "$1" != "cicd" ]; then
+  cd ~/CocktailBerry/ || exit
+fi
 # creating project venv with uv
 echo "> Creating project venv with uv"
-# set uv env variable "" to extra index piwheels if rpi
 uv venv --system-site-packages --python "$(python -V | awk '{print $2}')" || echo "ERROR: Could not create venv with uv, is uv installed?"
 
 # Making necessary steps for the according program
@@ -86,7 +91,7 @@ if [ "$1" = "dashboard" ]; then
   fi
 else
   echo "> Setting up CocktailBerry"
-  sudo cp ~/CocktailBerry/scripts/launcher.sh ~/launcher.sh
+  sudo cp ~/CocktailBerry/scripts/v1-launcher.sh ~/launcher.sh
   sudo chmod +x ~/launcher.sh
   echo "> Installing PyQt"
   sudo apt-get -y install qt5-default pyqt5-dev pyqt5-dev-tools || sudo apt-get -y install python3-pyqt5 || echo "ERROR: Could not install PyQt5"

scripts/launcher.sh scripts/v1-launcher.shscripts/launcher.sh renamed to scripts/v1-launcher.sh

@@ -1,15 +1,4 @@
 #!/bin/bash
-# launcher.sh for both, machine and dashboard
-# uncomment / comment the according lines
-
-# launcher.sh for dashboard
-# This for qt-app (recommended way)
-# cd ~/CocktailBerry/dashboard/qt-app/
-# python main.py
-# This for Dash (WebApp, advanced way)
-# cd ~/CocktailBerry/dashboard/frontend/
-# gunicorn --workers=5 --threads=1 -b :8050 index:server
-
 # Function to create or update the virtual environment if necessary
 create_or_update_venv() {
   system_python_version=$(python -V | awk '{print $2}')
@@ -27,7 +16,6 @@ create_or_update_venv() {
   fi
 }
 
-# launcher.sh for CocktailBerry
 export QT_SCALE_FACTOR=1
 cd ~/CocktailBerry/ || echo "Did not find ~/CocktailBerry/"
 create_or_update_venv

src/__init__.py

@@ -1,6 +1,6 @@
 from typing import Literal
 
-__version__ = "2.1.1"
+__version__ = "2.2.0"
 PROJECT_NAME = "CocktailBerry"
 MAX_SUPPORTED_BOTTLES = 24
 SupportedLanguagesType = Literal["en", "de"]