Check event name in UpdateEvent()

camptocamp · Aug 10, 2016 · def3e52 · def3e52
1 parent 1880add
commit def3e52
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 8 deletions.
diff --git a/engines/duplicity.go b/engines/duplicity.go
@@ -175,7 +175,7 @@ func (d *DuplicityEngine) verify() (err error) {
 	}
 
 	metric := d.Handler.MetricsHandler.NewMetric("conplicity_verifyExitCode", "gauge")
-	metric.UpdateEvent(
+	err = metric.UpdateEvent(
 		&metrics.Event{
 			Labels: map[string]string{
 				"volume": v.Name,

diff --git a/handler/handler.go b/handler/handler.go
@@ -122,14 +122,17 @@ func (c *Conplicity) GetVolumes() (volumes []*volume.Volume, err error) {
 func (c *Conplicity) LogTime(vol *volume.Volume, event string) (err error) {
 	metricName := fmt.Sprintf("conplicity_%s", event)
 	startTimeMetric := c.MetricsHandler.NewMetric(metricName, "counter")
-	startTimeMetric.UpdateEvent(
+	err = startTimeMetric.UpdateEvent(
 		&metrics.Event{
 			Labels: map[string]string{
 				"volume": vol.Name,
 			},
 			Value: strconv.FormatInt(time.Now().Unix(), 10),
 		},
 	)
+	if err != nil {
+		return
+	}
 	err = c.MetricsHandler.Push()
 	return
 }

diff --git a/metrics/metrics.go b/metrics/metrics.go
@@ -63,8 +63,13 @@ func (e *Event) Equals(newEvent *Event) bool {
 }
 
 // UpdateEvent adds an event, or updates it if the event already exists
-func (m *Metric) UpdateEvent(event *Event) {
-	event.Name = m.Name
+func (m *Metric) UpdateEvent(event *Event) error {
+	if event.Name == "" {
+		event.Name = m.Name
+	}
+	if event.Name != m.Name {
+		return fmt.Errorf("cannot add event %s to metric %s", event.Name, m.Name)
+	}
 	for i, e := range m.Events {
 		if e.Equals(event) {
 			log.WithFields(log.Fields{
@@ -73,14 +78,16 @@ func (m *Metric) UpdateEvent(event *Event) {
 				"new_event": event.String(),
 			}).Debug("Replacing event")
 			m.Events[i] = event
-			return
+			return nil
 		}
 	}
 	log.WithFields(log.Fields{
 		"metric": m.Name,
 		"event":  event.String(),
 	}).Debug("Adding event")
 	m.Events = append(m.Events, event)
+
+	return nil
 }
 
 // NewMetric adds a new metric if it doesn't exist yet

diff --git a/metrics/metrics_test.go b/metrics/metrics_test.go
@@ -136,6 +136,7 @@ func TestParseEvent(t *testing.T) {
 }
 
 func TestMetricUpdateEvent(t *testing.T) {
+	var err error
 	m := &Metric{
 		Name: "foo",
 	}
@@ -150,7 +151,10 @@ func TestMetricUpdateEvent(t *testing.T) {
 		},
 		Value: "bar",
 	}
-	m.UpdateEvent(e1)
+	err = m.UpdateEvent(e1)
+	if err != nil {
+		t.Fatalf("Expected no error, got %v", err)
+	}
 	if len(m.Events) != 1 {
 		t.Fatalf("Expected one event, got %v", len(m.Events))
 	}
@@ -168,7 +172,10 @@ func TestMetricUpdateEvent(t *testing.T) {
 		},
 		Value: "qux",
 	}
-	m.UpdateEvent(e2)
+	err = m.UpdateEvent(e2)
+	if err != nil {
+		t.Fatalf("Expected no error, got %v", err)
+	}
 	if len(m.Events) != 1 {
 		t.Fatalf("Expected one event, got %v", len(m.Events))
 	}
@@ -186,7 +193,10 @@ func TestMetricUpdateEvent(t *testing.T) {
 		},
 		Value: "quxx",
 	}
-	m.UpdateEvent(e3)
+	err = m.UpdateEvent(e3)
+	if err != nil {
+		t.Fatalf("Expected no error, got %v", err)
+	}
 	if len(m.Events) != 2 {
 		t.Fatalf("Expected two events, got %v", len(m.Events))
 	}
@@ -196,4 +206,20 @@ func TestMetricUpdateEvent(t *testing.T) {
 	if m.Events[1].Value != "quxx" {
 		t.Fatalf("Expected event value to be quxx, got %s", m.Events[1].Value)
 	}
+
+	// Add event with wrong name
+	e4 := &Event{
+		Name: "bar",
+		Labels: map[string]string{
+			"volume": "fooddd",
+		},
+		Value: "quxx",
+	}
+	err = m.UpdateEvent(e4)
+	if err == nil {
+		t.Fatal("Expected an error, got nil")
+	}
+	if len(m.Events) != 2 {
+		t.Fatalf("Expected two events, got %v", len(m.Events))
+	}
 }