strategicpatch

package
v0.31.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 19, 2024 License: Apache-2.0 Imports: 11 Imported by: 2,508

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateDeleteDirective 

func CreateDeleteDirective(mergeKey string, mergeKeyValue interface{}) map[string]interface{}

func CreateThreeWayMergePatch 

func CreateThreeWayMergePatch(original, modified, current []byte, schema LookupPatchMeta, overwrite bool, fns ...mergepatch.PreconditionFunc) ([]byte, error)

CreateThreeWayMergePatch reconciles a modified configuration with an original configuration, while preserving any changes or deletions made to the original configuration in the interim, and not overridden by the current configuration. All three documents must be passed to the method as json encoded content. It will return a strategic merge patch, or an error if any of the documents is invalid, or if there are any preconditions that fail against the modified configuration, or, if overwrite is false and there are conflicts between the modified and current configurations. Conflicts are defined as keys changed differently from original to modified than from original to current. In other words, a conflict occurs if modified changes any key in a way that is different from how it is changed in current (e.g., deleting it, changing its value). We also propagate values fields that do not exist in original but are explicitly defined in modified.

func CreateTwoWayMergePatch 

func CreateTwoWayMergePatch(original, modified []byte, dataStruct interface{}, fns ...mergepatch.PreconditionFunc) ([]byte, error)

CreateTwoWayMergePatch creates a patch that can be passed to StrategicMergePatch from an original document and a modified document, which are passed to the method as json encoded content. It will return a patch that yields the modified document when applied to the original document, or an error if either of the two documents is invalid.

func CreateTwoWayMergePatchUsingLookupPatchMeta 

func CreateTwoWayMergePatchUsingLookupPatchMeta(
	original, modified []byte, schema LookupPatchMeta, fns ...mergepatch.PreconditionFunc) ([]byte, error)

func GetTagStructTypeOrDie 

func GetTagStructTypeOrDie(dataStruct interface{}) reflect.Type

func ItemAddedToModifiedSlice 

func ItemAddedToModifiedSlice(original, modified string) bool

func ItemMatchesOriginalAndModifiedSlice 

func ItemMatchesOriginalAndModifiedSlice(original, modified string) bool

func ItemRemovedFromModifiedSlice 

func ItemRemovedFromModifiedSlice(original, modified string) bool

func MergingMapsHaveConflicts 

func MergingMapsHaveConflicts(left, right map[string]interface{}, schema LookupPatchMeta) (bool, error)

MergingMapsHaveConflicts returns true if the left and right JSON interface objects overlap with different values in any key. All keys are required to be strings. Since patches of the same Type have congruent keys, this is valid for multiple patch types. This method supports strategic merge patch semantics.

func NewKindItem 

func NewKindItem(key string, path *openapi.Path) *kindItem

func NewSliceItem 

func NewSliceItem(key string, path *openapi.Path) *sliceItem

func StrategicMergePatch 

func StrategicMergePatch(original, patch []byte, dataStruct interface{}) ([]byte, error)

StrategicMergePatch applies a strategic merge patch. The patch and the original document must be json encoded content. A patch can be created from an original and a modified document by calling CreateStrategicMergePatch.

func StrategicMergePatchUsingLookupPatchMeta 

func StrategicMergePatchUsingLookupPatchMeta(original, patch []byte, schema LookupPatchMeta) ([]byte, error)

Types

type DiffOptions 

type DiffOptions struct {
	// SetElementOrder determines whether we generate the $setElementOrder parallel list.
	SetElementOrder bool
	// IgnoreChangesAndAdditions indicates if we keep the changes and additions in the patch.
	IgnoreChangesAndAdditions bool
	// IgnoreDeletions indicates if we keep the deletions in the patch.
	IgnoreDeletions bool
	// We introduce a new value retainKeys for patchStrategy.
	// It indicates that all fields needing to be preserved must be
	// present in the `retainKeys` list.
	// And the fields that are present will be merged with live object.
	// All the missing fields will be cleared when patching.
	BuildRetainKeysDirective bool
}

type FieldNotFoundError 

type FieldNotFoundError struct {
	Path  string
	Field string
}

func (FieldNotFoundError) Error 

func (e FieldNotFoundError) Error() string

type InvalidTypeError 

type InvalidTypeError struct {
	Path     string
	Expected string
	Actual   string
}

func (InvalidTypeError) Error 

func (e InvalidTypeError) Error() string

type JSONMap 

type JSONMap map[string]interface{}

JSONMap is a representations of JSON object encoded as map[string]interface{} where the children can be either map[string]interface{}, []interface{} or primitive type). Operating on JSONMap representation is much faster as it doesn't require any json marshaling and/or unmarshaling operations.

func CreateTwoWayMergeMapPatch 

func CreateTwoWayMergeMapPatch(original, modified JSONMap, dataStruct interface{}, fns ...mergepatch.PreconditionFunc) (JSONMap, error)

CreateTwoWayMergeMapPatch creates a patch from an original and modified JSON objects, encoded JSONMap. The serialized version of the map can then be passed to StrategicMergeMapPatch.

func CreateTwoWayMergeMapPatchUsingLookupPatchMeta 

func CreateTwoWayMergeMapPatchUsingLookupPatchMeta(original, modified JSONMap, schema LookupPatchMeta, fns ...mergepatch.PreconditionFunc) (JSONMap, error)

func MergeStrategicMergeMapPatchUsingLookupPatchMeta 

func MergeStrategicMergeMapPatchUsingLookupPatchMeta(schema LookupPatchMeta, patches ...JSONMap) (JSONMap, error)

