openstack/openstacksdk
Code Issues Proposed changes

Resource.find should not raise ResourceNotFound

Browse Source 
Find now returns None if nothing is found.

Change-Id: I8106b61d991aa6e29b3182946c711eda8f5c4e89
Closes-Bug: 1415197
This commit is contained in:
Terry Howe 2015-01-29 07:12:10 -07:00
parent 82e5810c80
commit bddb145c54
10 changed files with 44 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/usage.rst
View File

@ -19,7 +19,6 @@ To use python-openstacksdk in a project::
# Third, create a connection
conn = connection.Connection(preference=pref, **auth_args)
# Finally, access your desired services
try:
network = conn.network.find_network("matrix")
except exceptions.ResourceNotFound:
network = conn.network.find_network("matrix")
if network is None:
network = conn.network.create_network({"name": "matrix"})

85
examples/jenkins.py
View File

@ -25,7 +25,6 @@ import sys
from examples import common
from openstack import connection
from openstack import exceptions
def create_jenkins(opts):
@ -38,15 +37,13 @@ def create_jenkins(opts):
args = vars(opts)
conn = connection.Connection(preference=opts.user_preferences, **args)
try:
network = conn.network.find_network(name)
except exceptions.ResourceNotFound:
network = conn.network.find_network(name)
if network is None:
network = conn.network.create_network(name=name)
print(str(network))
try:
subnet = conn.network.find_subnet(name)
except exceptions.ResourceNotFound:
subnet = conn.network.find_subnet(name)
if subnet is None:
args = {
"name": name,
"network_id": network.id,
@ -58,9 +55,8 @@ def create_jenkins(opts):
print(str(subnet))
extnet = conn.network.find_network("Ext-Net")
try:
router = conn.network.find_router(name)
except exceptions.ResourceNotFound:
router = conn.network.find_router(name)
if router is None:
args = {
"name": name,
"external_gateway_info": {"network_id": extnet.id}
@ -69,9 +65,8 @@ def create_jenkins(opts):
conn.network.router_add_interface(router, subnet.id)
print(str(router))
try:
sg = conn.network.find_security_group(name)
except exceptions.ResourceNotFound:
sg = conn.network.find_security_group(name)
if sg is None:
sg = conn.network.create_security_group(name=name)
print(str(sg))
rule = {
@ -164,9 +159,8 @@ def create_jenkins(opts):
print('rule allow ssh')
print(str(sg))
try:
kp = conn.compute.find_keypair(name)
except exceptions.ResourceNotFound:
kp = conn.compute.find_keypair(name)
if kp is None:
kp = conn.compute.create_keypair(name=name)
try:
os.remove('jenkins')
@ -185,10 +179,8 @@ def create_jenkins(opts):
f.close()
print(str(kp))
try:
server = conn.compute.find_server(name)
server = conn.get(server)
except exceptions.ResourceNotFound:
server = conn.compute.find_server(name)
if server is None:
f = open('examples/cloud-init.sh', 'r')
cmd = f.read()
f.close()
@ -203,15 +195,16 @@ def create_jenkins(opts):
"user_data": b64str,
}
server = conn.compute.create_server(**args)
else:
server = conn.get(server)
print(str(server))
print('Waiting for the server to come up....')
conn.compute.wait_for_status(server)
print('Server is up.')
if len(server.get_floating_ips()) <= 0:
try:
ip = conn.network.find_available_ip()
except exceptions.ResourceNotFound:
ip = conn.network.find_available_ip()
if ip is None:
ip = conn.network.create_ip(floating_network_id=extnet.id)
port = next(conn.network.list_ports(device_id=server.id, fields='id'))
conn.network.add_ip_to_port(port, ip)
@ -228,8 +221,8 @@ def delete_jenkins(opts):
args = vars(opts)
conn = connection.Connection(preference=opts.user_preferences, **args)
try:
server = conn.compute.find_server(name)
server = conn.compute.find_server(name)
if server is not None:
server = conn.get(server)
print(str(server))
ips = server.get_floating_ips()
@ -239,25 +232,18 @@ def delete_jenkins(opts):
conn.network.remove_ip_from_port(ip)
conn.delete(ip)
conn.delete(server)
except exceptions.ResourceNotFound:
pass
try:
kp = conn.compute.find_keypair(name)
kp = conn.compute.find_keypair(name)
if kp is not None:
print(str(kp))
conn.delete(kp)
except exceptions.ResourceNotFound:
pass
try:
router = conn.network.find_router(name)
router = conn.network.find_router(name)
if router is not None:
print(str(router))
except exceptions.ResourceNotFound:
router = None
pass
try:
subnet = conn.network.find_subnet(name)
subnet = conn.network.find_subnet(name)
if subnet is not None:
print(str(subnet))
if router:
try:
@ -267,28 +253,17 @@ def delete_jenkins(opts):
for port in conn.network.get_subnet_ports(subnet.id):
print(str(port))
conn.delete(port)
except exceptions.ResourceNotFound:
subnet = None
pass
try:
if router:
conn.delete(router)
except exceptions.ResourceNotFound:
pass
if router is not None:
conn.delete(router)
try:
if subnet:
conn.delete(subnet)
except exceptions.ResourceNotFound:
pass
if subnet:
conn.delete(subnet)
try:
network = conn.network.find_network(name)
network = conn.network.find_network(name)
if network is not None:
print(str(network))
conn.delete(network)
except exceptions.ResourceNotFound:
pass
def run_jenkins(opts):

4
openstack/compute/v2/keypair.py
View File

@ -60,6 +60,4 @@ class Keypair(resource.Resource):
return cls.get_by_id(session, name_or_id)
except exceptions.HttpException:
pass
msg = ("No %s with a name or ID of '%s' exists." %
(cls.get_resource_name(), name_or_id))
raise exceptions.ResourceNotFound(msg)
return None

5
openstack/connection.py
View File

@ -52,9 +52,8 @@ Find or create
If you wanted to make sure you had a network named 'jenkins', you would first
try to find it and if that fails, you would create it::
try:
network = conn.network.find_network("jenkins")
except exceptions.ResourceNotFound:
network = conn.network.find_network("jenkins")
if network is None:
network = conn.network.create_network({"name": "jenkins"})
"""

5
openstack/exceptions.py
View File

@ -79,11 +79,6 @@ class MethodNotSupported(SDKException):
pass
class ResourceNotFound(SDKException):
"""The requested resource was not found."""
pass
class DuplicateResource(SDKException):
"""More than one resource exists with that name."""
pass

4
openstack/network/v2/floatingip.py
View File

@ -10,7 +10,6 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack import exceptions
from openstack.network import network_service
from openstack import resource
@ -50,5 +49,4 @@ class FloatingIP(resource.Resource):
try:
return next(info)
except StopIteration:
msg = "No available floating ips exist."
raise exceptions.ResourceNotFound(msg)
return None

9
openstack/resource.py
View File

@ -699,9 +699,8 @@ class Resource(collections.MutableMapping):
a compound URL.
See `How path_args are used`_ for details.
:return: The :class:`Resource` object matching the given name or id.
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
resource can be found with that name or id.
:return: The :class:`Resource` object matching the given name or id
or None if nothing matches.
"""
try:
args = {
@ -740,6 +739,4 @@ class Resource(collections.MutableMapping):
if result is not None:
return result
msg = ("No %s with a name or ID of '%s' exists." %
(cls.get_resource_name(), name_or_id))
raise exceptions.ResourceNotFound(msg)
return None

2
openstack/tests/compute/v2/test_keypair.py
View File

@ -64,4 +64,4 @@ class TestKeypair(testtools.TestCase):
sess.get = mock.MagicMock()
sess.get.side_effect = exceptions.HttpException("404")
sot = keypair.Keypair()
self.assertRaises(exceptions.ResourceNotFound, sot.find, sess, "kato")
self.assertEqual(None, sot.find(sess, "kato"))

5
openstack/tests/network/v2/test_floatingip.py
View File

@ -13,7 +13,6 @@
import mock
import testtools
from openstack import exceptions
from openstack.network.v2 import floatingip
IDENTIFIER = '10.0.0.1'
@ -78,5 +77,5 @@ class TestFloatingIP(testtools.TestCase):
fake_response.body = {floatingip.FloatingIP.resources_key: []}
mock_get.return_value = fake_response
self.assertRaises(exceptions.ResourceNotFound,
floatingip.FloatingIP.find_available, mock_session)
self.assertEqual(None,
floatingip.FloatingIP.find_available(mock_session))

6
openstack/tests/test_resource.py
View File

@ -474,8 +474,7 @@ class TestFind(base.TestCase):
resp = FakeResponse({FakeResource.resources_key: []})
self.mock_get.return_value = resp
self.assertRaises(exceptions.ResourceNotFound, FakeResource.find,
self.mock_session, self.NAME)
self.assertEqual(None, FakeResource.find(self.mock_session, self.NAME))
def test_no_name(self):
self.mock_get.side_effect = [
@ -484,8 +483,7 @@ class TestFind(base.TestCase):
]
FakeResource.name_attribute = None
self.assertRaises(exceptions.ResourceNotFound, FakeResource.find,
self.mock_session, self.NAME)
self.assertEqual(None, FakeResource.find(self.mock_session, self.NAME))
def test_repr_name(self):
FakeResource.resource_name = 'foo'