Merge pull request #95 from openshift-kni/pfpstatus-max-size-prep

pfpstatus: record: generalize API

Author: ffromani

pkg/pfpstatus/record/recorder.go

@@ -54,29 +54,53 @@ type NodeRecorder struct {
 	statuses    []RecordedStatus
 }
 
+type NodeOption func(*NodeRecorder)
+
+func WithCapacity(capacity int) NodeOption {
+	return func(nr *NodeRecorder) {
+		nr.capacity = capacity
+	}
+}
+
 // NewNodeRecorder creates a new recorder for the given node with the given capacity.
 // The record is a ring buffer, so only the latest <capacity> Statuses are kept at any time.
 // The timestamper callback is used to mark times. Use `time.Now` if unsure.
 // Returns the newly created instance; if parameters are incorrect, returns an error, on which
 // case the returned instance should be ignored.
-func NewNodeRecorder(nodeName string, capacity int, timestamper Timestamper) (*NodeRecorder, error) {
+func NewNodeRecorder(nodeName string, timestamper Timestamper, opts ...NodeOption) (*NodeRecorder, error) {
 	if nodeName == "" {
 		return nil, ErrMissingNode
 	}
-	if capacity < 1 {
-		return nil, ErrInvalidCapacity
-	}
 	nr := NodeRecorder{
 		timestamper: timestamper,
 		nodeName:    nodeName,
-		capacity:    capacity,
 	}
-	if capacity == 1 { // handle common special case
+	for _, opt := range opts {
+		opt(&nr)
+	}
+	if nr.capacity < 1 {
+		return nil, ErrInvalidCapacity
+	}
+	if nr.capacity == 1 { // handle common special case
 		nr.statuses = make([]RecordedStatus, 1)
 	}
 	return &nr, nil
 }
 
+func (nr *NodeRecorder) dropOldest() {
+	if nr.Len() < 1 {
+		return
+	}
+	nr.statuses = nr.statuses[1:]
+}
+
+func (nr *NodeRecorder) makeRoom() {
+	if nr.Len() < nr.Cap() {
+		return
+	}
+	nr.dropOldest()
+}
+
 // Push adds a new Status to the record, evicting the oldest Status if necessary.
 // The pushed status is a full independent copy of the provided Status.
 // If the Status added is inconsistent, returns an error detailing the reason.
@@ -88,21 +112,17 @@ func (nr *NodeRecorder) Push(st podfingerprint.Status) error {
 	if st.NodeName != nr.nodeName {
 		return ErrMismatchingNode
 	}
+	ts := nr.timestamper()
+	item := RecordedStatus{
+		Status:     st.Clone(),
+		RecordTime: ts,
+	}
 	if nr.capacity == 1 { // handle common special case, avoid any resize
-		nr.statuses[0] = RecordedStatus{
-			Status:     st.Clone(),
-			RecordTime: nr.timestamper(),
-		}
+		nr.statuses[0] = item
 		return nil
 	}
-	if nr.Len() == nr.Cap() {
-		// drop the older sample
-		nr.statuses = nr.statuses[1:]
-	}
-	nr.statuses = append(nr.statuses, RecordedStatus{
-		Status:     st.Clone(),
-		RecordTime: nr.timestamper(),
-	})
+	nr.makeRoom()
+	nr.statuses = append(nr.statuses, item)
 	return nil
 }
 
@@ -203,7 +223,7 @@ func (rr *Recorder) Push(st podfingerprint.Status) error {
 	}
 
 	if !ok {
-		nr, err = NewNodeRecorder(st.NodeName, rr.nodeCapacity, rr.timestamper)
+		nr, err = NewNodeRecorder(st.NodeName, rr.timestamper, WithCapacity(rr.nodeCapacity))
 		if err != nil {
 			return err
 		}

pkg/pfpstatus/record/recorder_test.go

@@ -26,7 +26,7 @@ import (
 )
 
 func TestNodeRecorderCreate(t *testing.T) {
-	nr, err := NewNodeRecorder("test-node", 16, time.Now)
+	nr, err := NewNodeRecorder("test-node", time.Now, WithCapacity(16))
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
@@ -40,7 +40,7 @@ func TestNodeRecorderCreate(t *testing.T) {
 }
 
 func TestNodeRecorderCreateInvalid(t *testing.T) {
-	_, err := NewNodeRecorder("test-node", 0, time.Now)
+	_, err := NewNodeRecorder("test-node", time.Now)
 	if err == nil {
 		t.Fatalf("unexpected success")
 	}
@@ -50,7 +50,7 @@ func TestNodeRecorderCreateInvalid(t *testing.T) {
 }
 
 func TestNodeRecorderPushMissingNodeName(t *testing.T) {
-	nr, err := NewNodeRecorder("test-node", 16, time.Now)
+	nr, err := NewNodeRecorder("test-node", time.Now, WithCapacity(16))
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
@@ -66,7 +66,7 @@ func TestNodeRecorderPushMissingNodeName(t *testing.T) {
 }
 
 func TestNodeRecorderPushMismatchingNodeName(t *testing.T) {
-	nr, err := NewNodeRecorder("test-node", 16, time.Now)
+	nr, err := NewNodeRecorder("test-node", time.Now, WithCapacity(16))
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
@@ -82,7 +82,7 @@ func TestNodeRecorderPushMismatchingNodeName(t *testing.T) {
 }
 
 func TestNodeRecorderPushBasic(t *testing.T) {
-	nr, err := NewNodeRecorder("test-node", 16, time.Now)
+	nr, err := NewNodeRecorder("test-node", time.Now, WithCapacity(16))
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
@@ -98,7 +98,7 @@ func TestNodeRecorderPushBasic(t *testing.T) {
 }
 
 func TestNodeRecorderSingleEntryPushEvict(t *testing.T) {
-	nr, err := NewNodeRecorder("test-node", 1, time.Now)
+	nr, err := NewNodeRecorder("test-node", time.Now, WithCapacity(1))
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
@@ -132,7 +132,7 @@ func TestNodeRecorderSingleEntryPushEvict(t *testing.T) {
 }
 
 func TestNodeRecorderMultiEntryPushContentEvict(t *testing.T) {
-	nr, err := NewNodeRecorder("test-node", 3, time.Now)
+	nr, err := NewNodeRecorder("test-node", time.Now, WithCapacity(3))
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}