MergeStrategicMergeMapPatchUsingLookupPatchMeta merges strategic merge patches retaining `null` fields and parallel lists. If 2 patches change the same fields and the latter one will override the former one. If you don't want that happen, you need to run func MergingMapsHaveConflicts before merging these patches. Applying the resulting merged merge patch to a JSONMap yields the same as merging each strategic merge patch to the JSONMap in succession.

func StrategicMergeMapPatch 

func StrategicMergeMapPatch(original, patch JSONMap, dataStruct interface{}) (JSONMap, error)

StrategicMergeMapPatch applies a strategic merge patch. The original and patch documents must be JSONMap. A patch can be created from an original and modified document by calling CreateTwoWayMergeMapPatch. Warning: the original and patch JSONMap objects are mutated by this function and should not be reused.

func StrategicMergeMapPatchUsingLookupPatchMeta 

func StrategicMergeMapPatchUsingLookupPatchMeta(original, patch JSONMap, schema LookupPatchMeta) (JSONMap, error)

type LookupPatchItem 

type LookupPatchItem interface {
	openapi.SchemaVisitor

	Error() error
	Path() *openapi.Path
}

type LookupPatchMeta 

type LookupPatchMeta interface {
	// LookupPatchMetadataForStruct gets subschema and the patch metadata (e.g. patch strategy and merge key) for map.
	LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)
	// LookupPatchMetadataForSlice get subschema and the patch metadata for slice.
	LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)
	// Get the type name of the field
	Name() string
}

type LookupPatchMetaError 

type LookupPatchMetaError struct {
	Path string
	Err  error
}

func (LookupPatchMetaError) Error 

func (e LookupPatchMetaError) Error() string

type MergeOptions 

type MergeOptions struct {
	// MergeParallelList indicates if we are merging the parallel list.
	// We don't merge parallel list when calling mergeMap() in CreateThreeWayMergePatch()
	// which is called client-side.
	// We merge parallel list iff when calling mergeMap() in StrategicMergeMapPatch()
	// which is called server-side
	MergeParallelList bool
	// IgnoreUnmatchedNulls indicates if we should process the unmatched nulls.
	IgnoreUnmatchedNulls bool
}

type PatchMeta 

type PatchMeta struct {
	// contains filtered or unexported fields
}

func (*PatchMeta) GetPatchMergeKey 

func (pm *PatchMeta) GetPatchMergeKey() string

func (*PatchMeta) GetPatchStrategies 

func (pm *PatchMeta) GetPatchStrategies() []string

func (*PatchMeta) SetPatchMergeKey 

func (pm *PatchMeta) SetPatchMergeKey(pmk string)

func (*PatchMeta) SetPatchStrategies 

func (pm *PatchMeta) SetPatchStrategies(ps []string)

type PatchMetaFromOpenAPI 

type PatchMetaFromOpenAPI struct {
	Schema openapi.Schema
}

func NewPatchMetaFromOpenAPI 

func NewPatchMetaFromOpenAPI(s openapi.Schema) PatchMetaFromOpenAPI

func (PatchMetaFromOpenAPI) LookupPatchMetadataForSlice 

func (s PatchMetaFromOpenAPI) LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromOpenAPI) LookupPatchMetadataForStruct 

func (s PatchMetaFromOpenAPI) LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromOpenAPI) Name 

func (s PatchMetaFromOpenAPI) Name() string

type PatchMetaFromOpenAPIV3 added in v0.29.0 

type PatchMetaFromOpenAPIV3 struct {
	// SchemaList is required to resolve OpenAPI V3 references
	SchemaList map[string]*spec.Schema
	Schema     *spec.Schema
}

func (PatchMetaFromOpenAPIV3) LookupPatchMetadataForSlice added in v0.29.0 

func (s PatchMetaFromOpenAPIV3) LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromOpenAPIV3) LookupPatchMetadataForStruct added in v0.29.0 

func (s PatchMetaFromOpenAPIV3) LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromOpenAPIV3) Name added in v0.29.0 

func (s PatchMetaFromOpenAPIV3) Name() string

type PatchMetaFromStruct 

type PatchMetaFromStruct struct {
	T reflect.Type
}

func NewPatchMetaFromStruct 

func NewPatchMetaFromStruct(dataStruct interface{}) (PatchMetaFromStruct, error)

func (PatchMetaFromStruct) LookupPatchMetadataForSlice 

func (s PatchMetaFromStruct) LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromStruct) LookupPatchMetadataForStruct 

func (s PatchMetaFromStruct) LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromStruct) Name 

func (s PatchMetaFromStruct) Name() string

type SortableSliceOfMaps 

type SortableSliceOfMaps struct {
	// contains filtered or unexported fields
}

func (SortableSliceOfMaps) Len 

func (ss SortableSliceOfMaps) Len() int

func (SortableSliceOfMaps) Less 

func (ss SortableSliceOfMaps) Less(i, j int) bool

func (SortableSliceOfMaps) Swap 

func (ss SortableSliceOfMaps) Swap(i, j int)

type SortableSliceOfScalars 

type SortableSliceOfScalars struct {
	// contains filtered or unexported fields
}

func (SortableSliceOfScalars) Len 

func (ss SortableSliceOfScalars) Len() int

func (SortableSliceOfScalars) Less 

func (ss SortableSliceOfScalars) Less(i, j int) bool

func (SortableSliceOfScalars) Swap 

func (ss SortableSliceOfScalars) Swap(i, j int)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.