Add test to Public routes

Author: Vic Shóstak

app/controllers/book_controller.go

@@ -6,10 +6,10 @@ import (
 	"github.com/dgrijalva/jwt-go"
 	"github.com/gofiber/fiber/v2"
 	"github.com/google/uuid"
-	"github.com/koddr/tutorial-go-rest-api-fiber/app/models"
-	"github.com/koddr/tutorial-go-rest-api-fiber/app/validators"
-	"github.com/koddr/tutorial-go-rest-api-fiber/pkg/utils"
-	"github.com/koddr/tutorial-go-rest-api-fiber/platform/database"
+	"github.com/koddr/tutorial-go-fiber-rest-api/app/models"
+	"github.com/koddr/tutorial-go-fiber-rest-api/app/validators"
+	"github.com/koddr/tutorial-go-fiber-rest-api/pkg/utils"
+	"github.com/koddr/tutorial-go-fiber-rest-api/platform/database"
 )
 
 // GetBooks func gets all exists books.

app/queries/book_query.go

@@ -3,7 +3,7 @@ package queries
 import (
 	"github.com/google/uuid"
 	"github.com/jmoiron/sqlx"
-	"github.com/koddr/tutorial-go-rest-api-fiber/app/models"
+	"github.com/koddr/tutorial-go-fiber-rest-api/app/models"
 )
 
 // BookQueries struct for queries from Book model.

go.mod

@@ -1,4 +1,4 @@
-module github.com/koddr/tutorial-go-rest-api-fiber
+module github.com/koddr/tutorial-go-fiber-rest-api
 
 go 1.16
 
@@ -13,5 +13,6 @@ require (
 	github.com/jackc/pgx/v4 v4.10.1
 	github.com/jmoiron/sqlx v1.3.1
 	github.com/joho/godotenv v1.3.0
+	github.com/stretchr/testify v1.7.0
 	github.com/swaggo/swag v1.7.0
 )

go.sum

@@ -2,8 +2,8 @@ package routes
 
 import (
 	"github.com/gofiber/fiber/v2"
-	"github.com/koddr/tutorial-go-rest-api-fiber/app/controllers"
-	"github.com/koddr/tutorial-go-rest-api-fiber/pkg/middleware"
+	"github.com/koddr/tutorial-go-fiber-rest-api/app/controllers"
+	"github.com/koddr/tutorial-go-fiber-rest-api/pkg/middleware"
 )
 
 // PrivateRoutes func for describe group of private routes.

pkg/routes/private_routes.go

@@ -2,7 +2,7 @@ package routes
 
 import (
 	"github.com/gofiber/fiber/v2"
-	"github.com/koddr/tutorial-go-rest-api-fiber/app/controllers"
+	"github.com/koddr/tutorial-go-fiber-rest-api/app/controllers"
 )
 
 // PublicRoutes func for describe group of public routes.

pkg/routes/public_routes.go

@@ -0,0 +1,68 @@
+package routes
+
+import (
+	"net/http/httptest"
+	"testing"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/koddr/tutorial-go-fiber-rest-api/pkg/configs"
+	"github.com/koddr/tutorial-go-fiber-rest-api/pkg/routes"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestPublicRoutes(t *testing.T) {
+	// Define a structure for specifying input and output
+	// data of a single test case. This structure is then used
+	// to create a so called test map, which contains all test
+	// cases, that should be run for testing this function
+	tests := []struct {
+		description   string
+		route         string // input route
+		expectedError bool
+		expectedCode  int
+	}{
+		{
+			description:   "get all books",
+			route:         "/api/v1/books",
+			expectedError: false,
+			expectedCode:  200,
+		},
+		{
+			description:   "get book by ID",
+			route:         "/api/v1/book/1",
+			expectedError: false,
+			expectedCode:  200,
+		},
+	}
+
+	// Define Fiber config.
+	config := configs.FiberConfig()
+
+	// Define a new Fiber app with config.
+	app := fiber.New(config)
+
+	// Routes.
+	routes.PublicRoutes(app) // Register a public routes for app.
+
+	// Iterate through test single test cases
+	for _, test := range tests {
+		// Create a new http request with the route from the test case.
+		req := httptest.NewRequest("GET", test.route, nil)
+
+		// Perform the request plain with the app.
+		// The -1 disables request latency.
+		resp, err := app.Test(req, -1)
+
+		// Verify that no error occurred, that is not expected
+		assert.Equalf(t, test.expectedError, err != nil, test.description)
+
+		// As expected errors lead to broken responses, the next
+		// test case needs to be processed
+		if test.expectedError {
+			continue
+		}
+
+		// Verify if the status code is as expected
+		assert.Equalf(t, test.expectedCode, resp.StatusCode, test.description)
+	}
+}

pkg/routes/public_routes_test.go

@@ -1,6 +1,6 @@
 package database
 
-import "github.com/koddr/tutorial-go-rest-api-fiber/app/queries"
+import "github.com/koddr/tutorial-go-fiber-rest-api/app/queries"
 
 // Queries struct for collect all app queries.
 type Queries struct {