go/src/infra/cros/recovery/logger/metrics/metrics_test.go

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package metrics

import (
	"context"
	"fmt"
	"strings"
	"testing"

	"github.com/google/go-cmp/cmp"
)

// TestNewInt64Observation tests creating a new int64 observation.
func TestNewInt64Observation(t *testing.T) {
	t.Parallel()
	expected := &Observation{
		MetricKind: "ssh-attempt",
		Value:      "7",
		ValueType:  ValueTypeNumber,
	}
	actual := NewInt64Observation("ssh-attempt", 7)
	if diff := cmp.Diff(expected, actual); diff != "" {
		t.Errorf("unexpected diff (-want +got): %s", diff)
	}
}

// TestNewMetrics verifies that the default metrics logger writes a serialized message to
// the provided logger at the debug level.
//
// TODO(gregorynisbet): Drop this test once the default logger implementation is more substantial.
func TestNewMetrics(t *testing.T) {
	ctx := context.Background()
	expected := []string{
		lines(
			`Create action "b": {`,
			`    "Name": "",`,
			`    "ActionKind": "b",`,
			`    "SwarmingTaskID": "a",`,
			`    "BuildbucketID": "",`,
			`    "Board": "b",`,
			`    "Model": "m",`,
			`    "AssetTag": "",`,
			`    "StartTime": "0001-01-01T00:00:00Z",`,
			`    "StopTime": "0001-01-01T00:00:00Z",`,
			`    "Status": "",`,
			`    "Hostname": "",`,
			`    "FailReason": "",`,
			`    "Observations": [`,
			`        {`,
			`            "MetricKind": "c",`,
			`            "ValueType": "",`,
			`            "Value": ""`,
			`        }`,
			`    ],`,
			`    "RecoveredBy": "",`,
			`    "Restarts": 0,`,
			`    "AllowFail": "",`,
			`    "PlanName": "",`,
			`    "Type": ""`,
			`}`,
		),
	}
	l := newFakeLogger().(*fakeLogger)
	m := NewLogMetrics(l)

	action := &Action{
		SwarmingTaskID: "a",
		ActionKind:     "b",
		Board:          "b",
		Model:          "m",
		Observations: []*Observation{
			{
				MetricKind: "c",
			},
		},
	}
	m.Create(ctx, action)

	actual := l.messages["debug"]

	if diff := cmp.Diff(expected, actual); diff != "" {
		t.Errorf("unexpected diff: %s", diff)
	}
}

// TestLower tests lowering a query to a syntax that Karte will accept.
func TestLower(t *testing.T) {
	t.Parallel()

	cases := []struct {
		name string
		in   *Query
		out  string
	}{
		{
			name: "nil",
			in:   nil,
			out:  "",
		},
		{
			name: "empty",
			in:   nil,
			out:  "",
		},
		{
			name: "actionKind only",
			in: &Query{
				ActionKind: "foo",
			},
			out: `kind == "foo"`,
		},
		{
			name: "hostname only",
			in: &Query{
				Hostname: "bar",
			},
			out: `hostname == "bar"`,
		},
		{
			name: "actionKind and hostname",
			in: &Query{
				ActionKind: "foo",
				Hostname:   "bar",
			},
			out: `hostname == "bar" && kind == "foo"`,
		},
	}

	for _, tt := range cases {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()

			expected := tt.out
			actual, _ := tt.in.Lower()

			if diff := cmp.Diff(expected, actual); diff != "" {
				t.Errorf("unexpected diff (-want +got): %s", diff)
			}
		})
	}
}

// Join a sequence of lines together to make a string with newlines inserted after
// each element.
func lines(a ...string) string {
	return fmt.Sprintf("%s\n", strings.Join(a, "\n"))
}