versionconverter.go

Documentation: k8s.io/apimachinery/pkg/util/managedfields/internal

     1  /*
     2  Copyright 2018 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 internal
    18  
    19  import (
    20  	"fmt"
    21  
    22  	"k8s.io/apimachinery/pkg/runtime"
    23  	"k8s.io/apimachinery/pkg/runtime/schema"
    24  	"sigs.k8s.io/structured-merge-diff/v4/fieldpath"
    25  	"sigs.k8s.io/structured-merge-diff/v4/merge"
    26  	"sigs.k8s.io/structured-merge-diff/v4/typed"
    27  )
    28  
    29  // versionConverter is an implementation of
    30  // sigs.k8s.io/structured-merge-diff/merge.Converter
    31  type versionConverter struct {
    32  	typeConverter   TypeConverter
    33  	objectConvertor runtime.ObjectConvertor
    34  	hubGetter       func(from schema.GroupVersion) schema.GroupVersion
    35  }
    36  
    37  var _ merge.Converter = &versionConverter{}
    38  
    39  // NewVersionConverter builds a VersionConverter from a TypeConverter and an ObjectConvertor.
    40  func newVersionConverter(t TypeConverter, o runtime.ObjectConvertor, h schema.GroupVersion) merge.Converter {
    41  	return &versionConverter{
    42  		typeConverter:   t,
    43  		objectConvertor: o,
    44  		hubGetter: func(from schema.GroupVersion) schema.GroupVersion {
    45  			return schema.GroupVersion{
    46  				Group:   from.Group,
    47  				Version: h.Version,
    48  			}
    49  		},
    50  	}
    51  }
    52  
    53  // NewCRDVersionConverter builds a VersionConverter for CRDs from a TypeConverter and an ObjectConvertor.
    54  func newCRDVersionConverter(t TypeConverter, o runtime.ObjectConvertor, h schema.GroupVersion) merge.Converter {
    55  	return &versionConverter{
    56  		typeConverter:   t,
    57  		objectConvertor: o,
    58  		hubGetter: func(from schema.GroupVersion) schema.GroupVersion {
    59  			return h
    60  		},
    61  	}
    62  }
    63  
    64  // Convert implements sigs.k8s.io/structured-merge-diff/merge.Converter
    65  func (v *versionConverter) Convert(object *typed.TypedValue, version fieldpath.APIVersion) (*typed.TypedValue, error) {
    66  	// Convert the smd typed value to a kubernetes object.
    67  	objectToConvert, err := v.typeConverter.TypedToObject(object)
    68  	if err != nil {
    69  		return object, err
    70  	}
    71  
    72  	// Parse the target groupVersion.
    73  	groupVersion, err := schema.ParseGroupVersion(string(version))
    74  	if err != nil {
    75  		return object, err
    76  	}
    77  
    78  	// If attempting to convert to the same version as we already have, just return it.
    79  	fromVersion := objectToConvert.GetObjectKind().GroupVersionKind().GroupVersion()
    80  	if fromVersion == groupVersion {
    81  		return object, nil
    82  	}
    83  
    84  	// Convert to internal
    85  	internalObject, err := v.objectConvertor.ConvertToVersion(objectToConvert, v.hubGetter(fromVersion))
    86  	if err != nil {
    87  		return object, err
    88  	}
    89  
    90  	// Convert the object into the target version
    91  	convertedObject, err := v.objectConvertor.ConvertToVersion(internalObject, groupVersion)
    92  	if err != nil {
    93  		return object, err
    94  	}
    95  
    96  	// Convert the object back to a smd typed value and return it.
    97  	return v.typeConverter.ObjectToTyped(convertedObject)
    98  }
    99  
   100  // IsMissingVersionError
   101  func (v *versionConverter) IsMissingVersionError(err error) bool {
   102  	return runtime.IsNotRegisteredError(err) || isNoCorrespondingTypeError(err)
   103  }
   104  
   105  type noCorrespondingTypeErr struct {
   106  	gvk schema.GroupVersionKind
   107  }
   108  
   109  func NewNoCorrespondingTypeError(gvk schema.GroupVersionKind) error {
   110  	return &noCorrespondingTypeErr{gvk: gvk}
   111  }
   112  
   113  func (k *noCorrespondingTypeErr) Error() string {
   114  	return fmt.Sprintf("no corresponding type for %v", k.gvk)
   115  }
   116  
   117  func isNoCorrespondingTypeError(err error) bool {
   118  	if err == nil {
   119  		return false
   120  	}
   121  	_, ok := err.(*noCorrespondingTypeErr)
   122  	return ok
   123  }
   124
View as plain text