pytest tests

pyinstaller based

Author: tensorturtle

.github/workflows/tests.yaml

@@ -0,0 +1,33 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+     - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  run-tests:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true # Enable caching for faster builds
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uvx pytest
+ 

README.md

@@ -33,11 +33,19 @@ Run app in development:
 uv run fob
 ```
 
+# Test
+
+```
+uvx pytest
+```
+
+This is an end-to-end test. It installs `fob` to a temporary directory using `install.sh` and runs commands against it.
+
 # Release
 
-From the root of this repository, run `dev_install.sh`. It uses pyinstaller to create a standalone binary and places it in `~/.local/bin` for access from anywhere on the system.
+From the root of this repository, run `install.sh`. It uses pyinstaller to create a standalone binary and places it in `~/.local/bin` for access from anywhere on the system.
 
-Create a new Github Release with a new tag and upload the executable (path should be shown by `dev_install.sh`) to the Github Release.
+Create a new Github Release with a new tag and upload the executable. The binary is at: `dist/fob`.
 
 # Features
 
@@ -50,7 +58,9 @@ fob --database ~/Dropbox/my-fob.db help
 ```
 
 For more convenience, you can export a `FOB_DB_PATH` variable in your shell.
-For example, if you're using bash shell, add the following line to `~/.bashrc`:
+
+For example, to use a database synchronized across devices on your Dropbox,
+add the following line to `~/.bashrc` (for bash shell):
 ```
 export FOB_DB_PATH="~/Dropbox/my-fob.db"
 ```

dev_install.sh renamed to install.sh

@@ -15,6 +15,13 @@ if ! [ -x "$(command -v uv)" ]; then
     exit 1
 fi
 
+# Check for custom installation path
+if [ -z "$1" ]; then
+    INSTALL_PATH="$HOME/.local/bin"
+else
+    INSTALL_PATH="$1"
+fi
+
 # Activate the virtual environment
 uv venv
 source .venv/bin/activate
@@ -25,20 +32,14 @@ uv add pyinstaller
 # Call the tool
 pyinstaller --onefile --name fob src/fob/__init__.py
 
-# Copy the executable to somewhere on your PATH
-DEST_PATH="$HOME/.local/bin"
-
-# Delete previous version
-rm "$DEST_PATH/fob"
-
-# Copy the executable to somewhere on your PATH
-echo "Copying the executable to $DEST_PATH..."
+# Copy the executable to the custom installation path
+echo "Copying the executable to $INSTALL_PATH..."
 
-mkdir -p "$DEST_PATH"
-cp dist/fob "$DEST_PATH"
+mkdir -p "$INSTALL_PATH"
+cp dist/fob "$INSTALL_PATH"
 
 # Clean up
 echo "Cleaning up..."
 rm -r dist build fob.spec
 
-echo "Installation complete. The 'fob' command is now available. If not, please check that $DEST_PATH is in your PATH environment variable."
+echo "Installation complete. The 'fob' command is now available in $INSTALL_PATH. If not, please check that $INSTALL_PATH is in your PATH environment variable."

pyproject.toml

@@ -8,9 +8,10 @@ authors = [{ name = "tensorturtle", email = "[email protected]" }]
 requires-python = ">=3.12"
 dependencies = [
     "pyinstaller>=6.11.1",
+    "pytest>=8.3.4",
     "rich>=13.9.4",
     "tinydb>=4.8.2",
 ]
 
 [project.scripts]
-fob = "fob:main"
+fob = "fob:main"

src/fob/__init__.py

@@ -20,9 +20,9 @@ def run_app():
         print(
             '''[red][bold]Incorrect usage.[/bold][/red]
 
-[green][bold]Usage:[/bold][/green] [cyan][bold]fob[/bold] [OPTIONS] <command>[/cyan]
+[cyan][bold]Usage:[/bold][/cyan] [green][bold]fob[/bold] [OPTIONS] <command>[/green]
 
-Try [cyan bold]fob help[/cyan bold] for usage information.
+Try [green][bold]fob help[/green][/bold] for usage information.
 '''
         )
         sys.exit(1)

src/fob/commands/didnt.py

@@ -93,7 +93,7 @@ def didnt(args: Namespace, db: TinyDBWrapper):
 
         # print success message
         display_checklist(args, db)
-        print(f"[green]Block {num_to_convert} converted to Buffer block.[/green] See overview: [cyan]fob sup[/cyan]")
+        print(f"[green]Block {num_to_convert} converted to Buffer block.[/green] See overview: [green]fob sup[/green]")
 
     except ValueError:
         print("[red][bold]Please enter a number that corresponds to the checklist item[/red][/bold]")

src/fob/commands/help.py

@@ -22,7 +22,7 @@ def help(args: Namespace | None, db: TinyDBWrapper | None) -> None:
     [green bold]didnt[/green bold]       Convert a block from today's checklist to to a 'Buffer' block.
     [green bold]reset[/green bold]       Delete persistent database file.
 
-[green bold]Global Options:[/green bold]
+[cyan bold]Global Options:[/cyan bold]
     [green bold]-d, --database[/green bold] [magenta not bold]<PATH_TO_DB_FILE>[/magenta not bold]  Path to database file. You can use a cloud storage (eg. Dropbox) to sync the database across devices.
     [green bold]-x, --debug[/green bold]  Enable debug mode.
 

src/fob/commands/info.py

@@ -17,4 +17,4 @@ def info(args: Namespace, db: TinyDBWrapper):
     print("Licensed under the MIT License. https://opensource.org/license/mit")
     print("\n")
     print("[reverse] Configuration Information [/reverse]")
-    print(f"Using database at: [magenta]{get_db_path(args)}[/magenta]")
+    print(f"Using database at: [magenta]{get_db_path(args)}[/magenta]")

src/fob/commands/overviews/day_checklist.py

@@ -11,7 +11,7 @@ def display_checklist(args: Namespace, db: TinyDBWrapper) -> None:
         checklist = db.all()[0]['checklist']
     except (IndexError, KeyError):
         print("[red][bold]No day data found.[/red][/bold]")
-        print("Run [cyan][bold]fob gm[/cyan][/bold] to start a new day.")
+        print("Run [green][bold]fob gm[/green][/bold] to start a new day.")
         return
     if args.debug:
         print("Checklist from DB:")

src/fob/commands/overviews/month_overview.py

@@ -24,7 +24,7 @@ def month_overview(args: Namespace, db: TinyDBWrapper) -> None:
         data = db.search(where('year') == today.year and where('month') == today.month)[0]
     except IndexError:
         print("[red][bold]No month data found.[/red][/bold]")
-        print("Run [cyan][bold]fob new_month[/cyan][/bold] to start a new month.")
+        print("Run [green][bold]fob new_month[/green][/bold] to start a new month.")
         return
 
     console = Console()