Add test suite

joelseq · joelseq · commit ea1f125b7b18 · 2025-02-17T18:21:51.000-05:00
diff --git a/Makefile b/Makefile
@@ -0,0 +1,52 @@
+main_package_path = ./cmd/sqliteadmin
+binary_name = sqliteadmin
+
+# ==================================================================================== #
+# QUALITY CONTROL
+# ==================================================================================== #
+
+## audit: run quality control checks
+.PHONY: audit
+audit: test
+	go mod tidy -diff
+	go mod verify
+	test -z "$(shell gofmt -l .)" 
+	go vet ./...
+	go run honnef.co/go/tools/cmd/staticcheck@latest -checks=all,-ST1000,-U1000 ./...
+	go run golang.org/x/vuln/cmd/govulncheck@latest ./...
+
+## test: run all tests
+.PHONY: test
+test:
+	go test -v -race ./...
+
+## test/cover: run all tests and display coverage
+.PHONY: test/cover
+test/cover:
+	go test -v -race -buildvcs -coverprofile=/tmp/coverage.out ./...
+	go tool cover -html=/tmp/coverage.out
+
+# ==================================================================================== #
+# DEVELOPMENT
+# ==================================================================================== #
+
+## tidy: tidy modfiles and format .go files
+.PHONY: tidy
+tidy:
+	go mod tidy -v
+	go fmt ./...
+
+## build: build the application
+.PHONY: build
+build:
+	# Include additional build steps, like TypeScript, SCSS or Tailwind compilation here...
+	go build -o=/tmp/bin/${binary_name} ${main_package_path}
+
+## run: run the application
+.PHONY: run
+run: build
+	/tmp/bin/${binary_name}
+
+## run/live: run the application with reloading on file changes
+# .PHONY: run/live
+# run/live:
diff --git a/errors.go b/errors.go
@@ -13,23 +13,23 @@ var (
 	ErrInvalidInput        = errors.New("invalid input")
 )
 
