Add base64Encode/base64Decode filter

[jcamiel]

Discussed in #1921

^{Originally posted by eydun September 12, 2023}
My login-request returns a token, which I am able to capture with jsonpath.

But before I can use this token for authorization in the second request, I need to base64 encode it. Is that possible?

Add base64Encode/base64Decode filter.

• base64Encode: input is in bytes, output is a string
• base64Decode: input is a string, output is bytes

GET https://foo.com/data.bin
HTTP 200
[Asserts]
bytes base64Encode == "SGVsbG8="
body == "Hello"

Note: to be more useful, we need to have also a filter going from bytes to string for instance utf8Encode/utf8Decode:

• utf8Encode: input is a string, output is in bytes
• utf8Decode: input is in bytes, output is a string

GET https://api.foo.com
HTTP 200
[Asserts]
jsonpath "$.data" base64Decode == hex,534756736247383d;
jsonpath "$.data" base64Decode utf8Decode == "Hello"
jsonpath "$.data" utf8Encode base64Encode == "SGVsbG8="

? Do we need a strEncode "encoding"/strDecode "encoding" filter with arbitrary encoding ? Like strEncode "gb-2317"

[ashishajr]

Hey @jcamiel, I'd love to work on this, could I take this up?

[jcamiel]

Yes @ashishajr of course.

This could be maybe too big for only one commit / one PR.

What I propose you is to split in multiple PRs or in one PR with multiple commits so it will be easier to review (multiple PRs is preferred as we can commit to master as soon as the PRs are validated):

1. Update grammar hurl.grammar => see docs/spec/grammar/REAME.md
2. Implement filter base64Decode base64Encode parsing
3. Implement filter base64Decode runtime evaluation + unit tests
4. Implement filter base64Encode runtime evaluation + unit tests
5. Add integration tests for base64Decode => see integration/README.md
6. Add integration tests for base64Encode => see integration/README.md

[ashishajr]

Thanks @jcamiel, I'll start working on these.

Could you please tell me where I'd have to implement the parsing for the new filters, I couldn't quite find that part in code.

TODO List for myself, I'll keep coming back and updating it

• Update grammar hurl.grammar => see docs/spec/grammar/REAME.md (Updated grammar to include new filters #3626)
• Implement filter base64Decode base64Encode parsing (Add parsing for base64 filters #3628)
• Implement filter base64Decode runtime evaluation + unit tests
• Implement filter base64Encode runtime evaluation + unit tests
• Add integration tests for base64Decode => see integration/README.md
• Add integration tests for base64Encode => see integration/README.md

[jcamiel]

Hi @ashishajr you can look at a similar filter htmlEscape, parsing is done in hurl_core/src/parser/filter.rs