Feature/deployment to test

.github/workflows/deploy.yaml → .github/workflows/deploy-to-prod.yaml

@@ -1,4 +1,4 @@
-name: deploy-to-server
+name: deploy-to-prod-server
 
 on:
   workflow_run:
@@ -9,7 +9,7 @@ on:
       - completed
 
 jobs:
-  deploy-to-server:
+  deploy-to-prod-server:
     timeout-minutes: 60
     runs-on: ubuntu-latest
     env:
@@ -38,6 +38,7 @@ jobs:
         sed -i "s/__PASSWORD__/$PASSWORD/g" .example.env
         sed -i "s/__HOST__/$HOST/g" .example.env
         sed -i "s/__DB_PORT__/$DB_PORT/g" .example.env
+        echo "VITE_API_BASE_URL=https://www.dataframetrainer.com:5000" >> .example.env
 
         # todo: do we need both???
         cp .example.env .env

.github/workflows/deploy-to-test.yaml

@@ -0,0 +1,55 @@
+name: deploy-to-prod-server
+
+on:
+  workflow_run:
+    branches:
+      - 'test'
+    workflows: ["e2e-tests"]
+    types: 
+      - completed
+
+jobs:
+  deploy-to-prod-server:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    env:
+      DB_NAME: ${{ secrets.DB_NAME }}
+      DB_USER: ${{ secrets.DB_USER }}
+      DB_PORT: ${{ secrets.DB_PORT }}
+      PASSWORD: ${{ secrets.PASSWORD }}
+      HOST: ${{ secrets.HOST }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '20'
+    - name: Install SSH Key
+      uses: shimataro/ssh-key-action@v2
+      with:
+        key: ${{ secrets.SSH_DATAFRAMETRAINER_KEY }}
+        known_hosts: 'just-a-placeholder-to-not-get-errors'
+    - name: Adding Known Hosts
+      run: ssh-keyscan -H ${{ secrets.DATAFRAMETRAINER_SERVER_IP }} >> ~/.ssh/known_hosts
+    - name: Set .env file
+      run: |
+        sed -i "s/__DB_NAME__/$DB_NAME/g" .example.env
+        sed -i "s/__DB_USER__/$DB_USER/g" .example.env
+        sed -i "s/__PASSWORD__/$PASSWORD/g" .example.env
+        sed -i "s/__HOST__/$HOST/g" .example.env
+        sed -i "s/__DB_PORT__/$DB_PORT/g" .example.env
+        echo "VITE_API_BASE_URL=https://www.test.dataframetrainer.com:4000" >> .example.env
+
+        # todo: do we need both???
+        cp .example.env .env
+        # this is needed since vite/sveltekit rely on this file when running in production mode
+        cp .example.env ./frontend-svelte/.env
+      working-directory: ./
+    - name: Rsync to server
+      run: rsync -avz . dataframetrainer@${{ secrets.DATAFRAMETRAINER_SERVER_IP}}:/home/dataframetrainer/test/
+    - name: Run docker compose
+      run: |
+        ssh dataframetrainer@${{ secrets.DATAFRAMETRAINER_SERVER_IP}} "cd /home/dataframetrainer/test && make down && make cleanup_prod && make prod_detached"
+
+
+

.github/workflows/e2e-tests.yaml

@@ -71,7 +71,7 @@ jobs:
         working-directory: .
         run: |
           ls -la
-          docker compose -f docker-compose.test.yml up -d
+          docker compose -f docker-compose.testing.yml up -d
       -
         name: Check curl response of backend
         run: |

Makefile

@@ -10,6 +10,14 @@ cleanup_prod:
 	docker rm -f prod-db-fill-or-update-tables
 	docker image rm -f prod-db-fill-or-update-tables
 
+cleanup_test:
+	docker rm -f test-frontend-prod
+	docker image rm -f test-frontend-prod
+	docker rm -f test-backend
+	docker image rm -f test-backend
+	docker rm -f test-db-fill-or-update-tables
+	docker image rm -f test-db-fill-or-update-tables
+
 cleanup:
 	docker rm -f dataframetrainer-db-fill-or-update-tables-1
 	docker rm -f dataframetrainer-frontend-prod-1
@@ -34,6 +42,12 @@ prod:
 prod_detached:
 	docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
 
+test:
+	docker compose -f docker-compose.yml -f docker-compose.test.yml up
+
+test_detached:
+	docker compose -f docker-compose.yml -f docker-compose.test.yml up -d
+
 dev:
 	docker compose -f docker-compose.yml -f docker-compose.dev.yml up
 
@@ -44,7 +58,7 @@ up:
 	docker compose -f docker-compose.yml -f docker-compose.dev.yml up
 
 up_test:
-	docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.test.yml up
+	docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.testing.yml up
 
 recreate:
 	docker compose -f docker-compose.yml -f docker-compose.dev.yml up --force-recreate

docker-compose.dev.yml

@@ -16,6 +16,7 @@ services:
     environment:
       NODE_ENV: development
       ORIGIN: "http://localhost:3000"
+      API_BASE_URL: "http://localhost:5000"
     ports:
       # The port of the website
       - 5173:5173
@@ -24,4 +25,10 @@ services:
       # This excludes the node_modules folder from docker volume
       - /frontend-svelte/node_modules
       - /frontend-svelte/.svelte-kit
-    working_dir: /app
+    working_dir: /app
+
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - 8081:8080

docker-compose.prod.yml

@@ -17,6 +17,7 @@ services:
     environment:
       NODE_ENV: production
       ORIGIN: "https://www.dataframetrainer.com"
+      API_BASE_URL: "https://www.dataframetrainer.com:5000"
     ports:
       # The port of the website
       - 3000:3000

docker-compose.test.yml

@@ -1,11 +1,27 @@
 version: "3.1"
-### File only needed for test setup
 
 services:
-  fill-db-with-test-input:
+  backend:
+    ports:
+      # we use nginx to proxy port 3999 to the API_BASE_URL
+      - 3999:5000
+    environment:
+      ENV: "test"
+      BACKEND_PORT: 5000
+
+  frontend-test:
+    restart: on-failure
     build:
-      context: ./database/tests_docker
-      dockerfile: Dockerfile_fill_db_with_test_inputs
-    volumes:
-      - ./database/tests_docker/sql:/app/sql
-      - ./database/tests_docker/fill_for_local_test.py:/app/fill_for_local_test.py
+      context: ./frontend-svelte
+      dockerfile: Dockerfile.prod
+    environment:
+      NODE_ENV: test
+      ORIGIN: "https://www.test.dataframetrainer.com"
+      API_BASE_URL: "https://www.test.dataframetrainer.com:4000"
+    ports:
+      # The port of the website
+      - 4444:3000
+
+volumes:
+  dataframetrainer_postgres_test:
+    external: true

docker-compose.testing.yml

@@ -0,0 +1,11 @@
+version: "3.1"
+### File only needed for test setup
+
+services:
+  fill-db-with-test-input:
+    build:
+      context: ./database/tests_docker
+      dockerfile: Dockerfile_fill_db_with_test_inputs
+    volumes:
+      - ./database/tests_docker/sql:/app/sql
+      - ./database/tests_docker/fill_for_local_test.py:/app/fill_for_local_test.py

docker-compose.yml

@@ -5,8 +5,6 @@ services:
     build:
       context: backend
       dockerfile: Dockerfile
-    ports:
-      - 4999:5000
     working_dir: /app
     volumes:
       - ./backend:/app
@@ -46,14 +44,9 @@ services:
       - ./backend/challenges:/challenges
       - ./database/sql_scripts:/sql_scripts
       - dataframetrainer_postgres:/var/lib/postgresql/data
-    ports:
-      - "${DB_PORT}:5432"
-
-  adminer:
-    image: adminer
-    restart: always
-    ports:
-      - 8081:8080
+    # we do not need this
+    # ports:
+    #   - "${DB_PORT}:5432"
 
 volumes:
   dataframetrainer_postgres:

frontend-svelte/src/app.d.ts

@@ -39,6 +39,7 @@ declare module '$env/static/private' {
 	export const DB_USER: string;
 	export const DB_PORT: string;
 	export const DB_NAME: string;
+	export const API_BASE_URL: string;
 }
 
 interface UserProperties {

frontend-svelte/src/routes/config.ts

@@ -1,4 +1,4 @@
-export const API_BASE_URL = process.env.NODE_ENV === 'production'
-  // we use nginx as reverse proxy, so it redirects all requests to http://www.dataframetrainer.com:5000 to localhost:4999
-  ? 'https://www.dataframetrainer.com:5000'
-  : 'http://localhost:4999';
+let API_BASE_URL = import.meta.env.VITE_API_BASE_URL;
+let NODE_ENV = process.env.NODE_ENV;
+
+export { API_BASE_URL, NODE_ENV };