Follow up work on docker_log input (#6008)

2019-06-20 11:54:12 -07:00
parent 29c3d42e7e
commit a0c739eec7
10 changed files with 752 additions and 577 deletions
--- a/plugins/inputs/docker_log/docker_log_test.go
+++ b/plugins/inputs/docker_log/docker_log_test.go
@@ -0,0 +1,175 @@
+package docker_log
+
+import (
+	"bytes"
+	"context"
+	"crypto/tls"
+	"io"
+	"testing"
+	"time"
+
+	"github.com/docker/docker/api/types"
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/pkg/stdcopy"
+	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/internal"
+	"github.com/influxdata/telegraf/testutil"
+	"github.com/stretchr/testify/require"
+)
+
+type MockClient struct {
+	ContainerListF    func(ctx context.Context, options types.ContainerListOptions) ([]types.Container, error)
+	ContainerInspectF func(ctx context.Context, containerID string) (types.ContainerJSON, error)
+	ContainerLogsF    func(ctx context.Context, containerID string, options types.ContainerLogsOptions) (io.ReadCloser, error)
+}
+
+func (c *MockClient) ContainerList(
+	ctx context.Context,
+	options types.ContainerListOptions,
+) ([]types.Container, error) {
+	return c.ContainerListF(ctx, options)
+}
+
+func (c *MockClient) ContainerInspect(
+	ctx context.Context,
+	containerID string,
+) (types.ContainerJSON, error) {
+	return c.ContainerInspectF(ctx, containerID)
+}
+
+func (c *MockClient) ContainerLogs(
+	ctx context.Context,
+	containerID string,
+	options types.ContainerLogsOptions,
+) (io.ReadCloser, error) {
+	return c.ContainerLogsF(ctx, containerID, options)
+}
+
+type Response struct {
+	io.Reader
+}
+
+func (r *Response) Close() error {
+	return nil
+}
+
+func Test(t *testing.T) {
+	tests := []struct {
+		name     string
+		client   *MockClient
+		expected []telegraf.Metric
+	}{
+		{
+			name: "no containers",
+			client: &MockClient{
+				ContainerListF: func(ctx context.Context, options types.ContainerListOptions) ([]types.Container, error) {
+					return nil, nil
+				},
+			},
+		},
+		{
+			name: "one container tty",
+			client: &MockClient{
+				ContainerListF: func(ctx context.Context, options types.ContainerListOptions) ([]types.Container, error) {
+					return []types.Container{
+						{
+							ID:    "deadbeef",
+							Names: []string{"/telegraf"},
+							Image: "influxdata/telegraf:1.11.0",
+						},
+					}, nil
+				},
+				ContainerInspectF: func(ctx context.Context, containerID string) (types.ContainerJSON, error) {
+					return types.ContainerJSON{
+						Config: &container.Config{
+							Tty: true,
+						},
+					}, nil
+				},
+				ContainerLogsF: func(ctx context.Context, containerID string, options types.ContainerLogsOptions) (io.ReadCloser, error) {
+					return &Response{Reader: bytes.NewBuffer([]byte("hello\n"))}, nil
+				},
+			},
+			expected: []telegraf.Metric{
+				testutil.MustMetric(
+					"docker_log",
+					map[string]string{
+						"container_name":    "telegraf",
+						"container_image":   "influxdata/telegraf",
+						"container_version": "1.11.0",
+						"stream":            "tty",
+					},
+					map[string]interface{}{
+						"container_id": "deadbeef",
+						"message":      "hello",
+					},
+					time.Now(),
+				),
+			},
+		},
+		{
+			name: "one container multiplex",
+			client: &MockClient{
+				ContainerListF: func(ctx context.Context, options types.ContainerListOptions) ([]types.Container, error) {
+					return []types.Container{
+						{
+							ID:    "deadbeef",
+							Names: []string{"/telegraf"},
+							Image: "influxdata/telegraf:1.11.0",
+						},
+					}, nil
+				},
+				ContainerInspectF: func(ctx context.Context, containerID string) (types.ContainerJSON, error) {
+					return types.ContainerJSON{
+						Config: &container.Config{
+							Tty: false,
+						},
+					}, nil
+				},
+				ContainerLogsF: func(ctx context.Context, containerID string, options types.ContainerLogsOptions) (io.ReadCloser, error) {
+					var buf bytes.Buffer
+					w := stdcopy.NewStdWriter(&buf, stdcopy.Stdout)
+					w.Write([]byte("hello from stdout"))
+					return &Response{Reader: &buf}, nil
+				},
+			},
+			expected: []telegraf.Metric{
+				testutil.MustMetric(
+					"docker_log",
+					map[string]string{
+						"container_name":    "telegraf",
+						"container_image":   "influxdata/telegraf",
+						"container_version": "1.11.0",
+						"stream":            "stdout",
+					},
+					map[string]interface{}{
+						"container_id": "deadbeef",
+						"message":      "hello from stdout",
+					},
+					time.Now(),
+				),
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var acc testutil.Accumulator
+			plugin := &DockerLogs{
+				Timeout:       internal.Duration{Duration: time.Second * 5},
+				newClient:     func(string, *tls.Config) (Client, error) { return tt.client, nil },
+				containerList: make(map[string]context.CancelFunc),
+			}
+
+			err := plugin.Init()
+			require.NoError(t, err)
+
+			err = plugin.Gather(&acc)
+			require.NoError(t, err)
+
+			acc.Wait(len(tt.expected))
+			plugin.Stop()
+
+			testutil.RequireMetricsEqual(t, tt.expected, acc.GetTelegrafMetrics(), testutil.IgnoreTime())
+		})
+	}
+}