move generic stack into a common type package

Author: skattoju

internal/capability/auditor.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/opdev/opcap/internal/logger"
 	"github.com/opdev/opcap/internal/operator"
+	"github.com/opdev/opcap/internal/types"
 	"k8s.io/apimachinery/pkg/util/yaml"
 )
 
@@ -173,14 +174,14 @@ func (ca *CapAuditor) buildWorkQueueByCatalog(ctx context.Context, c operator.Cl
 	return nil
 }
 
-func (ca *CapAuditor) cleanup(ctx context.Context, stack *Stack[auditCleanupFn]) {
+func (ca *CapAuditor) cleanup(ctx context.Context, stack *types.Stack[auditCleanupFn]) {
 	if stack == nil {
 		return
 	}
 	for !stack.Empty() {
 		logger.Debugw("cleaning up...")
 		cleaner, err := stack.Pop()
-		if errors.Is(err, StackEmptyError) {
+		if errors.Is(err, types.StackEmptyError) {
 			break
 		}
 		if err := cleaner(ctx); err != nil {
@@ -192,7 +193,7 @@ func (ca *CapAuditor) cleanup(ctx context.Context, stack *Stack[auditCleanupFn])
 
 // RunAudits executes all selected functions in order for a given audit at a time
 func (ca *CapAuditor) RunAudits(ctx context.Context) error {
-	cleanups := Stack[auditCleanupFn]{}
+	cleanups := types.Stack[auditCleanupFn]{}
 	defer ca.cleanup(ctx, &cleanups)
 
 	err := ca.buildWorkQueueByCatalog(ctx, ca.OpCapClient)

internal/capability/types.go

@@ -2,7 +2,6 @@ package capability
 
 import (
 	"context"
-	"errors"
 	"time"
 
 	"github.com/opdev/opcap/internal/operator"
@@ -27,37 +26,3 @@ type (
 	auditFn        func(context.Context) error
 	auditCleanupFn func(context.Context) error
 )
-
-type Stack[T any] struct {
-	stack *element[T]
-}
-
-type element[T any] struct {
-	previous *element[T]
-	val      T
-}
-
-var StackEmptyError = errors.New("Stack empty")
-
-func (s *Stack[T]) Push(v T) {
-	e := &element[T]{
-		previous: s.stack,
-		val:      v,
-	}
-	s.stack = e
-}
-
-func (s *Stack[T]) Pop() (T, error) {
-	if s.stack == nil {
-		var r T
-		return r, StackEmptyError
-	}
-	e := *s.stack
-	s.stack = e.previous
-
-	return e.val, nil
-}
-
-func (s *Stack[T]) Empty() bool {
-	return s.stack == nil
-}

internal/types/stack.go

@@ -0,0 +1,37 @@
+package types
+
+import "errors"
+
+type Stack[T any] struct {
+	stack *element[T]
+}
+
+type element[T any] struct {
+	previous *element[T]
+	val      T
+}
+
+var StackEmptyError = errors.New("stack empty")
+
+func (s *Stack[T]) Push(v T) {
+	e := &element[T]{
+		previous: s.stack,
+		val:      v,
+	}
+	s.stack = e
+}
+
+func (s *Stack[T]) Pop() (T, error) {
+	if s.stack == nil {
+		var r T
+		return r, StackEmptyError
+	}
+	e := *s.stack
+	s.stack = e.previous
+
+	return e.val, nil
+}
+
+func (s *Stack[T]) Empty() bool {
+	return s.stack == nil
+}

internal/capability/types_test.go renamed to internal/types/stack_test.go

@@ -1,4 +1,4 @@
-package capability
+package types
 
 import (
 	. "github.com/onsi/ginkgo/v2"