Merge pull request #514 from zancas/bugfix.alias_issue_411_rebased

Fixing issue 411

Author: pjbreaux

conftest.py

@@ -17,6 +17,9 @@
 from f5.bigip import ManagementRoot
 import mock
 import pytest
+import requests
+
+requests.packages.urllib3.disable_warnings()
 
 from icontrol.session import iControlRESTSession
 

f5/bigip/mixins.py

@@ -18,20 +18,17 @@
 
 
 from distutils.version import LooseVersion
-from f5.sdk_exception import F5SDKError
 import logging
 
+from f5.sdk_exception import F5SDKError
+from f5.sdk_exception import UnsupportedMethod
+
 
 class InvalidCommand(F5SDKError):
     """Raise this if command argument supplied is invalid."""
     pass
 
 
-class UnsupportedMethod(F5SDKError):
-    """Raise this if a method supplied is unsupported."""
-    pass
-
-
 class UnsupportedTmosVersion(F5SDKError):
     """Raise the error if a class of an API is instantiated,
 
@@ -147,55 +144,6 @@ def __setattr__(self, key, value):
         super(ExclusiveAttributesMixin, self).__setattr__(key, value)
 
 
-class UnnamedResourceMixin(object):
-    '''This makes a resource object work if there is no name.
-
-    These objects do not support create or delete and are often found
-    as Resources that are under an organizing collection.  For example
-    the `mgmt/tm/sys/global-settings` is one of these and has a kind of
-    `tm:sys:global-settings:global-settingsstate` and the URI does not
-    match the kind.
-    '''
-
-    def create(self, **kwargs):
-        '''Create is not supported for unnamed resources
-
-        :raises: UnsupportedOperation
-        '''
-        raise UnsupportedMethod(
-            "%s does not support the create method" % self.__class__.__name__
-        )
-
-    def delete(self, **kwargs):
-        '''Delete is not supported for unnamed resources
-
-        :raises: UnsupportedOperation
-        '''
-        raise UnsupportedMethod(
-            "%s does not support the delete method" % self.__class__.__name__
-        )
-
-    def load(self, **kwargs):
-        return self._load(**kwargs)
-
-    def _load(self, **kwargs):
-        '''Override _load because Unnamed Resources use their uri directly.
-
-        The Unnamed resources don't have URIs that match their kinds so
-        we need to use their URI directly instead of the container's URI
-        with name/partitions.
-        '''
-        self._check_load_parameters(**kwargs)
-        kwargs['uri_as_parts'] = True
-        read_session = self._meta_data['bigip']._meta_data['icr_session']
-        base_uri = self._meta_data['uri']
-        response = read_session.get(base_uri, **kwargs)
-        self._local_update(response.json())
-        new_instance = self.__class__(self._meta_data['container'])
-        new_instance._local_update(response.json())
-        return new_instance
-
-
 class CommandExecutionMixin(object):
     """This adds command execution option on the objects.
 

f5/bigip/resource.py

@@ -84,6 +84,7 @@
 from f5.bigip.mixins import LazyAttributeMixin
 from f5.bigip.mixins import ToDictMixin
 from f5.sdk_exception import F5SDKError
+from f5.sdk_exception import UnsupportedMethod
 from requests.exceptions import HTTPError
 
 
@@ -389,7 +390,6 @@ class ResourceBase(PathElement, ToDictMixin):
     This can be shortened to just the last line:
 
     .. code-block:: python
-
         nat1 = bigip.ltm.nats.nat.create('Foo', 'Bar', '0.1.2.3', '1.2.3.4')
 
     Critically this enforces a convention relating device published uris to
@@ -531,6 +531,31 @@ def delete(self, **kwargs):
         error_message = "Only Resources support 'delete'."
         raise InvalidResource(error_message)
 
+    def _stamp_out_core(self):
+        container = self._meta_data['container']
+        core = self.__class__.__new__(self.__class__)
+        core.__init__(container)
+        return core
+
+    def _produce_instance(self, response):
+        '''Generate a new self, which is an instance of the self.'''
+        new_instance = self._stamp_out_core()
+        # Post-process the response
+        new_instance._local_update(response.json())
+
+        if new_instance.kind != new_instance._meta_data['required_json_kind'] \
+           and new_instance.kind != "tm:transaction:commandsstate":
+            error_message = "For instances of type '%r' the corresponding"\
+                " kind must be '%r' but creation returned JSON with kind: %r"\
+                % (new_instance.__class__.__name__,
+                   new_instance._meta_data['required_json_kind'],
+                   new_instance.kind)
+            raise KindTypeMismatch(error_message)
+
+        # Update the object to have the correct functional uri.
+        new_instance._activate_URI(new_instance.selfLink)
+        return new_instance
+
 
 class OrganizingCollection(ResourceBase):
     """Base class for objects that collect resources under them.
@@ -737,21 +762,8 @@ def _create(self, **kwargs):
         # Invoke the REST operation on the device.
         response = session.post(_create_uri, json=kwargs, **requests_params)
 
-        # Post-process the response
-        self._local_update(response.json())
-
-        if self.kind != self._meta_data['required_json_kind'] \
-           and self.kind != "tm:transaction:commandsstate":
-            error_message = "For instances of type '%r' the corresponding"\
-                " kind must be '%r' but creation returned JSON with kind: %r"\
-                % (self.__class__.__name__,
-                   self._meta_data['required_json_kind'],
-                   self.kind)
-            raise KindTypeMismatch(error_message)
-
-        # Update the object to have the correct functional uri.
-        self._activate_URI(self.selfLink)
-        return self
+        # Make new instance of self
+        return self._produce_instance(response)
 
     def create(self, **kwargs):
         """Create the resource on the BIG-IP®.
