Cleanup

evg4b · Nov 25, 2023 · cb06878 · cb06878
1 parent b6bb5c0
commit cb06878
Show file tree

Hide file tree

Showing 21 changed files with 102 additions and 118 deletions.
diff --git a/.run/format.run.xml b/.run/format.run.xml
@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="format" type="CompoundRunConfigurationType">
-    <toRun name="gofmt" type="ShConfigurationType" />
-    <toRun name="gofumpt" type="ShConfigurationType" />
-    <method v="2" />
-  </configuration>
+    <configuration default="false" name="format" type="CompoundRunConfigurationType">
+        <toRun name="gofmt" type="ShConfigurationType"/>
+        <toRun name="gofumpt" type="ShConfigurationType"/>
+        <method v="2"/>
+    </configuration>
 </component>
diff --git a/.run/go test uncors.run.xml b/.run/go test uncors.run.xml
@@ -1,12 +1,13 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="go test uncors" type="GoTestRunConfiguration" factoryName="Go Test" nameIsGenerated="true">
-    <module name="uncors" />
-    <working_directory value="$PROJECT_DIR$" />
-    <kind value="DIRECTORY" />
-    <package value="github.com/evg4b/uncors" />
-    <directory value="$PROJECT_DIR$" />
-    <filePath value="$PROJECT_DIR$" />
-    <framework value="gotest" />
-    <method v="2" />
-  </configuration>
+    <configuration default="false" name="go test uncors" type="GoTestRunConfiguration" factoryName="Go Test"
+                   nameIsGenerated="true">
+        <module name="uncors"/>
+        <working_directory value="$PROJECT_DIR$"/>
+        <kind value="DIRECTORY"/>
+        <package value="github.com/evg4b/uncors"/>
+        <directory value="$PROJECT_DIR$"/>
+        <filePath value="$PROJECT_DIR$"/>
+        <framework value="gotest"/>
+        <method v="2"/>
+    </configuration>
 </component>
diff --git a/.run/gofmt.run.xml b/.run/gofmt.run.xml
@@ -1,17 +1,17 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="gofmt" type="ShConfigurationType">
-    <option name="SCRIPT_TEXT" value="gofmt -l -s -w ." />
-    <option name="INDEPENDENT_SCRIPT_PATH" value="true" />
-    <option name="SCRIPT_PATH" value="" />
-    <option name="SCRIPT_OPTIONS" value="" />
-    <option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
-    <option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
-    <option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
-    <option name="INTERPRETER_PATH" value="/bin/zsh" />
-    <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="EXECUTE_IN_TERMINAL" value="true" />
-    <option name="EXECUTE_SCRIPT_FILE" value="false" />
-    <envs />
-    <method v="2" />
-  </configuration>
+    <configuration default="false" name="gofmt" type="ShConfigurationType">
+        <option name="SCRIPT_TEXT" value="gofmt -l -s -w ."/>
+        <option name="INDEPENDENT_SCRIPT_PATH" value="true"/>
+        <option name="SCRIPT_PATH" value=""/>
+        <option name="SCRIPT_OPTIONS" value=""/>
+        <option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true"/>
+        <option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$"/>
+        <option name="INDEPENDENT_INTERPRETER_PATH" value="true"/>
+        <option name="INTERPRETER_PATH" value="/bin/zsh"/>
+        <option name="INTERPRETER_OPTIONS" value=""/>
+        <option name="EXECUTE_IN_TERMINAL" value="true"/>
+        <option name="EXECUTE_SCRIPT_FILE" value="false"/>
+        <envs/>
+        <method v="2"/>
+    </configuration>
 </component>
