🚚 Move location of scripts to simplify file structure (#1352)

Author: tiangolo

.github/workflows/test.yml

@@ -26,9 +26,9 @@ jobs:
       - run: docker compose down -v --remove-orphans
       - run: docker compose up -d
       - name: Lint
-        run: docker compose exec -T backend bash /app/scripts/lint.sh
+        run: docker compose exec -T backend bash scripts/lint.sh
       - name: Run tests
-        run: docker compose exec -T backend bash /app/tests-start.sh "Coverage for ${{ github.sha }}"
+        run: docker compose exec -T backend bash scripts/tests-start.sh "Coverage for ${{ github.sha }}"
       - run: docker compose down -v --remove-orphans
       - name: Store coverage files
         uses: actions/upload-artifact@v4

backend/Dockerfile

@@ -17,14 +17,10 @@ RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; els
 
 ENV PYTHONPATH=/app
 
-COPY ./scripts/ /app/
+COPY ./scripts /app/scripts
 
 COPY ./alembic.ini /app/
 
-COPY ./prestart.sh /app/
-
-COPY ./tests-start.sh /app/
-
 COPY ./app /app/app
 
 CMD ["fastapi", "run", "--workers", "4", "app/main.py"]

backend/README.md

@@ -106,15 +106,15 @@ If you use GitHub Actions the tests will run automatically.
 If your stack is already up and you just want to run the tests, you can use:
 
 ```bash
-docker compose exec backend bash /app/tests-start.sh
+docker compose exec backend bash scripts/tests-start.sh
 ```
 
-That `/app/tests-start.sh` script just calls `pytest` after making sure that the rest of the stack is running. If you need to pass extra arguments to `pytest`, you can pass them to that command and they will be forwarded.
+That `/app/scripts/tests-start.sh` script just calls `pytest` after making sure that the rest of the stack is running. If you need to pass extra arguments to `pytest`, you can pass them to that command and they will be forwarded.
 
 For example, to stop on first error:
 
 ```bash
-docker compose exec backend bash /app/tests-start.sh -x
+docker compose exec backend bash scripts/tests-start.sh -x
 ```
 
 ### Test Coverage

backend/prestart.sh renamed to backend/scripts/prestart.sh

@@ -1,10 +1,10 @@
 #! /usr/bin/env bash
 
 # Let the DB start
-python /app/app/backend_pre_start.py
+python app/backend_pre_start.py
 
 # Run migrations
 alembic upgrade head
 
 # Create initial data in DB
-python /app/app/initial_data.py
+python app/initial_data.py

backend/scripts/tests-start.sh

@@ -0,0 +1,7 @@
+#! /usr/bin/env bash
+set -e
+set -x
+
+python app/tests_pre_start.py
+
+bash scripts/test.sh "$@"

backend/tests-start.sh

@@ -55,7 +55,7 @@ services:
       db:
         condition: service_healthy
         restart: true
-    command: bash prestart.sh
+    command: bash scripts/prestart.sh
     env_file:
       - .env
     environment:

docker-compose.yml

@@ -12,4 +12,4 @@ fi
 
 docker-compose build
 docker-compose up -d
-docker-compose exec -T backend bash /app/tests-start.sh "$@"
+docker-compose exec -T backend bash scripts/tests-start.sh "$@"

scripts/test-local.sh

@@ -7,5 +7,5 @@ set -x
 docker compose build
 docker compose down -v --remove-orphans # Remove possibly previous broken stacks left hanging after an error
 docker compose up -d
-docker compose exec -T backend bash /app/tests-start.sh "$@"
+docker compose exec -T backend bash scripts/tests-start.sh "$@"
 docker compose down -v --remove-orphans