-type ApiError struct {
+type APIError struct {
 	StatusCode int    `json:"statusCode"`
 	Message    string `json:"message"`
 }
 
-func (e ApiError) Error() string {
+func (e APIError) Error() string {
 	return fmt.Sprintf("api error: %d,  %s", e.StatusCode, e.Message)
 }
 
-func apiErrUnauthorized() ApiError {
-	return ApiError{StatusCode: http.StatusUnauthorized, Message: "Invalid credentials"}
+func apiErrUnauthorized() APIError {
+	return APIError{StatusCode: http.StatusUnauthorized, Message: "Invalid credentials"}
 }
 
-func apiErrBadRequest(details string) ApiError {
-	return ApiError{StatusCode: http.StatusBadRequest, Message: "Bad request: " + details}
+func apiErrBadRequest(details string) APIError {
+	return APIError{StatusCode: http.StatusBadRequest, Message: "Bad request: " + details}
 }
 
-func apiErrSomethingWentWrong() ApiError {
-	return ApiError{StatusCode: http.StatusInternalServerError, Message: "Something went wrong"}
+func apiErrSomethingWentWrong() APIError {
+	return APIError{StatusCode: http.StatusInternalServerError, Message: "Something went wrong"}
 }
diff --git a/examples/stdlib/stdlib.go b/examples/stdlib/stdlib.go
@@ -5,6 +5,7 @@ import (
 	"database/sql"
 	"fmt"
 	"log"
+	"log/slog"
 	"net/http"
 	"os/signal"
 	"syscall"
@@ -21,7 +22,15 @@ func main() {
 	if err != nil {
 		log.Fatalf("Error opening database: %v", err)
 	}
-	sHandler := sqliteadmin.NewHandler(db, "user", "password")
+	logger := slog.Default()
+
+	config := sqliteadmin.Config{
+		DB:       db,
+		Username: "user",
+		Password: "password",
+		Logger:   logger,
+	}
+	sHandler := sqliteadmin.NewHandler(config)
 
 	mux := http.NewServeMux()
 
diff --git a/go.mod b/go.mod
@@ -9,3 +9,10 @@ require (
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/rs/cors v1.11.1
 )
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/testify v1.10.0
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
diff --git a/go.sum b/go.sum
@@ -1,3 +1,5 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-chi/chi/v5 v5.2.0 h1:Aj1EtB0qR2Rdo2dG4O94RIU35w2lvQSj6BRA4+qwFL0=
 github.com/go-chi/chi/v5 v5.2.0/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
 github.com/go-chi/cors v1.2.1 h1:xEC8UT3Rlp2QuWNEr4Fs/c2EAGVKBwy/1vHx3bppil4=
@@ -6,5 +8,13 @@ github.com/mattn/go-sqlite3 v1.14.24 h1:tpSp2G2KyMnnQu99ngJ47EIkWVmliIizyZBfPrBW
 github.com/mattn/go-sqlite3 v1.14.24/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
 github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rs/cors v1.11.1 h1:eU3gRzXLRK57F5rKMGMZURNdIG4EoAmX8k94r9wXWHA=
 github.com/rs/cors v1.11.1/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/queryhandlers.go b/queryhandlers.go
@@ -488,7 +488,7 @@ func editRow(db *sql.DB, tableName string, row map[string]interface{}) error {
 	return nil
 }
 
-func writeError(w http.ResponseWriter, err ApiError) {
+func writeError(w http.ResponseWriter, err APIError) {
 	w.WriteHeader(err.StatusCode)
 	json.NewEncoder(w).Encode(err)
 }
diff --git a/sqliteadmin_test.go b/sqliteadmin_test.go

Original file line number	Diff line number	Diff line change
`@@ -13,23 +13,23 @@ var (`
`13`	`13`	`ErrInvalidInput = errors.New("invalid input")`
`14`	`14`	`)`
`15`	`15`
`16`		`-type ApiError struct {`
	`16`	`+type APIError struct {`
`17`	`17`	StatusCode int `json:"statusCode"`
`18`	`18`	Message string `json:"message"`
`19`	`19`	`}`
`20`	`20`
`21`		`-func (e ApiError) Error() string {`
	`21`	`+func (e APIError) Error() string {`
`22`	`22`	`return fmt.Sprintf("api error: %d, %s", e.StatusCode, e.Message)`
`23`	`23`	`}`
`24`	`24`
`25`		`-func apiErrUnauthorized() ApiError {`
`26`		`- return ApiError{StatusCode: http.StatusUnauthorized, Message: "Invalid credentials"}`
	`25`	`+func apiErrUnauthorized() APIError {`
	`26`	`+ return APIError{StatusCode: http.StatusUnauthorized, Message: "Invalid credentials"}`
`27`	`27`	`}`
`28`	`28`
`29`		`-func apiErrBadRequest(details string) ApiError {`
`30`		`- return ApiError{StatusCode: http.StatusBadRequest, Message: "Bad request: " + details}`
	`29`	`+func apiErrBadRequest(details string) APIError {`
	`30`	`+ return APIError{StatusCode: http.StatusBadRequest, Message: "Bad request: " + details}`
`31`	`31`	`}`
`32`	`32`
`33`		`-func apiErrSomethingWentWrong() ApiError {`
`34`		`- return ApiError{StatusCode: http.StatusInternalServerError, Message: "Something went wrong"}`
	`33`	`+func apiErrSomethingWentWrong() APIError {`
	`34`	`+ return APIError{StatusCode: http.StatusInternalServerError, Message: "Something went wrong"}`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -488,7 +488,7 @@ func editRow(db *sql.DB, tableName string, row map[string]interface{}) error {`
`488`	`488`	`return nil`
`489`	`489`	`}`
`490`	`490`
`491`		`-func writeError(w http.ResponseWriter, err ApiError) {`
	`491`	`+func writeError(w http.ResponseWriter, err APIError) {`
`492`	`492`	`w.WriteHeader(err.StatusCode)`
`493`	`493`	`json.NewEncoder(w).Encode(err)`
`494`	`494`	`}`