feat: add test with httptest

add test with httptest

add test with httptest

Author: yuanyu90221

docker-compose.yml

@@ -36,8 +36,6 @@ services:
       MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
     ports:
       - ${MYSQL_PORT}:${MYSQL_PORT}
-    volumes:
-      - ./data:/var/lib/mysql
     logging:
       driver: json-file
       options: 

go.mod

@@ -1,19 +1,22 @@
 module github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json
 
-go 1.21.4
+go 1.22.4
 
 require (
-	github.com/go-sql-driver/mysql v1.7.0
+	github.com/go-sql-driver/mysql v1.8.1
 	github.com/spf13/viper v1.19.0
+	github.com/stretchr/testify v1.9.0
 	gorm.io/driver/mysql v1.5.7
 	gorm.io/gorm v1.25.11
 )
 
 require (
+	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/bytedance/sonic v1.11.6 // indirect
 	github.com/bytedance/sonic/loader v0.1.1 // indirect
 	github.com/cloudwego/base64x v0.1.4 // indirect
 	github.com/cloudwego/iasm v0.2.0 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
@@ -28,6 +31,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.12 // indirect
 	golang.org/x/arch v0.8.0 // indirect

go.sum

@@ -1,3 +1,5 @@
+filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
+filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
 github.com/bytedance/sonic v1.11.6 h1:oUp34TzMlL+OY1OUWxHqsdkgC/Zfc85zGqw9siXjrc0=
 github.com/bytedance/sonic v1.11.6/go.mod h1:LysEHSvpvDySVdC2f87zGWf6CIKJcAvqab1ZaiQtds4=
 github.com/bytedance/sonic/loader v0.1.1 h1:c+e5Pt1k/cy5wMveRDyk2X4B9hF4g7an8N3zCYjJFNM=
@@ -28,8 +30,9 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn
 github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
 github.com/go-playground/validator/v10 v10.20.0 h1:K9ISHbSaI0lyB2eWMPJo+kOS/FBExVwjEviJTixqxL8=
 github.com/go-playground/validator/v10 v10.20.0/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM=
-github.com/go-sql-driver/mysql v1.7.0 h1:ueSltNNllEqE3qcWBTD0iQd3IpL/6U+mJxLkazJ7YPc=
 github.com/go-sql-driver/mysql v1.7.0/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
+github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvNJ1Y=
+github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg=
 github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
 github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=

tests/controllers/blogs_controller_test.go

@@ -0,0 +1,64 @@
+package controller_test
+
+import (
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	"github.com/gin-gonic/gin"
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/config"
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/model"
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/service/blog"
+	models_test "github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/tests/models"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMain(m *testing.M) {
+	// Setup the MySQL test database
+	models_test.SetupTestDB(config.AppConfig)
+	code := m.Run()
+	// cleanup
+	models_test.TeardownTestDB()
+	os.Exit(code)
+}
+
+type Response struct {
+	Blogs      []model.Blog `json:"blogs"`
+	Page       int          `json:"page"`
+	PageSize   int          `json:"pageSize"`
+	TotalPages int          `json:"totalPages"`
+}
+
+func TestBlogIndex(t *testing.T) {
+	gin.SetMode(gin.TestMode)
+	req := httptest.NewRequest(http.MethodGet, "/blogs?format=json", nil)
+	w := httptest.NewRecorder()
+	ctx, _ := gin.CreateTestContext(w)
+	ctx.Request = req
+
+	// Seed the database with some test data
+	blog1 := model.Blog{Title: "First Blog", Content: "Content of the first blog"}
+	blog2 := model.Blog{Title: "Second Blog", Content: "Content of the second blog"}
+	models_test.TRdb.Db.Create(&blog1)
+	models_test.TRdb.Db.Create(&blog2)
+	store := blog.NewBlogStore(models_test.TRdb)
+	hdr := blog.NewHandler(store)
+	hdr.BlogIndex(ctx)
+
+	res := w.Result()
+	defer res.Body.Close()
+	// Check the status code
+	assert.Equal(t, res.StatusCode, http.StatusOK, "API should return 200 stauts code")
+
+	// Read data from the body and parse the JSON
+	var result Response
+	err := json.NewDecoder(res.Body).Decode(&result)
+	assert.NoError(t, err)
+	// Check the length of the blogs array
+	assert.Len(t, result.Blogs, 2)
+	// Check content
+	assert.Equal(t, result.Blogs[0].Title, blog2.Title)
+	assert.Equal(t, result.Blogs[0].Content, blog2.Content)
+}

tests/models/setup.go

@@ -0,0 +1,40 @@
+package models_test
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/go-sql-driver/mysql"
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/config"
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/db"
+)
+
+var TRdb *db.Rdb
+
+func SetupTestDB(appConfig *config.Config) error {
+	rdb, err := db.New(mysql.Config{
+		User:                 appConfig.MysqlUser,
+		Passwd:               appConfig.MysqlPassword,
+		Addr:                 appConfig.MysqlAddr,
+		DBName:               appConfig.MysqlDatabase,
+		Net:                  "tcp",
+		AllowNativePasswords: true,
+		ParseTime:            true,
+	})
+	TRdb = rdb
+	if err != nil {
+		log.Fatal(err)
+	}
+	TRdb.Migration()
+	return nil
+}
+
+func TeardownTestDB() {
+	// cleanup
+	var tableNames []string
+	TRdb.Db.Raw("SHOW TABLES").Scan(&tableNames)
+	// Iterate over each table name and drop it
+	for _, tableName := range tableNames {
+		TRdb.Db.Exec(fmt.Sprintf("DROP TABLE IF EXISTS %s", tableName))
+	}
+}