openstack/openstacksdk
Code Issues Proposed changes

Proxy module for bare-metal service

Browse Source 
Depends-On: I81c35238ac5ac75a63c292c91dcbeb3a16e56db8
Depends-On: I93657edfcdd33549601f7587cb4fae259d31499e
Depends-On: I60962f4f9f5fbf6d7579b1cb4808cdd84549378c
Depends-On: I8aa493e300287941a2925f5d7228ee65e7e8cbc0
Depends-On: I26da9d910809d2ffd1c541d91284caf5b86e9560

Change-Id: I7f46ce41d19082c6592fd67bbf4ecf246168d71b
This commit is contained in:
tengqm 2016-12-15 01:18:44 -05:00
parent 0f83addd55
commit 7e3d664854
2 changed files with 644 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

490
openstack/bare_metal/v1/_proxy.py Normal file
View File

@ -0,0 +1,490 @@
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from openstack.bare_metal.v1 import chassis as _chassis
from openstack.bare_metal.v1 import driver as _driver
from openstack.bare_metal.v1 import node as _node
from openstack.bare_metal.v1 import port as _port
from openstack.bare_metal.v1 import port_group as _portgroup
from openstack import proxy2
class Proxy(proxy2.BaseProxy):
def chassis(self, details=False, **query):
"""Retrieve a generator of chassis.
:param details: A boolean indicating whether the detailed information
for every chassis should be returned.
:param dict query: Optional query parameters to be sent to
restrict the chassis to be returned. Available parameters include:
* ``fields``: A list containing one or more fields to be returned
in the response. This may lead to some performance gain
because other fields of the resource are not refreshed.
* ``limit``: Requests at most the specified number of items be
returned from the query.
* ``marker``: Specifies the ID of the last-seen chassis. Use the
``limit`` parameter to make an initial limited request and
use the ID of the last-seen chassis from the response as
the ``marker`` value in a subsequent limited request.
* ``sort_dir``: Sorts the response by the requested sort direction.
A valid value is ``asc`` (ascending) or ``desc``
(descending). Default is ``asc``. You can specify multiple
pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the
natural sorting direction of the server attribute that is
provided as the ``sort_key``.
* ``sort_key``: Sorts the response by the this attribute value.
Default is ``id``. You can specify multiple pairs of sort
key and sort direction query parameters. If you omit the
sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
``sort_key``.
:returns: A generator of chassis instances.
"""
cls = _chassis.ChassisDetail if details else _chassis.Chassis
return self._list(cls, paginated=True, **query)
def create_chassis(self, **attrs):
"""Create a new chassis from attributes.
:param dict attrs: Keyword arguments that will be used to create a
:class:`~openstack.bare_metal.v1.chassis.Chassis`, it comprised
of the properties on the ``Chassis`` class.
:returns: The results of chassis creation.
:rtype: :class:`~openstack.bare_metal.v1.chassis.Chassis`.
"""
return self._create(_chassis.Chassis, **attrs)
def find_chassis(self, name_or_id, ignore_missing=True):
"""Find a single chassis.
:param str name_or_id: The name or ID of a chassis.
:param bool ignore_missing: When set to ``False``, an exception of
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the chassis does not exist. When set to `True``, None will
be returned when attempting to find a nonexistent chassis.
:returns: One :class:`~openstack.bare_metal.v1.chassis.Chassis` object
or None.
"""
return self._find(_chassis.Chassis, name_or_id,
ignore_missing=ignore_missing)
def get_chassis(self, chassis):
"""Get a specific chassis.
:param chassis: The value can be the name or ID of a chassis or a
:class:`~openstack.bare_metal.v1.chassis.Chassis` instance.
:returns: One :class:`~openstack.bare_metal.v1.chassis.Chassis`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
chassis matching the name or ID could be found.
"""
return self._get(_chassis.Chassis, chassis)
def update_chassis(self, chassis, **attrs):
"""Update a chassis.
:param chassis: Either the name or the ID of a chassis, or an instance
of :class:`~openstack.bare_metal.v1.chassis.Chassis`.
:param dict attrs: The attributes to update on the chassis represented
by the ``chassis`` parameter.
:returns: The updated chassis.
:rtype: :class:`~openstack.bare_metal.v1.chassis.Chassis`
"""
return self._update(_chassis.Chassis, chassis, **attrs)
def delete_chassis(self, chassis, ignore_missing=True):
"""Delete a chassis.
:param chassis: The value can be either the name or ID of a chassis or
a :class:`~openstack.bare_metal.v1.chassis.Chassis` instance.
:param bool ignore_missing: When set to ``False``, an exception
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the chassis could not be found. When set to ``True``, no
exception will be raised when attempting to delete a non-existent
chassis.
:returns: The instance of the chassis which was deleted.
:rtype: :class:`~openstack.bare_metal.v1.chassis.Chassis`.
"""
return self._delete(_chassis.Chassis, chassis,
ignore_missing=ignore_missing)
def drivers(self):
"""Retrieve a generator of drivers.
:returns: A generator of driver instances.
"""
return self._list(_driver.Driver, paginated=False)
def get_driver(self, driver):
"""Get a specific driver.
:param driver: The value can be the name of a driver or a
:class:`~openstack.bare_metal.v1.driver.Driver` instance.
:returns: One :class:`~openstack.bare_metal.v1.driver.Driver`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
driver matching the name could be found.
"""
return self._get(_driver.Driver, driver)
def nodes(self, details=False, **query):
"""Retrieve a generator of nodes.
:param details: A boolean indicating whether the detailed information
for every node should be returned.
:param dict query: Optional query parameters to be sent to restrict
the nodes returned. Available parameters include:
* ``associated``: Only return those which are, or are not,
associated with an ``instance_id``.
* ``driver``: Only return those with the specified ``driver``.
* ``fields``: A list containing one or more fields to be returned
in the response. This may lead to some performance gain
because other fields of the resource are not refreshed.
* ``instance_id``: Only return the node with this specific instance
UUID or an empty set if not found.
* ``is_maintenance``: Only return those with ``maintenance`` set to
``True`` or ``False``.
* ``limit``: Requests at most the specified number of nodes be
returned from the query.
* ``marker``: Specifies the ID of the last-seen node. Use the
``limit`` parameter to make an initial limited request and
use the ID of the last-seen node from the response as
the ``marker`` value in a subsequent limited request.
* ``provision_state``: Only return those nodes with the specified
``provision_state``.
* ``sort_dir``: Sorts the response by the requested sort direction.
A valid value is ``asc`` (ascending) or ``desc``
(descending). Default is ``asc``. You can specify multiple
pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the
natural sorting direction of the server attribute that is
provided as the ``sort_key``.
* ``sort_key``: Sorts the response by the this attribute value.
Default is ``id``. You can specify multiple pairs of sort
key and sort direction query parameters. If you omit the
sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
``sort_key``.
:returns: A generator of node instances.
"""
cls = _node.NodeDetail if details else _node.Node
return self._list(cls, paginated=True, **query)
def create_node(self, **attrs):
"""Create a new node from attributes.
:param dict attrs: Keyword arguments that will be used to create a
:class:`~openstack.bare_metal.v1.node.Node`, it comprised
of the properties on the ``Node`` class.
:returns: The results of node creation.
:rtype: :class:`~openstack.bare_metal.v1.node.Node`.
"""
return self._create(_node.Node, **attrs)
def find_node(self, name_or_id, ignore_missing=True):
"""Find a single node.
:param str name_or_id: The name or ID of a node.
:param bool ignore_missing: When set to ``False``, an exception of
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the node does not exist. When set to `True``, None will
be returned when attempting to find a nonexistent node.
:returns: One :class:`~openstack.bare_metal.v1.node.Node` object
or None.
"""
return self._find(_node.Node, name_or_id,
ignore_missing=ignore_missing)
def get_node(self, node):
"""Get a specific node.
:param node: The value can be the name or ID of a chassis or a
:class:`~openstack.bare_metal.v1.node.Node` instance.
:returns: One :class:`~openstack.bare_metal.v1.node.Node`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
node matching the name or ID could be found.
"""
return self._get(_node.Node, node)
def update_node(self, node, **attrs):
"""Update a node.
:param chassis: Either the name or the ID of a node or an instance
of :class:`~openstack.bare_metal.v1.node.Node`.
:param dict attrs: The attributes to update on the node represented
by the ``node`` parameter.
:returns: The updated node.
:rtype: :class:`~openstack.bare_metal.v1.node.Node`
"""
return self._update(_node.Node, node, **attrs)
def delete_node(self, node, ignore_missing=True):
"""Delete a node.
:param node: The value can be either the name or ID of a node or
a :class:`~openstack.bare_metal.v1.node.Node` instance.
:param bool ignore_missing: When set to ``False``, an exception
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the node could not be found. When set to ``True``, no
exception will be raised when attempting to delete a non-existent
node.
:returns: The instance of the node which was deleted.
:rtype: :class:`~openstack.bare_metal.v1.node.Node`.
"""
return self._delete(_node.Node, node, ignore_missing=ignore_missing)
def ports(self, details=False, **query):
"""Retrieve a generator of ports.
:param details: A boolean indicating whether the detailed information
for every port should be returned.
:param dict query: Optional query parameters to be sent to restrict
the ports returned. Available parameters include:
* ``address``: Only return ports with the specified physical
hardware address, typically a MAC address.
* ``driver``: Only return those with the specified ``driver``.
* ``fields``: A list containing one or more fields to be returned
in the response. This may lead to some performance gain
because other fields of the resource are not refreshed.
* ``limit``: Requests at most the specified number of ports be
returned from the query.
* ``marker``: Specifies the ID of the last-seen port. Use the
``limit`` parameter to make an initial limited request and
use the ID of the last-seen port from the response as
the ``marker`` value in a subsequent limited request.
* ``node``:only return the ones associated with this specific node
(name or UUID), or an empty set if not found.
* ``node_id``:only return the ones associated with this specific
node UUID, or an empty set if not found.
* ``portgroup``: only return the ports associated with this
specific Portgroup (name or UUID), or an empty set if not
found. Added in API microversion 1.24.
* ``sort_dir``: Sorts the response by the requested sort direction.
A valid value is ``asc`` (ascending) or ``desc``
(descending). Default is ``asc``. You can specify multiple
pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the
natural sorting direction of the server attribute that is
provided as the ``sort_key``.
* ``sort_key``: Sorts the response by the this attribute value.
Default is ``id``. You can specify multiple pairs of sort
key and sort direction query parameters. If you omit the
sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
``sort_key``.
:returns: A generator of port instances.
"""
cls = _port.PortDetail if details else _port.Port
return self._list(cls, paginated=True, **query)
def create_port(self, **attrs):
"""Create a new port from attributes.
:param dict attrs: Keyword arguments that will be used to create a
:class:`~openstack.bare_metal.v1.port.Port`, it comprises of the
properties on the ``Port`` class.
:returns: The results of port creation.
:rtype: :class:`~openstack.bare_metal.v1.port.Port`.
"""
return self._create(_port.Port, **attrs)
def find_port(self, name_or_id, ignore_missing=True):
"""Find a single port.
:param str name_or_id: The name or ID of a port.
:param bool ignore_missing: When set to ``False``, an exception of
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the port does not exist. When set to `True``, None will
be returned when attempting to find a nonexistent port.
:returns: One :class:`~openstack.bare_metal.v1.port.Port` object
or None.
"""
return self._find(_port.Port, name_or_id,
ignore_missing=ignore_missing)
def get_port(self, port, **query):
"""Get a specific port.
:param port: The value can be the name or ID of a chassis or a
:class:`~openstack.bare_metal.v1.port.Port` instance.
:param dict query: Optional query parameters to be sent to restrict
the port properties returned. Available parameters include:
* ``fields``: A list containing one or more fields to be returned
in the response. This may lead to some performance gain
because other fields of the resource are not refreshed.
:returns: One :class:`~openstack.bare_metal.v1.port.Port`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
port matching the name or ID could be found.
"""
return self._get(_port.Port, port, **query)
def update_port(self, port, **attrs):
"""Update a port.
:param chassis: Either the name or the ID of a port or an instance
of :class:`~openstack.bare_metal.v1.port.Port`.
:param dict attrs: The attributes to update on the port represented
by the ``port`` parameter.
:returns: The updated port.
:rtype: :class:`~openstack.bare_metal.v1.port.Port`
"""
return self._update(_port.Port, port, **attrs)
def delete_port(self, port, ignore_missing=True):
"""Delete a port.
:param port: The value can be either the name or ID of a port or
a :class:`~openstack.bare_metal.v1.port.Port` instance.
:param bool ignore_missing: When set to ``False``, an exception
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the port could not be found. When set to ``True``, no
exception will be raised when attempting to delete a non-existent
port.
:returns: The instance of the port which was deleted.
:rtype: :class:`~openstack.bare_metal.v1.port.Port`.
"""
return self._delete(_port.Port, port, ignore_missing=ignore_missing)
def portgroups(self, details=False, **query):
"""Retrieve a generator of portgroups.
:param details: A boolean indicating whether the detailed information
for every portgroup should be returned.
:param dict query: Optional query parameters to be sent to restrict
the portgroups returned. Available parameters include:
* ``address``: Only return portgroups with the specified physical
hardware address, typically a MAC address.
* ``fields``: A list containing one or more fields to be returned
in the response. This may lead to some performance gain
because other fields of the resource are not refreshed.
* ``limit``: Requests at most the specified number of portgroups
returned from the query.
* ``marker``: Specifies the ID of the last-seen portgroup. Use the
``limit`` parameter to make an initial limited request and
use the ID of the last-seen portgroup from the response as
the ``marker`` value in a subsequent limited request.
* ``node``:only return the ones associated with this specific node
(name or UUID), or an empty set if not found.
* ``sort_dir``: Sorts the response by the requested sort direction.
A valid value is ``asc`` (ascending) or ``desc``
(descending). Default is ``asc``. You can specify multiple
pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the
natural sorting direction of the server attribute that is
provided as the ``sort_key``.
* ``sort_key``: Sorts the response by the this attribute value.
Default is ``id``. You can specify multiple pairs of sort
key and sort direction query parameters. If you omit the
sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
``sort_key``.
:returns: A generator of portgroup instances.
"""
cls = _portgroup.PortGroupDetail if details else _portgroup.PortGroup
return self._list(cls, paginated=True, **query)
def create_portgroup(self, **attrs):
"""Create a new portgroup from attributes.
:param dict attrs: Keyword arguments that will be used to create a
:class:`~openstack.bare_metal.v1.portgroup.PortGroup`, it
comprises of the properties on the ``PortGroup`` class.
:returns: The results of portgroup creation.
:rtype: :class:`~openstack.bare_metal.v1.portgroup.PortGroup`.
"""
return self._create(_portgroup.PortGroup, **attrs)
def find_portgroup(self, name_or_id, ignore_missing=True):
"""Find a single portgroup.
:param str name_or_id: The name or ID of a portgroup.
:param bool ignore_missing: When set to ``False``, an exception of
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the portgroup does not exist. When set to `True``, None will
be returned when attempting to find a nonexistent portgroup.
:returns: One :class:`~openstack.bare_metal.v1.portgroup.PortGroup`
object or None.
"""
return self._find(_portgroup.PortGroup, name_or_id,
ignore_missing=ignore_missing)
def get_portgroup(self, portgroup, **query):
"""Get a specific portgroup.
:param portgroup: The value can be the name or ID of a chassis or a
:class:`~openstack.bare_metal.v1.portgroup.PortGroup` instance.
:param dict query: Optional query parameters to be sent to restrict
the portgroup properties returned. Available parameters include:
* ``fields``: A list containing one or more fields to be returned
in the response. This may lead to some performance gain
because other fields of the resource are not refreshed.
:returns: One :class:`~openstack.bare_metal.v1.portgroup.PortGroup`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
portgroup matching the name or ID could be found.
"""
return self._get(_portgroup.PortGroup, portgroup, **query)
def update_portgroup(self, portgroup, **attrs):
"""Update a portgroup.
:param chassis: Either the name or the ID of a portgroup or an instance
of :class:`~openstack.bare_metal.v1.portgroup.PortGroup`.
:param dict attrs: The attributes to update on the portgroup
represented by the ``portgroup`` parameter.
:returns: The updated portgroup.
:rtype: :class:`~openstack.bare_metal.v1.portgroup.PortGroup`
"""
return self._update(_portgroup.PortGroup, portgroup, **attrs)
def delete_portgroup(self, portgroup, ignore_missing=True):
"""Delete a portgroup.
:param portgroup: The value can be either the name or ID of a portgroup
or a :class:`~openstack.bare_metal.v1.portgroup.PortGroup`
instance.
:param bool ignore_missing: When set to ``False``, an exception
:class:`~openstack.exceptions.ResourceNotFound` will be raised
when the portgroup could not be found. When set to ``True``, no
exception will be raised when attempting to delete a non-existent
portgroup.
:returns: The instance of the portgroup which was deleted.
:rtype: :class:`~openstack.bare_metal.v1.portgroup.PortGroup`.
"""
return self._delete(_portgroup.PortGroup, portgroup,
ignore_missing=ignore_missing)

