Merge pull request #114959 from ncdc/make-cr-conversions-safer

CR conversion: protect from converter input edits
This commit is contained in:
Kubernetes Prow Robot 2023-01-10 12:05:37 -08:00 committed by GitHub
commit f1e74f77ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 88 additions and 3 deletions

View File

@ -245,6 +245,11 @@ func (c *delegatingCRConverter) ConvertToVersion(in runtime.Object, target runti
return converted, nil return converted, nil
} }
// Deep copy the list before we invoke the converter to ensure that if the converter does mutate the
// list (which it shouldn't, but you never know), it doesn't have any impact.
convertedList := list.DeepCopy()
convertedList.SetAPIVersion(desiredAPIVersion)
convertedObjects, err := c.converter.Convert(list, toGVK.GroupVersion()) convertedObjects, err := c.converter.Convert(list, toGVK.GroupVersion())
if err != nil { if err != nil {
return nil, fmt.Errorf("conversion for %v failed: %w", in.GetObjectKind().GroupVersionKind(), err) return nil, fmt.Errorf("conversion for %v failed: %w", in.GetObjectKind().GroupVersionKind(), err)
@ -253,10 +258,8 @@ func (c *delegatingCRConverter) ConvertToVersion(in runtime.Object, target runti
return nil, fmt.Errorf("conversion for %v returned %d objects, expected %d", in.GetObjectKind().GroupVersionKind(), len(convertedObjects.Items), len(objectsToConvert)) return nil, fmt.Errorf("conversion for %v returned %d objects, expected %d", in.GetObjectKind().GroupVersionKind(), len(convertedObjects.Items), len(objectsToConvert))
} }
// start a deepcopy of the input and fill in the converted objects from the response at the right spots. // Fill in the converted objects from the response at the right spots.
// The response list might be sparse because objects had the right version already. // The response list might be sparse because objects had the right version already.
convertedList := list.DeepCopy()
convertedList.SetAPIVersion(desiredAPIVersion)
convertedIndex := 0 convertedIndex := 0
for i := range convertedList.Items { for i := range convertedList.Items {
original := &convertedList.Items[i] original := &convertedList.Items[i]

View File

@ -46,6 +46,7 @@ func TestConversion(t *testing.T) {
SourceObject: &unstructured.Unstructured{ SourceObject: &unstructured.Unstructured{
Object: map[string]interface{}{ Object: map[string]interface{}{
"apiVersion": "example.com/v1", "apiVersion": "example.com/v1",
"metadata": map[string]interface{}{},
"other": "data", "other": "data",
"kind": "foo", "kind": "foo",
}, },
@ -53,6 +54,7 @@ func TestConversion(t *testing.T) {
ExpectedObject: &unstructured.Unstructured{ ExpectedObject: &unstructured.Unstructured{
Object: map[string]interface{}{ Object: map[string]interface{}{
"apiVersion": "example.com/v2", "apiVersion": "example.com/v2",
"metadata": map[string]interface{}{},
"other": "data", "other": "data",
"kind": "foo", "kind": "foo",
}, },
@ -86,6 +88,7 @@ func TestConversion(t *testing.T) {
{ {
Object: map[string]interface{}{ Object: map[string]interface{}{
"apiVersion": "example.com/v1", "apiVersion": "example.com/v1",
"metadata": map[string]interface{}{},
"kind": "foo", "kind": "foo",
"other": "data", "other": "data",
}, },
@ -93,6 +96,7 @@ func TestConversion(t *testing.T) {
{ {
Object: map[string]interface{}{ Object: map[string]interface{}{
"apiVersion": "example.com/v1", "apiVersion": "example.com/v1",
"metadata": map[string]interface{}{},
"kind": "foo", "kind": "foo",
"other": "data2", "other": "data2",
}, },
@ -108,6 +112,7 @@ func TestConversion(t *testing.T) {
{ {
Object: map[string]interface{}{ Object: map[string]interface{}{
"apiVersion": "example.com/v2", "apiVersion": "example.com/v2",
"metadata": map[string]interface{}{},
"kind": "foo", "kind": "foo",
"other": "data", "other": "data",
}, },
@ -115,6 +120,7 @@ func TestConversion(t *testing.T) {
{ {
Object: map[string]interface{}{ Object: map[string]interface{}{
"apiVersion": "example.com/v2", "apiVersion": "example.com/v2",
"metadata": map[string]interface{}{},
"kind": "foo", "kind": "foo",
"other": "data2", "other": "data2",
}, },
@ -288,3 +294,79 @@ func TestGetObjectsToConvert(t *testing.T) {
}) })
} }
} }
func TestConverterMutatesInput(t *testing.T) {
testCRD := apiextensionsv1.CustomResourceDefinition{
Spec: apiextensionsv1.CustomResourceDefinitionSpec{
Conversion: &apiextensionsv1.CustomResourceConversion{
Strategy: apiextensionsv1.NoneConverter,
},
Group: "test.k8s.io",
Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
{
Name: "v1alpha1",
Served: true,
},
{
Name: "v1alpha2",
Served: true,
},
},
},
}
safeConverter, _, err := NewDelegatingConverter(&testCRD, &inputMutatingConverter{})
if err != nil {
t.Fatalf("Cannot create converter: %v", err)
}
input := &unstructured.UnstructuredList{
Object: map[string]interface{}{
"apiVersion": "test.k8s.io/v1alpha1",
},
Items: []unstructured.Unstructured{
{
Object: map[string]interface{}{
"apiVersion": "test.k8s.io/v1alpha1",
"metadata": map[string]interface{}{
"name": "item1",
},
},
},
{
Object: map[string]interface{}{
"apiVersion": "test.k8s.io/v1alpha1",
"metadata": map[string]interface{}{
"name": "item2",
},
},
},
},
}
toVersion, _ := schema.ParseGroupVersion("test.k8s.io/v1alpha2")
toVersions := schema.GroupVersions{toVersion}
converted, err := safeConverter.ConvertToVersion(input, toVersions)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
convertedList := converted.(*unstructured.UnstructuredList)
if e, a := 2, len(convertedList.Items); e != a {
t.Fatalf("length: expected %d, got %d", e, a)
}
}
type inputMutatingConverter struct{}
func (i *inputMutatingConverter) Convert(in *unstructured.UnstructuredList, targetGVK schema.GroupVersion) (*unstructured.UnstructuredList, error) {
out := &unstructured.UnstructuredList{}
for _, obj := range in.Items {
u := obj.DeepCopy()
u.SetAPIVersion(targetGVK.String())
out.Items = append(out.Items, *u)
}
in.Items = nil
return out, nil
}