Add nilaway and rework test setup

Author: eikendev

Makefile

@@ -29,6 +29,7 @@ test:
 	errcheck -exclude errcheck_excludes.txt ./...
 	gocritic check -disable='#experimental,#opinionated' [email protected] 3 ./...
 	revive -set_exit_status -exclude ./docs ./...
+	nilaway ./...
 	go test -v -cover ./...
 	gosec -exclude-dir=tests ./...
 	govulncheck ./...
@@ -43,6 +44,7 @@ setup:
 	go install github.com/mgechev/revive@latest
 	go install github.com/securego/gosec/v2/cmd/gosec@latest
 	go install github.com/swaggo/swag/cmd/swag@latest
+	go install go.uber.org/nilaway/cmd/nilaway@latest
 	go install golang.org/x/vuln/cmd/govulncheck@latest
 	go install honnef.co/go/tools/cmd/staticcheck@latest
 	go install mvdan.cc/gofumpt@latest

cmd/pushbits/main.go

@@ -29,6 +29,14 @@ func setupCleanup(db *database.Database, dp *dispatcher.Dispatcher) {
 	}()
 }
 
+func printStarupMessage() {
+	if len(version) == 0 {
+		log.L.Panic("Version not set")
+	} else {
+		log.L.Printf("Starting PushBits %s", version)
+	}
+}
+
 // @title PushBits Server API Documentation
 // @version 0.10.5
 // @description Documentation for the PushBits server API.
