Skip to content

Bug 1825944: kube_cloud_config: enforce the target key in config map to cloud.conf #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-robot merged 1 commit into from
Apr 21, 2020
Merged

Bug 1825944: kube_cloud_config: enforce the target key in config map to cloud.conf #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions pkg/operator/kube_cloud_config/aws.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ func awsTransformer(input *corev1.ConfigMap, key string, infra *configv1.Infrast
output := input.DeepCopy()
output.Namespace = operatorclient.GlobalMachineSpecifiedConfigNamespace
output.Name = targetConfigName
delete(output.Data, key)
delete(output.BinaryData, key)

inCfgRaw := &bytes.Buffer{}
if v, ok := input.Data[key]; ok {
Expand Down Expand Up @@ -68,14 +70,14 @@ func awsTransformer(input *corev1.ConfigMap, key string, infra *configv1.Infrast
}

if _, ok := input.Data[key]; ok {
output.Data[key] = inCfgRaw.String() // store the config to same as input
output.Data[targetConfigKey] = inCfgRaw.String() // store the config to same as input
} else if _, ok := input.BinaryData[key]; ok {
output.BinaryData[key] = inCfgRaw.Bytes() // store the config to same as input
output.BinaryData[targetConfigKey] = inCfgRaw.Bytes() // store the config to same as input
} else {
if output.Data == nil {
output.Data = map[string]string{}
}
output.Data[key] = inCfgRaw.String() // store the new config to input key
output.Data[targetConfigKey] = inCfgRaw.String() // store the new config to input key
}

return output, nil
Expand Down
22 changes: 11 additions & 11 deletions pkg/operator/kube_cloud_config/aws_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ func Test_awsTransformer(t *testing.T) {
err: `invalid platform, expected to be AWS`,
}, {
name: "non empty config map, non aws infra",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `{"resource-group": "test-rg"}`}},
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `{"resource-group": "test-rg"}`}},
inputinfra: &configv1.Infrastructure{Status: configv1.InfrastructureStatus{Platform: configv1.AzurePlatformType, PlatformStatus: &configv1.PlatformStatus{Type: configv1.AzurePlatformType, Azure: &configv1.AzurePlatformStatus{ResourceGroupName: "test-rg"}}}},

