Skip to content

Commit

Permalink
Add test for collector
Browse files Browse the repository at this point in the history
  • Loading branch information
@arunvelsriram
arunvelsriram committed Aug 14, 2020
1 parent f8cd072 commit 8b595a5
Show file tree
Hide file tree
Showing 2 changed files with 232 additions and 9 deletions.
1 change: 1 addition & 0 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ require (
github.com/golang/mock v1.4.3
github.com/pkg/sftp v1.11.0
github.com/prometheus/client_golang v0.9.3
github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90
github.com/sirupsen/logrus v1.2.0
github.com/spf13/afero v1.1.2
github.com/spf13/cobra v1.0.0
Expand Down
240 changes: 231 additions & 9 deletions pkg/collector/sftp_collector_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
package collector

import (
"fmt"
"github.com/arunvelsriram/sftp-exporter/pkg/model"
"testing"

"github.com/arunvelsriram/sftp-exporter/pkg/client"
"github.com/arunvelsriram/sftp-exporter/pkg/config"
"github.com/arunvelsriram/sftp-exporter/pkg/internal/mocks"
"github.com/golang/mock/gomock"
"github.com/prometheus/client_golang/prometheus"
dto "github.com/prometheus/client_model/go"
"github.com/stretchr/testify/suite"
)

type SFTPCollectorSuite struct {
suite.Suite
ctrl *gomock.Controller
config config.Config
sftpClient client.SFTPClient
sftpClient *mocks.MockSFTPClient
createClientFn CreateClientFn
collector prometheus.Collector
}
Expand Down Expand Up @@ -44,32 +47,251 @@ func (s *SFTPCollectorSuite) TestSFTPCollectorDescribe() {
go s.collector.Describe(ch)

up := <-ch
s.Equal(
`Desc{fqName: "sftp_up", help: "Tells if exporter is able to connect to SFTP", constLabels: {}, variableLabels: []}`,
s.Equal(`Desc{fqName: "sftp_up", help: "Tells if exporter is able to connect to SFTP", `+
`constLabels: {}, variableLabels: []}`,
up.String(),
)

fsTotalSpace := <-ch
s.Equal(
`Desc{fqName: "sftp_filesystem_total_space_bytes", help: "Total space in the filesystem containing the path", constLabels: {}, variableLabels: [path]}`,
s.Equal(`Desc{fqName: "sftp_filesystem_total_space_bytes", `+
`help: "Total space in the filesystem containing the path", constLabels: {}, variableLabels: [path]}`,
fsTotalSpace.String(),
)

fsFreeSpace := <-ch
s.Equal(
`Desc{fqName: "sftp_filesystem_free_space_bytes", help: "Free space in the filesystem containing the path", constLabels: {}, variableLabels: [path]}`,
s.Equal(`Desc{fqName: "sftp_filesystem_free_space_bytes", `+
`help: "Free space in the filesystem containing the path", constLabels: {}, variableLabels: [path]}`,
fsFreeSpace.String(),
)

objectCount := <-ch
s.Equal(
`Desc{fqName: "sftp_objects_count_total", help: "Total number of objects in the path", constLabels: {}, variableLabels: [path]}`,
`Desc{fqName: "sftp_objects_count_total", `+
`help: "Total number of objects in the path", constLabels: {}, variableLabels: [path]}`,
objectCount.String(),
)

objectSize := <-ch
s.Equal(
`Desc{fqName: "sftp_objects_size_total_bytes", help: "Total size of all objects in the path", constLabels: {}, variableLabels: [path]}`,
`Desc{fqName: "sftp_objects_size_total_bytes", `+
`help: "Total size of all objects in the path", constLabels: {}, variableLabels: [path]}`,
objectSize.String(),
)
}

func (s *SFTPCollectorSuite) TestSFTPCollectorCollectShouldWriteUpMetric() {
s.sftpClient.EXPECT().Close()
s.sftpClient.EXPECT().FSStats()
s.sftpClient.EXPECT().ObjectStats()
ch := make(chan prometheus.Metric)
done := make(chan bool)

go func() {
s.collector.Collect(ch)
done <- true
}()

up := <-ch
metric := dto.Metric{}
desc := up.Desc()
_ = up.Write(&metric)
s.Equal(`Desc{fqName: "sftp_up", help: "Tells if exporter is able to connect to SFTP", `+
`constLabels: {}, variableLabels: []}`, desc.String())
s.Equal(1.0, metric.GetGauge().GetValue())

<-done
}

func (s *SFTPCollectorSuite) TestSFTPCollectorCollectShouldWriteUpMetricAndReturnIfClientCreationFails() {
s.createClientFn = func(c config.Config) (client.SFTPClient, error) {
return nil, fmt.Errorf("failed to create sftp client")
}
s.collector = NewSFTPCollector(s.config, s.createClientFn)
ch := make(chan prometheus.Metric)
done := make(chan bool)

go func() {
s.collector.Collect(ch)
done <- true
}()

up := <-ch
metric := dto.Metric{}
desc := up.Desc()
_ = up.Write(&metric)
s.Equal(`Desc{fqName: "sftp_up", help: "Tells if exporter is able to connect to SFTP", `+
`constLabels: {}, variableLabels: []}`, desc.String())
s.Equal(0.0, metric.GetGauge().GetValue())

<-done
}

func (s *SFTPCollectorSuite) TestSFTPCollectorCollectShouldWriteFSStats() {
fsStats := model.FSStats([]model.FSStat{
{
Path: "/path1",
TotalSpace: 1111.11,
FreeSpace: 2222.22,
},
{
Path: "/path2",
TotalSpace: 3333.33,
FreeSpace: 4444.44,
},
})
s.sftpClient.EXPECT().FSStats().Return(fsStats, nil)
s.sftpClient.EXPECT().ObjectStats()
s.sftpClient.EXPECT().Close()
ch := make(chan prometheus.Metric)
done := make(chan bool)

go func() {
s.collector.Collect(ch)
done <- true
}()

<-ch
metric := &dto.Metric{}
var desc *prometheus.Desc

totalSpace1 := <-ch
desc = totalSpace1.Desc()
_ = totalSpace1.Write(metric)
s.Equal(`Desc{fqName: "sftp_filesystem_total_space_bytes", help: "Total space in the filesystem containing the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(1111.11, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path1", metric.GetLabel()[0].GetValue())

freeSpace1 := <-ch
desc = freeSpace1.Desc()
_ = freeSpace1.Write(metric)
s.Equal(`Desc{fqName: "sftp_filesystem_free_space_bytes", help: "Free space in the filesystem containing the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(2222.22, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path1", metric.GetLabel()[0].GetValue())

totalSpace2 := <-ch
desc = totalSpace2.Desc()
_ = totalSpace2.Write(metric)
s.Equal(`Desc{fqName: "sftp_filesystem_total_space_bytes", help: "Total space in the filesystem containing the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(3333.33, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path2", metric.GetLabel()[0].GetValue())

freeSpace2 := <-ch
desc = freeSpace2.Desc()
_ = freeSpace2.Write(metric)
s.Equal(`Desc{fqName: "sftp_filesystem_free_space_bytes", help: "Free space in the filesystem containing the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(4444.44, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path2", metric.GetLabel()[0].GetValue())

<-done
}

func (s *SFTPCollectorSuite) TestSFTPCollectorCollectShouldNotWriteFSStatsIfGettingFSStatsFails() {
s.sftpClient.EXPECT().FSStats().Return(nil, fmt.Errorf("failed to get FS stats"))
s.sftpClient.EXPECT().ObjectStats()
s.sftpClient.EXPECT().Close()
ch := make(chan prometheus.Metric)
done := make(chan bool)

go func() {
s.collector.Collect(ch)
done <- true
}()

<-ch
close(ch)

<-done
}

func (s *SFTPCollectorSuite) TestSFTPCollectorCollectShouldWriteObjectStats() {
objectStats := model.ObjectStats([]model.ObjectStat{
{
Path: "/path1",
ObjectCount: 100,
ObjectSize: 1111.11,
},
{
Path: "/path2",
ObjectCount: 200,
ObjectSize: 2222.22,
},
})
s.sftpClient.EXPECT().FSStats()
s.sftpClient.EXPECT().ObjectStats().Return(objectStats, nil)
s.sftpClient.EXPECT().Close()
ch := make(chan prometheus.Metric)
done := make(chan bool)

go func() {
s.collector.Collect(ch)
done <- true
}()

<-ch
metric := &dto.Metric{}
var desc *prometheus.Desc

objectCount1 := <-ch
desc = objectCount1.Desc()
_ = objectCount1.Write(metric)
s.Equal(`Desc{fqName: "sftp_objects_count_total", help: "Total number of objects in the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(100.0, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path1", metric.GetLabel()[0].GetValue())

objectSize1 := <-ch
desc = objectSize1.Desc()
_ = objectSize1.Write(metric)
s.Equal(`Desc{fqName: "sftp_objects_size_total_bytes", help: "Total size of all objects in the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(1111.11, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path1", metric.GetLabel()[0].GetValue())

objectCount2 := <-ch
desc = objectCount2.Desc()
_ = objectCount2.Write(metric)
s.Equal(`Desc{fqName: "sftp_objects_count_total", help: "Total number of objects in the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(200.0, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path2", metric.GetLabel()[0].GetValue())

objectSize2 := <-ch
desc = objectSize2.Desc()
_ = objectSize2.Write(metric)
s.Equal(`Desc{fqName: "sftp_objects_size_total_bytes", help: "Total size of all objects in the path", `+
`constLabels: {}, variableLabels: [path]}`, desc.String())
s.Equal(2222.22, metric.GetGauge().GetValue())
s.Equal("path", metric.GetLabel()[0].GetName())
s.Equal("/path2", metric.GetLabel()[0].GetValue())

<-done
}

func (s *SFTPCollectorSuite) TestSFTPCollectorCollectShouldNotWriteObjectStatsIfGettingObjectStatsFails() {
s.sftpClient.EXPECT().FSStats()
s.sftpClient.EXPECT().ObjectStats().Return(nil, fmt.Errorf("failed to get object stats"))
s.sftpClient.EXPECT().Close()
ch := make(chan prometheus.Metric)
done := make(chan bool)

go func() {
s.collector.Collect(ch)
done <- true
}()

<-ch
close(ch)

<-done
}

0 comments on commit 8b595a5

Please sign in to comment.