Add misspell, gocritic, and revive

Makefile

@@ -21,11 +21,13 @@ clean:
 
 .PHONY: test
 test:
-	stdout=$$(gofumpt -l $(GO_FILES) 2>&1); if [ "$$stdout" ]; then exit 1; fi
+	stdout=$$(gofumpt -l . 2>&1); if [ "$$stdout" ]; then exit 1; fi
 	go vet ./...
-	gocyclo -over 10 $(GO_FILES)
+	misspell -error $(GO_FILES)
 	staticcheck ./...
 	errcheck -exclude errcheck_excludes.txt ./...
+	gocritic check -disable='#experimental,#opinionated' -@ifElseChain.minThreshold 3 ./...
+	revive -set_exit_status -exclude ./docs ./...
 	go test -v -cover ./...
 	gosec -exclude-dir=tests ./...
 	govulncheck ./...
@@ -33,8 +35,10 @@ test:
 
 .PHONY: setup
 setup:
-	go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
+	go install github.com/client9/misspell/cmd/misspell@latest
+	go install github.com/go-critic/go-critic/cmd/gocritic@latest
 	go install github.com/kisielk/errcheck@latest
+	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 golang.org/x/vuln/cmd/govulncheck@latest

cmd/pushbits/main.go

@@ -1,3 +1,4 @@
+// Package main provides the main function as a starting point of this tool.
 package main
 
 import (

internal/api/alertmanager/handler.go

@@ -1,3 +1,4 @@
+// Package alertmanager provides definitions and functionality related to Alertmanager notifications.
 package alertmanager
 
 import (
@@ -11,12 +12,14 @@ import (
 	"github.com/pushbits/server/internal/model"
 )
 
-type AlertmanagerHandler struct {
+// Handler holds information for processing alerts received via Alertmanager.
+type Handler struct {
 	DP       api.NotificationDispatcher
-	Settings AlertmanagerHandlerSettings
+	Settings HandlerSettings
 }
 
-type AlertmanagerHandlerSettings struct {
+// HandlerSettings represents the settings for processing alerts received via Alertmanager.
+type HandlerSettings struct {
 	TitleAnnotation   string
 	MessageAnnotation string
 }
@@ -33,7 +36,7 @@ type AlertmanagerHandlerSettings struct {
 // @Success 200 {object} []model.Notification
 // @Failure 500,404,403 ""
 // @Router /alert [post]
-func (h *AlertmanagerHandler) CreateAlert(ctx *gin.Context) {
+func (h *Handler) CreateAlert(ctx *gin.Context) {
 	application := authentication.GetApplication(ctx)
 	log.L.Printf("Sending alert notification for application %s.", application.Name)
 
@@ -52,7 +55,7 @@ func (h *AlertmanagerHandler) CreateAlert(ctx *gin.Context) {
 		}
 
 		notification.ID = messageID
-		notification.UrlEncodedID = url.QueryEscape(messageID)
+		notification.URLEncodedID = url.QueryEscape(messageID)
 		notifications[i] = notification
 	}
 	ctx.JSON(http.StatusOK, &notifications)

internal/api/application.go

@@ -30,7 +30,7 @@ func (h *ApplicationHandler) generateToken(compat bool) string {
 func (h *ApplicationHandler) registerApplication(ctx *gin.Context, a *model.Application, u *model.User) error {
 	log.L.Printf("Registering application %s.", a.Name)
 
-	channelID, err := h.DP.RegisterApplication(a.ID, a.Name, a.Token, u.MatrixID)
+	channelID, err := h.DP.RegisterApplication(a.ID, a.Name, u.MatrixID)
 	if success := SuccessOrAbort(ctx, http.StatusInternalServerError, err); !success {
 		return err
 	}

internal/api/application_test.go

@@ -323,7 +323,7 @@ func TestApi_DeleteApplication(t *testing.T) {
 }
 
 // GetApplicationHandler creates and returns an application handler
-func getApplicationHandler(c *configuration.Configuration) (*ApplicationHandler, error) {
+func getApplicationHandler(_ *configuration.Configuration) (*ApplicationHandler, error) {
 	dispatcher := &mockups.MockDispatcher{}
 
 	return &ApplicationHandler{

internal/api/interfaces.go

@@ -1,3 +1,4 @@
+// Package api provides definitions and functionality related to the API.
 package api
 
 import (
@@ -27,7 +28,7 @@ type Database interface {
 
 // The Dispatcher interface for relaying notifications.
 type Dispatcher interface {
-	RegisterApplication(id uint, name, token, user string) (string, error)
+	RegisterApplication(id uint, name, user string) (string, error)
 	DeregisterApplication(a *model.Application, u *model.User) error
 	UpdateApplication(a *model.Application, behavior *configuration.RepairBehavior) error
 }

internal/api/middleware.go

@@ -4,18 +4,20 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-type idInURI struct {
+// IDInURI is used to retrieve an ID from a context.
+type IDInURI struct {
 	ID uint `uri:"id" binding:"required"`
 }
 
-type messageIdInURI struct {
+// messageIDInURI is used to retrieve an message ID from a context.
+type messageIDInURI struct {
 	MessageID string `uri:"messageid" binding:"required"`
 }
 
 // RequireIDInURI returns a Gin middleware which requires an ID to be supplied in the URI of the request.
 func RequireIDInURI() gin.HandlerFunc {
 	return func(ctx *gin.Context) {
-		var requestModel idInURI
+		var requestModel IDInURI
 
 		if err := ctx.BindUri(&requestModel); err != nil {
 			return
@@ -28,7 +30,7 @@ func RequireIDInURI() gin.HandlerFunc {
 // RequireMessageIDInURI returns a Gin middleware which requires an messageID to be supplied in the URI of the request.
 func RequireMessageIDInURI() gin.HandlerFunc {
 	return func(ctx *gin.Context) {
-		var requestModel messageIdInURI
+		var requestModel messageIDInURI
 
 		if err := ctx.BindUri(&requestModel); err != nil {
 			return

internal/api/notification.go

@@ -59,7 +59,7 @@ func (h *NotificationHandler) CreateNotification(ctx *gin.Context) {
 	}
 
 	notification.ID = messageID
-	notification.UrlEncodedID = url.QueryEscape(messageID)
+	notification.URLEncodedID = url.QueryEscape(messageID)
 
 	ctx.JSON(http.StatusOK, &notification)
 }

internal/api/util.go

@@ -10,6 +10,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
+// SuccessOrAbort is a convenience function to write a HTTP status code based on a given error.
 func SuccessOrAbort(ctx *gin.Context, code int, err error) bool {
 	if err != nil {
 		// If we know the error force error code
@@ -24,13 +25,13 @@ func SuccessOrAbort(ctx *gin.Context, code int, err error) bool {
 	return err == nil
 }
 
-func isCurrentUser(ctx *gin.Context, ID uint) bool {
+func isCurrentUser(ctx *gin.Context, id uint) bool {
 	user := authentication.GetUser(ctx)
 	if user == nil {
 		return false
 	}
 
-	if user.ID != ID {
+	if user.ID != id {
 		ctx.AbortWithError(http.StatusForbidden, errors.New("only owner can delete application"))
 		return false
 	}

internal/assert/assert.go

@@ -1,3 +1,4 @@
+// Package assert provides convenience function to make assertions at runtime.
 package assert
 
 import (

internal/authentication/authentication.go

@@ -1,3 +1,4 @@
+// Package authentication provides definitions and functionality related to user authentication.
 package authentication
 
 import (

internal/authentication/credentials/credentials.go

@@ -1,3 +1,4 @@
+// Package credentials provides definitions and functionality related to credential management.
 package credentials
 
 import (

internal/authentication/token_test.go

@@ -11,7 +11,7 @@ const (
 	minRandomChars = 14
 )
 
-func isGoodToken(assert *assert.Assertions, require *require.Assertions, token string, compat bool) {
+func isGoodToken(assert *assert.Assertions, _ *require.Assertions, token string, compat bool) {
 	tokenLength := len(token)
 
 	if compat {

internal/configuration/configuration.go

@@ -1,3 +1,4 @@
+// Package configuration provides definitions and functionality related to the configuration.
 package configuration
 
 import (

internal/database/application.go

@@ -25,16 +25,16 @@ func (d *Database) UpdateApplication(application *model.Application) error {
 }
 
 // GetApplicationByID returns the application with the given ID or nil.
-func (d *Database) GetApplicationByID(ID uint) (*model.Application, error) {
+func (d *Database) GetApplicationByID(id uint) (*model.Application, error) {
 	var application model.Application
 
-	err := d.gormdb.First(&application, ID).Error
+	err := d.gormdb.First(&application, id).Error
 
 	if errors.Is(err, gorm.ErrRecordNotFound) {
 		return nil, err
 	}
 
-	assert.Assert(application.ID == ID)
+	assert.Assert(application.ID == id)
 
 	return &application, err
 }

internal/database/database.go

@@ -1,3 +1,4 @@
+// Package database provides definitions and functionality related to the database.
 package database
 
 import (

internal/database/user.go

@@ -34,16 +34,16 @@ func (d *Database) UpdateUser(user *model.User) error {
 }
 
 // GetUserByID returns the user with the given ID or nil.
-func (d *Database) GetUserByID(ID uint) (*model.User, error) {
+func (d *Database) GetUserByID(id uint) (*model.User, error) {
 	var user model.User
 
-	err := d.gormdb.First(&user, ID).Error
+	err := d.gormdb.First(&user, id).Error
 
 	if errors.Is(err, gorm.ErrRecordNotFound) {
 		return nil, err
 	}
 
-	assert.Assert(user.ID == ID)
+	assert.Assert(user.ID == id)
 
 	return &user, err
 }

internal/dispatcher/application.go

@@ -17,7 +17,7 @@ func buildRoomTopic(id uint) string {
 }
 
 // RegisterApplication creates a channel for an application.
-func (d *Dispatcher) RegisterApplication(id uint, name, token, user string) (string, error) {
+func (d *Dispatcher) RegisterApplication(id uint, name, user string) (string, error) {
 	log.L.Printf("Registering application %s, notifications will be relayed to user %s.\n", name, user)
 
 	resp, err := d.mautrixClient.CreateRoom(&mautrix.ReqCreateRoom{

internal/dispatcher/dispatcher.go

@@ -1,3 +1,4 @@
+// Package dispatcher provides definitions and functionality related to executing Matrix requests.
 package dispatcher
 
 import (

internal/dispatcher/notification.go

@@ -52,8 +52,8 @@ type NewContent struct {
 	Format        MessageFormat `json:"format"`
 }
 
-// SendNotification sends a notification to the specified user.
+// SendNotification sends a notification to a given user.
-func (d *Dispatcher) SendNotification(a *model.Application, n *model.Notification) (eventId string, err error) {
+func (d *Dispatcher) SendNotification(a *model.Application, n *model.Notification) (eventID string, err error) {
 	log.L.Printf("Sending notification to room %s.", a.MatrixID)
 
 	plainMessage := strings.TrimSpace(n.Message)
@@ -80,7 +80,7 @@ func (d *Dispatcher) SendNotification(a *model.Application, n *model.Notificatio
 	return evt.EventID.String(), nil
 }
 
-// DeleteNotification sends a notification to the specified user that another notificaion is deleted
+// DeleteNotification sends a notification to a given user that another notification is deleted
 func (d *Dispatcher) DeleteNotification(a *model.Application, n *model.DeleteNotification) error {
 	log.L.Printf("Sending delete notification to room %s", a.MatrixID)
 	var oldFormattedBody string
@@ -128,7 +128,7 @@ func (d *Dispatcher) getFormattedTitle(n *model.Notification) string {
 // Converts different syntaxes to a HTML-formatted message
 func (d *Dispatcher) getFormattedMessage(n *model.Notification) string {
 	trimmedMessage := strings.TrimSpace(n.Message)
-	message := strings.Replace(html.EscapeString(trimmedMessage), "\n", "<br />", -1) // default to text/plain
+	message := strings.ReplaceAll(html.EscapeString(trimmedMessage), "\n", "<br />") // default to text/plain
 
 	if optionsDisplayRaw, ok := n.Extras["client::display"]; ok {
 		optionsDisplay, ok := optionsDisplayRaw.(map[string]interface{})
@@ -140,7 +140,7 @@ func (d *Dispatcher) getFormattedMessage(n *model.Notification) string {
 
 				switch contentType {
 				case "html", "text/html":
-					message = strings.Replace(trimmedMessage, "\n", "<br />", -1)
+					message = strings.ReplaceAll(trimmedMessage, "\n", "<br />")
 				case "markdown", "md", "text/md", "text/markdown":
 					// Allow HTML in Markdown
 					message = string(markdown.ToHTML([]byte(trimmedMessage), nil, nil))

internal/log/ginlogrus.go

@@ -1,5 +1,6 @@
 // Source: https://github.com/toorop/gin-logrus
 
+// Package log provides a connector between gin and logrus.
 package log
 
 import (

internal/log/log.go

@@ -1,3 +1,4 @@
+// Package log provides functionality to configure the logger.
 package log
 
 import (
@@ -6,6 +7,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
+// L is the global logger instance for PushBits.
 var L *log.Logger
 
 func init() {
@@ -17,6 +19,7 @@ func init() {
 	})
 }
 
+// SetDebug sets the logger to output debug information.
 func SetDebug() {
 	L.SetLevel(log.DebugLevel)
 }

internal/model/alertmanager.go

@@ -2,6 +2,7 @@ package model
 
 import "strings"
 
+// AlertmanagerWebhook is used to pass notifications over webhook pushes.
 type AlertmanagerWebhook struct {
 	Version           string              `json:"version"`
 	GroupKey          string              `json:"groupKey"`
@@ -13,6 +14,7 @@ type AlertmanagerWebhook struct {
 	Alerts            []AlertmanagerAlert `json:"alerts"`
 }
 
+// AlertmanagerAlert holds information related to a single alert in a notification.
 type AlertmanagerAlert struct {
 	Labels      map[string]string `json:"labels"`
 	Annotations map[string]string `json:"annotations"`
@@ -21,6 +23,7 @@ type AlertmanagerAlert struct {
 	Status      string            `json:"status"`
 }
 
+// ToNotification converts an Alertmanager alert into a Notification
 func (alert *AlertmanagerAlert) ToNotification(titleAnnotation, messageAnnotation string) Notification {
 	title := strings.Builder{}
 	message := strings.Builder{}

internal/model/notification.go

@@ -1,3 +1,4 @@
+// Package model contains structs used in the PushBits API and across the application.
 package model
 
 import (
@@ -8,7 +9,7 @@ import (
 // Notification holds information like the message, the title, and the priority of a notification.
 type Notification struct {
 	ID            string                 `json:"id"`
-	UrlEncodedID  string                 `json:"id_url_encoded"`
+	URLEncodedID  string                 `json:"id_url_encoded"`
 	ApplicationID uint                   `json:"appid"`
 	Message       string                 `json:"message" form:"message" query:"message" binding:"required"`
 	Title         string                 `json:"title" form:"title" query:"title"`
@@ -20,7 +21,7 @@ type Notification struct {
 // Sanitize sets explicit defaults for a notification.
 func (n *Notification) Sanitize(application *Application) {
 	n.ID = ""
-	n.UrlEncodedID = ""
+	n.URLEncodedID = ""
 	n.ApplicationID = application.ID
 	if strings.TrimSpace(n.Title) == "" {
 		n.Title = application.Name

internal/pberrors/errors.go

@@ -1,3 +1,4 @@
+// Package pberrors defines errors specific to PushBits
 package pberrors
 
 import "errors"

internal/router/router.go

@@ -1,3 +1,4 @@
+// Package router provides functions to configure the web server.
 package router
 
 import (
@@ -28,7 +29,7 @@ func Create(debug bool, trustedProxies []string, cm *credentials.Manager, db *da
 	healthHandler := api.HealthHandler{DB: db}
 	notificationHandler := api.NotificationHandler{DB: db, DP: dp}
 	userHandler := api.UserHandler{AH: &applicationHandler, CM: cm, DB: db, DP: dp}
-	alertmanagerHandler := alertmanager.AlertmanagerHandler{DP: dp, Settings: alertmanager.AlertmanagerHandlerSettings{
+	alertmanagerHandler := alertmanager.Handler{DP: dp, Settings: alertmanager.HandlerSettings{
 		TitleAnnotation:   alertmanagerConfig.AnnotationTitle,
 		MessageAnnotation: alertmanagerConfig.AnnotationMessage,
 	}}

internal/runner/runner.go

@@ -1,3 +1,4 @@
+// Package runner provides functions to run the web server.
 package runner
 
 import (

tests/mockups/application.go

@@ -1,3 +1,4 @@
+// Package mockups contains mockup objects and functions for tests.
 package mockups
 
 import "github.com/pushbits/server/internal/model"

tests/mockups/dispatcher.go

@@ -10,22 +10,27 @@ import (
 // MockDispatcher is a dispatcher used for testing - it does not need any storage interface
 type MockDispatcher struct{}
 
-func (d *MockDispatcher) RegisterApplication(id uint, name, token, user string) (string, error) {
+// RegisterApplication mocks a functions to create a channel for an application.
+func (*MockDispatcher) RegisterApplication(id uint, name, _ string) (string, error) {
 	return fmt.Sprintf("%d-%s", id, name), nil
 }
 
-func (d *MockDispatcher) DeregisterApplication(a *model.Application, u *model.User) error {
+// DeregisterApplication mocks a function to delete a channel for an application.
+func (*MockDispatcher) DeregisterApplication(_ *model.Application, _ *model.User) error {
 	return nil
 }
 
-func (d *MockDispatcher) UpdateApplication(a *model.Application, behavior *configuration.RepairBehavior) error {
+// UpdateApplication mocks a function to update a channel for an application.
+func (*MockDispatcher) UpdateApplication(_ *model.Application, _ *configuration.RepairBehavior) error {
 	return nil
 }
 
-func (d *MockDispatcher) SendNotification(a *model.Application, n *model.Notification) (id string, err error) {
+// SendNotification mocks a function to send a notification to a given user.
+func (*MockDispatcher) SendNotification(_ *model.Application, _ *model.Notification) (id string, err error) {
 	return randStr(15), nil
 }
 
-func (d *MockDispatcher) DeleteNotification(a *model.Application, n *model.DeleteNotification) error {
+// DeleteNotification mocks a function to send a notification to a given user that another notification is deleted
+func (*MockDispatcher) DeleteNotification(_ *model.Application, _ *model.DeleteNotification) error {
 	return nil
 }

tests/request.go

@@ -1,3 +1,4 @@
+// Package tests provides definitions and functionality related to unit and integration tests.
 package tests
 
 import (
@@ -23,14 +24,14 @@ type Request struct {
 // GetRequest returns a ResponseRecorder and gin context according to the data set in the Request.
 // String data is passed as is, all other data types are marshaled before.
 func (r *Request) GetRequest() (w *httptest.ResponseRecorder, c *gin.Context, err error) {
-	var body io.Reader
 	w = httptest.NewRecorder()
+	var body io.Reader
 
-	switch r.Data.(type) {
+	switch data := r.Data.(type) {
 	case string:
-		body = strings.NewReader(r.Data.(string))
+		body = strings.NewReader(data)
 	default:
-		dataMarshaled, err := json.Marshal(r.Data)
+		dataMarshaled, err := json.Marshal(data)
 		if err != nil {
 			return nil, nil, err
 		}