| 1 | // SPDX-License-Identifier: GPL-3.0-or-later |
| 2 | |
| 3 | package rethinkdb |
| 4 | |
| 5 | import ( |
| 6 | "bytes" |
| 7 | "context" |
| 8 | "errors" |
| 9 | "fmt" |
| 10 | "os" |
| 11 | "strings" |
| 12 | "testing" |
| 13 | |
| 14 | "github.com/netdata/netdata/go/plugins/plugin/framework/collectorapi" |
| 15 | "github.com/netdata/netdata/go/plugins/plugin/go.d/pkg/collecttest" |
| 16 | |
| 17 | "github.com/stretchr/testify/assert" |
| 18 | "github.com/stretchr/testify/require" |
| 19 | ) |
| 20 | |
| 21 | var ( |
| 22 | dataConfigJSON, _ = os.ReadFile("testdata/config.json") |
| 23 | dataConfigYAML, _ = os.ReadFile("testdata/config.yaml") |
| 24 | |
| 25 | dataStats, _ = os.ReadFile("testdata/v2.4.4/stats.txt") |
| 26 | ) |
| 27 | |
| 28 | func Test_testDataIsValid(t *testing.T) { |
| 29 | for name, data := range map[string][]byte{ |
| 30 | "dataConfigJSON": dataConfigJSON, |
| 31 | "dataConfigYAML": dataConfigYAML, |
| 32 | |
| 33 | "dataStats": dataStats, |
| 34 | } { |
| 35 | require.NotNil(t, data, name) |
| 36 | } |
| 37 | } |
| 38 | |
| 39 | func TestCollector_ConfigurationSerialize(t *testing.T) { |
| 40 | collecttest.TestConfigurationSerialize(t, &Collector{}, dataConfigJSON, dataConfigYAML) |
| 41 | } |
| 42 | |
| 43 | func TestCollector_Init(t *testing.T) { |
| 44 | tests := map[string]struct { |
| 45 | config Config |
| 46 | wantFail bool |
| 47 | }{ |
| 48 | "success with default config": { |
| 49 | wantFail: false, |
| 50 | config: New().Config, |
| 51 | }, |
| 52 | "fails if address not set": { |
| 53 | wantFail: true, |
| 54 | config: func() Config { |
| 55 | conf := New().Config |
| 56 | conf.Address = "" |
| 57 | return conf |
| 58 | }(), |
| 59 | }, |
| 60 | } |
| 61 | |
| 62 | for name, test := range tests { |
| 63 | t.Run(name, func(t *testing.T) { |
| 64 | collr := New() |
| 65 | collr.Config = test.config |
| 66 | |
| 67 | if test.wantFail { |
| 68 | assert.Error(t, collr.Init(context.Background())) |
| 69 | } else { |
| 70 | assert.NoError(t, collr.Init(context.Background())) |
| 71 | } |
| 72 | }) |
| 73 | } |
| 74 | } |
| 75 | |
| 76 | func TestCollector_Cleanup(t *testing.T) { |
| 77 | tests := map[string]struct { |
| 78 | prepare func() *Collector |
| 79 | }{ |
| 80 | "not initialized": { |
| 81 | prepare: func() *Collector { |
| 82 | return New() |
| 83 | }, |
| 84 | }, |
| 85 | "after check": { |
| 86 | prepare: func() *Collector { |
| 87 | collr := New() |
| 88 | collr.newConn = func(config Config) (rdbConn, error) { |
| 89 | return &mockRethinkdbConn{dataStats: dataStats}, nil |
| 90 | } |
| 91 | _ = collr.Check(context.Background()) |
| 92 | return collr |
| 93 | }, |
| 94 | }, |
| 95 | "after collect": { |
| 96 | prepare: func() *Collector { |
| 97 | collr := New() |
| 98 | collr.newConn = func(config Config) (rdbConn, error) { |
| 99 | return &mockRethinkdbConn{dataStats: dataStats}, nil |
| 100 | } |
| 101 | _ = collr.Check(context.Background()) |
| 102 | return collr |
| 103 | }, |
| 104 | }, |
| 105 | } |
| 106 | |
| 107 | for name, test := range tests { |
| 108 | t.Run(name, func(t *testing.T) { |
| 109 | collr := test.prepare() |
| 110 | |
| 111 | assert.NotPanics(t, func() { collr.Cleanup(context.Background()) }) |
| 112 | }) |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | func TestCollector_Check(t *testing.T) { |
| 117 | tests := map[string]struct { |
| 118 | prepare func() *Collector |
| 119 | wantFail bool |
| 120 | }{ |
| 121 | "success on valid response": { |
| 122 | wantFail: false, |
| 123 | prepare: prepareCaseOk, |
| 124 | }, |
| 125 | "fails if error on stats": { |
| 126 | wantFail: true, |
| 127 | prepare: prepareCaseErrOnStats, |
| 128 | }, |
| 129 | "fails if error on connect": { |
| 130 | wantFail: true, |
| 131 | prepare: prepareCaseErrOnConnect, |
| 132 | }, |
| 133 | } |
| 134 | |
| 135 | for name, test := range tests { |
| 136 | t.Run(name, func(t *testing.T) { |
| 137 | collr := test.prepare() |
| 138 | |
| 139 | if test.wantFail { |
| 140 | assert.Error(t, collr.Check(context.Background())) |
| 141 | } else { |
| 142 | assert.NoError(t, collr.Check(context.Background())) |
| 143 | } |
| 144 | |
| 145 | if m, ok := collr.rdb.(*mockRethinkdbConn); ok { |
| 146 | assert.False(t, m.disconnectCalled, "rdb close before cleanup") |
| 147 | collr.Cleanup(context.Background()) |
| 148 | assert.True(t, m.disconnectCalled, "rdb close after cleanup") |
| 149 | } |
| 150 | }) |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | func TestCollector_Collect(t *testing.T) { |
| 155 | tests := map[string]struct { |
| 156 | prepare func() *Collector |
| 157 | wantMetrics map[string]int64 |
| 158 | wantCharts int |
| 159 | skipChart func(chart *collectorapi.Chart, dim *collectorapi.Dim) bool |
| 160 | }{ |
| 161 | "success on valid response": { |
| 162 | prepare: prepareCaseOk, |
| 163 | wantCharts: len(clusterCharts) + len(serverChartsTmpl)*3, |
| 164 | skipChart: func(chart *collectorapi.Chart, dim *collectorapi.Dim) bool { |
| 165 | return strings.HasPrefix(chart.ID, "server_0f74c641-af5f-48d6-a005-35b8983c576a") && |
| 166 | !strings.Contains(chart.ID, "stats_request_status") |
| 167 | }, |
| 168 | wantMetrics: map[string]int64{ |
| 169 | "cluster_client_connections": 3, |
| 170 | "cluster_clients_active": 3, |
| 171 | "cluster_queries_total": 27, |
| 172 | "cluster_read_docs_total": 3, |
| 173 | "cluster_servers_stats_request_success": 2, |
| 174 | "cluster_servers_stats_request_timeout": 1, |
| 175 | "cluster_written_docs_total": 3, |
| 176 | "server_0f74c641-af5f-48d6-a005-35b8983c576a_stats_request_status_success": 0, |
| 177 | "server_0f74c641-af5f-48d6-a005-35b8983c576a_stats_request_status_timeout": 1, |
| 178 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_client_connections": 1, |
| 179 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_clients_active": 1, |
| 180 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_queries_total": 13, |
| 181 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_read_docs_total": 1, |
| 182 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_stats_request_status_success": 1, |
| 183 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_stats_request_status_timeout": 0, |
| 184 | "server_b7730db2-4303-4719-aef8-2a3c339c672b_written_docs_total": 1, |
| 185 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_client_connections": 2, |
| 186 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_clients_active": 2, |
| 187 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_queries_total": 14, |
| 188 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_read_docs_total": 2, |
| 189 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_stats_request_status_success": 1, |
| 190 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_stats_request_status_timeout": 0, |
| 191 | "server_f325e3c3-22d9-4005-b4b2-1f561d384edc_written_docs_total": 2, |
| 192 | }, |
| 193 | }, |
| 194 | "fails if error on stats": { |
| 195 | wantCharts: len(clusterCharts), |
| 196 | prepare: prepareCaseErrOnStats, |
| 197 | }, |
| 198 | "fails if error on connect": { |
| 199 | wantCharts: len(clusterCharts), |
| 200 | prepare: prepareCaseErrOnStats, |
| 201 | }, |
| 202 | } |
| 203 | |
| 204 | for name, test := range tests { |
| 205 | t.Run(name, func(t *testing.T) { |
| 206 | collr := test.prepare() |
| 207 | |
| 208 | require.NoError(t, collr.Init(context.Background())) |
| 209 | |
| 210 | mx := collr.Collect(context.Background()) |
| 211 | |
| 212 | require.Equal(t, test.wantMetrics, mx) |
| 213 | |
| 214 | assert.Equal(t, test.wantCharts, len(*collr.Charts())) |
| 215 | |
| 216 | if len(test.wantMetrics) > 0 { |
| 217 | collecttest.TestMetricsHasAllChartsDimsSkip(t, collr.Charts(), mx, test.skipChart) |
| 218 | } |
| 219 | |
| 220 | if m, ok := collr.rdb.(*mockRethinkdbConn); ok { |
| 221 | assert.False(t, m.disconnectCalled, "rdb close before cleanup") |
| 222 | collr.Cleanup(context.Background()) |
| 223 | assert.True(t, m.disconnectCalled, "rdb close after cleanup") |
| 224 | } |
| 225 | }) |
| 226 | } |
| 227 | } |
| 228 | |
| 229 | func prepareCaseOk() *Collector { |
| 230 | collr := New() |
| 231 | collr.newConn = func(cfg Config) (rdbConn, error) { |
| 232 | return &mockRethinkdbConn{dataStats: dataStats}, nil |
| 233 | } |
| 234 | return collr |
| 235 | } |
| 236 | |
| 237 | func prepareCaseErrOnStats() *Collector { |
| 238 | collr := New() |
| 239 | collr.newConn = func(cfg Config) (rdbConn, error) { |
| 240 | return &mockRethinkdbConn{errOnStats: true}, nil |
| 241 | } |
| 242 | return collr |
| 243 | } |
| 244 | |
| 245 | func prepareCaseErrOnConnect() *Collector { |
| 246 | collr := New() |
| 247 | collr.newConn = func(cfg Config) (rdbConn, error) { |
| 248 | return nil, errors.New("mock failed to connect") |
| 249 | } |
| 250 | return collr |
| 251 | } |
| 252 | |
| 253 | type mockRethinkdbConn struct { |
| 254 | dataStats []byte |
| 255 | errOnStats bool |
| 256 | disconnectCalled bool |
| 257 | } |
| 258 | |
| 259 | func (m *mockRethinkdbConn) stats() ([][]byte, error) { |
| 260 | if m.errOnStats { |
| 261 | return nil, fmt.Errorf("mock.stats() error") |
| 262 | } |
| 263 | return bytes.Split(bytes.TrimSpace(m.dataStats), []byte("\n")), nil |
| 264 | } |
| 265 | |
| 266 | func (m *mockRethinkdbConn) jobs(ctx context.Context) ([]map[string]any, error) { |
| 267 | return []map[string]any{}, nil |
| 268 | } |
| 269 | |
| 270 | func (m *mockRethinkdbConn) close() error { |
| 271 | m.disconnectCalled = true |
| 272 | return nil |
| 273 | } |