adjust visitor config

Author: steiler

pkg/tree/entry.go

@@ -158,7 +158,7 @@ type Entry interface {
 }
 
 type EntryVisitor interface {
-	Config() *EntryVisitorConfig
+	DescendMethod() DescendMethod
 	Visit(ctx context.Context, e Entry) error
 	Up()
 }
@@ -178,21 +178,6 @@ type LeafVariantEntries interface {
 	GetByOwner(owner string) *LeafEntry
 }
 
-type EntryVisitorConfig struct {
-	descendMethod DescendMethod
-}
-
-func NewEntryVisitorConfig() *EntryVisitorConfig {
-	return &EntryVisitorConfig{
-		descendMethod: DescendMethodActiveChilds,
-	}
-}
-
-func (e *EntryVisitorConfig) SetDescendingMethod(d DescendMethod) *EntryVisitorConfig {
-	e.descendMethod = d
-	return e
-}
-
 type DescendMethod int
 
 const (

pkg/tree/sharedEntryAttributes.go

@@ -430,7 +430,7 @@ func (s *sharedEntryAttributes) Walk(ctx context.Context, v EntryVisitor) error
 	}
 
 	// trigger the execution on all childs
-	for _, c := range s.GetChilds(v.Config().descendMethod) {
+	for _, c := range s.GetChilds(v.DescendMethod()) {
 		err := c.Walk(ctx, v)
 		if err != nil {
 			return err

pkg/tree/visitor_base.go

@@ -0,0 +1,12 @@
+package tree
+
+// BaseVisitor abstract base visitor implementation that all the concrete visitory are ment to embed.
+type BaseVisitor struct{}
+
+func (b *BaseVisitor) Up() {
+	// noop
+}
+
+func (b *BaseVisitor) DescendMethod() DescendMethod {
+	return DescendMethodAll
+}

pkg/tree/visitor_blame_config.go

@@ -0,0 +1,82 @@
+package tree
+
+import (
+	"context"
+	"slices"
+	"strings"
+
+	sdcpb "github.com/sdcio/sdc-protos/sdcpb"
+	"google.golang.org/protobuf/proto"
+)
+
+type BlameConfigVisitor struct {
+	BaseVisitor
+	stack           []*sdcpb.BlameTreeElement
+	includeDefaults bool
+}
+
+var _ EntryVisitor = (*BlameConfigVisitor)(nil)
+
+func NewBlameConfigVisitor(includeDefaults bool) *BlameConfigVisitor {
+	return &BlameConfigVisitor{
+		stack:           []*sdcpb.BlameTreeElement{},
+		includeDefaults: includeDefaults,
+	}
+}
+
+func (b *BlameConfigVisitor) Visit(ctx context.Context, e Entry) error {
+	name := e.PathName()
+	if e.IsRoot() {
+		name = "root"
+	}
+	result := sdcpb.NewBlameTreeElement(name)
+	skipAdd := false
+
+	// process Value
+	highestLe := e.GetLeafVariantEntries().GetHighestPrecedence(false, true)
+	if highestLe != nil {
+		if highestLe.Update.Owner() != DefaultsIntentName || b.includeDefaults {
+			result.SetValue(highestLe.Update.Value()).SetOwner(highestLe.Update.Owner())
+
+			// check if running equals the expected
+			runningLe := e.GetLeafVariantEntries().GetRunning()
+			if runningLe != nil {
+				if !proto.Equal(runningLe.Update.Value(), highestLe.Update.Value()) {
+					result.DeviationValue = runningLe.Value()
+				}
+			}
+		} else {
+			// if it is default but no default is meant to be returned
+			skipAdd = true
+		}
+	}
+	// add to the result tree as a child
+	if !skipAdd && len(b.stack) > 0 {
+		b.stack[len(b.stack)-1].AddChild(result)
+	}
+	// add to the stack as last element
+	b.stack = append(b.stack, result)
+	return nil
+}
+
+func (b *BlameConfigVisitor) Up() {
+	// sort to make te output stable
+	slices.SortFunc(b.stack[len(b.stack)-1].Childs, func(a *sdcpb.BlameTreeElement, b *sdcpb.BlameTreeElement) int {
+		return strings.Compare(a.GetName(), b.GetName())
+	})
+	// remove the last elem from stack
+	if len(b.stack) > 1 {
+		b.stack = b.stack[:len(b.stack)-1]
+	}
+}
+
+func (o *BlameConfigVisitor) DescendMethod() DescendMethod {
+	return DescendMethodAll
+}
+
+func (b *BlameConfigVisitor) GetResult() *sdcpb.BlameTreeElement {
+	if len(b.stack) == 1 {
+		return b.stack[0]
+	}
+	return nil
+}

pkg/tree/visitor_explicit_delete.go

@@ -5,6 +5,7 @@ import (
 )
 
 type ExplicitDeleteVisitor struct {
+	BaseVisitor
 	owner    string
 	priority int32
 
@@ -36,14 +37,6 @@ func (edv *ExplicitDeleteVisitor) Visit(ctx context.Context, e Entry) error {
 	return nil
 }
 
-func (edv *ExplicitDeleteVisitor) Up() {
-	// noop
-}
-
-func (o *ExplicitDeleteVisitor) Config() *EntryVisitorConfig {
-	return NewEntryVisitorConfig().SetDescendingMethod(DescendMethodAll)
-}
-
 // GetExplicitDeleteCreationCount returns the amount of all the explicitDelete LeafVariants that where created.
 func (edv *ExplicitDeleteVisitor) GetExplicitDeleteCreationCount() int {
 	return len(edv.relatedLeafVariants)

pkg/tree/visitor_explicit_delete_test.go

@@ -80,12 +80,12 @@ func TestExplicitDeleteVisitor_Visit(t *testing.T) {
 					t.Error(err)
 				}
 
-				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, owner1, owner1Prio, flagsNew)
+				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, owner1, owner1Prio, flagsExisting)
 				if err != nil {
 					t.Error(err)
 				}
 
-				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, RunningIntentName, RunningValuesPrio, flagsNew)
+				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, RunningIntentName, RunningValuesPrio, flagsExisting)
 				if err != nil {
 					t.Error(err)
 				}
@@ -126,12 +126,12 @@ func TestExplicitDeleteVisitor_Visit(t *testing.T) {
 					t.Error(err)
 				}
 
-				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, owner1, owner1Prio, flagsNew)
+				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, owner1, owner1Prio, flagsExisting)
 				if err != nil {
 					t.Error(err)
 				}
 
