chore: add tests

Author: ebuildy

go.mod

@@ -3,7 +3,6 @@ module github.com/ebuildy/mattermost-plugin-minotor
 go 1.23.3
 
 require (
-	github.com/gorilla/mux v1.8.1
 	github.com/jarcoal/httpmock v1.3.1
 	github.com/mattermost/mattermost/server/public v0.1.5
 	github.com/pkg/errors v0.9.1
@@ -48,6 +47,7 @@ require (
 	github.com/prometheus/common v0.55.0 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
 	github.com/tinylib/msgp v1.2.0 // indirect
 	github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
 	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect

go.sum

@@ -68,8 +68,6 @@ github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 github.com/googleapis/gax-go v2.0.0+incompatible/go.mod h1:SFVmujtThgffbyetf+mdk2eWhX2bMyUtNHzFKcPA9HY=
 github.com/googleapis/gax-go/v2 v2.0.3/go.mod h1:LLvjysVCY1JZeum8Z6l8qUty8fiNwE08qbEPm1M08qg=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
-github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
-github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
 github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA=

server/internal/adapters/collector/mattermost/collector.go

@@ -7,6 +7,7 @@ import (
 	"github.com/ebuildy/mattermost-plugin-minotor/server/internal/core/ports"
 )
 
+// Collector is responsible for collecting various metrics and aggregating data from different sources.
 type Collector struct {
 	logger  ports.Logger
 	gateway *mattermost_gateway.Client

server/internal/adapters/collector/mattermost/health_collector.go

@@ -7,6 +7,9 @@ import (
 	"github.com/mattermost/mattermost/server/public/model"
 )
 
+// collectHealth gathers system health metrics including overall status, database, and filestore health.
+// It interacts with the Mattermost API to fetch ping information with full status options.
+// Returns a MetricsDataHealth object containing boolean values for each health status.
 func (c *Collector) collectHealth(ctx context.Context) *domain.MetricsDataHealth {
 	pingResp, _, err := c.gateway.API.GetPingWithOptions(ctx, model.SystemPingOptions{FullStatus: true})
 	if err != nil {

server/internal/adapters/collector/mattermost/info_collector.go

@@ -4,17 +4,24 @@ import (
 	"github.com/ebuildy/mattermost-plugin-minotor/server/internal/core/domain"
 )
 
+// collectInfo gathers and returns core system information such as server version, edition, installation time, and SQL driver name.
 func (c *Collector) collectInfo() *domain.MetricsDataInfo {
 	apiSystem := c.gateway.PluginAPI.System
 	apiConfiguration := c.gateway.PluginAPI.Configuration
 
 	installationTime, _ := apiSystem.GetSystemInstallDate()
 
+	SQLDriverName := ""
+
+	if apiConfiguration.GetConfig() != nil {
+		SQLDriverName = *apiConfiguration.GetConfig().SqlSettings.DriverName
+	}
+
 	return &domain.MetricsDataInfo{
 		MattermostVersion:          apiSystem.GetServerVersion(),
 		MattermostEdition:          c.getInfoEdition(),
 		MattermostInstallationTime: installationTime,
-		SQLDriverName:              *apiConfiguration.GetConfig().SqlSettings.DriverName,
+		SQLDriverName:              SQLDriverName,
 	}
 }
 

server/internal/adapters/collector/mattermost/info_collector_test.go

@@ -0,0 +1,101 @@
+package mattermost
+
+import (
+	"github.com/ebuildy/mattermost-plugin-minotor/server/internal/adapters/logger/fake"
+	"github.com/ebuildy/mattermost-plugin-minotor/server/internal/adapters/services/mattermost_gateway"
+	"github.com/ebuildy/mattermost-plugin-minotor/server/internal/core/domain"
+	"github.com/ebuildy/mattermost-plugin-minotor/server/internal/utils"
+	"github.com/jarcoal/httpmock"
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/plugin/plugintest"
+	"github.com/mattermost/mattermost/server/public/pluginapi"
+	"github.com/stretchr/testify/assert"
+	"testing"
+	"time"
+)
+
+func TestDriver_collectInfo(t *testing.T) {
+	httpmock.Activate()
+
+	tests := []struct {
+		name      string
+		want      domain.MetricsDataInfo
+		setupMock func(api *plugintest.API)
+	}{
+		{
+			name: "all is good",
+			want: domain.MetricsDataInfo{
+				MattermostVersion:          "10.0",
+				MattermostEdition:          "free",
+				MattermostInstallationTime: time.Unix(1638224000, 0),
+				SQLDriverName:              "mysql",
+			},
+			setupMock: func(api *plugintest.API) {
+				api.On("GetConfig").Return(&model.Config{
+					SqlSettings: model.SqlSettings{
+						DriverName: utils.SafeRef("mysql"),
+					},
+				}, nil)
+				api.On("GetSystemInstallDate").Return(int64(1638224000*1000), nil)
+				api.On("GetServerVersion").Return("10.0", nil)
+				api.On("GetLicense").Return(nil, nil)
+			},
+		},
+		{
+			name: "entreprise",
+			want: domain.MetricsDataInfo{
+				MattermostVersion:          "10.0",
+				MattermostEdition:          "entreprise",
+				MattermostInstallationTime: time.Unix(1638224000, 0),
+				SQLDriverName:              "postgres",
+			},
+			setupMock: func(api *plugintest.API) {
+				api.On("GetConfig").Return(&model.Config{
+					SqlSettings: model.SqlSettings{
+						DriverName: utils.SafeRef("postgres"),
+					},
+				}, nil)
+				api.On("GetSystemInstallDate").Return(int64(1638224000*1000), nil)
+				api.On("GetServerVersion").Return("10.0", nil)
+				api.On("GetLicense").Return(&model.License{}, nil)
+			},
+		},
+		{
+			name: "API send a 500 error",
+			want: domain.MetricsDataInfo{
+				MattermostVersion:          "",
+				MattermostEdition:          "free",
+				MattermostInstallationTime: time.Unix(0, 0),
+				SQLDriverName:              "",
+			},
+			setupMock: func(api *plugintest.API) {
+				api.On("GetServerVersion").Return("", nil)
+				api.On("GetSystemInstallDate").Return(int64(0), nil)
+				api.On("GetConfig").Return(nil, nil)
+				api.On("GetLicense").Return(nil, nil)
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		api := plugintest.NewAPI(t)
+
+		mattermostGatewayClient := &mattermost_gateway.Client{
+			API:       model.NewAPIv4Client(mattermostEndpointURL),
+			PluginAPI: pluginapi.NewClient(api, &plugintest.Driver{}),
+		}
+
+		c := NewCollector(fake.NewFakeLogger(), mattermostGatewayClient)
+
+		tt.setupMock(api)
+
+		t.Run(tt.name, func(t *testing.T) {
+			metrics := c.collectInfo()
+
+			assert.Equal(t, tt.want.MattermostInstallationTime, metrics.MattermostInstallationTime)
+			assert.Equal(t, tt.want.MattermostVersion, metrics.MattermostVersion)
+			assert.Equal(t, tt.want.MattermostEdition, metrics.MattermostEdition)
+			assert.Equal(t, tt.want.SQLDriverName, metrics.SQLDriverName)
+		})
+	}
+}

server/internal/adapters/collector/mattermost/job_collector.go

@@ -5,6 +5,7 @@ import (
 	"time"
 )
 
+// collectJob retrieves job data from the database, including job counts grouped by type and status, and returns metric data.
 func (c *Collector) collectJob() *domain.MetricsDataJobs {
 	var countByTypesStatus []domain.JobCountByStatusType
 

server/internal/adapters/collector/mattermost_api.go

@@ -0,0 +1,13 @@
+package utils
+
+func SafeDeref[T any](p *T) T {
+	if p == nil {
+		var v T
+		return v
+	}
+	return *p
+}
+
+func SafeRef[T any](p T) *T {
+	return &p
+}