outputcm: nil,
Expand All @@ -125,7 +125,7 @@ func Test_awsTransformer(t *testing.T) {
err: ``,
}, {
name: "non empty config map, aws infra",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `[Global]
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test
`}},
Expand All @@ -151,7 +151,7 @@ SubnetID = subnet-test
err: ``,
}, {
name: "non empty config map, aws infra with service endpoints",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `[Global]
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test
`}},
Expand Down Expand Up @@ -189,7 +189,7 @@ SubnetID = subnet-test
err: ``,
}, {
name: "non empty config map, aws infra with service endpoints",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `[Global]
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test
`}},
Expand Down Expand Up @@ -221,7 +221,7 @@ SubnetID = subnet-test
err: `status\.platformStatus\.aws\.region: Required value: region is required to be set for AWS platform`,
}, {
name: "non empty config map, aws infra with service endpoints, no region",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `[Global]
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test
`}},
Expand All @@ -231,7 +231,7 @@ SubnetID = subnet-test
err: `status\.platformStatus\.aws\.region: Required value: region is required to be set for AWS platform`,
}, {
name: "non empty config map, aws infra with service endpoints",
inputcm: &corev1.ConfigMap{BinaryData: map[string][]byte{"cloud.conf": []byte(`[Global]
inputcm: &corev1.ConfigMap{BinaryData: map[string][]byte{"config": []byte(`[Global]
VPC = vpc-test
SubnetID = subnet-test
`)}},
Expand All @@ -254,7 +254,7 @@ SubnetID = subnet-test
"cloud.ca": `-----BUNDLE-----
-----END BUNDLE----
`,
"cloud.conf": `[Global]
"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test
`}},
Expand All @@ -278,7 +278,7 @@ SubnetID = subnet-test
}, {
name: "non empty config map, aws infra with service endpoints",
inputcm: &corev1.ConfigMap{
Data: map[string]string{"cloud.conf": `[Global]
Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test
`},
Expand Down Expand Up @@ -306,7 +306,7 @@ SubnetID = subnet-test
err: ``,
}, {
name: "non empty config map, aws infra with service endpoints, conflict",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `[Global]
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test

Expand All @@ -322,7 +322,7 @@ SubnetID = subnet-test
err: `invalid user provided cloud.conf: user provided cloud.conf and infrastructure object both include service overrides`,
}, {
name: "non empty config map, aws infra with service endpoints, conflict",
inputcm: &corev1.ConfigMap{Data: map[string]string{"cloud.conf": `[Global]
inputcm: &corev1.ConfigMap{Data: map[string]string{"config": `[Global]
VPC = vpc-test
SubnetID = subnet-test

Expand All @@ -340,7 +340,7 @@ SubnetID = subnet-test

for _, test := range cases {
t.Run(test.name, func(t *testing.T) {
outputcm, err := awsTransformer(test.inputcm, "cloud.conf", test.inputinfra)
outputcm, err := awsTransformer(test.inputcm, "config", test.inputinfra)
if test.err == "" {
assert.NoError(t, err)
outputcm.ObjectMeta = metav1.ObjectMeta{}
Expand Down
17 changes: 15 additions & 2 deletions pkg/operator/kube_cloud_config/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,19 @@ func (c KubeCloudConfigController) sync(ctx context.Context, syncCtx factory.Syn
}

// asIsTransformer implements cloudConfigTransformer and copies the input ConfigMap as-is to the output ConfigMap.
func asIsTransformer(input *corev1.ConfigMap, _ string, _ *configv1.Infrastructure) (*corev1.ConfigMap, error) {
return input.DeepCopy(), nil
// this ensure that the input cloud conf is stored at `targetConfigKey` for the output.
func asIsTransformer(input *corev1.ConfigMap, sourceKey string, _ *configv1.Infrastructure) (*corev1.ConfigMap, error) {
output := input.DeepCopy()
output.Namespace = operatorclient.GlobalMachineSpecifiedConfigNamespace
output.Name = targetConfigName
delete(output.Data, sourceKey)
delete(output.BinaryData, sourceKey)

if vd, ok := input.Data[sourceKey]; ok {
output.Data[targetConfigKey] = vd // store the config to same as input
} else if vbd, ok := input.BinaryData[sourceKey]; ok {
output.BinaryData[targetConfigKey] = vbd // store the config to same as input
}

return output, nil
}
79 changes: 79 additions & 0 deletions pkg/operator/kube_cloud_config/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
package kube_cloud_config

import (
"testing"

"github.com/openshift/cluster-config-operator/pkg/operator/operatorclient"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func Test_asIsTransformer(t *testing.T) {
cases := []struct {
input, output *corev1.ConfigMap
}{{
input: &corev1.ConfigMap{},
output: &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace}},
}, {
input: &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "something", Namespace: "something-else"}},
output: &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace}},
}, {
input: &corev1.ConfigMap{
Data: map[string]string{"config": "someval"},
},
output: &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace},
Data: map[string]string{"cloud.conf": "someval"},
},
}, {
input: &corev1.ConfigMap{
BinaryData: map[string][]byte{"config": []byte("someval")},
},
output: &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace},
BinaryData: map[string][]byte{"cloud.conf": []byte("someval")},
},
}, {
input: &corev1.ConfigMap{
Data: map[string]string{"config": "someval", "ca-bundle": "bundle"},
},
output: &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace},
Data: map[string]string{"cloud.conf": "someval", "ca-bundle": "bundle"},
},
}, {
input: &corev1.ConfigMap{
Data: map[string]string{"config": "someval"},
BinaryData: map[string][]byte{"ca-bundle": []byte("bundle")},
},
output: &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace},
Data: map[string]string{"cloud.conf": "someval"},
BinaryData: map[string][]byte{"ca-bundle": []byte("bundle")},
},
}, {
input: &corev1.ConfigMap{
Data: map[string]string{"ca-bundle": "bundle"},
},
output: &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace},
Data: map[string]string{"ca-bundle": "bundle"},
},
}, {
input: &corev1.ConfigMap{
BinaryData: map[string][]byte{"ca-bundle": []byte("bundle")},
},
output: &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: targetConfigName, Namespace: operatorclient.GlobalMachineSpecifiedConfigNamespace},
BinaryData: map[string][]byte{"ca-bundle": []byte("bundle")},
},
}}
for _, test := range cases {
t.Run("", func(t *testing.T) {
got, err := asIsTransformer(test.input, "config", nil)
assert.NoError(t, err)
assert.EqualValues(t, test.output, got)
})
}
}