fixed conflicts from dev -> Comfortstat

Author: SimonPergel

.dockerignore

@@ -0,0 +1,2 @@
+Dockerfile
+.git*

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Tests and Linters
+name: Linters, Spellcheck, and Tests
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
 jobs:
   Linters:
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 2
     steps:
       - uses: actions/checkout@v4
       - name: Setup go
@@ -19,9 +19,16 @@ jobs:
       - name: Run linters
         run: make lint
 
+  Spellcheck:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/[email protected]
+
   Tests:
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 2
     steps:
       - uses: actions/checkout@v4
       - name: Setup go

Comfortstat/Comfortstat.go

@@ -20,7 +20,7 @@ func main() {
 	// instantiate the System
 	sys := components.NewSystem("Comfortstat", ctx)
 
-	// Instatiate the Capusle
+	// Instantiate the Capsule
 	sys.Husk = &components.Husk{
 		Description: " is a controller for a consumed servo motor position based on a consumed temperature",
 		Certificate: "ABCD",
@@ -31,7 +31,7 @@ func main() {
 
 	// instantiate a template unit asset
 	assetTemplate := initTemplate()
-	// Calling initAPI() starts the pricefeedbackloop that fetches the current electrisity price for the particular hour
+	// Calling initAPI() starts the pricefeedbackloop that fetches the current electricity price for the particular hour
 	initAPI()
 	time.Sleep(1 * time.Second)
 	assetName := assetTemplate.GetName()
@@ -69,7 +69,7 @@ func main() {
 	time.Sleep(2 * time.Second) // allow the go routines to be executed, which might take more time than the main routine to end
 }
 
-// Serving handles the resources services. NOTE: it exepcts those names from the request URL path
+// Serving handles the resources services. NOTE: it expects those names from the request URL path
 func (t *UnitAsset) Serving(w http.ResponseWriter, r *http.Request, servicePath string) {
 	switch servicePath {
 	case "MinTemperature":
@@ -103,7 +103,7 @@ func (rsc *UnitAsset) httpSetSEKPrice(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
-// All these functions below handles HTTP "PUT" or "GET" requests to modefy or retrieve the MAX/MIN temprature/price and desierd temprature
+// All these functions below handles HTTP "PUT" or "GET" requests to modefy or retrieve the MAX/MIN temprature/price and desierd temperature
 // For the PUT case - the "HTTPProcessSetRequest(w, r)" is called to prosses the data given from the user and if no error,
 // call the set functions in things.go with the value witch updates the value in the struct
 func (rsc *UnitAsset) httpSetMinTemp(w http.ResponseWriter, r *http.Request) {
@@ -112,7 +112,7 @@ func (rsc *UnitAsset) httpSetMinTemp(w http.ResponseWriter, r *http.Request) {
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
 			//log.Println("Error with the setting request of the position ", err)
-			http.Error(w, "request incorreclty formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 
 		}
@@ -130,7 +130,7 @@ func (rsc *UnitAsset) httpSetMaxTemp(w http.ResponseWriter, r *http.Request) {
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
 			//log.Println("Error with the setting request of the position ", err)
-			http.Error(w, "request incorreclty formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 		}
 		rsc.setMaxTemp(sig)
@@ -148,7 +148,7 @@ func (rsc *UnitAsset) httpSetMinPrice(w http.ResponseWriter, r *http.Request) {
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
 			//log.Println("Error with the setting request of the position ", err)
-			http.Error(w, "request incorreclty formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 		}
 		rsc.setMinPrice(sig)
@@ -167,7 +167,7 @@ func (rsc *UnitAsset) httpSetMaxPrice(w http.ResponseWriter, r *http.Request) {
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
 			//log.Println("Error with the setting request of the position ", err)
-			http.Error(w, "request incorreclty formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 		}
 		rsc.setMaxPrice(sig)
@@ -186,7 +186,7 @@ func (rsc *UnitAsset) httpSetDesiredTemp(w http.ResponseWriter, r *http.Request)
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
 			//log.Println("Error with the setting request of the position ", err)
-			http.Error(w, "request incorreclty formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 		}
 		rsc.setDesiredTemp(sig)
@@ -204,7 +204,7 @@ func (rsc *UnitAsset) httpSetUserTemp(w http.ResponseWriter, r *http.Request) {
 	case "PUT":
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
-			http.Error(w, "request incorrectly formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 		}
 		rsc.setUserTemp(sig)
@@ -221,7 +221,7 @@ func (rsc *UnitAsset) httpSetRegion(w http.ResponseWriter, r *http.Request) {
 	case "PUT":
 		sig, err := usecases.HTTPProcessSetRequest(w, r)
 		if err != nil {
-			http.Error(w, "request incorrectly formated", http.StatusBadRequest)
+			http.Error(w, "request incorrectly formatted", http.StatusBadRequest)
 			return
 		}
 		rsc.setRegion(sig)

Comfortstat/Comfortstat_test.go

@@ -29,13 +29,13 @@ func TestHttpSetSEKPrice(t *testing.T) {
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 	// check results from above
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// Bad test case: default part of code
 	w = httptest.NewRecorder()
@@ -97,13 +97,13 @@ func TestHttpSetMinTemp(t *testing.T) {
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 	// check the result from above
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code
 	// force the case to hit default statement but alter the method
@@ -165,13 +165,13 @@ func TestHttpSetMaxTemp(t *testing.T) {
 	unit := strings.Contains(string(body), `"unit": "Celsius"`)
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code
 
@@ -233,13 +233,13 @@ func TestHttpSetMinPrice(t *testing.T) {
 	unit := strings.Contains(string(body), `"unit": "SEK"`)
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code
 
@@ -303,13 +303,13 @@ func TestHttpSetMaxPrice(t *testing.T) {
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code
 
@@ -377,13 +377,13 @@ func TestHttpSetDesiredTemp(t *testing.T) {
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code
 
@@ -450,13 +450,13 @@ func TestHttpSetUserTemp(t *testing.T) {
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 
 	if value != true {
-		t.Errorf("expected the statment to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if unit != true {
 		t.Errorf("expected the unit statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code
 
@@ -477,9 +477,9 @@ func TestHttpSetRegion(t *testing.T) {
 
 	// creates a fake request body with JSON data
 	w := httptest.NewRecorder()
-	fakebody := bytes.NewReader([]byte(`{"value": 1, "unit": "RegionPoint", "version": "SignalA_v1.0"}`)) // converts the Jason data so it can be read
-	r := httptest.NewRequest("PUT", "http://localhost:8670/Comfortstat/Set%20Values/Region", fakebody)    // simulating a put request from a user to update the min temp
-	r.Header.Set("Content-Type", "application/json")                                                      // basic setup to prevent the request to be rejected.
+	fakebody := bytes.NewReader([]byte(`{"value": 1, "version": "SignalA_v1.0"}`))                     // converts the Jason data so it can be read
+	r := httptest.NewRequest("PUT", "http://localhost:8670/Comfortstat/Set%20Values/Region", fakebody) // simulating a put request from a user to update the min temp
+	r.Header.Set("Content-Type", "application/json")                                                   // basic setup to prevent the request to be rejected.
 	goodStatusCode := 200
 
 	ua.httpSetRegion(w, r)
@@ -494,7 +494,7 @@ func TestHttpSetRegion(t *testing.T) {
 
 	// creates a fake request body with JSON data
 	w = httptest.NewRecorder()
-	fakebody = bytes.NewReader([]byte(`{"123, "unit": "RegionPoint", "version": "SignalA_v1.0"}`))    // converts the Jason data so it can be read
+	fakebody = bytes.NewReader([]byte(`{"123, "version": "SignalA_v1.0"}`))                           // converts the Jason data so it can be read
 	r = httptest.NewRequest("PUT", "http://localhost:8670/Comfortstat/Set%20Values/Region", fakebody) // simulating a put request from a user to update the min temp
 	r.Header.Set("Content-Type", "application/json")                                                  // basic setup to prevent the request to be rejected.
 
@@ -519,17 +519,13 @@ func TestHttpSetRegion(t *testing.T) {
 	body, _ := io.ReadAll(resp.Body)
 	// this is a simple check if the JSON response contains the specific value/unit/version
 	value := strings.Contains(string(body), `"value": 1`)
-	unit := strings.Contains(string(body), `"unit": "RegionPoint"`)
 	version := strings.Contains(string(body), `"version": "SignalA_v1.0"`)
 
 	if value != true {
-		t.Errorf("expected the statment to be true!")
-	}
-	if unit != true {
-		t.Errorf("expected the unit statement to be true!")
+		t.Errorf("expected the statement to be true!")
 	}
 	if version != true {
-		t.Errorf("expected the version statment to be true!")
+		t.Errorf("expected the version statement to be true!")
 	}
 	// bad test case: default part of code