stripmeta.go 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. /*
  2. Copyright 2019 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package internal
  14. import (
  15. "fmt"
  16. "k8s.io/apimachinery/pkg/runtime"
  17. "sigs.k8s.io/structured-merge-diff/v4/fieldpath"
  18. )
  19. type stripMetaManager struct {
  20. fieldManager Manager
  21. // stripSet is the list of fields that should never be part of a mangedFields.
  22. stripSet *fieldpath.Set
  23. }
  24. var _ Manager = &stripMetaManager{}
  25. // NewStripMetaManager creates a new Manager that strips metadata and typemeta fields from the manager's fieldset.
  26. func NewStripMetaManager(fieldManager Manager) Manager {
  27. return &stripMetaManager{
  28. fieldManager: fieldManager,
  29. stripSet: fieldpath.NewSet(
  30. fieldpath.MakePathOrDie("apiVersion"),
  31. fieldpath.MakePathOrDie("kind"),
  32. fieldpath.MakePathOrDie("metadata"),
  33. fieldpath.MakePathOrDie("metadata", "name"),
  34. fieldpath.MakePathOrDie("metadata", "namespace"),
  35. fieldpath.MakePathOrDie("metadata", "creationTimestamp"),
  36. fieldpath.MakePathOrDie("metadata", "selfLink"),
  37. fieldpath.MakePathOrDie("metadata", "uid"),
  38. fieldpath.MakePathOrDie("metadata", "clusterName"),
  39. fieldpath.MakePathOrDie("metadata", "generation"),
  40. fieldpath.MakePathOrDie("metadata", "managedFields"),
  41. fieldpath.MakePathOrDie("metadata", "resourceVersion"),
  42. ),
  43. }
  44. }
  45. // Update implements Manager.
  46. func (f *stripMetaManager) Update(liveObj, newObj runtime.Object, managed Managed, manager string) (runtime.Object, Managed, error) {
  47. newObj, managed, err := f.fieldManager.Update(liveObj, newObj, managed, manager)
  48. if err != nil {
  49. return nil, nil, err
  50. }
  51. f.stripFields(managed.Fields(), manager)
  52. return newObj, managed, nil
  53. }
  54. // Apply implements Manager.
  55. func (f *stripMetaManager) Apply(liveObj, appliedObj runtime.Object, managed Managed, manager string, force bool) (runtime.Object, Managed, error) {
  56. newObj, managed, err := f.fieldManager.Apply(liveObj, appliedObj, managed, manager, force)
  57. if err != nil {
  58. return nil, nil, err
  59. }
  60. f.stripFields(managed.Fields(), manager)
  61. return newObj, managed, nil
  62. }
  63. // stripFields removes a predefined set of paths found in typed from managed
  64. func (f *stripMetaManager) stripFields(managed fieldpath.ManagedFields, manager string) {
  65. vs, ok := managed[manager]
  66. if ok {
  67. if vs == nil {
  68. panic(fmt.Sprintf("Found unexpected nil manager which should never happen: %s", manager))
  69. }
  70. newSet := vs.Set().Difference(f.stripSet)
  71. if newSet.Empty() {
  72. delete(managed, manager)
  73. } else {
  74. managed[manager] = fieldpath.NewVersionedSet(newSet, vs.APIVersion(), vs.Applied())
  75. }
  76. }
  77. }