Merge pull request #204 from Onyxmoon/feature/readme-changes

Feature/readme changes

.github/workflows/create coverage badge.yml

@@ -32,7 +32,7 @@ jobs:
 
       - name: Run Test
         run: |
-          go test -v hsfl.de/group6/hsfl-master-ai-cloud-engineering/... -covermode=count -coverprofile=coverage.out
+          go test -v hsfl.de/group6/hsfl-master-ai-cloud-engineering/... -covermode=count -coverprofile=coverage.out --tags=integration
           go tool cover -func=coverage.out -o=coverage.out
 
       - name: Go Coverage Badge  # Pass the `coverage.out` output to this action

.github/workflows/run-tests-http-proxy-service.yml

@@ -20,14 +20,6 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies
-        working-directory: ./src/http-proxy-service
-        run: go mod tidy
-
-      - name: Build
-        working-directory: ./src/http-proxy-service
-        run: go build -v ./...
-
       - name: Test Go Module
         run: |
           cd src/http-proxy-service

.github/workflows/run-tests-lib-folder.yml

@@ -21,30 +21,6 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies for config
-        working-directory: ./lib/config
-        run: go mod tidy
-
-      - name: Install dependencies for router
-        working-directory: ./lib/router
-        run: go mod tidy
-
-      - name: Install dependencies for rpc
-        working-directory: ./lib/rpc
-        run: go mod tidy
-
-      - name: Build config library
-        working-directory: ./lib/config
-        run: go build -v ./...
-
-      - name: Build router library
-        working-directory: ./lib/router
-        run: go build -v ./...
-
-      - name: Build rpc library
-        working-directory: ./lib/rpc
-        run: go build -v ./...
-
       - name: Test Go config Module
         run: |
           cd lib/config

.github/workflows/run-tests-load-balancer-service.yml

@@ -20,14 +20,6 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies
-        working-directory: ./src/load-balancer-service
-        run: go mod tidy
-
-      - name: Build
-        working-directory: ./src/load-balancer-service
-        run: go build -v ./...
-
       - name: Test Go Module
         run: |
           cd src/load-balancer-service

.github/workflows/run-tests-product-service.yml

@@ -20,18 +20,10 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies
-        working-directory: ./src/product-service
-        run: go mod tidy
-
-      - name: Build
-        working-directory: ./src/product-service
-        run: go build -v ./...
-
       - name: Test Go Module
         run: |
           cd src/product-service
-          go test ./...
+          go test ./... --tags=integration
           test_exit_code=$? # Capture the exit code of the go test command
           if [ $test_exit_code -eq 0 ]; then
             echo "Tests passed successfully."

.github/workflows/run-tests-shoppinglist-service.yml

@@ -20,18 +20,10 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies
-        working-directory: ./src/shoppinglist-service
-        run: go mod tidy
-
-      - name: Build
-        working-directory: ./src/shoppinglist-service
-        run: go build -v ./...
-
       - name: Test Go Module
         run: |
           cd src/shoppinglist-service
-          go test ./...
+          go test ./... --tags=integration
           test_exit_code=$? # Capture the exit code of the go test command
           if [ $test_exit_code -eq 0 ]; then
             echo "Tests passed successfully."

.github/workflows/run-tests-user-service.yml

@@ -20,18 +20,10 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies
-        working-directory: ./src/user-service
-        run: go mod tidy
-
-      - name: Build
-        working-directory: ./src/user-service
-        run: go build -v ./...
-
       - name: Test Go Module
         run: |
           cd src/user-service
-          go test ./...
+          go test ./... --tags=integration
           test_exit_code=$? # Capture the exit code of the go test command
           if [ $test_exit_code -eq 0 ]; then
             echo "Tests passed successfully."

.github/workflows/run-tests-web-service.yml

@@ -20,14 +20,6 @@ jobs:
         with:
           go-version: 1.21
 
-      - name: Install dependencies
-        working-directory: ./src/web-service
-        run: go mod tidy
-
-      - name: Build
-        working-directory: ./src/web-service
-        run: go build -v ./...
-
       - name: Test Go Module
         run: |
           cd src/web-service

.mockery.yaml

@@ -30,3 +30,13 @@ packages:
     interfaces:
       Controller:
       Repository:
+  hsfl.de/group6/hsfl-master-ai-cloud-engineering/user-service/auth:
+    config:
+      dir: "./src/user-service/auth/_mock"
+    interfaces:
+      TokenGenerator:
+  hsfl.de/group6/hsfl-master-ai-cloud-engineering/user-service/crypto:
+    config:
+      dir: "./src/user-service/crypto/_mock"
+    interfaces:
+      Hasher:

README.md

@@ -1,5 +1,5 @@
 # Price Whisper
