OpenStack Compute (Nova)
Go to file
Chris Dent 68a689b0f3 Clean up header encoding handling in compute API
PEP 3333[1] says request and response headers (within the application)
should be treated as native `str` (whatever the Python version). It's
the job of the WSGI server to translate from `str` to reasonable output
on the outgoing socket connection.

This was already mostly correct but two issues were discovered while
trying to create integration tests that use the value of the location
response header when POSTing to create a server. In python2 it was
working. In Python3 the header had a value of

location: http://192.168.1.76/compute/v2.1/b'http:/192.168.1.76/compute/v2.1/servers/fad04042-850b-443a-9e48-773111cbc981'

(note the b'...' bounding the full url on the end).

This was happening for two reasons:

* nova/api/openstack/compute/servers.py independently encodes the
  location header to utf-8, instead of using the centralized handling
  in nova/api/openstack/wsgi.py

  This meant that the value of the location header would arrive, in
  Python 3, at the centralized handling as a bytestring.

* The centralized handling in nova/api/openstack/wsgi.py was incorrectly
  using the six.text_type() method. That is simply an alias to unicode
  in python 2 and str in python3. In python3 when given a bytestring
  as the only argument object.__str()__ is called on the argument.
  Which yields b'whatever'.

At that stage, the handling in the web server which processes a location
header to check for the presence of a host and prefix already at the
start of the provided location will find b'...' and do a concatenation
without any replace.

So, because of all that, this patch includes three changes:

* The server creation location header code does no encoding and relies
  on the centralized handling.

* The centralized handling removes the use of text_type() as a function
  because that is redundant with the safe_encode and safe_decode changes
  in the same loop.

* Doc strings and comments in the ResponseObject are clarified with
  regard to this encoding topic.

Also, comments in Resource._process_stack are updated to correspond with
the changes above. The code is not changed, as they are already doing
the right thing: The comment was misrepresenting what was going on.
There is some duplication of code between these two areas, but the code
is too inscrutable for me to be willing to change a part that isn't
presenting an explicit bug.

Tests for the internal production of the location header are adjusted
to reflect these changes.

[1] https://www.python.org/dev/peps/pep-3333/#a-note-on-string-types

Change-Id: I163c417375678b428ac77aac87ccafaf1f6186ab
Closes-Bug: #1795425
2018-12-04 10:06:21 +00:00
api-guide/source Fix server query examples 2018-11-19 23:22:39 +00:00
api-ref/source Merge "api-ref: Add a description about sort order" 2018-11-12 06:50:27 +00:00
devstack Remove the CachingScheduler 2018-10-18 17:55:36 -04:00
doc Merge "Add CellsV2 FAQ about API design decisions" 2018-11-20 15:55:36 +00:00
etc/nova Add osprofiler config options to generated reference 2018-06-16 12:46:19 +00:00
gate Add volume-backed evacuate test 2018-10-25 16:15:56 -04:00
nova Clean up header encoding handling in compute API 2018-12-04 10:06:21 +00:00
placement-api-ref Merge "Document no content on POST /reshaper 204" 2018-08-29 09:22:16 +00:00
playbooks/legacy Add post-test hook for testing evacuate 2018-10-25 16:15:56 -04:00
releasenotes Merge "SIGHUP n-cpu to clear provider tree cache" 2018-12-04 02:23:39 +00:00
tools Make Xen code py3-compatible 2018-08-10 20:04:19 +00:00
.coveragerc Remove nova/openstack/* from .coveragerc 2016-10-12 16:20:49 -04:00
.gitignore Implement granular policy rules for placement 2018-05-17 11:12:16 -04:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:07:19 -04:00
.mailmap Add mailmap entry 2014-05-07 12:14:26 -07:00
.stestr.conf Finish stestr migration 2017-11-24 16:51:12 -05:00
.zuul.yaml Add post-test hook for testing evacuate 2018-10-25 16:15:56 -04:00
CONTRIBUTING.rst Update links in documents 2018-01-12 17:05:11 +08:00
HACKING.rst Add a hacking rule for deprecated assertion methods 2018-10-25 11:49:10 +09:00
LICENSE initial commit 2010-05-27 23:05:26 -07:00
MAINTAINERS Fix broken URLs 2017-09-07 15:42:31 +02:00
README.rst Docs: modernise links 2018-03-24 20:27:11 +08:00
babel.cfg Get rid of distutils.extra. 2012-02-08 19:30:39 -08:00
bindep.txt Merge "Bindep does not catch missing libpcre3-dev on Ubuntu" 2018-02-14 07:31:09 +00:00
lower-constraints.txt Use SleepFixture instead of mocking _ThreadingEvent.wait 2018-11-08 16:50:39 -05:00
requirements.txt Use SleepFixture instead of mocking _ThreadingEvent.wait 2018-11-08 16:50:39 -05:00
setup.cfg Remove the CachingScheduler 2018-10-18 17:55:36 -04:00
setup.py Updated from global requirements 2017-03-02 11:50:48 +00:00
test-requirements.txt Fix ironic client ironic_url deprecation warning 2018-10-24 17:59:10 +02:00
tox.ini tox: Stop build *all* docs in 'docs' 2018-10-26 18:00:53 +01:00

README.rst

Team and repository tags

image

OpenStack Nova

OpenStack Nova provides a cloud computing fabric controller, supporting a wide variety of compute technologies, including: libvirt (KVM, Xen, LXC and more), Hyper-V, VMware, XenServer, OpenStack Ironic and PowerVM.

Use the following resources to learn more.

API

To learn how to use Nova's API, consult the documentation available online at:

For more information on OpenStack APIs, SDKs and CLIs in general, refer to:

Operators

To learn how to deploy and configure OpenStack Nova, consult the documentation available online at:

In the unfortunate event that bugs are discovered, they should be reported to the appropriate bug tracker. If you obtained the software from a 3rd party operating system vendor, it is often wise to use their own bug tracker for reporting problems. In all other cases use the master OpenStack bug tracker, available at:

Developers

For information on how to contribute to Nova, please see the contents of the CONTRIBUTING.rst.

Any new code must follow the development guidelines detailed in the HACKING.rst file, and pass all unit tests.

Further developer focused documentation is available at:

Other Information

During each Summit and Project Team Gathering, we agree on what the whole community wants to focus on for the upcoming release. The plans for nova can be found at: