Version 1.7.2 (#454)

* Fix map issues

* Add projects to todo list

* Fix and refactor ascent list skeletons

* Fix menu overflow issue

* Fix login infinity loop

* Add contributors to the Readme file

* Fix confusing renamed import of pbkdf2_sha256

* Fix broken ascent records

* Docker-Compose-based Development Setup (#463)

* Added SMTP_TYPE to config

* Fixed AttributeError when relaunching an instance while having an session running

* Added Docker Compose Dev Setup

* Added SPACES_ADDRESSING option to account for MinIO path addressing in dev setup

* Fixed generated upload urls and bucket placeholder generation

* Slightly improved password formatting in registration mail since I copied the whitespace before way too many times

* Added documentation for docker setup

* Escaped all $ in docker-compose.yml

* Update license

* Fix conflicting license files

* Show LC logo as favicon if no favicon is set

* Rework project climbed message feature

* Fix tests

* Add flake8 and format according to it

* Reformat server code according to black style

* Add isort config and order imports according to config

* Move linting tools to dev packages

* Update readme, add dev tooling docs

* Add pre commit config

* Fix black version in pre commit hook

* Fix branches in pipelines to match version branches and add server linting pipeline

* Update linting pipeline

* Update linting pipeline

* Update linting pipeline

* Reformat linting pipeline yml

* Restructuring of Server Tests (#474)

* Added type hints to BaseEntity

* update_slugs() now listens for 'before_flush'

* Merged upstream branch

* Reworked test setup: All tests are now capsuled in a transaction and the database is populated from Python, not a psql dump

* Reworked test_region_resources as sample

* Monkey patched test client to improve using a JWT in tests

* Adjusted docker setup for testing

* Tests: Migrated some more sample data

* Finished migrating test data

* Event listeners need to be re-registered for every db session in testing

* Updated test_area_resources to new test design

* Migrated test_instance_settings

# Conflicts:
#	server/tests/test_instance_settings_resources.py

* Migrated test_crag_resources

* Migrated all auth_resources tests except for SMTP stuff

* Migrated ascent_resources

* Migrated test_line_path_resources

* Migrated test_line_resources

* Fixed sample data

* Migrated test_menu_item_resources

* Migrated test_menu_page_resources

* Migrated test_menu_page_resources

* Migrated test_ranking_resources

* Migrated test_search_resources

* Migrated test_secret_spots

* Migrated test_sector_resources

* Migrated test_todo_resources

* Migrated test_topo_image_resources

* Migrated test_upload_resources

* Migrated test_user_resources

* Migrated test_health_resources

* Updated SMTP mock counts as we only have 1 admin

* SuperadminEmail has been removed from instance_settings in v1.7.2

* Clean environment, so we read values from test-ci.cfg

* test_topo_image_resources: Fixed comparison with wrong value

* Addressed MR reviews and improved testing in docker setup

* Cleaned up test dump and user_test_util

* Dockerfile: aliases for easy usage of flake8, black and isort

* Including tests into black and isort coverage

* black and isort on tests

* Remove restoring dump for test pipline db

* Use even numbered node version in frontend tests

* Fix node versions and add command to create dumps directory if it does not exist

* Try cypress pipeline fix

* Try cypress pipeline fix

* Try cypress pipeline fix

* Fix cypress login credentials

* Fix test user slug

* Add eslint and prettier

* Prettify client code

* Optimize frontend imports

* Optimize frontend imports

* Optimize frontend imports

* Fix linting issues

* Fix linting issues

* Fix linting issues

* Prettier

* Fix build issues

* Add frontend linting to pipeline

* Update linting pipe node version

* Fix linting issue

* Fix pipeline

* Run prettier

* Replace pre-commit with husky

---------

Co-authored-by: BlobbyBob <[email protected]>

Author: dorthrithil

.github/workflows/backend-unit-tests.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     branches:
       - main
-      - next
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   backend-unit-tests:
     environment: Testing
@@ -45,10 +45,9 @@ jobs:
           cd server/src
           pipenv install
 
-      - name: Setup database with test dump
+      - name: Add UUID extension to test database
         run: |
           export PGPASSWORD='postgres'; psql -h 0.0.0.0 -p 5432 -U postgres -d localcrag_test < server/scripts/create_uuid_extension.sql
-          export PGPASSWORD='postgres'; pg_restore --no-privileges --no-owner -h 0.0.0.0 -p 5432 -U postgres -d localcrag_test server/tests/dumps/localcrag_test_dump.sql
 
       - name: Run Tests
         run: |

.github/workflows/check-frontend-prod-build.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     branches:
       - main
-      - next
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   frontend-prod-build-check:
     runs-on: ubuntu-latest
@@ -12,10 +12,10 @@ jobs:
         working-directory: ./client
     steps:
       - uses: actions/checkout@v4
-      - name: Use latest node.js
+      - name: Use node.js v22
         uses: actions/setup-node@v4
         with:
-          node-version: latest
+          node-version: 22
       - name: Install dependencies
         run: npm install
       - name: Build production bundle

.github/workflows/check-migrate-from-empty-db.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     branches:
       - main
-      - next
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   check-migrate-from-empty-db:
     environment: Testing

.github/workflows/check-migrate-from-prod-db.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     branches:
       - main
-      - next
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   check-migrate-from-prod-db:
     environment: Testing
@@ -49,6 +49,7 @@ jobs:
         run: |
           echo "${{ secrets.BACKUP_SERVER_SSH_KEY }}" >> backup_key.pem
           chmod 600 backup_key.pem
+          mkdir -p server/tests/dumps
           scp -i backup_key.pem -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null  ${{ secrets.BACKUP_SERVER_USER }}@${{ secrets.BACKUP_SERVER_IP }}:${{ secrets.BACKUP_SERVER_DUMPPATH }} server/tests/dumps/localcrag_prod_dump.sql    
 
       - name: Setup database with prod dump

.github/workflows/cypress-e2e-tests.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     branches:
       - main
-      - next
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   cypress-run:
     runs-on: ubuntu-latest
@@ -54,7 +54,7 @@ jobs:
       - name: Setup database
         run: |
           export PGPASSWORD='postgres'; psql -h 0.0.0.0 -p 5432 -U postgres -d localcrag_test < server/scripts/create_uuid_extension.sql
-          export PGPASSWORD='postgres'; pg_restore --no-privileges --no-owner -h 0.0.0.0 -p 5432 -U postgres -d localcrag_test server/tests/dumps/localcrag_test_dump.sql
+          cd server && PYTHONPATH=.:src LOCALCRAG_CONFIG=config/test-ci-e2e.cfg pipenv run python3 scripts/setup_cypress_db.py
 
       - name: Copy assets
         run: |

.github/workflows/frontend-unit-tests.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     branches:
       - main
-      - next
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 jobs:
   frontend-unit-tests:
     runs-on: ubuntu-latest
@@ -12,10 +12,10 @@ jobs:
         working-directory: ./client
     steps:
       - uses: actions/checkout@v4
-      - name: Use latest node.js
+      - name: Use node.js v22
         uses: actions/setup-node@v4
         with:
-          node-version: latest
+          node-version: 22
       - name: Install dependencies
         run: npm install
       - name: Run unit tests

.github/workflows/linting.yml

@@ -0,0 +1,61 @@
+name: Linting Pipeline
+on:
+  pull_request:
+    branches:
+      - main
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+jobs:
+  lint-server:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          pip install pipenv
+          cd server
+          pipenv install --dev
+
+      - name: Run Flake8
+        run: |
+          cd server
+          pipenv run flake8 .
+
+      - name: Run Black
+        run: |
+          cd server
+          pipenv run black --check .
+
+      - name: Run Isort
+        run: |
+          cd server
+          pipenv run isort --check-only .
+  lint-client:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: |
+          cd client
+          npm install
+
+      - name: Run ESLint
+        run: |
+          cd client
+          npm run lint
+
+      - name: Run Prettier
+        run: |
+          cd client
+          npx prettier --check .

.gitignore

@@ -1 +1,3 @@
-.idea
+.idea
+node_modules
+.husky/_/

.husky/pre-commit

@@ -0,0 +1,8 @@
+cd client
+npx prettier --write .
+npm run lint
+cd ..
+cd server
+pipenv run black .
+pipenv run flake8 .
+pipenv run isort .

Dockerfile

@@ -0,0 +1,27 @@
+FROM python AS localcragapp-server
+RUN pip install pipenv
+ENV PYTHONPATH=/localcragapp/src
+RUN mkdir /.local && chown 1000:1000 /.local
+RUN echo 'alias pytest="SQLALCHEMY_DATABASE_URI=${SQLALCHEMY_DATABASE_URI}_test LOCALCRAG_CONFIG=/localcragapp/src/config/test-ci.cfg env -u SPACES_SECRET_KEY -u SPACES_ACCESS_KEY -u SPACES_ENDPOINT -u SPACES_ACCESS_ENDPOINT -u SPACES_REGION -u SPACES_BUCKET -u SPACES_ADDRESSING -u SMTP_HOST -u SMTP_USER -u SMTP_PASSWORD -u SMTP_PORT -u SMTP_TYPE pipenv run pytest"' >> /tmp/aliases && \
+    echo 'alias flake8="pipenv run flake8"' >> /tmp/aliases && \
+    echo 'alias black="pipenv run black --config=/localcragapp/pyproject.toml"' >> /tmp/aliases && \
+    echo 'alias isort="pipenv run isort --settings-path=/localcragapp/pyproject.toml"' >> /tmp/aliases && \
+    cat /tmp/aliases >> /etc/profile && \
+    cat /tmp/aliases >> /etc/bash.bashrc
+USER 1000:1000
+WORKDIR /localcragapp
+COPY ./server/.flake8 /localcragapp/.flake8
+COPY ./server/pyproject.toml /localcragapp/pyproject.toml
+COPY ./server/Pipfile /localcragapp/Pipfile
+COPY ./server/Pipfile.lock /localcragapp/Pipfile.lock
+RUN pipenv install --dev
+USER root
+RUN chown -R 1000:1000 /localcragapp
+USER 1000:1000
+WORKDIR /localcragapp/src
+
+FROM node AS localcragapp-client
+USER 1000:1000
+WORKDIR /localcragapp
+COPY ./client .
+RUN npm ci