Add yaml outputs of resources to streaming logs and add import&update steps to uptest #136
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Let's put a YAML comment at the top of this file telling that this assert step belongs to the resource update test. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,19 @@ | ||
| # This assert file belongs to the resource update step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: {{ .TestCase.Timeout }} | ||
| commands: | ||
| - script: echo "Dump MR manifests for the update assertion step:"; ${KUBECTL} get managed -o yaml | ||
| {{- range $resource := .Resources }} | ||
| {{- if eq $resource.UpdateParameter "" -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- if eq $resource.KindGroup "secret." -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- if not $resource.Namespace }} | ||
| {{- if $resource.Root }} | ||
| - script: ${KUBECTL} get {{ $resource.KindGroup }}/{{ $resource.Name }} -o=jsonpath='{.status.atProvider{{ $resource.UpdateAssertKey }}}' | grep -q "^{{ $resource.UpdateAssertValue }}$" | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} |
sergenyalcin marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # This file belongs to the resource update step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| {{- range $resource := .Resources }} | ||
| {{- if eq $resource.UpdateParameter "" -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- if eq $resource.KindGroup "secret." -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- if not $resource.Namespace }} | ||
|
There was a problem hiding this comment. In the next iteration, we can consider adding claim update tests. |
||
| {{- if $resource.Root }} | ||
| - command: ${KUBECTL} patch {{ $resource.KindGroup }}/{{ $resource.Name }} --type=merge -p '{"spec":{"forProvider":{{ $resource.UpdateParameter }}}}' | ||
|
There was a problem hiding this comment. nit: We constrain the update parameter to be a direct child of There was a problem hiding this comment. We had better only patch the target manifest in the update tests. |
||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # This assert file belongs to the resource import step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: {{ .TestCase.Timeout }} | ||
| commands: | ||
| - script: echo "Dump MR manifests for the import assertion step:"; ${KUBECTL} get managed -o yaml | ||
| {{- range $resource := .Resources }} | ||
| {{- if eq $resource.KindGroup "secret." -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- range $condition := $resource.Conditions }} | ||
| {{- if not $resource.Namespace }} | ||
| - command: ${KUBECTL} wait {{ $resource.KindGroup }}/{{ $resource.Name }} --for=condition={{ $condition }} --timeout 10s | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- if not $resource.Namespace }} | ||
| - script: new_id=$(${KUBECTL} get {{ $resource.KindGroup }}/{{ $resource.Name }} -o=jsonpath='{.status.atProvider.id}') && old_id=$(${KUBECTL} get {{ $resource.KindGroup }}/{{ $resource.Name }} -o=jsonpath='{.metadata.annotations.uptest-old-id}') && [ "$new_id" == "$old_id" ] | ||
| {{- end }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # This file belongs to the resource import step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| - command: ${KUBECTL} scale deployment crossplane -n upbound-system --replicas=0 | ||
| - script: ${KUBECTL} -n upbound-system get deploy --no-headers -o custom-columns=":metadata.name" | grep "provider-" | xargs ${KUBECTL} -n upbound-system scale deploy --replicas=0 | ||
| {{- range $resource := .Resources }} | ||
| {{- if eq $resource.KindGroup "secret." -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- if not $resource.Namespace }} | ||
| - command: ${KUBECTL} --subresource=status patch {{ $resource.KindGroup }}/{{ $resource.Name }} --type=merge -p '{"status":{"conditions":[]}}' | ||
| - script: ${KUBECTL} annotate {{ $resource.KindGroup }}/{{ $resource.Name }} uptest-old-id=$(${KUBECTL} get {{ $resource.KindGroup }}/{{ $resource.Name }} -o=jsonpath='{.status.atProvider.id}') --overwrite | ||
|
Comment on lines
+12
to
+13
There was a problem hiding this comment. nit: We have better scale the provider deployment down before updating the status and putting the annotation here. |
||
| {{- end }} | ||
| {{- end }} | ||
| - command: ${KUBECTL} scale deployment crossplane -n upbound-system --replicas=1 | ||
| - script: ${KUBECTL} -n upbound-system get deploy --no-headers -o custom-columns=":metadata.name" | grep "provider-" | xargs ${KUBECTL} -n upbound-system scale deploy --replicas=1 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # This assert file belongs to the resource delete step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: {{ .TestCase.Timeout }} | ||
| commands: | ||
| - script: echo "Dump MR manifests for the delete assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - script: echo "Dump Claim manifests for the delete assertion step:" || ${KUBECTL} get claim --all-namespaces -o yaml | ||
| {{- range $resource := .Resources }} | ||
| {{- if eq $resource.KindGroup "secret." -}} | ||
| {{continue}} | ||
| {{- end -}} | ||
| {{- if $resource.Namespace }} | ||
| - script: ${KUBECTL} wait {{ $resource.KindGroup }}/{{ $resource.Name }} --for=delete --timeout 10s --namespace {{ $resource.Namespace }} | ||
| {{- else }} | ||
| - command: ${KUBECTL} wait {{ $resource.KindGroup }}/{{ $resource.Name }} --for=delete --timeout 10s | ||
| {{- end }} | ||
| {{- end }} | ||
| - command: ${KUBECTL} wait managed --all --for=delete --timeout 10s | ||
| {{- if .TestCase.TeardownScriptPath }} | ||
| - command: {{ .TestCase.TeardownScriptPath }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # This file belongs to the resource delete step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,8 +28,12 @@ import ( | |
| var fileTemplates = map[string]string{ | ||
| "00-apply.yaml": inputFileTemplate, | ||
| "00-assert.yaml": assertFileTemplate, | ||
| "01-update.yaml": updateFileTemplate, | ||
| "01-assert.yaml": assertUpdatedFileTemplate, | ||
| "02-import.yaml": importFileTemplate, | ||
| "02-assert.yaml": assertImportedFileTemplate, | ||
| "03-delete.yaml": deleteFileTemplate, | ||
| "03-assert.yaml": assertDeletedFileTemplate, | ||
| } | ||
|
|
||
| // Render renders the specified list of resources as a test case | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -84,25 +84,65 @@ func TestRender(t *testing.T) { | |
| }, | ||
| want: want{ | ||
| out: map[string]string{ | ||
| "00-apply.yaml": "# This file belongs to the resource apply step.\n---\n" + bucketManifest, | ||
| "00-assert.yaml": `# This assert file belongs to the resource apply step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - command: ${KUBECTL} annotate managed --all upjet.upbound.io/test=true --overwrite | ||
| - script: echo "Dump MR manifests for the apply assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - script: echo "Dump Claim manifests for the apply assertion step:" || ${KUBECTL} get claim --all-namespaces -o yaml | ||
| - command: ${KUBECTL} wait s3.aws.upbound.io/example-bucket --for=condition=Test --timeout 10s | ||
| `, | ||
| "01-update.yaml": `# This file belongs to the resource update step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| `, | ||
| "01-assert.yaml": `# This assert file belongs to the resource update step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - script: echo "Dump MR manifests for the update assertion step:"; ${KUBECTL} get managed -o yaml | ||
| `, | ||
| "02-assert.yaml": `# This assert file belongs to the resource import step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - script: echo "Dump MR manifests for the import assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - command: ${KUBECTL} wait s3.aws.upbound.io/example-bucket --for=condition=Test --timeout 10s | ||
| - script: new_id=$(${KUBECTL} get s3.aws.upbound.io/example-bucket -o=jsonpath='{.status.atProvider.id}') && old_id=$(${KUBECTL} get s3.aws.upbound.io/example-bucket -o=jsonpath='{.metadata.annotations.uptest-old-id}') && [ "$new_id" == "$old_id" ] | ||
| `, | ||
| "02-import.yaml": `# This file belongs to the resource import step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| - command: ${KUBECTL} scale deployment crossplane -n upbound-system --replicas=0 | ||
| - script: ${KUBECTL} -n upbound-system get deploy --no-headers -o custom-columns=":metadata.name" | grep "provider-" | xargs ${KUBECTL} -n upbound-system scale deploy --replicas=0 | ||
| - command: ${KUBECTL} --subresource=status patch s3.aws.upbound.io/example-bucket --type=merge -p '{"status":{"conditions":[]}}' | ||
| - script: ${KUBECTL} annotate s3.aws.upbound.io/example-bucket uptest-old-id=$(${KUBECTL} get s3.aws.upbound.io/example-bucket -o=jsonpath='{.status.atProvider.id}') --overwrite | ||
| - command: ${KUBECTL} scale deployment crossplane -n upbound-system --replicas=1 | ||
| - script: ${KUBECTL} -n upbound-system get deploy --no-headers -o custom-columns=":metadata.name" | grep "provider-" | xargs ${KUBECTL} -n upbound-system scale deploy --replicas=1 | ||
| `, | ||
|
|
||
| "03-assert.yaml": `# This assert file belongs to the resource delete step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - script: echo "Dump MR manifests for the delete assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - script: echo "Dump Claim manifests for the delete assertion step:" || ${KUBECTL} get claim --all-namespaces -o yaml | ||
| - command: ${KUBECTL} wait s3.aws.upbound.io/example-bucket --for=delete --timeout 10s | ||
| - command: ${KUBECTL} wait managed --all --for=delete --timeout 10s | ||
| `, | ||
| "03-delete.yaml": `# This file belongs to the resource delete step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| - command: ${KUBECTL} delete s3.aws.upbound.io/example-bucket --wait=false --ignore-not-found | ||
| `, | ||
| }, | ||
| }, | ||
|
|
@@ -142,38 +182,78 @@ commands: | |
| }, | ||
| want: want{ | ||
| out: map[string]string{ | ||
| "00-apply.yaml": `# This file belongs to the resource apply step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| - command: /tmp/setup.sh | ||
| ` + "---\n" + bucketManifest + "---\n" + claimManifest + "---\n" + secretManifest, | ||
| "00-assert.yaml": `# This assert file belongs to the resource apply step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - command: ${KUBECTL} annotate managed --all upjet.upbound.io/test=true --overwrite | ||
| - script: echo "Dump MR manifests for the apply assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - script: echo "Dump Claim manifests for the apply assertion step:" || ${KUBECTL} get claim --all-namespaces -o yaml | ||
| - command: /tmp/bucket/pre-assert.sh | ||
| - command: ${KUBECTL} wait s3.aws.upbound.io/example-bucket --for=condition=Test --timeout 10s | ||
| - command: ${KUBECTL} wait cluster.gcp.platformref.upbound.io/test-cluster-claim --for=condition=Ready --timeout 10s --namespace upbound-system | ||
| - command: ${KUBECTL} wait cluster.gcp.platformref.upbound.io/test-cluster-claim --for=condition=Synced --timeout 10s --namespace upbound-system | ||
| - command: /tmp/claim/post-assert.sh | ||
| `, | ||
| "01-update.yaml": `# This file belongs to the resource update step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| `, | ||
| "01-assert.yaml": `# This assert file belongs to the resource update step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - script: echo "Dump MR manifests for the update assertion step:"; ${KUBECTL} get managed -o yaml | ||
| `, | ||
| "02-assert.yaml": `# This assert file belongs to the resource import step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - script: echo "Dump MR manifests for the import assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - command: ${KUBECTL} wait s3.aws.upbound.io/example-bucket --for=condition=Test --timeout 10s | ||
| - script: new_id=$(${KUBECTL} get s3.aws.upbound.io/example-bucket -o=jsonpath='{.status.atProvider.id}') && old_id=$(${KUBECTL} get s3.aws.upbound.io/example-bucket -o=jsonpath='{.metadata.annotations.uptest-old-id}') && [ "$new_id" == "$old_id" ] | ||
| `, | ||
| "02-import.yaml": `# This file belongs to the resource import step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| - command: ${KUBECTL} scale deployment crossplane -n upbound-system --replicas=0 | ||
| - script: ${KUBECTL} -n upbound-system get deploy --no-headers -o custom-columns=":metadata.name" | grep "provider-" | xargs ${KUBECTL} -n upbound-system scale deploy --replicas=0 | ||
| - command: ${KUBECTL} --subresource=status patch s3.aws.upbound.io/example-bucket --type=merge -p '{"status":{"conditions":[]}}' | ||
| - script: ${KUBECTL} annotate s3.aws.upbound.io/example-bucket uptest-old-id=$(${KUBECTL} get s3.aws.upbound.io/example-bucket -o=jsonpath='{.status.atProvider.id}') --overwrite | ||
| - command: ${KUBECTL} scale deployment crossplane -n upbound-system --replicas=1 | ||
| - script: ${KUBECTL} -n upbound-system get deploy --no-headers -o custom-columns=":metadata.name" | grep "provider-" | xargs ${KUBECTL} -n upbound-system scale deploy --replicas=1 | ||
| `, | ||
| "03-assert.yaml": `# This assert file belongs to the resource delete step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestAssert | ||
| timeout: 10 | ||
| commands: | ||
| - script: echo "Dump MR manifests for the delete assertion step:"; ${KUBECTL} get managed -o yaml | ||
| - script: echo "Dump Claim manifests for the delete assertion step:" || ${KUBECTL} get claim --all-namespaces -o yaml | ||
| - command: ${KUBECTL} wait s3.aws.upbound.io/example-bucket --for=delete --timeout 10s | ||
| - script: ${KUBECTL} wait cluster.gcp.platformref.upbound.io/test-cluster-claim --for=delete --timeout 10s --namespace upbound-system | ||
| - command: ${KUBECTL} wait managed --all --for=delete --timeout 10s | ||
| - command: /tmp/teardown.sh | ||
| `, | ||
| "03-delete.yaml": `# This file belongs to the resource delete step. | ||
| apiVersion: kuttl.dev/v1beta1 | ||
| kind: TestStep | ||
| commands: | ||
| - command: ${KUBECTL} delete s3.aws.upbound.io/example-bucket --wait=false --ignore-not-found | ||
| - command: /tmp/bucket/post-delete.sh | ||
| - command: /tmp/claim/pre-delete.sh | ||
| - command: ${KUBECTL} delete cluster.gcp.platformref.upbound.io/test-cluster-claim --wait=false --namespace upbound-system --ignore-not-found | ||
| `, | ||
| }, | ||
| }, | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: We may consider adding a description to the new parameter.
Let's also document that the update parameter should be a serialized JSON object and if the JSON object has nested children, then there must be only one leaf.