multitransformer.go 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. /*
  2. Copyright 2018 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 transformers
  14. import (
  15. "fmt"
  16. "sigs.k8s.io/kustomize/pkg/resource"
  17. "sigs.k8s.io/kustomize/pkg/resmap"
  18. )
  19. // multiTransformer contains a list of transformers.
  20. type multiTransformer struct {
  21. transformers []Transformer
  22. checkConflictEnabled bool
  23. rf *resource.Factory
  24. }
  25. var _ Transformer = &multiTransformer{}
  26. // NewMultiTransformer constructs a multiTransformer.
  27. func NewMultiTransformer(t []Transformer) Transformer {
  28. r := &multiTransformer{
  29. transformers: make([]Transformer, len(t)),
  30. checkConflictEnabled: false}
  31. copy(r.transformers, t)
  32. return r
  33. }
  34. // NewMultiTransformerWithConflictCheck constructs a multiTransformer with checking of conflicts.
  35. func NewMultiTransformerWithConflictCheck(t []Transformer) Transformer {
  36. r := &multiTransformer{
  37. transformers: make([]Transformer, len(t)),
  38. checkConflictEnabled: true}
  39. copy(r.transformers, t)
  40. return r
  41. }
  42. // Transform prepends the name prefix.
  43. func (o *multiTransformer) Transform(m resmap.ResMap) error {
  44. if o.checkConflictEnabled {
  45. return o.transformWithCheckConflict(m)
  46. }
  47. return o.transform(m)
  48. }
  49. func (o *multiTransformer) transform(m resmap.ResMap) error {
  50. for _, t := range o.transformers {
  51. err := t.Transform(m)
  52. if err != nil {
  53. return err
  54. }
  55. }
  56. return nil
  57. }
  58. // Of the len(o.transformers)! possible transformer orderings, compare to a reversed order.
  59. // A spot check to perform when the transformations are supposed to be commutative.
  60. // Fail if there's a difference in the result.
  61. func (o *multiTransformer) transformWithCheckConflict(m resmap.ResMap) error {
  62. mcopy := m.DeepCopy(o.rf)
  63. err := o.transform(m)
  64. if err != nil {
  65. return err
  66. }
  67. o.reverseTransformers()
  68. err = o.transform(mcopy)
  69. if err != nil {
  70. return err
  71. }
  72. err = m.ErrorIfNotEqual(mcopy)
  73. if err != nil {
  74. return fmt.Errorf("found conflict between different patches\n%v", err)
  75. }
  76. return nil
  77. }
  78. func (o *multiTransformer) reverseTransformers() {
  79. for i, j := 0, len(o.transformers)-1; i < j; i, j = i+1, j-1 {
  80. o.transformers[i], o.transformers[j] = o.transformers[j], o.transformers[i]
  81. }
  82. }