-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Codecoverage improve middlewares (#19)
* codecov * codecove middleware * testing code coverage * deleting token cache test for now
- Loading branch information
1 parent
4a02065
commit f41c697
Showing
11 changed files
with
491 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| name: Run tests and upload coverage | ||
|
|
||
| on: | ||
| push | ||
| on: push | ||
|
|
||
| jobs: | ||
| test: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| func TestAuthMiddlewareFunc(t *testing.T) { | ||
| // Set Gin to Test Mode | ||
| gin.SetMode(gin.TestMode) | ||
|
|
||
| // Create a new Gin engine | ||
| r := gin.New() | ||
|
|
||
| // Use the AuthMiddleware | ||
| protected := r.Group("/") | ||
| protected.Use(AuthMiddleware()) | ||
| // Define a test route | ||
| protected.GET("/protected", func(c *gin.Context) { | ||
| c.String(http.StatusOK, "protected") | ||
| }) | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| token string | ||
| expectedStatus int | ||
| }{ | ||
| {"Valid Token", "Bearer valid_token", http.StatusOK}, | ||
| {"Invalid Token", "Bearer invalid_token", http.StatusOK}, // This is expected to pass, as the auth only checks for the token presence | ||
| {"No Token", "", http.StatusUnauthorized}, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| req, _ := http.NewRequest("GET", "/protected", nil) | ||
| if tt.token != "" { | ||
| req.Header.Set("Authorization", tt.token) | ||
| } | ||
| resp := httptest.NewRecorder() | ||
|
|
||
| r.ServeHTTP(resp, req) | ||
|
|
||
| if resp.Code != tt.expectedStatus { | ||
| t.Errorf("Expected status %d; got %d", tt.expectedStatus, resp.Code) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,33 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/gin-contrib/cors" | ||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| func CORSMiddleware() gin.HandlerFunc { | ||
| config := cors.DefaultConfig() | ||
| return func(c *gin.Context) { | ||
| origin := c.Request.Header.Get("Origin") | ||
| allowedOrigins := os.Getenv("ALLOWED_ORIGINS") | ||
|
|
||
| allowedOrigins := os.Getenv("ALLOWED_ORIGINS") | ||
| if allowedOrigins != "" { | ||
| config.AllowOrigins = strings.Split(allowedOrigins, ",") | ||
| } else { | ||
| config.AllowOriginFunc = func(origin string) bool { | ||
| return strings.HasPrefix(origin, "http://localhost") || strings.HasPrefix(origin, "https://localhost") | ||
| if origin != "" && (allowedOrigins == "*" || strings.Contains(allowedOrigins, origin)) { | ||
| c.Header("Access-Control-Allow-Origin", origin) | ||
| } else { | ||
| c.Header("Access-Control-Allow-Origin", "*") | ||
| } | ||
| } | ||
|
|
||
| config.AllowMethods = []string{"GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"} | ||
| config.AllowHeaders = []string{"Origin", "Content-Type", "Accept", "Authorization"} | ||
| c.Header("Access-Control-Allow-Methods", "GET,POST,PUT,PATCH,DELETE,OPTIONS") | ||
| c.Header("Access-Control-Allow-Headers", "Authorization,Content-Type") | ||
| c.Header("Access-Control-Allow-Credentials", "true") | ||
|
|
||
| if c.Request.Method == "OPTIONS" { | ||
| c.AbortWithStatus(http.StatusOK) | ||
| return | ||
| } | ||
|
|
||
| return cors.New(config) | ||
| c.Next() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| func TestCORSMiddlewareFunc(t *testing.T) { | ||
| // Set Gin to Test Mode | ||
| gin.SetMode(gin.TestMode) | ||
|
|
||
| // Create a new Gin engine | ||
| r := gin.New() | ||
|
|
||
| // Use the CORSMiddleware | ||
| r.Use(CORSMiddleware()) | ||
|
|
||
| // Define a test route | ||
| r.GET("/test", func(c *gin.Context) { | ||
| c.String(http.StatusOK, "test") | ||
| }) | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| method string | ||
| origin string | ||
| expectedStatus int | ||
| expectedHeaders map[string]string | ||
| }{ | ||
| { | ||
| name: "OPTIONS request", | ||
| method: "OPTIONS", | ||
| origin: "http://example.com", | ||
| expectedStatus: http.StatusOK, | ||
| expectedHeaders: map[string]string{ | ||
| "Access-Control-Allow-Origin": "http://example.com", | ||
| "Access-Control-Allow-Methods": "GET,POST,PUT,PATCH,DELETE,OPTIONS", | ||
| "Access-Control-Allow-Headers": "Authorization,Content-Type", | ||
| "Access-Control-Allow-Credentials": "true", | ||
| }, | ||
| }, | ||
| { | ||
| name: "GET request", | ||
| method: "GET", | ||
| origin: "http://example.com", | ||
| expectedStatus: http.StatusOK, | ||
| expectedHeaders: map[string]string{ | ||
| "Access-Control-Allow-Origin": "http://example.com", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| os.Setenv("ALLOWED_ORIGINS", tt.origin) | ||
| req, _ := http.NewRequest(tt.method, "/test", nil) | ||
| req.Header.Set("Origin", tt.origin) | ||
| resp := httptest.NewRecorder() | ||
|
|
||
| r.ServeHTTP(resp, req) | ||
|
|
||
| if resp.Code != tt.expectedStatus { | ||
| t.Errorf("Expected status %d; got %d", tt.expectedStatus, resp.Code) | ||
| } | ||
|
|
||
| for key, value := range tt.expectedHeaders { | ||
| if resp.Header().Get(key) != value { | ||
| t.Errorf("Expected header %s to be %s; got %s", key, value, resp.Header().Get(key)) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| customLogger "github.com/nicobistolfi/go-rest-api/pkg" | ||
| ) | ||
|
|
||
| func TestLoggerMiddlewareFunc(t *testing.T) { | ||
| customLogger.Init() | ||
| // Set Gin to Test Mode | ||
| gin.SetMode(gin.TestMode) | ||
|
|
||
| // Create a new Gin engine | ||
| r := gin.New() | ||
|
|
||
| // Create a custom logger | ||
| logger := customLogger.Log | ||
|
|
||
| // Use the LoggerMiddleware | ||
| r.Use(LoggerMiddleware(logger)) | ||
|
|
||
| // Define a test route | ||
| r.GET("/test", func(c *gin.Context) { | ||
| c.String(http.StatusOK, "test") | ||
| }) | ||
|
|
||
| // Create a test request | ||
| req, _ := http.NewRequest("GET", "/test", nil) | ||
| resp := httptest.NewRecorder() | ||
|
|
||
| // Serve the request | ||
| r.ServeHTTP(resp, req) | ||
|
|
||
| // Check the status code | ||
| if resp.Code != http.StatusOK { | ||
| t.Errorf("Expected status %d; got %d", http.StatusOK, resp.Code) | ||
| } | ||
|
|
||
| // Add more assertions here to check logging behavior | ||
| // For example, you could use a custom io.Writer to capture log output | ||
| // and assert on its contents | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.