@@ -781,8 +793,7 @@ def create(self, **kwargs):
                   configuration and state on the BIG-IP®.
 
         """
-        self._create(**kwargs)
-        return self
+        return self._create(**kwargs)
 
     def _load(self, **kwargs):
         """wrapped with load, override that in a subclass to customize"""
@@ -798,9 +809,8 @@ def _load(self, **kwargs):
         base_uri = self._meta_data['container']._meta_data['uri']
         kwargs.update(requests_params)
         response = refresh_session.get(base_uri, **kwargs)
-        self._local_update(response.json())
-        self._activate_URI(self.selfLink)
-        return self
+        # Make new instance of self
+        return self._produce_instance(response)
 
     def load(self, **kwargs):
         """Load an already configured service into this instance.
@@ -819,12 +829,12 @@ def load(self, **kwargs):
         be handled according to that API. THIS IS HOW TO PASS QUERY-ARGS!
         :returns: a Resource Instance (with a populated _meta_data['uri'])
         """
-        self._load(**kwargs)
-        return self
+        return self._load(**kwargs)
 
     def _delete(self, **kwargs):
         """wrapped with delete, override that in a subclass to customize """
         requests_params = self._handle_requests_params(kwargs)
+
         delete_uri = self._meta_data['uri']
         session = self._meta_data['bigip']._meta_data['icr_session']
 
@@ -887,3 +897,37 @@ def exists(self, **kwargs):
             else:
                 raise
         return True
+
+
+class UnnamedResource(ResourceBase):
+    '''This makes a resource object work if there is no name.
+
+    These objects do not support create or delete and are often found
+    as Resources that are under an organizing collection.  For example
+    the `mgmt/tm/sys/global-settings` is one of these and has a kind of
+    `tm:sys:global-settings:global-settingsstate` and the URI does not
+    match the kind.
+    '''
+
+    def create(self, **kwargs):
+        '''Create is not supported for unnamed resources
+
+        :raises: UnsupportedOperation
+        '''
+        raise UnsupportedMethod(
+            "%s does not support the create method" % self.__class__.__name__
+        )
+
+    def delete(self, **kwargs):
+        '''Delete is not supported for unnamed resources
+
+        :raises: UnsupportedOperation
+        '''
+        raise UnsupportedMethod(
+            "%s does not support the delete method" % self.__class__.__name__
+        )
+
+    def load(self, **kwargs):
+        newinst = self._stamp_out_core()
+        newinst._refresh(**kwargs)
+        return newinst

f5/bigip/test/test_mixins.py

@@ -17,7 +17,6 @@
 
 from f5.bigip.mixins import CommandExecutionMixin
 from f5.bigip.mixins import ToDictMixin
-from f5.bigip.mixins import UnnamedResourceMixin
 from f5.bigip.mixins import UnsupportedMethod
 
 
@@ -107,18 +106,6 @@ def test_TestClass_Basic():
     assert json.dumps(mtc_as_dict) == '{"y": {"test_attribute": 42}}'
 
 
-class TestUnnamedResourceMixin(object):
-    def test_create_raises(self):
-        unnamed_resource = UnnamedResourceMixin()
-        with pytest.raises(UnsupportedMethod):
-            unnamed_resource.create()
-
-    def test_delete_raises(self):
-        unnamed_resource = UnnamedResourceMixin()
-        with pytest.raises(UnsupportedMethod):
-            unnamed_resource.create()
-
-
 class TestCommandExecutionMixin(object):
     def test_create_raises(self):
         command_resource = CommandExecutionMixin()

f5/bigip/test/test_resource.py

@@ -31,8 +31,11 @@
 from f5.bigip.resource import RequestParamKwargCollision
 from f5.bigip.resource import Resource
 from f5.bigip.resource import ResourceBase
+from f5.bigip.resource import UnnamedResource
 from f5.bigip.resource import UnregisteredKind
 from f5.bigip.resource import URICreationCollision
+from f5.bigip.tm.ltm.virtual import Virtual
+from f5.sdk_exception import UnsupportedMethod
 
 
 class MockResponse(object):
@@ -102,26 +105,26 @@ def test_missing_required_creation_parameter(self):
             "Missing required params: ['NONEMPTY']"
 
     def test_KindTypeMismatch(self):
-        r = Resource(mock.MagicMock())
+        r = Virtual(mock.MagicMock())
         r._meta_data['bigip']._meta_data['icr_session'].post.return_value =\
             MockResponse({u"kind": u"tm:"})
-        r._meta_data['required_json_kind'] = 'INCORRECT!'
         with pytest.raises(KindTypeMismatch) as KTMmEIO:
             r.create(partition="Common", name="test_create")
         assert KTMmEIO.value.message ==\
-            "For instances of type ''Resource'' the corresponding kind must"\
-            " be ''INCORRECT!'' but creation returned JSON with kind: u'tm:'"
+            "For instances of type ''Virtual'' the corresponding kind must "\
+            "be ''tm:ltm:virtual:virtualstate'' but creation returned "\
+            "JSON with kind: u'tm:'"
 
-    def test_successful(self):
-        r = Resource(mock.MagicMock())
-        MRO = MockResponse({u"kind": u"tm:",
+    def test_success(self):
+        r = Virtual(mock.MagicMock())
+        MRO = MockResponse({u"kind": u"tm:ltm:virtual:virtualstate",
                             u"selfLink": u".../~Common~test_create"})
         r._meta_data['bigip']._meta_data['icr_session'].post.return_value = MRO
-        r._meta_data['required_json_kind'] = u"tm:"
+        r._meta_data['required_json_kind'] = u"tm:ltm:virtual:virtualstate"
         r._meta_data['allowed_lazy_attributes'] = []
-        r.create(partition="Common", name="test_create")
-        assert r.kind == u"tm:"
-        assert r.selfLink == u".../~Common~test_create"
+        x = r.create(partition="Common", name="test_create")
+        assert x.kind == u"tm:ltm:virtual:virtualstate"
+        assert x.selfLink == u".../~Common~test_create"
 
 
 def test__activate_URI():
@@ -338,19 +341,25 @@ def test_icontrol_version_default(self):
         assert 'params' not in submitted
 
     def test_success(self):
-        r = Resource(mock.MagicMock())
+        r = Virtual(mock.MagicMock())
         r._meta_data['allowed_lazy_attributes'] = []
-        mockuri = "https://localhost:443/mgmt/tm/ltm/nat/~Common~test_load"
+        mockuri = "https://localhost:443/mgmt/tm/ltm/virtual/~Common~test_load"
         attrs = {'get.return_value':
-                 MockResponse({u"generation": 0, u"selfLink": mockuri})}
+                 MockResponse(
+                     {
+                         u"generation": 0,
+                         u"selfLink": mockuri,
+                         u"kind": u"tm:ltm:virtual:virtualstate"
+                     }
+                 )}
         mock_session = mock.MagicMock(**attrs)
         r._meta_data['bigip']._meta_data =\
             {'icr_session': mock_session,
              'hostname': 'TESTDOMAINNAME',
              'uri': 'https://TESTDOMAIN:443/mgmt/tm/'}
         r.generation = 0
-        r.load(partition='Common', name='test_load')
-        assert r.selfLink == mockuri
+        x = r.load(partition='Common', name='test_load')
+        assert x.selfLink == mockuri
 
 
 class TestResource_exists(object):
@@ -507,3 +516,15 @@ def test_check_exclusive_parameters_fail(self):
         with pytest.raises(ExclusiveAttributesPresent) as EAEIO:
             p._check_exclusive_parameters(**fakearg)
         assert 'FOOEX, BAREX' in EAEIO.value.message
+
+
+class TestUnnamedResource(object):
+    def test_create_raises(self):
+        unnamed_resource = UnnamedResource(mock.MagicMock())
+        with pytest.raises(UnsupportedMethod):
+            unnamed_resource.create()
+
+    def test_delete_raises(self):
+        unnamed_resource = UnnamedResource(mock.MagicMock())
+        with pytest.raises(UnsupportedMethod):
+            unnamed_resource.create()

f5/bigip/tm/auth/password_policy.py

@@ -30,11 +30,10 @@
     ``tm:auth:password-policy:password-policystate``
 """
 
-from f5.bigip.mixins import UnnamedResourceMixin
-from f5.bigip.resource import ResourceBase
+from f5.bigip.resource import UnnamedResource
 
 
-class Password_Policy(UnnamedResourceMixin, ResourceBase):
+class Password_Policy(UnnamedResource):
     """BIG-IP® password policy unnamed resource
 
         .. note::

f5/bigip/tm/cm/sync_status.py

@@ -27,11 +27,10 @@
     ``tm:cm:sync-status:*``
 """
 
-from f5.bigip.mixins import UnnamedResourceMixin
-from f5.bigip.resource import ResourceBase
+from f5.bigip.resource import UnnamedResource
 
 
-class Sync_Status(ResourceBase, UnnamedResourceMixin):
+class Sync_Status(UnnamedResource):
     '''A Resource concrete subclass.'''
     def __init__(self, cm):
         '''Autogenerated constructor.'''