metrics_test.go

// Copyright 2014 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.

package charm_test

import (
	"sort"
	"strings"

	gc "gopkg.in/check.v1"

	"github.com/juju/charm/v12"
)

// Keys returns a list of all defined metrics keys.
func Keys(m *charm.Metrics) []string {
	result := make([]string, 0, len(m.Metrics))

	for name := range m.Metrics {
		result = append(result, name)

	}
	sort.Strings(result)
	return result
}

type MetricsSuite struct{}

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

func (s *MetricsSuite) TestReadEmpty(c *gc.C) {
	metrics, err := charm.ReadMetrics(strings.NewReader(""))
	c.Assert(err, gc.IsNil)
	c.Assert(metrics, gc.NotNil)
}

func (s *MetricsSuite) TestReadAlmostEmpty(c *gc.C) {
	metrics, err := charm.ReadMetrics(strings.NewReader(`
metrics:
`))
	c.Assert(err, gc.IsNil)
	c.Assert(metrics, gc.NotNil)
}

func (s *MetricsSuite) TestNoDescription(c *gc.C) {
	metrics, err := charm.ReadMetrics(strings.NewReader(`
metrics:
  some-metric:
    type: gauge
`))
	c.Assert(err, gc.ErrorMatches, "invalid metrics declaration: metric \"some-metric\" lacks description")
	c.Assert(metrics, gc.IsNil)
}

func (s *MetricsSuite) TestIncorrectType(c *gc.C) {
	metrics, err := charm.ReadMetrics(strings.NewReader(`
metrics:
  some-metric:
    type: not-a-type
    description: Some description.
`))
	c.Assert(err, gc.ErrorMatches, "invalid metrics declaration: metric \"some-metric\" has unknown type \"not-a-type\"")
	c.Assert(metrics, gc.IsNil)
}

func (s *MetricsSuite) TestMultipleDefinition(c *gc.C) {
	metrics, err := charm.ReadMetrics(strings.NewReader(`
metrics:
  some-metric:
    type: gauge
    description: Some description.
  some-metric:
    type: absolute
    description: Some other description.

`))
	c.Assert(err, gc.IsNil)
	c.Assert(metrics.Metrics, gc.HasLen, 1)
	c.Assert(metrics.Metrics["some-metric"].Type, gc.Equals, charm.MetricTypeAbsolute)
}

func (s *MetricsSuite) TestIsBuiltinMetric(c *gc.C) {
	tests := []struct {
		input     string
		isbuiltin bool
	}{{
		"juju-thing",
		true,
	}, {
		"jujuthing",
		true,
	}, {
		"thing",
		false,
	},
	}

	for i, test := range tests {
		c.Logf("test %d isBuiltinMetric(%v) = %v", i, test.input, test.isbuiltin)
		is := charm.IsBuiltinMetric(test.input)
		c.Assert(is, gc.Equals, test.isbuiltin)
	}
}

func (s *MetricsSuite) TestValidYaml(c *gc.C) {
	metrics, err := charm.ReadMetrics(strings.NewReader(`
metrics:
  blips:
    type: absolute
    description: An absolute metric.
  blops:
    type: gauge
    description: A gauge metric.
  juju-unit-time:
`))
	c.Assert(err, gc.IsNil)
	c.Assert(metrics, gc.NotNil)
	c.Assert(Keys(metrics), gc.DeepEquals, []string{"blips", "blops", "juju-unit-time"})

	testCases := []struct {
		about string
		name  string
		value string
		err   string
	}{{
		about: "valid gauge metric",
		name:  "blops",
		value: "1",
		err:   "",
	}, {
		about: "valid absolute metric",
		name:  "blips",
		value: "0",
		err:   "",
	}, {
		about: "valid gauge metric, float value",
		name:  "blops",
		value: "0.15",
		err:   "",
	}, {
		about: "valid absolute metric, float value",
		name:  "blips",
		value: "6.015e15",
		err:   "",
	}, {
		about: "undeclared metric",
		name:  "undeclared",
		value: "6.015e15",
		err:   "metric \"undeclared\" not defined",
	}, {
		about: "invalid type for gauge metric",
		name:  "blops",
		value: "true",
		err:   "invalid value type: expected float, got \"true\"",
	}, {
		about: "metric value too large",
		name:  "blips",
		value: "1111111111111111111111111111111",
		err:   "metric value is too large",
	},
	}

	for i, t := range testCases {
		c.Logf("test %d: %s", i, t.about)
		err := metrics.ValidateMetric(t.name, t.value)
		if t.err == "" {
			c.Check(err, gc.IsNil)
		} else {
			c.Check(err, gc.ErrorMatches, t.err)
		}
	}

}

func (s *MetricsSuite) TestBuiltInMetrics(c *gc.C) {
	tests := []string{`
metrics:
  some-metric:
    type: gauge
    description: Some description.
  juju-unit-time:
    type: absolute
`, `
metrics:
  some-metric:
    type: gauge
    description: Some description.
  juju-unit-time:
    description: Some description
`,
	}
	for _, test := range tests {
		c.Logf("%s", test)
		_, err := charm.ReadMetrics(strings.NewReader(test))
		c.Assert(err, gc.ErrorMatches, `metric "juju-unit-time" is using a prefix reserved for built-in metrics: it should not have type or description specification`)
	}
}

func (s *MetricsSuite) TestValidateValue(c *gc.C) {
	tests := []struct {
		value         string
		expectedError string
	}{{
		value: "1234567890",
	}, {
		value: "0",
	}, {
		value:         "abcd",
		expectedError: `invalid value type: expected float, got "abcd"`,
	}, {
		value:         "1234567890123456789012345678901234567890",
		expectedError: "metric value is too large",
	}, {
		value:         "-42",
		expectedError: "invalid value: value must be greater or equal to zero, got -42",
	},
	}

	for _, test := range tests {
		err := charm.ValidateValue(test.value)
		if test.expectedError != "" {
			c.Assert(err, gc.ErrorMatches, test.expectedError)
		} else {
			c.Assert(err, gc.IsNil)
		}
	}
}

func (s *MetricsSuite) TestPlanRequired(c *gc.C) {
	tests := []struct {
		about        string
		input        string
		planRequired bool
	}{{
		about: "not specified",
		input: `
metrics:
  some-metric:
    type: gauge
    description: thing
`,
		planRequired: false,
	}, {
		about: "plan optional",
		input: `
plan: 
  required: false
metrics:
`,
		planRequired: false,
	}, {
		about: "plan required",
		input: `
plan: 
  required: true
metrics:
`,
		planRequired: true,
	}, {
		about: "not set",
		input: `
plan:
metrics:
`,
		planRequired: false,
	},
	}
	for i, test := range tests {
		c.Logf("testplanrequired %d: %s", i, test.about)
		metrics, err := charm.ReadMetrics(strings.NewReader(test.input))
		c.Assert(err, gc.IsNil)
		c.Assert(metrics.PlanRequired(), gc.Equals, test.planRequired)
	}
}