@@ -45,11 +53,7 @@ func setupCleanup(db *database.Database, dp *dispatcher.Dispatcher) {
 
 // @securityDefinitions.basic BasicAuth
 func main() {
-	if len(version) == 0 {
-		log.L.Panic("Version not set")
-	} else {
-		log.L.Printf("Starting PushBits %s", version)
-	}
+	printStarupMessage()
 
 	c := configuration.Get()
 
@@ -63,6 +67,11 @@ func main() {
 	db, err := database.Create(cm, c.Database.Dialect, c.Database.Connection)
 	if err != nil {
 		log.L.Fatal(err)
+		return
+	}
+	if db == nil {
+		log.L.Fatal("db is nil but error was nil")
+		return
 	}
 	defer db.Close()
 
@@ -73,6 +82,11 @@ func main() {
 	dp, err := dispatcher.Create(c.Matrix.Homeserver, c.Matrix.Username, c.Matrix.Password, c.Formatting)
 	if err != nil {
 		log.L.Fatal(err)
+		return
+	}
+	if dp == nil {
+		log.L.Fatal("dp is nil but error was nil")
+		return
 	}
 	defer dp.Close()
 
@@ -81,15 +95,18 @@ func main() {
 	err = db.RepairChannels(dp, &c.RepairBehavior)
 	if err != nil {
 		log.L.Fatal(err)
+		return
 	}
 
 	engine, err := router.Create(c.Debug, c.HTTP.TrustedProxies, cm, db, dp, &c.Alertmanager)
 	if err != nil {
 		log.L.Fatal(err)
+		return
 	}
 
 	err = runner.Run(engine, c)
 	if err != nil {
 		log.L.Fatal(err)
+		return
 	}
 }

internal/api/alertmanager/handler.go

@@ -38,6 +38,10 @@ type HandlerSettings struct {
 // @Router /alert [post]
 func (h *Handler) CreateAlert(ctx *gin.Context) {
 	application := authentication.GetApplication(ctx)
+	if application == nil {
+		return
+	}
+
 	log.L.Printf("Sending alert notification for application %s.", application.Name)
 
 	var hook model.AlertmanagerWebhook

internal/api/api_test.go

@@ -0,0 +1,100 @@
+package api
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/gin-gonic/gin"
+	"github.com/pushbits/server/internal/authentication/credentials"
+	"github.com/pushbits/server/internal/configuration"
+	"github.com/pushbits/server/internal/database"
+	"github.com/pushbits/server/internal/log"
+	"github.com/pushbits/server/internal/model"
+	"github.com/pushbits/server/tests/mockups"
+)
+
+// TestContext holds all test-related objects
+type TestContext struct {
+	ApplicationHandler  *ApplicationHandler
+	Users               []*model.User
+	Database            *database.Database
+	NotificationHandler *NotificationHandler
+	UserHandler         *UserHandler
+	Config              *configuration.Configuration
+}
+
+var GlobalTestContext *TestContext
+
+func cleanup() {
+	err := os.Remove("pushbits-test.db")
+	if err != nil {
+		log.L.Warnln("Cannot delete test database: ", err)
+	}
+}
+
+func TestMain(m *testing.M) {
+	cleanup()
+
+	gin.SetMode(gin.TestMode)
+
+	GlobalTestContext = CreateTestContext(nil)
+
+	m.Run()
+
+	cleanup()
+}
+
+// GetTestContext initializes and verifies all required test components
+func GetTestContext(_ *testing.T) *TestContext {
+	if GlobalTestContext == nil {
+		GlobalTestContext = CreateTestContext(nil)
+	}
+
+	return GlobalTestContext
+}
+
+// CreateTestContext initializes and verifies all required test components
+func CreateTestContext(_ *testing.T) *TestContext {
+	ctx := &TestContext{}
+
+	config := configuration.Configuration{}
+	config.Database.Connection = "pushbits-test.db"
+	config.Database.Dialect = "sqlite3"
+	config.Crypto.Argon2.Iterations = 4
+	config.Crypto.Argon2.Parallelism = 4
+	config.Crypto.Argon2.Memory = 131072
+	config.Crypto.Argon2.SaltLength = 16
+	config.Crypto.Argon2.KeyLength = 32
+	config.Admin.Name = "user"
+	config.Admin.Password = "pushbits"
+	ctx.Config = &config
+
+	db, err := mockups.GetEmptyDatabase(ctx.Config.Crypto)
+	if err != nil {
+		cleanup()
+		panic(fmt.Errorf("cannot set up database: %w", err))
+	}
+	ctx.Database = db
+
+	ctx.ApplicationHandler = &ApplicationHandler{
+		DB: ctx.Database,
+		DP: &mockups.MockDispatcher{},
+	}
+
+	ctx.Users = mockups.GetUsers(ctx.Config)
+
+	ctx.NotificationHandler = &NotificationHandler{
+		DB: ctx.Database,
+		DP: &mockups.MockDispatcher{},
+	}
+
+	ctx.UserHandler = &UserHandler{
+		AH: ctx.ApplicationHandler,
+		CM: credentials.CreateManager(false, ctx.Config.Crypto),
+		DB: ctx.Database,
+		DP: &mockups.MockDispatcher{},
+	}
+
+	return ctx
+}

internal/api/application.go

@@ -28,6 +28,10 @@ func (h *ApplicationHandler) generateToken(compat bool) string {
 }
 
 func (h *ApplicationHandler) registerApplication(ctx *gin.Context, a *model.Application, u *model.User) error {
+	if a == nil || u == nil {
+		return errors.New("nil parameters provided")
+	}
+
 	log.L.Printf("Registering application %s.", a.Name)
 
 	channelID, err := h.DP.RegisterApplication(a.ID, a.Name, u.MatrixID)
@@ -46,6 +50,10 @@ func (h *ApplicationHandler) registerApplication(ctx *gin.Context, a *model.Appl
 }
 
 func (h *ApplicationHandler) createApplication(ctx *gin.Context, u *model.User, name string, compat bool) (*model.Application, error) {
+	if u == nil {
+		return nil, errors.New("nil parameters provided")
+	}
+
 	log.L.Printf("Creating application %s.", name)
 
 	application := model.Application{}
@@ -71,6 +79,10 @@ func (h *ApplicationHandler) createApplication(ctx *gin.Context, u *model.User,
 }
 
 func (h *ApplicationHandler) deleteApplication(ctx *gin.Context, a *model.Application, u *model.User) error {
+	if a == nil || u == nil {
+		return errors.New("nil parameters provided")
+	}
+
 	log.L.Printf("Deleting application %s (ID %d).", a.Name, a.ID)
 
 	err := h.DP.DeregisterApplication(a, u)
@@ -87,6 +99,10 @@ func (h *ApplicationHandler) deleteApplication(ctx *gin.Context, a *model.Applic
 }
 
 func (h *ApplicationHandler) updateApplication(ctx *gin.Context, a *model.Application, updateApplication *model.UpdateApplication) error {
+	if a == nil || updateApplication == nil {
+		return errors.New("nil parameters provided")
+	}
+
 	log.L.Printf("Updating application %s (ID %d).", a.Name, a.ID)
 
 	if updateApplication.Name != nil {
@@ -186,7 +202,7 @@ func (h *ApplicationHandler) GetApplications(ctx *gin.Context) {
 // @Router /application/{id} [get]
 func (h *ApplicationHandler) GetApplication(ctx *gin.Context) {
 	application, err := getApplication(ctx, h.DB)
-	if err != nil {
+	if err != nil || application == nil {
 		return
 	}
 
@@ -218,7 +234,7 @@ func (h *ApplicationHandler) GetApplication(ctx *gin.Context) {
 // @Router /application/{id} [delete]
 func (h *ApplicationHandler) DeleteApplication(ctx *gin.Context) {
 	application, err := getApplication(ctx, h.DB)
-	if err != nil {
+	if err != nil || application == nil {
 		return
 	}
 
@@ -250,7 +266,7 @@ func (h *ApplicationHandler) DeleteApplication(ctx *gin.Context) {
 // @Router /application/{id} [put]
 func (h *ApplicationHandler) UpdateApplication(ctx *gin.Context) {
 	application, err := getApplication(ctx, h.DB)
-	if err != nil {
+	if err != nil || application == nil {
 		return
 	}