Expose indexing funcs

Signed-off-by: Micah Hausler <[email protected]>
tinkerbell · May 6, 2022 · 80f20f8 · 80f20f8
1 parent f48c79b
commit 80f20f8
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 20 deletions.
diff --git a/pkg/controllers/manager.go b/pkg/controllers/manager.go
@@ -96,27 +96,27 @@ func NewManager(config *rest.Config, options controllerruntime.Options) (Manager
 		{
 			&v1alpha1.Workflow{},
 			WorkflowWorkerAddrIndex,
-			workflowWorkerAddrIndexFunc,
+			WorkflowWorkerAddrIndexFunc,
 		},
 		{
 			&v1alpha1.Workflow{},
 			WorkflowWorkerNonTerminalStateIndex,
-			workflowWorkerNonTerminalStateIndexFunc,
+			WorkflowWorkerNonTerminalStateIndexFunc,
 		},
 		{
 			&v1alpha1.Workflow{},
 			WorkflowStateIndex,
-			workflowStateIndexFunc,
+			WorkflowStateIndexFunc,
 		},
 		{
 			&v1alpha1.Hardware{},
 			HardwareIPAddrIndex,
-			hardwareIPIndexFunc,
+			HardwareIPIndexFunc,
 		},
 		{
 			&v1alpha1.Hardware{},
 			HardwareMACAddrIndex,
-			hardwareMacIndexFunc,
+			HardwareMacIndexFunc,
 		},
 	}
 	for _, indexer := range indexers {
@@ -150,8 +150,8 @@ func (m *GenericControllerManager) RegisterControllers(ctx context.Context, cont
 	return m
 }
 
-// workflowWorkerAddrIndexFunc func returns a list of worker addresses from a workflow.
-func workflowWorkerAddrIndexFunc(obj client.Object) []string {
+// WorkflowWorkerAddrIndexFunc func returns a list of worker addresses from a workflow.
+func WorkflowWorkerAddrIndexFunc(obj client.Object) []string {
 	wf, ok := obj.(*v1alpha1.Workflow)
 	if !ok {
 		return nil
@@ -165,8 +165,9 @@ func workflowWorkerAddrIndexFunc(obj client.Object) []string {
 	return resp
 }
 
-// workflowWorkerNonTerminalStateIndexFunc func indexes workflow by worker for non terminal workflows.
-func workflowWorkerNonTerminalStateIndexFunc(obj client.Object) []string {
+// WorkflowWorkerNonTerminalStateIndexFunc func returns a list of worker addresses for workflows
+// in a running or pending state.
+func WorkflowWorkerNonTerminalStateIndexFunc(obj client.Object) []string {
 	wf, ok := obj.(*v1alpha1.Workflow)
 	if !ok {
 		return nil
@@ -184,17 +185,17 @@ func workflowWorkerNonTerminalStateIndexFunc(obj client.Object) []string {
 	return resp
 }
 
-// workflowStateIndexFunc func indexes workflow by worker for non terminal workflows.
-func workflowStateIndexFunc(obj client.Object) []string {
+// WorkflowStateIndexFunc func returns the workflow state.
+func WorkflowStateIndexFunc(obj client.Object) []string {
 	wf, ok := obj.(*v1alpha1.Workflow)
 	if !ok {
 		return nil
 	}
 	return []string{string(wf.Status.State)}
 }
 
-// hardwareMacIndexFunc returns a list of mac addresses from a hardware.
-func hardwareMacIndexFunc(obj client.Object) []string {
+// HardwareMacIndexFunc returns a list of mac addresses from a hardware.
+func HardwareMacIndexFunc(obj client.Object) []string {
 	hw, ok := obj.(*v1alpha1.Hardware)
 	if !ok {
 		return nil
@@ -208,8 +209,8 @@ func hardwareMacIndexFunc(obj client.Object) []string {
 	return resp
 }
 
-// hardwareIPIndexFunc returns a list of mac addresses from a hardware.
-func hardwareIPIndexFunc(obj client.Object) []string {
+// HardwareIPIndexFunc returns a list of IP addresses from a hardware.
+func HardwareIPIndexFunc(obj client.Object) []string {
 	hw, ok := obj.(*v1alpha1.Hardware)
 	if !ok {
 		return nil

diff --git a/pkg/controllers/manager_test.go b/pkg/controllers/manager_test.go
@@ -91,15 +91,15 @@ func TestWorkflowIndexFuncs(t *testing.T) {
 
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {
-			gotAddr := workflowWorkerAddrIndexFunc(tc.input)
+			gotAddr := WorkflowWorkerAddrIndexFunc(tc.input)
 			if !reflect.DeepEqual(tc.wantAddrs, gotAddr) {
 				t.Errorf("Unexpected wokerAddr response: wanted %#v, got %#v", tc.wantAddrs, gotAddr)
 			}
-			gotStateAddrs := workflowWorkerNonTerminalStateIndexFunc(tc.input)
+			gotStateAddrs := WorkflowWorkerNonTerminalStateIndexFunc(tc.input)
 			if !reflect.DeepEqual(tc.wantStateAddrs, gotStateAddrs) {
 				t.Errorf("Unexpected non-terminating workflow response: wanted %#v, got %#v", tc.wantStateAddrs, gotStateAddrs)
 			}
-			gotStates := workflowStateIndexFunc(tc.input)
+			gotStates := WorkflowStateIndexFunc(tc.input)
 			if !reflect.DeepEqual(tc.wantStates, gotStates) {
 				t.Errorf("Unexpected workflow state response: wanted %#v, got %#v", tc.wantStates, gotStates)
 			}
@@ -203,11 +203,11 @@ func TestHardwareIndexFunc(t *testing.T) {
 
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {
-			gotMac := hardwareMacIndexFunc(tc.input)
+			gotMac := HardwareMacIndexFunc(tc.input)
 			if !reflect.DeepEqual(tc.wantMac, gotMac) {
 				t.Errorf("Unexpected response: wanted %#v, got %#v", tc.wantMac, gotMac)
 			}
-			gotIPs := hardwareIPIndexFunc(tc.input)
+			gotIPs := HardwareIPIndexFunc(tc.input)
 			if !reflect.DeepEqual(tc.wantIP, gotIPs) {
 				t.Errorf("Unexpected response: wanted %#v, got %#v", tc.wantIP, gotIPs)
 			}