diff --git a/internal/config/mappings.go b/internal/config/mappings.go
@@ -15,18 +15,18 @@ func (m Mappings) String() string {
 
 	for _, group := range lo.GroupBy(m, extractHost) {
 		for _, mapping := range group {
-			helpers.Fprintf(builder, "%s => %s\n", mapping.From, mapping.To)
+			helpers.FPrintf(builder, "%s => %s\n", mapping.From, mapping.To)
 		}
 
 		mapping := group[0]
 		for _, mock := range mapping.Mocks {
-			helpers.Fprintf(builder, "    mock: %s\n", mock.String())
+			helpers.FPrintf(builder, "    mock: %s\n", mock.String())
 		}
 		for _, static := range mapping.Statics {
-			helpers.Fprintf(builder, "    static: %s\n", static.String())
+			helpers.FPrintf(builder, "    static: %s\n", static.String())
 		}
 		for _, cacheGlob := range mapping.Cache {
-			helpers.Fprintf(builder, "    cache: %s\n", cacheGlob)
+			helpers.FPrintf(builder, "    cache: %s\n", cacheGlob)
 		}
 	}
 

diff --git a/internal/config/validators/mapping_test.go b/internal/config/validators/mapping_test.go
@@ -56,7 +56,7 @@ func TestMappingValidator(t *testing.T) {
 						},
 					},
 					Cache: config.CacheGlobs{
-						"/api/info",
+						"/api/constants",
 						"/**",
 					},
 				},