-				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, RunningIntentName, RunningValuesPrio, flagsNew)
+				err = testhelper.LoadYgotStructIntoTreeRoot(ctx, config1(), root, RunningIntentName, RunningValuesPrio, flagsExisting)
 				if err != nil {
 					t.Error(err)
 				}
@@ -190,14 +190,18 @@ func TestExplicitDeleteVisitor_Visit(t *testing.T) {
 				}
 			}
 
-			//
+			// get the resulting deletes
 			dels, err := root.GetDeletes(true)
 			if err != nil {
 				t.Error(err)
 				return
 			}
 			t.Logf("Deletes:\n%s", dels.PathSlices().StringSlice())
-			t.Errorf("foo")
+			updates := root.GetHighestPrecedence(true)
+
+			t.Logf("Updates:\n%s", updates.String())
+
+			t.Error(nil)
 		})
 	}
 }

pkg/tree/visitor_mark_owner_delete.go

@@ -0,0 +1,40 @@
+package tree
+
+import (
+	"context"
+)
+
+type MarkOwnerDeleteVisitor struct {
+	BaseVisitor
+	owner               string
+	onlyIntended        bool
+	leafVariantsMatched LeafVariantSlice
+}
+
+var _ EntryVisitor = (*MarkOwnerDeleteVisitor)(nil)
+
+func NewMarkOwnerDeleteVisitor(owner string, onlyIntended bool) *MarkOwnerDeleteVisitor {
+	return &MarkOwnerDeleteVisitor{
+		owner:               owner,
+		onlyIntended:        onlyIntended,
+		leafVariantsMatched: LeafVariantSlice{},
+	}
+}
+
+func (o *MarkOwnerDeleteVisitor) Visit(ctx context.Context, e Entry) error {
+	le := e.GetLeafVariantEntries().MarkOwnerForDeletion(o.owner, o.onlyIntended)
+	if le != nil {
+		o.leafVariantsMatched = append(o.leafVariantsMatched, le)
+	}
+	return nil
+}
+
+// GetHitCount returns the number of entries marked for deletion
+func (o *MarkOwnerDeleteVisitor) GetHitCount() int {
+	return len(o.leafVariantsMatched)
+}
+
+// GetMatches return all the altered LeafVariants
+func (o *MarkOwnerDeleteVisitor) GetMatches() LeafVariantSlice {
+	return o.leafVariantsMatched
+}