Add provider defined functions for encoding and decoding Kubernetes manifests #2428
Conversation
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
SarahFrench
reviewed
Feb 20, 2024
There was a problem hiding this comment.
I'm assuming it's too early to review for real, but something that could be added in internal/framework/provider/provider.go is
// Ensure KubernetesProvider satisfies various provider interfaces.
var _ provider.Provider = &KubernetesProvider{}
+ var _ provider.ProviderWithFunctions = &KubernetesProvider{}
austinvalle
reviewed
Mar 1, 2024
internal/framework/provider/functions/manifest_decode_multi_test.go
Outdated
Show resolved
Hide resolved
| return types.TupleValue(tl, vl) | ||
| } | ||
|
|
||
| func decodeScalar(m any) (value attr.Value, diags diag.Diagnostics) { |
There was a problem hiding this comment.
As you probably found out, we punted on defining any reflection rules for converting native Go types into a types.Dynamic. We started down that route and then decided we'd rather return to the problem later.
Perhaps when your team (or other developers) start looking at potentially using types.Dynamic with managed resources/data source schemas we could revisit that problem.
jrhouston
changed the title
manifest_decode() function
jrhouston
force-pushed
the
add-manifest-decode-function
branch
from
8d6534c
to
217b4bf
Compare
austinvalle
reviewed
Mar 27, 2024
| { | ||
| Config: testManifestDecodeMultiConfig("testdata/decode_single.yaml"), | ||
| ConfigStateChecks: []statecheck.StateCheck{ | ||
| statecheck.ExpectKnownOutputValue(outputName, knownvalue.ListExact([]knownvalue.Check{ |
There was a problem hiding this comment.
Not released yet, but in terraform-plugin-testing v1.8.0 you can use the essentially equivalent TupleExact for a little better readability 👍🏻
austinvalle
reviewed
Mar 27, 2024
austinvalle
reviewed
Mar 27, 2024
austinvalle
reviewed
Mar 27, 2024
jrhouston
force-pushed
the
add-manifest-decode-function
branch
from
9a6aeec
to
4915eaa
Compare
BBBmau
approved these changes
Apr 5, 2024
dduportal
referenced
this pull request
in jenkins-infra/azure
Apr 9, 2024
<Actions>
<action
id="bcd9b70d7c1eb1e07eb5ad8a958f18dc1bbd81461ee1a2604adeea46e3148a47">
<h3>Bump Terraform `kubernetes` provider version</h3>
<details
id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24">
<summary>Update Terraform lock file</summary>
<p>changes detected:
	"hashicorp/kubernetes" updated
from "2.27.0" to "2.28.0" in file
".terraform.lock.hcl"</p>
<details>
<summary>2.28.0</summary>
<pre>Changelog retrieved
from:
	https://github.com/hashicorp/terraform-provider-kubernetes/releases/tag/v2.28.0
ENHANCEMENTS:

**NOTE:
Using [Provider Defined
Functions](https://developer.hashicorp.com/terraform/plugin/framework/functions/concepts)
requires Terraform version 1.8.0.**

* Add provider defined
functions: `manifest_encode`, `manifest_decode`, `manifest_decode_multi`
[[GH-2428](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2428)]


</pre>
</details>
</details>
<a
href="https://infra.ci.jenkins.io/job/updatecli/job/azure/job/main/96/">Jenkins
pipeline link</a>
</action>
</Actions>
---
<table>
<tr>
<td width="77">
<img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli
logo" width="50" height="50">
</td>
<td>
<p>
Created automatically by <a
href="https://www.updatecli.io/">Updatecli</a>
</p>
<details><summary>Options:</summary>
<br />
<p>Most of Updatecli configuration is done via <a
href="https://www.updatecli.io/docs/prologue/quick-start/">its
manifest(s)</a>.</p>
<ul>
<li>If you close this pull request, Updatecli will automatically reopen
it, the next time it runs.</li>
<li>If you close this pull request and delete the base branch, Updatecli
will automatically recreate it, erasing all previous commits made.</li>
</ul>
<p>
Feel free to report any issues at <a
href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br
/>
If you find this tool useful, do not hesitate to star <a
href="https://github.com/updatecli/updatecli/stargazers">our GitHub
repository</a> as a sign of appreciation, and/or to tell us directly on
our <a
href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>!
</p>
</details>
</td>
</tr>
</table>
Co-authored-by: Jenkins Infra Bot (updatecli) <60776566+jenkins-infra-bot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces the following provider defined functions:
manifest_encodeto encode a Terraform object representation of a Kubernetes manifest as a YAML string.manifest_decodeto decode a string containing a Kubernetes manifest in YAML format and return it as a Terraform object.manifest_decode_multiTo do the above but for YAML manifests containing multiple resources.Solves hashicorp/terraform#29729
TODO
context.TODO()/internal/framework/providerdirectoryExpectKnownValue,ExpectKnownOutputValue, andExpectKnownOutputValueAtPathplan and state checks terraform-plugin-testing#276go.modto reference latest plugin framework once this is merged: all: Add dynamic type, attribute, and function support terraform-plugin-framework#931Output from acceptance testing:
Release Note
Release note for CHANGELOG:
References
Community Note