Add raw body support to python3 templates

[viveksyngh]

Signed-off-by: Vivek Singh [email protected]

Description

Motivation and Context

• I have raised an issue to propose this change (required)

Which issue(s) this PR fixes

Fixes #

How Has This Been Tested?

This has been tested on my local with kind

faas-cli invoke raw-body-test <<< "Hello"
Handling connection for 8080
Hello

<class 'str'>
➜  templates git:(raw_body) ✗ faas-cli deploy -f raw-body-test.yml --env=RAW_BODY=True
Deploying: raw-body-test.
WARNING! Communication is not secure, please consider using HTTPS. Letsencrypt.org offers free SSL/TLS certificates.
Handling connection for 8080

Deployed. 202 Accepted.
URL: http://127.0.0.1:8080/function/raw-body-test

➜  templates git:(raw_body) ✗ faas-cli invoke raw-body-test <<< "Hello"               
Handling connection for 8080
Hello

<class 'str'>
➜  templates git:(raw_body) ✗ faas-cli invoke raw-body-test <<< "Hello"
Handling connection for 8080
b'Hello\n'
<class 'bytes'>
➜  templates git:(raw_body) ✗ faas-cli deploy -f raw-body-debian.yml   
Deploying: raw-body-debian.
WARNING! Communication is not secure, please consider using HTTPS. Letsencrypt.org offers free SSL/TLS certificates.
Handling connection for 8080

Deployed. 202 Accepted.
URL: http://127.0.0.1:8080/function/raw-body-debian

➜  templates git:(raw_body) ✗ faas-cli invoke raw-body-debian <<< "Hello"
Handling connection for 8080
Hello

<class 'str'>
➜  templates git:(raw_body) ✗ faas-cli deploy -f raw-body-debian.yml --env=RAW_BODY=True
Deploying: raw-body-debian.
WARNING! Communication is not secure, please consider using HTTPS. Letsencrypt.org offers free SSL/TLS certificates.
Handling connection for 8080

Deployed. 202 Accepted.
URL: http://127.0.0.1:8080/function/raw-body-debian

➜  templates git:(raw_body) ✗ faas-cli invoke raw-body-debian <<< "Hello"               
Handling connection for 8080
b'Hello\n'
<class 'bytes'>

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Version change (see: Impact to existing users)

Impact to existing users

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have signed-off my commits with git commit -s
• I have added tests to cover my changes.
• All new and existing tests passed.

[alexellis]

Thanks for the PR. Just bear in mind to fill out the template i.e. How Has This Been Tested?

[LucasRoesler]

A complete sentence for the doc string would be better, it is clear to me because i recommended strtobool, but a future contributor won't have the context

if you want to use strtobool, you could also do this

def is_true(val):
    try:
        return distutils.util.strtobool(val)
    except:
        return false

but either method is good to me 👍

[alexellis]

I would guess that get_stdin() will produce an invalid set of bytes since it is reading lines, I would imagine it should attempt to read an entire payload as bytes. There may not even be any newlines in the binary input - i.e. a JPEG image.

[alexellis]

We need to see a test that verifies the input received in the function is a perfect match for the bytes inputted.

[alexellis]

If you accept the data in from a HTTP request (curl --data-binary @input.jpg), then write it to the container in /tmp you can use kubectl cp -n openfaas-fn pod/name ./local-file.jpg to get the file back and compare for instance.

[viveksyngh]

I have updated this PR and tested with image data and it is working fine. Image file written in container is rendering correctly.

[alexellis]

Need to cross reference with openfaas/python-flask-template#38

[viveksyngh]

Need to cross reference with openfaas-incubator/python-flask-template#38

This has been handled within is_val function.

[jpauwels]

Hi @alexellis, @viveksyngh

Sorry to hijack this PR, but I opened a similar, but more extensive issue (#205) in May. In it, I proposed opening a PR with my tried-and-tested solution, but since I got no response on the issue, I didn't at the time. I've now created it as #217.

Imho, my solution is less hackish, as it parses standard headers and doesn't require environment variable definition. It also is more extensive in functionality.

I'd be happy to propose similar changes to the flask templates (actually have those running privately too).