Base64 encode response body #158

bendbennett · 2022-07-11T13:01:00Z

Closes: #157
Closes: #147
Closes: #145
Closes: #99
Closes: #72
Closes: #67
Closes: #38
Closes: #13
Closes: #11

detro

Aside from the nitpick over the suffix _std, LGTM

detro · 2022-07-12T12:47:33Z

docs/data-sources/http.md

@@ -107,5 +107,6 @@ resource "random_uuid" "example" {

 - `id` (String) The ID of this resource.
 - `response_body` (String) The response body returned as a string.
+- `response_body_base64_std` (String) The response body encoded as base64 (standard) as defined in [RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648#section-4).


Nitpick: I know you are being precise here, but I don't think there can be any confusion as for what base64 is. Do we need the _std suffix?

I know it's not a rule written in stone, but I haven't seen that prefix used in other providers that expose binaries that way.

Ah, I looked at the RFC, and I think what you are tying to convey here is that we are using the standard Base64. But, even in the RFC, it says <<it might be referred to as "base64">>

I don't think I've ever heard the "standard" part before (which very much intrigued me that there was another shorthand encoding term, "base64url", okay makes sense and today I learned), but take that with whatever grain of salt. 😅

If you're looking for something more concrete with respect to other large Terraform providers, it is safe to bet on calling it *_base64. 👍

Some various references:

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_object#content_base64

https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_certificate#certificate_data_base64

https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/endpoints_service#protoc_output_base64

Have removed the _std suffix.

bmuschko · 2022-10-17T17:45:28Z

Any chance we can get this PR merged and released? I am running into the same issue.

…oding of the response body (#157)

…e64 (#157)

mza08 · 2022-11-17T14:59:33Z

internal/provider/data_source_http_test.go

+							}`, svr.URL),
+				Check: resource.ComposeTestCheckFunc(
+					// Note the replacement character in the string representation in `response_body`.
+					resource.TestCheckResourceAttr("data.http.http_test", "response_body", "GIF89a\x01\x00\x01\x00�\x00\x00\x00\x00\x00\x00\x00\x00!�\x04\x01\x00\x00\x00\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02D\x01\x00;"),


@bendbennett what's the deal with the special characters instead of plain \xXX (hex) notation?

@mza08 response_body contains the output from:

responseBody := string(bytes)

When an invalid UTF-8 sequence is encountered, it is replaced by the Unicode replacement character �.

ddelnano · 2022-12-20T17:36:46Z

I maintain a terraform provider for Xen Orchestra and leveraging this new functionality would allow me to avoid reimplementing similar logic in the terraform provider.

What's the remaining work here? Is there any way I can help this effort?

dploeger · 2023-03-17T14:10:59Z

@bendbennett @detro Also asking about the state of this PR. Any chance to have this merged?

benkeil · 2023-03-22T06:45:29Z

Can we merge this?

austinvalle · 2023-03-22T15:13:21Z

Hi all 👋, sorry about the delayed response.

This PR is currently on-hold as there is a need to skip certain test scenarios for specific terraform versions ( 0.14.* ) and the testing framework currently does not have that capability. There has been some internal discussion about design of that testing functionality but our team's attention is currently elsewhere at the moment.

kishaningithub · 2023-05-25T14:20:51Z

Is this feature available in some sort of a fork? because i really need this

bendbennett · 2023-05-26T09:47:02Z

Hi @kishaningithub 👋,

As mentioned above there are some additional considerations so this PR is currently on-hold until we've addressed the issue of being able to skip certain test scenarios for specific terraform versions. Apologies for any inconvenience.

# Conflicts: # CHANGELOG.md # internal/provider/data_source_http.go # internal/provider/data_source_http_test.go

…v0.14.0`

austinvalle

Just one small note, looks good! 🚀

internal/provider/data_source_http.go

# Conflicts: # go.mod # go.sum

darren-recentive · 2023-06-21T01:31:21Z

Thanks for the hard works folks, what's the release schedule so we can get this out? 🙏

austinvalle · 2023-06-22T13:18:10Z

Hi there @darren-recentive 👋🏻 !

The team has released this feature with 3.4.0 yesterday: https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http#response_body_base64

github-actions · 2024-05-25T15:35:59Z

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 added size/M documentation labels Jul 11, 2022

bendbennett marked this pull request as ready for review July 11, 2022 13:08

bendbennett requested a review from a team as a code owner July 11, 2022 13:08

bendbennett added the enhancement label Jul 11, 2022

bendbennett added this to the v3.1.0 milestone Jul 11, 2022

This was referenced Jul 11, 2022

Allow XML Content-Type #99

Closed

application/octet-stream for yaml #72

Closed

Getting warning for application/vnd.docker.distribution.manifest.v2+json content types #67

Closed

Feature Request: Handle remote archive types #11

Closed

detro approved these changes Jul 12, 2022

View reviewed changes

bendbennett modified the milestones: v3.1.0, v3.2.0 Aug 22, 2022

bogdangi mentioned this pull request Oct 19, 2022

Base64 encode response body without _std #195

Closed

bendbennett added 3 commits October 24, 2022 13:06

Adding response_body_base64_std attribute to hold standard base64 enc…

5e1b692

…oding of the response body (#157)

Updating CHANGELOG.md and docs (#157)

d1571f2

Renaming attribute from response_body_base64_std to response_body_bas…

fd8ca19

…e64 (#157)

bendbennett force-pushed the bendbennett/issues-157 branch from 7c90dcc to fd8ca19 Compare October 24, 2022 12:15

bendbennett requested a review from bflad October 24, 2022 12:16

bendbennett removed this from the v3.2.0 milestone Oct 27, 2022

mza08 reviewed Nov 17, 2022

View reviewed changes

This was referenced Dec 20, 2022

Add xenorchestra_vdi resource vatesfr/terraform-provider-xenorchestra#225

Merged

[Feature] Upload isos via terraform vatesfr/terraform-provider-xenorchestra#193

Open

Base64 encode response body #214

Closed

kishaningithub mentioned this pull request May 26, 2023

[Feature request] Download binary files through the data source devops-rob/terraform-provider-terracurl#62

Open

SBGoods added 4 commits June 13, 2023 13:07

Merge branch 'main' into bendbennett/issues-157

363592e

# Conflicts: # CHANGELOG.md # internal/provider/data_source_http.go # internal/provider/data_source_http_test.go

Clean up imports from merge

d0d6ea9

Add version check to x509cert test to skip Terraform v0.14.0

8b49ab9

Add Changie entries

f6aa193

github-actions bot added dependencies size/L and removed size/M labels Jun 13, 2023

SBGoods added 3 commits June 13, 2023 13:49

Add version check to TestDataSource_ResponseBodyBinary to skip TF `…

e6fd128

…v0.14.0`

Update version checks to skip all TF versions 0.14.x

da5a0e1

Update version checks to use tfversion variables

3668d83

austinvalle approved these changes Jun 14, 2023

View reviewed changes

internal/provider/data_source_http.go Outdated Show resolved Hide resolved

SBGoods added 3 commits June 14, 2023 10:20

Rename ResponseBodyBase64 field

8806590

Merge branch 'main' into bendbennett/issues-157

ff73127

# Conflicts: # go.mod # go.sum

Clean up go.mod

e0dba99

github-actions bot removed the dependencies label Jun 14, 2023

SBGoods added this to the v3.4.0 milestone Jun 14, 2023

SBGoods merged commit 0eeb981 into main Jun 14, 2023

SBGoods deleted the bendbennett/issues-157 branch June 14, 2023 15:30

bendbennett mentioned this pull request Jun 28, 2023

Warning: Response body is not recognized as UTF-8 even if response_body is not used #286

Open

1 task

github-actions bot locked as resolved and limited conversation to collaborators May 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Base64 encode response body #158

Base64 encode response body #158

bendbennett commented Jul 11, 2022 •

edited

Loading

detro left a comment •

edited

Loading

detro Jul 12, 2022

detro Jul 12, 2022

bflad Jul 13, 2022

bendbennett Oct 24, 2022

bmuschko commented Oct 17, 2022

mza08 Nov 17, 2022

bendbennett Nov 17, 2022

ddelnano commented Dec 20, 2022 •

edited

Loading

dploeger commented Mar 17, 2023

benkeil commented Mar 22, 2023

austinvalle commented Mar 22, 2023

kishaningithub commented May 25, 2023

bendbennett commented May 26, 2023

austinvalle left a comment

darren-recentive commented Jun 21, 2023

austinvalle commented Jun 22, 2023

github-actions bot commented May 25, 2024

Base64 encode response body #158

Base64 encode response body #158

Conversation

bendbennett commented Jul 11, 2022 • edited Loading

detro left a comment • edited Loading

Choose a reason for hiding this comment

detro Jul 12, 2022

Choose a reason for hiding this comment

detro Jul 12, 2022

Choose a reason for hiding this comment

bflad Jul 13, 2022

Choose a reason for hiding this comment

bendbennett Oct 24, 2022

Choose a reason for hiding this comment

bmuschko commented Oct 17, 2022

mza08 Nov 17, 2022

Choose a reason for hiding this comment

bendbennett Nov 17, 2022

Choose a reason for hiding this comment

ddelnano commented Dec 20, 2022 • edited Loading

dploeger commented Mar 17, 2023

benkeil commented Mar 22, 2023

austinvalle commented Mar 22, 2023

kishaningithub commented May 25, 2023

bendbennett commented May 26, 2023

austinvalle left a comment

Choose a reason for hiding this comment

darren-recentive commented Jun 21, 2023

austinvalle commented Jun 22, 2023

github-actions bot commented May 25, 2024

bendbennett commented Jul 11, 2022 •

edited

Loading

detro left a comment •

edited

Loading

ddelnano commented Dec 20, 2022 •

edited

Loading