154
openstack/tests/unit/bare_metal/v1/test_proxy.py Normal file
View File

@ -0,0 +1,154 @@
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from openstack.bare_metal.v1 import _proxy
from openstack.bare_metal.v1 import chassis
from openstack.bare_metal.v1 import driver
from openstack.bare_metal.v1 import node
from openstack.bare_metal.v1 import port
from openstack.bare_metal.v1 import port_group
from openstack.tests.unit import test_proxy_base2
class TestBareMetalProxy(test_proxy_base2.TestProxyBase):
def setUp(self):
super(TestBareMetalProxy, self).setUp()
self.proxy = _proxy.Proxy(self.session)
def test_drivers(self):
self.verify_list(self.proxy.drivers, driver.Driver, paginated=False)
def test_get_driver(self):
self.verify_get(self.proxy.get_driver, driver.Driver)
def test_chassis_detailed(self):
self.verify_list(self.proxy.chassis, chassis.ChassisDetail,
paginated=True,
method_kwargs={"details": True, "query": 1},
expected_kwargs={"query": 1})
def test_chassis_not_detailed(self):
self.verify_list(self.proxy.chassis, chassis.Chassis,
paginated=True,
method_kwargs={"details": False, "query": 1},
expected_kwargs={"query": 1})
def test_create_chassis(self):
self.verify_create(self.proxy.create_chassis, chassis.Chassis)
def test_find_chassis(self):
self.verify_find(self.proxy.find_chassis, chassis.Chassis)
def test_get_chassis(self):
self.verify_get(self.proxy.get_chassis, chassis.Chassis)
def test_update_chassis(self):
self.verify_update(self.proxy.update_chassis, chassis.Chassis)
def test_delete_chassis(self):
self.verify_delete(self.proxy.delete_chassis, chassis.Chassis, False)
def test_delete_chassis_ignore(self):
self.verify_delete(self.proxy.delete_chassis, chassis.Chassis, True)
def test_nodes_detailed(self):
self.verify_list(self.proxy.nodes, node.NodeDetail,
paginated=True,
method_kwargs={"details": True, "query": 1},
expected_kwargs={"query": 1})
def test_nodes_not_detailed(self):
self.verify_list(self.proxy.nodes, node.Node,
paginated=True,
method_kwargs={"details": False, "query": 1},
expected_kwargs={"query": 1})
def test_create_node(self):
self.verify_create(self.proxy.create_node, node.Node)
def test_find_node(self):
self.verify_find(self.proxy.find_node, node.Node)
def test_get_node(self):
self.verify_get(self.proxy.get_node, node.Node)
def test_update_node(self):
self.verify_update(self.proxy.update_node, node.Node)
def test_delete_node(self):
self.verify_delete(self.proxy.delete_node, node.Node, False)
def test_delete_node_ignore(self):
self.verify_delete(self.proxy.delete_node, node.Node, True)
def test_ports_detailed(self):
self.verify_list(self.proxy.ports, port.PortDetail,
paginated=True,
method_kwargs={"details": True, "query": 1},
expected_kwargs={"query": 1})
def test_ports_not_detailed(self):
self.verify_list(self.proxy.ports, port.Port,
paginated=True,
method_kwargs={"details": False, "query": 1},
expected_kwargs={"query": 1})
def test_create_port(self):
self.verify_create(self.proxy.create_port, port.Port)
def test_find_port(self):
self.verify_find(self.proxy.find_port, port.Port)
def test_get_port(self):
self.verify_get(self.proxy.get_port, port.Port)
def test_update_port(self):
self.verify_update(self.proxy.update_port, port.Port)
def test_delete_port(self):
self.verify_delete(self.proxy.delete_port, port.Port, False)
def test_delete_port_ignore(self):
self.verify_delete(self.proxy.delete_port, port.Port, True)
def test_portgroups_detailed(self):
self.verify_list(self.proxy.portgroups, port_group.PortGroupDetail,
paginated=True,
method_kwargs={"details": True, "query": 1},
expected_kwargs={"query": 1})
def test_portgroups_not_detailed(self):
self.verify_list(self.proxy.portgroups, port_group.PortGroup,
paginated=True,
method_kwargs={"details": False, "query": 1},
expected_kwargs={"query": 1})
def test_create_portgroup(self):
self.verify_create(self.proxy.create_portgroup, port_group.PortGroup)
def test_find_portgroup(self):
self.verify_find(self.proxy.find_portgroup, port_group.PortGroup)
def test_get_portgroup(self):
self.verify_get(self.proxy.get_portgroup, port_group.PortGroup)
def test_update_portgroup(self):
self.verify_update(self.proxy.update_portgroup, port_group.PortGroup)
def test_delete_portgroup(self):
self.verify_delete(self.proxy.delete_portgroup, port_group.PortGroup,
False)
def test_delete_portgroup_ignore(self):
self.verify_delete(self.proxy.delete_portgroup, port_group.PortGroup,
True)