-![Coverage](https://img.shields.io/badge/Coverage-75.1%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Coverage-83.3%25-brightgreen)
 ![GitHub release (by tag)](https://img.shields.io/github/v/tag/onyxmoon/hsfl-master-ai-cloud-engineering.svg?sort=semver&label=Version&color=4ccc93d)
 [![Run tests (lib folder)](https://github.com/Onyxmoon/hsfl-master-ai-cloud-engineering/actions/workflows/run-tests-lib-folder.yml/badge.svg)](https://github.com/Onyxmoon/hsfl-master-ai-cloud-engineering/actions/workflows/run-tests-lib-folder.yml)
 [![Run tests (http proxy service)](https://github.com/Onyxmoon/hsfl-master-ai-cloud-engineering/actions/workflows/run-tests-http-proxy-service.yml/badge.svg)](https://github.com/Onyxmoon/hsfl-master-ai-cloud-engineering/actions/workflows/run-tests-http-proxy-service.yml)
@@ -41,7 +41,8 @@ The complete application can be deployed within a kubernetes cluster.
    ```shell
    kubectl apply -R -f ./kubernetes/manifests
    ```
-
+5. The main page can be accessed via the public port of the `HTTP Proxy Service` container.
+Monitoring can be accessed via the Grafana public port. There is an example dashboard configuration file at [kubernetes/grafana](kubernetes/grafana/dashboard-config.json).
 ## Setup project in Docker
 ### Requirements
 - Docker Compose version v2.23.3

kubernetes/kubernetes-cluster/README.md

@@ -0,0 +1,24 @@
+# Kubernetes Cluster Setup
+
+This README guides you through the process of setting up a Kubernetes cluster with vms using Vagrant and Ansible. Ensure that you have all necessary dependencies installed, including Ansible, Vagrant, and any SSH tools needed.
+
+## Steps to Follow
+
+1. First, change to the `kubernetes-cluster` directory
+2. Move your ssh public key into `kubernetes-cluster/ubuntu/vagrant/id_rsa.pub`
+3. Start the vm deployment with `vagrant up`
+4. Change, to the `ansible_playbooks` folder
+5. Optional: Sometimes you have to specify the ansible config
+    ```shell
+    export ANSIBLE_CONFIG=./ansible.cfg
+    ```
+6. Run `ansible-playbook setup.yaml` to setup cluster
+
+> The first time the manifests are automatically deployed after commissioning, the distribution of the pods may not be uniform.
+
+## Additional Notes
+Ensure that Ansible is properly installed and configured on your system.
+Verify that the SSH key has the correct permissions and is recognized by your system.
+If you encounter any issues, consult the official Kubernetes and Ansible documentation for troubleshooting steps.
+Conclusion
+Following these steps should successfully set up a Kubernetes cluster using Ansible. For more detailed instructions or advanced configurations, refer to the Kubernetes and Ansible official documentation.

kubernetes/manifests/price-whisper/database.yaml

@@ -9,8 +9,8 @@ stringData:
   config.json: |
     [
       {
-        "username": "username",
-        "password": "changeMe!",
+        "username": "db-username",
+        "password": "db-pw-changeMe!",
         "perms": [ "all" ]
       },
       {
@@ -20,13 +20,30 @@ stringData:
     ]
 ---
 apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: database-data
+  annotations:
+    author: Gruppe 6 <philipp.borucki@stud.hs-flensburg.de | dorien.groenwald@stud.hs-flensburg.de | jannick.lindner@stud.hs-flensburg.de>
+spec:
+  capacity:
+    storage: 1Gi
+  volumeMode: Filesystem
+  accessModes:
+    - ReadWriteOnce
+  persistentVolumeReclaimPolicy: Delete
+  hostPath:
+    path: /var/price-whisper/database-data/
+---
+apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: database-data
   namespace: price-whisper
   annotations:
     author: Gruppe 6 <philipp.borucki@stud.hs-flensburg.de | dorien.groenwald@stud.hs-flensburg.de | jannick.lindner@stud.hs-flensburg.de>
 spec:
+  volumeName: database-data
   accessModes:
     - ReadWriteOnce
   resources:

kubernetes/manifests/price-whisper/products.yaml

@@ -6,8 +6,8 @@ metadata:
   annotations:
     author: Gruppe 6 <philipp.borucki@stud.hs-flensburg.de | dorien.groenwald@stud.hs-flensburg.de | jannick.lindner@stud.hs-flensburg.de>
 stringData:
-  RQLITE_USER: "username"
-  RQLITE_PASSWORD: "changeMe!"
+  RQLITE_USER: "db-username"
+  RQLITE_PASSWORD: "db-pw-changeMe!"
 ---
 apiVersion: v1
 kind: ConfigMap

kubernetes/manifests/price-whisper/shoppinglists.yaml

@@ -6,8 +6,8 @@ metadata:
   annotations:
     author: Gruppe 6 <philipp.borucki@stud.hs-flensburg.de | dorien.groenwald@stud.hs-flensburg.de | jannick.lindner@stud.hs-flensburg.de>
 stringData:
-  RQLITE_USER: "username"
-  RQLITE_PASSWORD: "changeMe!"
+  RQLITE_USER: "db-username"
+  RQLITE_PASSWORD: "db-pw-changeMe!"
 ---
 apiVersion: v1
 kind: ConfigMap

kubernetes/manifests/price-whisper/test-data.yaml

@@ -6,8 +6,8 @@ metadata:
   annotations:
     author: Gruppe 6 <philipp.borucki@stud.hs-flensburg.de | dorien.groenwald@stud.hs-flensburg.de | jannick.lindner@stud.hs-flensburg.de>
 stringData:
-  RQLITE_USER: "username"
-  RQLITE_PASSWORD: "changeMe!"
+  RQLITE_USER: "db-username"
+  RQLITE_PASSWORD: "db-pw-changeMe!"
 ---
 apiVersion: v1
 kind: ConfigMap

kubernetes/manifests/price-whisper/users.yaml

@@ -6,8 +6,8 @@ metadata:
   annotations:
     author: Gruppe 6 <philipp.borucki@stud.hs-flensburg.de | dorien.groenwald@stud.hs-flensburg.de | jannick.lindner@stud.hs-flensburg.de>
 stringData:
-  RQLITE_USER: "username"
-  RQLITE_PASSWORD: "changeMe!"
+  RQLITE_USER: "db-username"
+  RQLITE_PASSWORD: "db-pw-changeMe!"
   JWT_PRIVATE_KEY: |
     # provide ecdsa private key as string or container local file path