a11c3d3161
Attribute accesses in SDK pass through a type-conversion utility method
that is responsible for ensuring the following behavior:
>>> class Demo(resource.Resource):
... foo = resource.Body('foo', type=str)
...
>>> demo = Demo(foo=123)
>>> demo.foo
'123' # result is cast to a string
Unfortunately, because of how this is implemented, attribute accesses
can result result in a copy of the attribute being returned, rather than
the attribute itself. This means attempts to modify mutable attributes
in-place can end up modifying a copy of the attributes, rather than the
attribute itself.
>>> class Demo(resource.Resource):
... foo = resource.Body('foo', type=list, list_type=str)
...
>>> demo = Demo(foo=[123])
>>> demo.foo
['123'] # items are cast to strings
>>> demo.foo.append(456)
>>> demo.foo
['123'] # 456 is missing!
This was not previously an issue for horizon as we were not hitting any
of these cases, however, in in openstacksdk 4.3.0, a bug was addressed
where conversion would not happen if using 'type=list', if 'list_type'
was unset, and if the item was a set or tuple (i.e. not a list).
>>> class Demo(resource.Resource):
... foo = resource.Body('foo', type=list)
...
>>> demo = Demo(foo={'123'})
>>> demo.foo
{'123'} # should be a list!
This has now been fixed, however, the bugfix has exposed a case where we
were in fact modifying a mutable list in-place.
The long-term fix lies in changing how openstacksdk works, so that it
always return the original attribute rather potentially returning a
copy. However, this fix is likely going to be rather involved and not
something we want to cram into the end of the Epoxy release. Instead,
modify Horizon so that it updates the entire attribute rather than
modifying it in place.
Change-Id: I6e7814ea16ca84689b363a53f22de62800c1f0d8
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Related-bug: #2100605
Horizon (OpenStack Dashboard)
Horizon is a Django-based project aimed at providing a complete
OpenStack Dashboard along with an extensible framework for building new
dashboards from reusable components. The
openstack_dashboard module is a reference implementation of
a Django site that uses the horizon app to provide
web-based interactions with the various OpenStack projects.
- Project documentation: https://docs.openstack.org/horizon/latest/
- Release management: https://launchpad.net/horizon
- Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
- Issue tracking: https://bugs.launchpad.net/horizon
- Release notes: https://docs.openstack.org/releasenotes/horizon/
Using Horizon
See doc/source/install/index.rst about how to install
Horizon in your OpenStack setup. It describes the example steps and has
pointers for more detailed settings and configurations.
It is also available at Installation Guide.
Getting Started for Developers
doc/source/quickstart.rst or Quickstart
Guide describes how to setup Horizon development environment and
start development.
Building Contributor Documentation
This documentation is written by contributors, for contributors.
The source is maintained in the doc/source directory
using reStructuredText and
built by Sphinx
To build the docs, use:
$ tox -e docsResults are in the doc/build/html directory