summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/ipfs/ipfs_test.go
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/go/plugin/go.d/modules/ipfs/ipfs_test.go278
1 files changed, 278 insertions, 0 deletions
diff --git a/src/go/plugin/go.d/modules/ipfs/ipfs_test.go b/src/go/plugin/go.d/modules/ipfs/ipfs_test.go
new file mode 100644
index 000000000..5e353a1bc
--- /dev/null
+++ b/src/go/plugin/go.d/modules/ipfs/ipfs_test.go
@@ -0,0 +1,278 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+package ipfs
+
+import (
+ "net/http"
+ "net/http/httptest"
+ "os"
+ "testing"
+
+ "github.com/netdata/netdata/go/plugins/plugin/go.d/agent/module"
+ "github.com/netdata/netdata/go/plugins/plugin/go.d/pkg/web"
+
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+var (
+ dataConfigJSON, _ = os.ReadFile("testdata/config.json")
+ dataConfigYAML, _ = os.ReadFile("testdata/config.yaml")
+
+ apiv0PinLsData, _ = os.ReadFile("testdata/api_v0_pin_ls.json")
+ apiv0StatsBwData, _ = os.ReadFile("testdata/api_v0_stats_bw.json")
+ apiv0StatsRepoData, _ = os.ReadFile("testdata/api_v0_stats_repo.json")
+ apiv0SwarmPeersData, _ = os.ReadFile("testdata/api_v0_swarm_peers.json")
+)
+
+func Test_testDataIsValid(t *testing.T) {
+ for name, data := range map[string][]byte{
+ "dataConfigJSON": dataConfigJSON,
+ "dataConfigYAML": dataConfigYAML,
+ "apiv0PinLsData": apiv0PinLsData,
+ "apiv0StatsBwData": apiv0StatsBwData,
+ "apiv0StatsRepoData": apiv0StatsRepoData,
+ "apiv0SwarmPeersData": apiv0SwarmPeersData,
+ } {
+ require.NotNil(t, data, name)
+ }
+}
+
+func TestIPFS_ConfigurationSerialize(t *testing.T) {
+ module.TestConfigurationSerialize(t, &IPFS{}, dataConfigJSON, dataConfigYAML)
+}
+
+func TestIPFS_Init(t *testing.T) {
+ tests := map[string]struct {
+ wantFail bool
+ config Config
+ }{
+ "success with default": {
+ wantFail: false,
+ config: New().Config,
+ },
+ "fail when URL not set": {
+ wantFail: true,
+ config: Config{
+ HTTP: web.HTTP{
+ Request: web.Request{URL: ""},
+ },
+ },
+ },
+ }
+
+ for name, test := range tests {
+ t.Run(name, func(t *testing.T) {
+ ipfs := New()
+ ipfs.Config = test.config
+
+ if test.wantFail {
+ assert.Error(t, ipfs.Init())
+ } else {
+ assert.NoError(t, ipfs.Init())
+ }
+ })
+ }
+}
+
+func TestIPFS_Charts(t *testing.T) {
+ assert.NotNil(t, New().Charts())
+}
+
+func TestIPFS_Check(t *testing.T) {
+ tests := map[string]struct {
+ wantFail bool
+ prepare func(t *testing.T) (*IPFS, func())
+ }{
+ "success default config": {
+ wantFail: false,
+ prepare: prepareCaseOkDefault,
+ },
+ "success all queries enabled": {
+ wantFail: false,
+ prepare: prepareCaseOkDefault,
+ },
+ "fails on unexpected json response": {
+ wantFail: true,
+ prepare: prepareCaseUnexpectedJsonResponse,
+ },
+ "fails on invalid format response": {
+ wantFail: true,
+ prepare: prepareCaseInvalidFormatResponse,
+ },
+ "fails on connection refused": {
+ wantFail: true,
+ prepare: prepareCaseConnectionRefused,
+ },
+ }
+
+ for name, test := range tests {
+ t.Run(name, func(t *testing.T) {
+ ipfs, cleanup := test.prepare(t)
+ defer cleanup()
+
+ if test.wantFail {
+ assert.Error(t, ipfs.Check())
+ } else {
+ assert.NoError(t, ipfs.Check())
+ }
+ })
+ }
+}
+
+func TestIPFS_Collect(t *testing.T) {
+ tests := map[string]struct {
+ prepare func(t *testing.T) (*IPFS, func())
+ wantMetrics map[string]int64
+ }{
+ "success default config": {
+ prepare: prepareCaseOkDefault,
+ wantMetrics: map[string]int64{
+ "in": 20113594,
+ "out": 3113852,
+ "peers": 6,
+ },
+ },
+ "success all queries enabled": {
+ prepare: prepareCaseOkAllQueriesEnabled,
+ wantMetrics: map[string]int64{
+ "in": 20113594,
+ "objects": 1,
+ "out": 3113852,
+ "peers": 6,
+ "pinned": 1,
+ "recursive_pins": 1,
+ "size": 25495,
+ "used_percent": 0,
+ },
+ },
+ "fails on unexpected json response": {
+ prepare: prepareCaseUnexpectedJsonResponse,
+ },
+ "fails on invalid format response": {
+ prepare: prepareCaseInvalidFormatResponse,
+ },
+ "fails on connection refused": {
+ prepare: prepareCaseConnectionRefused,
+ },
+ }
+
+ for name, test := range tests {
+ t.Run(name, func(t *testing.T) {
+ ipfs, cleanup := test.prepare(t)
+ defer cleanup()
+
+ mx := ipfs.Collect()
+
+ require.Equal(t, test.wantMetrics, mx)
+ if len(test.wantMetrics) > 0 {
+ testMetricsHasAllChartsDims(t, ipfs, mx)
+ }
+ })
+ }
+}
+
+func testMetricsHasAllChartsDims(t *testing.T, ipfs *IPFS, mx map[string]int64) {
+ for _, chart := range *ipfs.Charts() {
+ if chart.Obsolete {
+ continue
+ }
+ for _, dim := range chart.Dims {
+ _, ok := mx[dim.ID]
+ assert.Truef(t, ok, "collected metrics has no data for dim '%s' chart '%s'", dim.ID, chart.ID)
+ }
+ for _, v := range chart.Vars {
+ _, ok := mx[v.ID]
+ assert.Truef(t, ok, "collected metrics has no data for var '%s' chart '%s'", v.ID, chart.ID)
+ }
+ }
+}
+
+func prepareCaseOkDefault(t *testing.T) (*IPFS, func()) {
+ t.Helper()
+ srv := httptest.NewServer(http.HandlerFunc(
+ func(w http.ResponseWriter, r *http.Request) {
+ switch r.URL.Path {
+ case urlPathStatsBandwidth:
+ _, _ = w.Write(apiv0StatsBwData)
+ case urlPathStatsRepo:
+ _, _ = w.Write(apiv0StatsRepoData)
+ case urlPathSwarmPeers:
+ _, _ = w.Write(apiv0SwarmPeersData)
+ case urlPathPinLs:
+ _, _ = w.Write(apiv0PinLsData)
+ default:
+ w.WriteHeader(http.StatusNotFound)
+ }
+ }))
+
+ ipfs := New()
+ ipfs.URL = srv.URL
+ require.NoError(t, ipfs.Init())
+
+ return ipfs, srv.Close
+}
+
+func prepareCaseOkAllQueriesEnabled(t *testing.T) (*IPFS, func()) {
+ t.Helper()
+ ipfs, cleanup := prepareCaseOkDefault(t)
+
+ ipfs.QueryRepoApi = true
+ ipfs.QueryPinApi = true
+
+ return ipfs, cleanup
+}
+
+func prepareCaseUnexpectedJsonResponse(t *testing.T) (*IPFS, func()) {
+ t.Helper()
+ resp := `
+{
+ "elephant": {
+ "burn": false,
+ "mountain": true,
+ "fog": false,
+ "skin": -1561907625,
+ "burst": "anyway",
+ "shadow": 1558616893
+ },
+ "start": "ever",
+ "base": 2093056027,
+ "mission": -2007590351,
+ "victory": 999053756,
+ "die": false
+}
+`
+ srv := httptest.NewServer(http.HandlerFunc(
+ func(w http.ResponseWriter, r *http.Request) {
+ _, _ = w.Write([]byte(resp))
+ }))
+
+ ipfs := New()
+ ipfs.URL = srv.URL
+ require.NoError(t, ipfs.Init())
+
+ return ipfs, srv.Close
+}
+
+func prepareCaseInvalidFormatResponse(t *testing.T) (*IPFS, func()) {
+ t.Helper()
+ srv := httptest.NewServer(http.HandlerFunc(
+ func(w http.ResponseWriter, r *http.Request) {
+ _, _ = w.Write([]byte("hello and\n goodbye"))
+ }))
+
+ ipfs := New()
+ ipfs.URL = srv.URL
+ require.NoError(t, ipfs.Init())
+
+ return ipfs, srv.Close
+}
+
+func prepareCaseConnectionRefused(t *testing.T) (*IPFS, func()) {
+ t.Helper()
+ ipfs := New()
+ ipfs.URL = "http://127.0.0.1:65001"
+ require.NoError(t, ipfs.Init())
+
+ return ipfs, func() {}
+}