github.com/niedbalski/juju@v0.0.0-20190215020005-8ff100488e47/worker/metrics/spool/metrics_test.go

// Copyright 2012-2014 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

package spool_test

import (
	"path/filepath"
	"runtime"
	"time"

	"github.com/juju/testing"
	jc "github.com/juju/testing/checkers"
	gc "gopkg.in/check.v1"
	corecharm "gopkg.in/juju/charm.v6"
	"gopkg.in/juju/names.v2"

	"github.com/juju/juju/worker/metrics/spool"
	"github.com/juju/juju/worker/uniter/runner/jujuc"
)

type metricsBatchSuite struct {
}

var _ = gc.Suite(&metricsBatchSuite{})

func (s *metricsBatchSuite) TestAPIMetricBatch(c *gc.C) {
	batches := []spool.MetricBatch{{
		CharmURL: "local:trusty/test-charm",
		UUID:     "test-uuid",
		Created:  time.Now(),
		Metrics: []jujuc.Metric{
			{
				Key:   "test-key-1",
				Value: "test-value-1",
				Time:  time.Now(),
			}, {
				Key:   "test-key-2",
				Value: "test-value-2",
				Time:  time.Now(),
			},
		},
	}, {
		CharmURL: "local:trusty/test-charm",
		UUID:     "test-uuid",
		Created:  time.Now(),
		Metrics:  []jujuc.Metric{},
	},
	}
	for _, batch := range batches {
		apiBatch := spool.APIMetricBatch(batch)
		c.Assert(apiBatch.Batch.UUID, gc.DeepEquals, batch.UUID)
		c.Assert(apiBatch.Batch.CharmURL, gc.DeepEquals, batch.CharmURL)
		c.Assert(apiBatch.Batch.Created, gc.DeepEquals, batch.Created)
		c.Assert(len(apiBatch.Batch.Metrics), gc.Equals, len(batch.Metrics))
		for i, metric := range batch.Metrics {
			c.Assert(metric.Key, gc.DeepEquals, apiBatch.Batch.Metrics[i].Key)
			c.Assert(metric.Value, gc.DeepEquals, apiBatch.Batch.Metrics[i].Value)
			c.Assert(metric.Time, gc.DeepEquals, apiBatch.Batch.Metrics[i].Time)
		}
	}
}

func osDependentSockPath(c *gc.C) string {
	sockPath := filepath.Join(c.MkDir(), "test.sock")
	if runtime.GOOS == "windows" {
		return `\\.\pipe` + sockPath[2:]
	}
	return sockPath
}

// testPaths implements Paths for tests that do touch the filesystem.
type testPaths struct {
	tools        string
	charm        string
	socket       string
	metricsspool string
}

func newTestPaths(c *gc.C) testPaths {
	return testPaths{
		tools:        c.MkDir(),
		charm:        c.MkDir(),
		socket:       osDependentSockPath(c),
		metricsspool: c.MkDir(),
	}
}

func (p testPaths) GetMetricsSpoolDir() string {
	return p.metricsspool
}

func (p testPaths) GetToolsDir() string {
	return p.tools
}

func (p testPaths) GetCharmDir() string {
	return p.charm
}

func (p testPaths) GetJujucSocket() string {
	return p.socket
}

type metricsRecorderSuite struct {
	testing.IsolationSuite

	paths   testPaths
	unitTag string
}

var _ = gc.Suite(&metricsRecorderSuite{})

func (s *metricsRecorderSuite) SetUpTest(c *gc.C) {
	s.IsolationSuite.SetUpTest(c)
	s.paths = newTestPaths(c)
	s.unitTag = names.NewUnitTag("test-unit/0").String()
}

func (s *metricsRecorderSuite) TestInit(c *gc.C) {
	w, err := spool.NewJSONMetricRecorder(
		spool.MetricRecorderConfig{
			SpoolDir: s.paths.GetMetricsSpoolDir(),
			Metrics: map[string]corecharm.Metric{
				"pings": {},
				"pongs": {},
			},
			CharmURL: "local:precise/wordpress",
			UnitTag:  s.unitTag,
		})
	c.Assert(err, jc.ErrorIsNil)
	c.Assert(w, gc.NotNil)
	err = w.AddMetric("pings", "5", time.Now(), nil)
	c.Assert(err, jc.ErrorIsNil)
	err = w.AddMetric("pongs", "10", time.Now(), map[string]string{"foo": "bar"})
	c.Assert(err, jc.ErrorIsNil)
	err = w.Close()
	c.Assert(err, jc.ErrorIsNil)

	r, err := spool.NewJSONMetricReader(s.paths.GetMetricsSpoolDir())
	c.Assert(err, jc.ErrorIsNil)
	batches, err := r.Read()
	c.Assert(err, jc.ErrorIsNil)
	c.Assert(batches, gc.HasLen, 1)
	batch := batches[0]
	c.Assert(batch.CharmURL, gc.Equals, "local:precise/wordpress")
	c.Assert(batch.UUID, gc.Not(gc.Equals), "")
	c.Assert(batch.Metrics, gc.HasLen, 2)
	c.Assert(batch.Metrics[0].Key, gc.Equals, "pings")
	c.Assert(batch.Metrics[0].Value, gc.Equals, "5")
	c.Assert(batch.Metrics[0].Labels, gc.HasLen, 0)
	c.Assert(batch.Metrics[1].Key, gc.Equals, "pongs")
	c.Assert(batch.Metrics[1].Value, gc.Equals, "10")
	c.Assert(batch.Metrics[1].Labels, gc.DeepEquals, map[string]string{"foo": "bar"})
	c.Assert(batch.UnitTag, gc.Equals, s.unitTag)

	err = r.Close()
	c.Assert(err, jc.ErrorIsNil)
}