@@ -139,7 +139,7 @@ func TestMappingValidator(t *testing.T) {
 					Statics: []config.StaticDirectory{},
 					Mocks: []config.Mock{
 						{
-							Path:   "/api/info",
+							Path:   "/api/user",
 							Method: "invalid",
 							Response: config.Response{
 								Code: 200,

diff --git a/internal/contracts/http_test.go b/internal/contracts/http_test.go
@@ -15,7 +15,7 @@ func TestCastToHTTPHandler(t *testing.T) {
 	const expectedBody = `{ "OK": true }`
 	handlerStub := contracts.HandlerFunc(func(w contracts.ResponseWriter, r *contracts.Request) {
 		w.WriteHeader(http.StatusOK)
-		helpers.Fprint(w, expectedBody)
+		helpers.FPrint(w, expectedBody)
 	})
 
 	request := httptest.NewRequest(http.MethodGet, "/data", nil)
@@ -44,7 +44,7 @@ func TestHandlerFunc(t *testing.T) {
 	const expectedBody = `{ "OK": true }`
 	uncorsHandler := contracts.HandlerFunc(func(w contracts.ResponseWriter, r *contracts.Request) {
 		w.WriteHeader(http.StatusOK)
-		helpers.Fprint(w, expectedBody)
+		helpers.FPrint(w, expectedBody)
 	})
 
 	recorder := httptest.NewRecorder()

diff --git a/internal/contracts/response_writer_test.go b/internal/contracts/response_writer_test.go
@@ -18,7 +18,7 @@ func TestResponseWriterWrapper(t *testing.T) {
 	writer := contracts.WrapResponseWriter(recorder)
 
 	writer.WriteHeader(expectedCode)
-	helpers.Fprint(writer, expectedValue)
+	helpers.FPrint(writer, expectedValue)
 
 	t.Run("save status code", func(t *testing.T) {
 		assert.Equal(t, expectedCode, writer.StatusCode())

diff --git a/internal/handler/cache/cacheable_writer_test.go b/internal/handler/cache/cacheable_writer_test.go
@@ -26,7 +26,7 @@ func TestCacheableResponseWriter(t *testing.T) {
 		{
 			name: "write body bytes only",
 			action: func(w http.ResponseWriter) {
-				helpers.Fprint(w, bodyString)
+				helpers.FPrint(w, bodyString)
 			},
 			expected: &cache.CachedResponse{
 				Header: http.Header{
@@ -64,7 +64,7 @@ func TestCacheableResponseWriter(t *testing.T) {
 			action: func(w http.ResponseWriter) {
 				header := w.Header()
 				header.Set(headers.ContentLength, "999")
-				helpers.Fprint(w, bodyString)
+				helpers.FPrint(w, bodyString)
 			},
 			expected: &cache.CachedResponse{
 				Header: http.Header{
@@ -81,7 +81,7 @@ func TestCacheableResponseWriter(t *testing.T) {
 				header.Set(headers.ContentLength, "9")
 				header.Set(headers.Authorization, authorization)
 				writer.WriteHeader(http.StatusBadGateway)
-				helpers.Fprint(writer, bodyString)
+				helpers.FPrint(writer, bodyString)
 			},
 			expected: &cache.CachedResponse{
 				Code: http.StatusBadGateway,

diff --git a/internal/handler/cache/middleware_test.go b/internal/handler/cache/middleware_test.go
@@ -20,6 +20,8 @@ import (
 
 func TestCacheMiddleware(t *testing.T) {
 	const expectedBody = "this is test"
+	const cacheGlob = "/api/**"
+	const constantEndpoint = "/api/constants"
 
 	expectedHeader := http.Header{
 		headers.ContentType:     {"text/html; charset=iso-8859-1"},
@@ -32,14 +34,14 @@ func TestCacheMiddleware(t *testing.T) {
 		cache.WithMethods([]string{http.MethodGet}),
 		cache.WithGlobs(config.CacheGlobs{
 			"/translations",
-			"/api/**",
+			cacheGlob,
 		}),
 	)
 
 	handler := testutils.NewCounter(func(writer contracts.ResponseWriter, request *contracts.Request) {
 		writer.WriteHeader(http.StatusOK)
 		testutils.CopyHeaders(expectedHeader, writer.Header())
-		helpers.Fprintf(writer, expectedBody)
+		helpers.FPrintf(writer, expectedBody)
 	})
 
 	t.Run("should not call cached response just one time for", func(t *testing.T) {
@@ -135,19 +137,19 @@ func TestCacheMiddleware(t *testing.T) {
 			{
 				name:       "witch response with status code 500",
 				method:     http.MethodGet,
-				path:       "/api/constants",
+				path:       constantEndpoint,
 				statusCode: http.StatusInternalServerError,
 			},
 			{
 				name:       "witch response with status code 400",
 				method:     http.MethodGet,
-				path:       "/api/constants",
+				path:       constantEndpoint,
 				statusCode: http.StatusBadRequest,
 			},
 			{
 				name:       "witch response with status code 304",
 				method:     http.MethodGet,
-				path:       "/api/constants",
+				path:       constantEndpoint,
 				statusCode: http.StatusNotModified,
 			},
 		}
@@ -156,7 +158,7 @@ func TestCacheMiddleware(t *testing.T) {
 				handler := testutils.NewCounter(func(writer contracts.ResponseWriter, request *contracts.Request) {
 					writer.WriteHeader(testCase.statusCode)
 					testutils.CopyHeaders(expectedHeader, writer.Header())
-					helpers.Fprintf(writer, expectedBody)
+					helpers.FPrintf(writer, expectedBody)
 				})
 
 				wrappedHandler := middleware.Wrap(handler)
@@ -184,7 +186,7 @@ func TestCacheMiddleware(t *testing.T) {
 			cache.WithCacheStorage(goCache.New(time.Minute, time.Minute)),
 			cache.WithLogger(mocks.NewNoopLogger(t)),
 			cache.WithMethods([]string{http.MethodGet}),
-			cache.WithGlobs(config.CacheGlobs{"/api/**"}),
+			cache.WithGlobs(config.CacheGlobs{cacheGlob}),
 		)
 
 		wrappedHandler := middleware.Wrap(handler)
@@ -212,13 +214,13 @@ func TestCacheMiddleware(t *testing.T) {
 			cache.WithCacheStorage(goCache.New(time.Minute, time.Minute)),
 			cache.WithLogger(mocks.NewNoopLogger(t)),
 			cache.WithMethods(methods),
-			cache.WithGlobs(config.CacheGlobs{"/api/**"}),
+			cache.WithGlobs(config.CacheGlobs{cacheGlob}),
 		)
 
 		handler := testutils.NewCounter(func(writer contracts.ResponseWriter, request *contracts.Request) {
 			writer.WriteHeader(http.StatusOK)
 			testutils.CopyHeaders(expectedHeader, writer.Header())
-			helpers.Fprintf(writer, request.Method)
+			helpers.FPrintf(writer, request.Method)
 		})
 
 		wrappedHandler := middleware.Wrap(handler)

diff --git a/internal/handler/mock/serve_raw_content.go b/internal/handler/mock/serve_raw_content.go
@@ -16,5 +16,5 @@ func (h *Handler) serveRawContent(writer http.ResponseWriter) {
 	}
 
 	writer.WriteHeader(normaliseCode(response.Code))
-	helpers.Fprint(writer, response.Raw)
+	helpers.FPrint(writer, response.Raw)
 }
diff --git a/internal/handler/static/middleware_test.go b/internal/handler/static/middleware_test.go
@@ -108,7 +108,7 @@ func TestStaticMiddleware(t *testing.T) {
 
 		handler := middleware.Wrap(contracts.HandlerFunc(func(writer contracts.ResponseWriter, _ *contracts.Request) {
 			writer.WriteHeader(testHTTPStatusCode)
-			helpers.Fprint(writer, testHTTPBody)
+			helpers.FPrint(writer, testHTTPBody)
 		}))
 
 		t.Run("return static content", func(t *testing.T) {

diff --git a/internal/helpers/clone_test.go b/internal/helpers/clone_test.go
@@ -8,13 +8,13 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-type clonableTestStruct struct{ Value string }
+type cloneableTestStruct struct{ Value string }
 
-func (t *clonableTestStruct) Clone() clonableTestStruct {
-	return clonableTestStruct{Value: "Cloned:" + t.Value}
+func (t *cloneableTestStruct) Clone() cloneableTestStruct {
+	return cloneableTestStruct{Value: "Cloned:" + t.Value}
 }
 
-type nonClonableTestStruct struct{ Value string }
+type nonCloneableTestStruct struct{ Value string }
 
 func TestCloneMap(t *testing.T) {
 	t.Run("base types", func(t *testing.T) {
@@ -73,14 +73,14 @@ func TestCloneMap(t *testing.T) {
 		})
 	})
 
-	t.Run("clonable objects", func(t *testing.T) {
-		data := map[string]clonableTestStruct{
+	t.Run("cloneable objects", func(t *testing.T) {
+		data := map[string]cloneableTestStruct{
 			"1": {Value: "property 1"},
 			"2": {Value: "property 2"},
 			"3": {Value: "property 3"},
 		}
 
-		expected := map[string]clonableTestStruct{
+		expected := map[string]cloneableTestStruct{
 			"1": {Value: "Cloned:property 1"},
 			"2": {Value: "Cloned:property 2"},
 			"3": {Value: "Cloned:property 3"},
@@ -92,8 +92,8 @@ func TestCloneMap(t *testing.T) {
 		assert.EqualValues(t, &expected, &actual)
 	})
 
-	t.Run("non clonable objects", func(t *testing.T) {
-		data := map[string]nonClonableTestStruct{
+	t.Run("non cloneable objects", func(t *testing.T) {
+		data := map[string]nonCloneableTestStruct{
 			"1": {Value: "demo"},
 			"2": {Value: "demo"},
 			"3": {Value: "demo"},

diff --git a/internal/helpers/print.go b/internal/helpers/print.go
@@ -5,13 +5,13 @@ import (
 	"io"
 )
 
-func Fprint(w io.Writer, payload ...any) {
+func FPrint(w io.Writer, payload ...any) {
 	if _, err := fmt.Fprint(w, payload...); err != nil {
 		panic(err)
 	}
 }
 
-func Fprintf(w io.Writer, format string, a ...any) {
+func FPrintf(w io.Writer, format string, a ...any) {
 	if _, err := fmt.Fprintf(w, format, a...); err != nil {
 		panic(err)
 	}
@@ -21,7 +21,7 @@ func Sprintf(format string, a ...any) string {
 	return fmt.Sprintf(format, a...)
 }
 
-func Fprintln(w io.Writer, a ...any) {
+func FPrintln(w io.Writer, a ...any) {
 	if _, err := fmt.Fprintln(w, a...); err != nil {
 		panic(err)
 	}