Updated deployment pipeline + updated config

.github/workflows/deploy.yml

@@ -8,7 +8,7 @@ jobs:
   push_to_registery:
     name: Push Docker image
     runs-on: ubuntu-latest
-    #environment: Azure
+    environment: Azure
     steps:
       - name: Check out the repo
         uses: actions/checkout@v4
@@ -25,6 +25,12 @@ jobs:
         with:
           images: michalmoudry/user-service
 
+      - name: Edit app's config
+        uses: jacobtomlinson/gha-find-replace@v3
+        find: "[dev]"
+        replace: "[prod]"
+        include: "**config.toml"
+
       - name: Build and push Docker image
         uses: docker/build-push-action@v3
         with:
@@ -37,7 +43,7 @@ jobs:
     name: Deploy
     runs-on: ubuntu-latest
     needs: [push_to_registery]
-    #environment: Azure
+    environment: Azure
     steps:
       - name: Check out the repo
         uses: actions/checkout@v4

README.md

@@ -4,25 +4,43 @@
 
 
 # User service
-A repository with a service for managing users. This repository is part of Microservices Reference Framework.
+A repository with a service for managing users. This repository is part of [Microservices Reference Framework](https://github.com/MichalMoudry/microservices-reference-framework "Link to Microservices Reference Framework").
 
 [![Build and test project](https://github.com/MichalMoudry/mrf-user-service/actions/workflows/go.yml/badge.svg)](https://github.com/MichalMoudry/mrf-user-service/actions/workflows/go.yml)
 [![Deploy to Azure](https://github.com/MichalMoudry/mrf-user-service/actions/workflows/deploy.yml/badge.svg)](https://github.com/MichalMoudry/mrf-user-service/actions/workflows/deploy.yml)
 
 ## Project structure
-- /src
-    - /cmd
+- **/src** - Folder with all the source/test code related to this service.
+    - /cmd - Folder with service's entrypoints.
     - /internal
         - /transport
         - /service
         - /config
-- /.dapr
-- /.azure
-- /assets
+- **/.dapr** - Folder with Dapr components for local deployment.
+- **/.azure** - Folder containing definitions for Azure resources.
+- **/assets** - Folder with repository's assets that are not part of the source code.
 
 ### Service architecture
 This section describes architecture of this particular service and not the entire system.
 
+**Note**: Arrows in the diagram below display direction of dependencies between layers. This project utilises Inversion of Control pattern for many component, layers including.
+
+```mermaid
+---
+title: "Layers of the workflow service"
+---
+classDiagram
+    class transport["Transport layer"]
+    click transport href "https://github.com/MichalMoudry/mrf-workflow-service/tree/main/transport" "Go to transport layer package"
+    class service["Service layer"]
+    transport <-- service
+
+    note for transport "validates requests\nparses request content\ncontains HTTP middleware\nrequest & response contracts"
+    note for service "contains business logic\nhandles commiting transactions\nhandles rolling back of transactions\n..."
+```
+
+**Note**: This is a stateless service, so there is no persistance layer/database.
+
 ## Getting started
 
 ## Used technologies

src/internal/config/firebase.go

@@ -3,6 +3,7 @@ package config
 import (
 	"encoding/json"
 	"os"
+	"strings"
 
 	firebase "firebase.google.com/go/v4"
 )
@@ -35,7 +36,7 @@ func CreateFirebaseCredentials() ([]byte, error) {
 		Type:                os.Getenv("FB_TYPE"),
 		ProjectId:           "ocr-microservice-project",
 		PrivateKeyId:        os.Getenv("FB_PRIV_KEY_ID"),
-		PrivateKey:          os.Getenv("FB_PRIV_KEY"),
+		PrivateKey:          strings.ReplaceAll(os.Getenv("FB_PRIV_KEY"), "\\n", "\n"),
 		ClientEmail:         os.Getenv("FB_CLIENT_EMAIL"),
 		ClientId:            os.Getenv("FB_CLIENT_ID"),
 		AuthUri:             "https://accounts.google.com/o/oauth2/auth",

src/internal/config/firebase_test.go

@@ -0,0 +1,45 @@
+package config
+
+import (
+	"encoding/json"
+	"os"
+	"testing"
+)
+
+func Test_PrivateKeyFormatting(t *testing.T) {
+	type args struct {
+		privKey string
+		wantErr bool
+	}
+	tests := []struct {
+		name string
+		args args
+	}{
+		{
+			name: "Test basic string replacement in private key",
+			args: args{
+				privKey: "-----BEGIN PRIVATE KEY-----\\nwfjwjfowfkwepkf\\n",
+				wantErr: false,
+			},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			os.Setenv("FB_PRIV_KEY", test.args.privKey)
+			data, err := CreateFirebaseCredentials()
+			if err != nil {
+				t.Error(err)
+				return
+			}
+
+			credentials := GoogleCredentials{}
+			err = json.Unmarshal(data, &credentials)
+			if err != nil {
+				t.Error(err)
+				return
+			}
+			t.Log(credentials)
+		})
+	}
+}