Fix scraping Refs from attributes containing lists #441
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
Scraping does not handle `TupleConsExpr` when parsing example HCL code from
Terraform documentation.
Example 1):
```hcl
require_attestations_by = [google_binary_authorization_attestor.attestor.name]
```
Does not add:
```
cluster_admission_rules.require_attestations_by: google_binary_authorization_attestor.attestor.name
```
As it should since the reference is contained in a _list_.
1) https://github.com/hashicorp/terraform-provider-google/blob/v5.39.0/website/docs/r/binary_authorization_policy.html.markdown?plain=1#L49
Signed-off-by: Rickard von Essen <rickard.von.essen@gmail.com>
This correctly parses references contained in lists and adds them to the map of
references.
Example 1):
```hcl
require_attestations_by = [google_binary_authorization_attestor.attestor.name]
```
Correctly generates a ref and building `provider-upjet-gcp` with this change
produces the expected `examples-generated/binaryauthorization/v1beta2/policy.yaml`
with this diff compared to without this change.
```
@@ -14,8 +14,8 @@ spec:
- cluster: us-central1-a.prod-cluster
enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG
evaluationMode: REQUIRE_ATTESTATION
- requireAttestationsBy:
- - ${google_binary_authorization_attestor.attestor.name}
+ requireAttestationsByRefs:
+ - name: attestor
defaultAdmissionRule:
- enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG
evaluationMode: ALWAYS_ALLOW
```
1) https://github.com/hashicorp/terraform-provider-google/blob/v5.39.0/website/docs/r/binary_authorization_policy.html.markdown?plain=1#L49
Signed-off-by: Rickard von Essen <rickard.von.essen@gmail.com>
rickard-von-essen
requested review from
ulucinar,
sergenyalcin,
erhancagirici and
mergenci
as code owners
rickard-von-essen
added a commit
to rickard-von-essen/provider-upjet-gcp
that referenced
this pull request
Oct 5, 2024
Signed-off-by: Rickard von Essen <rickard.von.essen@gmail.com>
rickard-von-essen
force-pushed
the
bug/ref-subnet
branch
from
38869ad
to
1ae4c81
Compare
sergenyalcin
approved these changes
Oct 7, 2024
There was a problem hiding this comment.
Thanks @rickard-von-essen for this valuable fix. I also tested the change against provider-upjet-aws and did not observe any issue or unwanted changes. LGTM!
Merged
3 tasks
3 tasks
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 of your changes
Scraping does not handle
TupleConsExprwhen parsing example HCL code from Terraform documentation.Example 1):
Does not add:
To metadata as it should since the reference is contained in a list.
With this patch it's correctly scraped and adds a ref. Building
provider-upjet-gcpwith this changeproduces the expected
examples-generated/binaryauthorization/v1beta2/policy.yamlwith this diff compared to without this change.
Fixes #349
I have:
make reviewableto ensure this PR is ready for review.Addedbackport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested
By updating the unit test in
meta_test.goand rebuildingprovider-upjet-gcp(rickard-von-essen/provider-upjet-gcp@f162f83)