managedfields.go

Documentation: k8s.io/cli-runtime/pkg/printers

     1  /*
     2  Copyright 2021 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package printers
    18  
    19  import (
    20  	"io"
    21  
    22  	"k8s.io/apimachinery/pkg/api/meta"
    23  	"k8s.io/apimachinery/pkg/runtime"
    24  )
    25  
    26  // OmitManagedFieldsPrinter wraps an existing printer and omits the managed fields from the object
    27  // before printing it.
    28  type OmitManagedFieldsPrinter struct {
    29  	Delegate ResourcePrinter
    30  }
    31  
    32  var _ ResourcePrinter = (*OmitManagedFieldsPrinter)(nil)
    33  
    34  func omitManagedFields(o runtime.Object) runtime.Object {
    35  	a, err := meta.Accessor(o)
    36  	if err != nil {
    37  		// The object is not a `metav1.Object`, ignore it.
    38  		return o
    39  	}
    40  	a.SetManagedFields(nil)
    41  	return o
    42  }
    43  
    44  // PrintObj copies the object and omits the managed fields from the copied object before printing it.
    45  func (p *OmitManagedFieldsPrinter) PrintObj(obj runtime.Object, w io.Writer) error {
    46  	if obj == nil {
    47  		return p.Delegate.PrintObj(obj, w)
    48  	}
    49  	if meta.IsListType(obj) {
    50  		obj = obj.DeepCopyObject()
    51  		_ = meta.EachListItem(obj, func(item runtime.Object) error {
    52  			omitManagedFields(item)
    53  			return nil
    54  		})
    55  	} else if _, err := meta.Accessor(obj); err == nil {
    56  		obj = omitManagedFields(obj.DeepCopyObject())
    57  	}
    58  	return p.Delegate.PrintObj(obj, w)
    59  }
    60
View as plain text