keystoneauth raises error when application name is empty string

[Matt Mulsow]

If the application name, sys.argv[0], is an empty string, like when called from the Ansible os_network module, then keystoneauth (with the new requests 2.11.0) will raise an exception saying:

Invalid return character or leading space in header: User-Agent

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/352985

[Brant Knudson (blk-u)]

I opened a bug against the requests library to check if this change in behavior is intentional. Was closed saying working as designed: https://github.com/kennethreitz/requests/issues/3488

[Brant Knudson (blk-u)]

$ python
Python 2.7.6 (default, Jun 22 2015, 17:58:13)
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> print(repr(sys.argv[0]))
''

[Sean Perry (sean-perry-a)]

Fun. This is on me. I made the code in question.

I have been working on a different design based on jamie lennox's feedback but it is not quite ready yet.

[Sean Perry (sean-perry-a)]

The long term goal is to require the user of keystoneauth to provide a name so this heuristic code can be removed.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/352985
Committed: https://git.openstack.org/cgit/openstack/keystoneauth/commit/?id=c9ae7067bdc41bdc3ac757a3412d1e17f6c1796a
Submitter: Jenkins
Branch: master

commit c9ae7067bdc41bdc3ac757a3412d1e17f6c1796a
Author: Brant Knudson <email address hidden>
Date: Tue Aug 9 10:43:16 2016 -0500

    Add tests for user-agent with odd sys.argv

    There was no test that verified that when sys.argv is an empty
    list or when sys.argv[0] is an empty string that the default
    user-agent value is constructed as expected.

    Change-Id: Iacf1557b6dbf48bf6bfb59d7cfbfec14e4fa8e56
    Related-Bug: 1611426

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/352673
Committed: https://git.openstack.org/cgit/openstack/keystoneauth/commit/?id=4a0ac4583b5e896d5b1af033ca2347f9fcc9daab
Submitter: Jenkins
Branch: master

commit 4a0ac4583b5e896d5b1af033ca2347f9fcc9daab
Author: Matt Mulsow <email address hidden>
Date: Mon Aug 8 21:26:01 2016 -0500

    User-agent header shouldn't start with a space

    If the application name, sys.argv[0], is an empty string, like when
    called from the Ansible os_network module, then keystoneauth (with
    the new requests 2.11.0) will raise an exception saying:

    Invalid return character or leading space in header: User-Agent

    This comes from keystoneauth trying to prepend the empty module
    name to the default user agent, which leads to it sending a
    User-Agent header that starts with a blank space. This was fine
    until the new requests 2.11.0 was released which errors if header
    values start with a leading space.

    With this change, if sys.argv[0] is an empty string we'll just use
    the DEFAULT_USER_AGENT and not try to prepend a calling module.

    Closes-Bug: #1611426

    Change-Id: I56d3e352dce7628add0479b3333a880700844ebc
    Signed-off-by: Matt Mulsow <email address hidden>

[Davanum Srinivas (DIMS) (dims-v)]

This issue was fixed in the openstack/keystoneauth 2.11.1 release.