func (s *metricsRecorderSuite) TestMetricValidation(c *gc.C) {
	tests := []struct {
		about         string
		key           string
		value         string
		expectedError string
	}{{
		about:         "metric not declared",
		key:           "pings",
		value:         "5",
		expectedError: `metric key "pings" not declared by the charm`,
	}, {
		about:         "non float metrics",
		key:           "pongs",
		value:         "abcd",
		expectedError: `invalid value type: expected float, got "abcd"`,
	}, {
		about:         "negative value",
		key:           "pongs",
		value:         "-5.0",
		expectedError: `invalid value: value must be greater or equal to zero, got -5.0`,
	}, {
		about:         "large value",
		key:           "pongs",
		value:         "1234567890123456789012345678901234567890",
		expectedError: `metric value is too large`,
	},
	}

	for _, test := range tests {
		w, err := spool.NewJSONMetricRecorder(
			spool.MetricRecorderConfig{
				SpoolDir: s.paths.GetMetricsSpoolDir(),
				Metrics: map[string]corecharm.Metric{
					"juju-units": {},
					"pongs": {
						Type: corecharm.MetricTypeAbsolute,
					},
				},
				CharmURL: "local:precise/wordpress",
				UnitTag:  s.unitTag,
			})
		c.Assert(err, jc.ErrorIsNil)
		c.Assert(w, gc.NotNil)

		c.Logf("running test: %s", test.about)
		err = w.AddMetric(test.key, test.value, time.Now(), nil)
		if test.expectedError != "" {
			c.Assert(err, gc.ErrorMatches, test.expectedError)
			err = w.Close()
			c.Assert(err, jc.ErrorIsNil)

			r, err := spool.NewJSONMetricReader(s.paths.GetMetricsSpoolDir())
			c.Assert(err, jc.ErrorIsNil)
			batches, err := r.Read()
			c.Assert(err, jc.ErrorIsNil)
			c.Assert(batches, gc.HasLen, 0)
		} else {
			c.Assert(err, jc.ErrorIsNil)
			err = w.Close()
			c.Assert(err, jc.ErrorIsNil)
		}
	}
}

type metricsReaderSuite struct {
	paths   testPaths
	unitTag string

	w *spool.JSONMetricRecorder
}

var _ = gc.Suite(&metricsReaderSuite{})

func (s *metricsReaderSuite) SetUpTest(c *gc.C) {
	s.paths = newTestPaths(c)
	s.unitTag = names.NewUnitTag("test-unit/0").String()

	var err error
	s.w, err = spool.NewJSONMetricRecorder(
		spool.MetricRecorderConfig{
			SpoolDir: s.paths.GetMetricsSpoolDir(),
			Metrics:  map[string]corecharm.Metric{"pings": {}},
			CharmURL: "local:precise/wordpress",
			UnitTag:  s.unitTag,
		})

	c.Assert(err, jc.ErrorIsNil)
	err = s.w.AddMetric("pings", "5", time.Now(), nil)
	c.Assert(err, jc.ErrorIsNil)
	err = s.w.Close()
	c.Assert(err, jc.ErrorIsNil)
}

func (s *metricsReaderSuite) TestTwoSimultaneousReaders(c *gc.C) {
	r, err := spool.NewJSONMetricReader(s.paths.GetMetricsSpoolDir())
	c.Assert(err, jc.ErrorIsNil)

	r2, err := spool.NewJSONMetricReader(c.MkDir())
	c.Assert(err, jc.ErrorIsNil)
	c.Assert(r2, gc.NotNil)
	err = r2.Close()
	c.Assert(err, jc.ErrorIsNil)
	err = r.Close()
	c.Assert(err, jc.ErrorIsNil)

}

func (s *metricsReaderSuite) TestUnblockedReaders(c *gc.C) {
	r, err := spool.NewJSONMetricReader(s.paths.GetMetricsSpoolDir())
	c.Assert(err, jc.ErrorIsNil)
	err = r.Close()
	c.Assert(err, jc.ErrorIsNil)

	r2, err := spool.NewJSONMetricReader(s.paths.GetMetricsSpoolDir())
	c.Assert(err, jc.ErrorIsNil)
	c.Assert(r2, gc.NotNil)
	err = r2.Close()
	c.Assert(err, jc.ErrorIsNil)
}

func (s *metricsReaderSuite) TestRemoval(c *gc.C) {
	r, err := spool.NewJSONMetricReader(s.paths.GetMetricsSpoolDir())
	c.Assert(err, jc.ErrorIsNil)

	batches, err := r.Read()
	c.Assert(err, jc.ErrorIsNil)
	for _, batch := range batches {
		err := r.Remove(batch.UUID)
		c.Assert(err, jc.ErrorIsNil)
	}
	err = r.Close()
	c.Assert(err, jc.ErrorIsNil)

	batches, err = r.Read()
	c.Assert(err, jc.ErrorIsNil)
	c.Assert(batches, gc.HasLen, 0)
	err = r.Close()
	c.Assert(err, jc.ErrorIsNil)
}