ephemeral: support write-only attributes#36031

Merged

DanielMSchmidt merged 12 commits intomainfrom

Dec 12, 2024

Contributor

DanielMSchmidt commented Nov 18, 2024 •

edited

Loading

This PR aims on building baseline support for write-only attributes, so attributes that can be set to ephemeral values and can not be read / referenced. These attributes are hidden from the state.

Target Release

1.11.x

Draft CHANGELOG entry

NEW FEATURES

Ephemeral Values: support for write-only attributes, so attributes that can be set to ephemeral values and can not be read / referenced. These attributes are hidden from the state and plan files.

DanielMSchmidt requested a review from a team as a code owner

November 18, 2024 16:28

DanielMSchmidt marked this pull request as draft

November 18, 2024 16:28

DanielMSchmidt force-pushed the TF-18617 branch 2 times, most recently from 2b388e8 to be31c29 Compare

November 18, 2024 16:32

Contributor

github-actions bot commented Nov 18, 2024

The equivalence tests will be updated. Please verify the changes here.

DanielMSchmidt force-pushed the TF-18617 branch from be31c29 to 2adec4b Compare

November 18, 2024 16:39

Contributor

github-actions bot commented Nov 18, 2024

The equivalence tests will be updated. Please verify the changes here.

vercel bot temporarily deployed to Preview

November 18, 2024 16:47

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from 2adec4b to 90a9119 Compare

November 19, 2024 16:33

vercel bot temporarily deployed to Preview

November 19, 2024 16:39

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from 90a9119 to 625b207 Compare

November 21, 2024 13:03

Contributor

github-actions bot commented Nov 21, 2024

The equivalence tests will be updated. Please verify the changes here.

vercel bot temporarily deployed to Preview

November 21, 2024 13:09

Inactive

DanielMSchmidt force-pushed the TF-18617 branch 2 times, most recently from ead805d to 9f0ce65 Compare

November 21, 2024 13:17

Contributor

github-actions bot commented Nov 21, 2024

The equivalence tests will be updated. Please verify the changes here.

vercel bot temporarily deployed to Preview

November 21, 2024 13:27

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from 9f0ce65 to 3cd2fad Compare

November 21, 2024 13:52

vercel bot temporarily deployed to Preview

November 21, 2024 13:58

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from 3cd2fad to 2149025 Compare

November 21, 2024 13:58

Contributor

github-actions bot commented Nov 21, 2024

The equivalence tests will be updated. Please verify the changes here.

vercel bot temporarily deployed to Preview

November 21, 2024 14:03

Inactive

jbardin reviewed

View reviewed changes

internal/terraform/node_resource_abstract_instance.go Outdated Show resolved Hide resolved

internal/plans/changes_src.go Outdated Show resolved Hide resolved

internal/states/instance_object.go Outdated Show resolved Hide resolved

internal/states/remote/state_test.go Outdated Show resolved Hide resolved

Contributor

github-actions bot commented Nov 25, 2024

The equivalence tests will be updated. Please verify the changes here.

vercel bot temporarily deployed to Preview

November 25, 2024 15:07

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from 76f2ba7 to 298b60b Compare

November 25, 2024 15:08

DanielMSchmidt marked this pull request as ready for review

November 25, 2024 15:08

Contributor

github-actions bot commented Nov 25, 2024

The equivalence tests will be updated. Please verify the changes here.

Contributor

github-actions bot commented Nov 25, 2024

The equivalence tests will be updated. Please verify the changes here.

vercel bot temporarily deployed to Preview

November 25, 2024 15:13

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from a8c6fc9 to eee275f Compare

December 5, 2024 09:58

vercel bot temporarily deployed to Preview

December 5, 2024 10:03

Inactive

DanielMSchmidt requested a review from jbardin

December 6, 2024 08:13

radeksimko mentioned this pull request

Ensure WriteOnly attributes are rejected as non-ephemeral output values #36171

Closed

DanielMSchmidt force-pushed the TF-18617 branch from eee275f to fda482c Compare

December 10, 2024 12:01

vercel bot temporarily deployed to Preview

December 10, 2024 12:07

Inactive

DanielMSchmidt force-pushed the TF-18617 branch from fda482c to aee7e70 Compare

December 11, 2024 08:43

vercel bot temporarily deployed to Preview

December 11, 2024 08:50

Inactive

jbardin requested changes

View reviewed changes

Member

jbardin left a comment

Thanks @DanielMSchmidt, this should be enough to get us basic write-only support. I left a few comments in-inline. We may want to just drop the toBeImplemented tests from the PR and evaluate if that is even something to be supported.

internal/lang/ephemeral/validate.go Outdated Show resolved Hide resolved

internal/terraform/context_plan.go Outdated Show resolved Hide resolved

internal/terraform/context_plan_ephemeral_test.go Outdated Show resolved Hide resolved

internal/terraform/context_plan_ephemeral_test.go Outdated Show resolved Hide resolved

internal/terraform/transform_import_state_test.go Outdated Show resolved Hide resolved

DanielMSchmidt added 12 commits

December 12, 2024 10:56


          ephemeral: add tests for write-only attributes

9df72a9


          ephemeral: add helper to remove ephemeral values from cty.Values

6b49e80


          ephemeral: add write only attribute paths

1fa1f00


          ephemeral: allow ephemeral values in write-only attributes

78b69ab


          ephemeral: add support for write-only attributes

8fbd41f


          ephemeral: send diagnostics if plan responds with an ephemeral value

9ac000d


          ephemeral: remove write only paths

ea19aa1

we might need them later on, but it will be easier to find the right place and abstraction when the need to use them arises


          ephemeral: after plan set ephemeral values to null

5ef7b92

we got the marks from the proposed value, the provider gets the value without the marks

we then reapply the marks and need to also remove the write-only values by setting the values to null


          ephemeral: providers are responsible for setting write-only attribute…

970ff7f

…s to null


          ephemeral: add write-only attribute to proto to schema conversion

0222b97


          ephemeral: validate provider responses for write-only attributes

17581e4


          ephemeral: add WriteOnlyAttributesAllowed client capability

3a962e8

we allow it for all requests

DanielMSchmidt force-pushed the TF-18617 branch from aee7e70 to 3a962e8 Compare

December 12, 2024 09:56

DanielMSchmidt requested a review from jbardin

December 12, 2024 09:57

vercel bot temporarily deployed to Preview

December 12, 2024 10:02

Inactive

jbardin approved these changes

View reviewed changes

DanielMSchmidt merged commit ab2846c into main

DanielMSchmidt deleted the TF-18617 branch

December 12, 2024 14:59

Contributor

github-actions bot commented Dec 12, 2024

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

Contributor

github-actions bot commented Jan 12, 2025

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

github-actions bot locked as resolved and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet