Merge pull request #1 from xperimental/master

Catch up with upstream
This commit is contained in:
Thomas Renger 2021-01-13 17:22:23 +01:00 committed by GitHub
commit 71df28f7cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 144 additions and 4 deletions

31
.github/workflows/pull-request.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: Pull-Request
on:
pull_request:
branches: [ master ]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Set up Go 1.x
uses: actions/setup-go@v2
with:
go-version: ^1.15
id: go
- name: Check out code into the Go module directory
uses: actions/checkout@v2
- name: Get dependencies
run: |
go get -v -t -d ./...
- name: Build
run: go build -v .
- name: Test
run: go test -cover ./...

1
go.mod
View File

@ -4,6 +4,7 @@ go 1.14
require ( require (
github.com/exzz/netatmo-api-go v0.0.0-20171026152754-41589231f446 github.com/exzz/netatmo-api-go v0.0.0-20171026152754-41589231f446
github.com/google/go-cmp v0.4.0
github.com/prometheus/client_golang v1.7.1 github.com/prometheus/client_golang v1.7.1
github.com/sirupsen/logrus v1.6.0 github.com/sirupsen/logrus v1.6.0
github.com/spf13/pflag v1.0.5 github.com/spf13/pflag v1.0.5

View File

@ -112,12 +112,15 @@ var (
nil) nil)
) )
// ReadFunction defines the interface for reading from the Netatmo API.
type ReadFunction func() (*netatmo.DeviceCollection, error)
// NetatmoCollector is a Prometheus collector for Netatmo sensor values. // NetatmoCollector is a Prometheus collector for Netatmo sensor values.
type NetatmoCollector struct { type NetatmoCollector struct {
Log logrus.FieldLogger Log logrus.FieldLogger
RefreshInterval time.Duration RefreshInterval time.Duration
StaleThreshold time.Duration StaleThreshold time.Duration
Client *netatmo.Client ReadFunction ReadFunction
lastRefresh time.Time lastRefresh time.Time
lastRefreshError error lastRefreshError error
lastRefreshDuration time.Duration lastRefreshDuration time.Duration
@ -175,10 +178,10 @@ func (c *NetatmoCollector) RefreshData(now time.Time) {
c.lastRefreshDuration = time.Since(start) c.lastRefreshDuration = time.Since(start)
}(time.Now()) }(time.Now())
devices, err := c.Client.Read() devices, err := c.ReadFunction()
c.lastRefreshError = err
if err != nil { if err != nil {
c.Log.Errorf("Error during refresh: %s", err) c.Log.Errorf("Error during refresh: %s", err)
c.lastRefreshError = err
return return
} }

View File

@ -0,0 +1,105 @@
package collector
import (
"errors"
"testing"
"time"
netatmo "github.com/exzz/netatmo-api-go"
"github.com/google/go-cmp/cmp"
"github.com/sirupsen/logrus"
)
func TestRefreshData(t *testing.T) {
testData := &netatmo.DeviceCollection{}
testError := errors.New("test error")
tt := []struct {
desc string
time time.Time
readFunction ReadFunction
wantTime time.Time
wantData *netatmo.DeviceCollection
wantError error
}{
{
desc: "success",
time: time.Unix(0, 0),
readFunction: func() (*netatmo.DeviceCollection, error) {
return testData, nil
},
wantTime: time.Unix(0, 0),
wantData: testData,
wantError: nil,
},
{
desc: "error",
time: time.Unix(0, 0),
readFunction: func() (*netatmo.DeviceCollection, error) {
return nil, testError
},
wantTime: time.Time{},
wantData: nil,
wantError: testError,
},
}
for _, tc := range tt {
tc := tc
t.Run(tc.desc, func(t *testing.T) {
t.Parallel()
c := &NetatmoCollector{
Log: logrus.New(),
ReadFunction: tc.readFunction,
}
c.RefreshData(tc.time)
if c.cacheTimestamp != tc.wantTime {
t.Errorf("got time %s, want %s", c.cacheTimestamp, tc.wantTime)
}
if diff := cmp.Diff(c.cachedData, tc.wantData); diff != "" {
t.Errorf("data differs: -got+want\n%s", diff)
}
if c.lastRefreshError != tc.wantError {
t.Errorf("got error %q, want %q", c.lastRefreshError, tc.wantError)
}
})
}
}
func TestRefreshDataResetError(t *testing.T) {
testData := &netatmo.DeviceCollection{}
testError := errors.New("test error")
successFunc := func() (*netatmo.DeviceCollection, error) {
return testData, nil
}
errorFunc := func() (*netatmo.DeviceCollection, error) {
return nil, testError
}
c := &NetatmoCollector{
Log: logrus.New(),
ReadFunction: successFunc,
}
c.RefreshData(time.Unix(0, 0))
if c.lastRefreshError != nil {
t.Errorf("got error %q, want none", c.lastRefreshError)
}
c.ReadFunction = errorFunc
c.RefreshData(time.Unix(1, 0))
if c.lastRefreshError != testError {
t.Errorf("got error %q, want %q", c.lastRefreshError, testError)
}
c.ReadFunction = successFunc
c.RefreshData(time.Unix(0, 0))
if c.lastRefreshError != nil {
t.Errorf("got error %q, want none", c.lastRefreshError)
}
}

View File

@ -40,7 +40,7 @@ func main() {
metrics := &collector.NetatmoCollector{ metrics := &collector.NetatmoCollector{
Log: log, Log: log,
Client: client, ReadFunction: client.Read,
RefreshInterval: cfg.RefreshInterval, RefreshInterval: cfg.RefreshInterval,
StaleThreshold: cfg.StaleDuration, StaleThreshold: cfg.StaleDuration,
} }