Project refactor (#4)

* refactor project into foundation and modules
- get app running again
* fix tests
* add more tests
* Refactor workflows and update project structure
- Remove redundant Node.js dependency installation from workflow
- Use distinct install targets in Makefile for Python and Node.js
- Update paths and references in pyproject.toml and .gitignore
- Adjust commands in Makefile to accommodate new directory structure
* fix init_data path in Makefile
* fix pyproject.toml
* fix test targets in github actions
* fix test targets in github actions again

---------

Co-authored-by: phernandez <phernandez@basicmachines.co>

Author: phernandez

.coveragerc

@@ -2,10 +2,10 @@
 dynamic_context = test_function
 branch = true
 source =
-    app/src
+    foundation
 
 omit =
-    app/tests/foundation/conftest.py
-    app/src/foundation/web/*
+    foundation/conftest.py
+    modules/foundation/web/*
 
 concurrency=greenlet

.github/workflows/basic-foundation-test.yml

@@ -35,42 +35,6 @@ jobs:
         with:
           python-version: "3.12.1"
 
-      #      - name: Cache Poetry
-      #        id: poetry-cache
-      #        uses: actions/cache@v3
-      #        with:
-      #          path: ~/.poetry
-      #          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
-      #          restore-keys: |
-      #            ${{ runner.os }}-poetry-
-      #
-      #      - name: Cache virtualenv
-      #        id: venv-cache
-      #        uses: actions/cache@v3
-      #        with:
-      #          path: .venv
-      #          key: ${{ runner.os }}-venv-${{ hashFiles('**/poetry.lock') }}
-      #          restore-keys: |
-      #            ${{ runner.os }}-venv-
-      #
-      #      - name: Cache Playwright binaries
-      #        id: playwright-cache
-      #        uses: actions/cache@v3
-      #        with:
-      #          path: ~/.cache/ms-playwright
-      #          key: ${{ runner.os }}-playwright-${{ hashFiles('**/poetry.lock') }}
-      #          restore-keys: |
-      #            ${{ runner.os }}-playwright-
-      #
-      #      - name: Cache Node.js modules
-      #        id: node-modules-cache
-      #        uses: actions/cache@v3
-      #        with:
-      #          path: node_modules
-      #          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-      #          restore-keys: |
-      #            ${{ runner.os }}-node-
-
       - name: Bootstrap poetry
         run: |
           if [ ! -x "$(command -v poetry)" ]; then
@@ -88,12 +52,6 @@ jobs:
         run: |
           make install
 
-      - name: Install Node.js dependencies
-        run: |
-          if [ ! -d "node_modules" ]; then
-            npm install
-          fi
-
       - name: Run dbmate migrations
         run: |
           make migrate-up
@@ -106,9 +64,13 @@ jobs:
         run: |
           make type-check
 
-      - name: Run api tests
+      - name: Run foundation tests
         run: |
-          make test-api
+          make test-foundation
+
+      - name: Run foundation tests
+        run: |
+          make test-modules-api
 
       - name: Install Playwright and dependencies
         run: |
@@ -126,7 +88,7 @@ jobs:
 
       - name: Run Playwright tests
         run: |
-          make test-playwright
+          make test-modules-web
 
       - name: Upload Playwright Traces
         uses: actions/upload-artifact@v4
@@ -147,7 +109,6 @@ jobs:
       - name: Display coverage report in job summary
         run: cat coverage.md >> $GITHUB_STEP_SUMMARY
 
-
       - name: Upload Coverage Report
         uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -157,12 +157,7 @@ cython_debug/
 
 
 .DS_Store
-/.idea/
-/node_modules/
-!/templates/email/build/
-<<<<<<< HEAD
-/coverage.txt
-=======
-
+.idea/
+modules/foundation/web/node_modules/
+!/foundation/templates/email/build/
 coverage.txt
->>>>>>> bea77b7

Makefile

@@ -2,22 +2,29 @@ include .env
 
 .PHONY: install test clean lint lint-fix format migrate-new migrate-up migrate-down migrate-dump migrate-reset
 
-install:
+install: install-python install-node
+
+install-python:
 	poetry install
-	npm install
+
+install-node:
+	cd modules/foundation/web && npm install
 
 reset-cov:
 	rm -f .coverage
 
-test: reset-cov test-api test-playwright
+test: reset-cov test-foundation test-modules-api test-modules-web
+
+COVERAGE_ARGS ?= --cov-append --cov-report=term-missing --cov-config=.coveragerc
 
-COV_REPORT ?= term-missing
+test-foundation:
+	poetry run pytest foundation --cov=./foundation $(COVERAGE_ARGS)
 
-test-api:
-	poetry run pytest --cov=./app --cov-append  --cov-config=.coveragerc -m "not playwright"
+test-modules-api:
+	poetry run pytest modules/foundation/api --cov=./modules/foundation/api $(COVERAGE_ARGS)
 
-test-playwright:  # assumes app is running on at API_URL in config
-	poetry run pytest --cov=./app --cov-append  --cov-config=.coveragerc -m "playwright" --tracing=retain-on-failure
+test-modules-web:  # runs playwright tests: assumes app is running on at API_URL in config
+	poetry run pytest modules/foundation/web --cov=./modules/foundation/web $(COVERAGE_ARGS) -m "playwright" --tracing=retain-on-failure
 	#poetry run pytest -m "playwright" --headed --slowmo 500
 
 test-coverage:
@@ -40,18 +47,18 @@ format-python:
 	poetry run ruff format .
 
 format-prettier:
-	npx prettier templates --write
+	cd modules/foundation/web && npx prettier templates --write
 
 format: format-python format-prettier
 
 type-check:
 	poetry run pyright
 
 tailwind:
-	npm run build
+	cd modules/foundation/web && npm run build
 
 tailwind-prod:
-	npm run build-prod
+	cd modules/foundation/web && npm run build-prod
 
 # Database migrations
 
@@ -91,7 +98,7 @@ migrate-reset:
 # You might need to adjust this depending on your Docker setup and database location.
 
 init-data:
-	poetry run python app/src/tools/init_data.py
+	poetry run python foundation/tools/init_data.py
 
 run:
-	poetry run fastapi run app/src/foundation/app.py  --port 10000
+	poetry run fastapi run foundation/app.py  --port 10000

TODO.md

@@ -8,12 +8,12 @@
     - web-htmx
 - [ ] uv
 - [ ] permission checks
-    - [ ] user service with current user
     - [x] has to be at least one admin
     - [x] only admins can create/edit users
-    - [ ] db: rename is_superuser to is_admin
 - [ ] dashboard stats should link to filtered list
+- [ ] user service with current user
 - [ ] make active/admin colums enums
+- [ ] db: rename is_superuser to is_admin
 - [ ] page_size is appended to url
 - [x] use fixtures in web tests
 - [x] delete user after test