Addressing code review comments from @zancas. Overriding _check_load_parameters and _check_create_parameters to raise if we see partition as a parameter to either load or create.

Author: Paul Breaux

f5/bigip/__init__.py

@@ -35,7 +35,6 @@
 from f5.bigip.tm.sys import Sys
 from f5.bigip.tm import Tm
 from f5.bigip.tm.transaction import Transactions
-from f5.bigip.tm.vcmp import Vcmp
 
 
 class ManagementRoot(PathElement):
@@ -90,10 +89,15 @@ def _get_tmos_version(self):
 class BigIP(ManagementRoot):
     """A shim class used to access the default config resources in 'mgmt/tm.'
 
+    PLEASE DO NOT ADD ATTRIBUTES TO THIS CLASS.
+
+    This class is depcrated in favor of MangementRoot above. Do not add any
+    more objects to the allowed_lazy_attributes list here!
+
     This class is solely implemented for backwards compatibility.
     """
     def __init__(self, hostname, username, password, **kwargs):
         super(BigIP, self).__init__(hostname, username, password, **kwargs)
         self._meta_data['uri'] = self._meta_data['uri'] + 'tm/'
         self._meta_data['allowed_lazy_attributes'] =\
-            [TmAuth, TmCm, Ltm, Gtm, Net, TmShared, Sys, Transactions, Vcmp]
+            [TmAuth, TmCm, Ltm, Gtm, Net, TmShared, Sys, Transactions]

f5/bigip/tm/vcmp/guest.py

@@ -29,6 +29,17 @@
 
 from f5.bigip.resource import Collection
 from f5.bigip.resource import Resource
+from f5.sdk_exception import F5SDKError
+
+
+class DisallowedCreationParameter(F5SDKError):
+    """Exception when partition is passed to create for guest resource."""
+    pass
+
+
+class DisallowedReadParameter(F5SDKError):
+    """Exception when partition is passed to load for guest resource."""
+    pass
 
 
 class Guests(Collection):
@@ -48,3 +59,33 @@ def __init__(self, guests):
         super(Guest, self).__init__(guests)
         self._meta_data['required_json_kind'] =\
             'tm:vcmp:guest:gueststate'
+
+    def _check_load_parameters(self, **kwargs):
+        """Override method for one in resource.py to check partition
+
+        The partition cannot be included as a parameter to load a guest.
+        Raise an exception if a consumer gives the partition.
+
+        :raises: DisallowedReadParameter
+        """
+
+        if 'partition' in kwargs:
+            msg = "'partition' is not allowed as a load parameter. Vcmp " \
+                "guests are accessed by name."
+            raise DisallowedReadParameter(msg)
+        super(Guest, self)._check_load_parameters(**kwargs)
+
+    def _check_create_parameters(self, **kwargs):
+        """Override method for one in resource.py to check partition
+
+        The partition cannot be included as a parameter to create a guest.
+        Raise an exception if a consumer gives the partition.
+
+        :raises: DisallowedCreationParameter
+        """
+
+        if 'partition' in kwargs:
+            msg = "'partition' is not allowed as a create parameter. Vcmp " \
+                "guests are created with the 'name' at least."
+            raise DisallowedCreationParameter(msg)
+        super(Guest, self)._check_create_parameters(**kwargs)

f5/bigip/tm/vcmp/test/test_guest.py

@@ -17,6 +17,8 @@
 import pytest
 
 from f5.bigip.resource import MissingRequiredCreationParameter
+from f5.bigip.tm.vcmp.guest import DisallowedCreationParameter
+from f5.bigip.tm.vcmp.guest import DisallowedReadParameter
 from f5.bigip.tm.vcmp.guest import Guest
 
 
@@ -30,3 +32,17 @@ def test_create_no_args(FakeGuest):
     with pytest.raises(MissingRequiredCreationParameter) as ex:
         FakeGuest.create()
     assert "Missing required params: ['name']" in ex.value.message
+
+
+def test_create_with_parition(FakeGuest):
+    with pytest.raises(DisallowedCreationParameter) as ex:
+        FakeGuest.create(name='test', partition='Common')
+    assert "'partition' is not allowed as a create parameter" in \
+        ex.value.message
+
+
+def test_load_with_partition(FakeGuest):
+    with pytest.raises(DisallowedReadParameter) as ex:
+        FakeGuest.load(name='test', partition='Common')
+    assert "'partition' is not allowed as a load parameter" in \
+        ex.value.message

test/functional/tm/vcmp/test_guest.py

@@ -15,6 +15,8 @@
 
 from f5.bigip.resource import MissingRequiredCreationParameter
 from f5.bigip.resource import MissingRequiredReadParameter
+from f5.bigip.tm.vcmp.guest import DisallowedCreationParameter
+from f5.bigip.tm.vcmp.guest import DisallowedReadParameter
 from icontrol.session import iControlUnexpectedHTTPError
 
 import copy
@@ -55,18 +57,20 @@ def test_guest_create_refresh_update_delete_load_modify(
         guest1.update()
         assert guest1.managementGw == '10.190.0.1'
         old_sslmode = guest1.sslMode
-        guest1.sslMode = 'dedicated'
+        guest1.sslMode = 'testing ssl mode'
         guest1.refresh()
         assert guest1.sslMode == old_sslmode
         guest2 = guests.guest.load(name='test')
         assert guest1.selfLink == guest2.selfLink
+        assert guest1.sslMode != 'dedicated'
         guest2.modify(sslMode='dedicated')
         guest1.refresh()
         assert guest2.sslMode == guest1.sslMode
 
     def test_guest_modify(self, setup_guest_test):
         guests, guest1 = setup_guest_test
         original_dict = copy.copy(guest1.__dict__)
+        assert guest1.managementGw != '10.190.0.1'
         gw = 'managementGw'
         guest1.modify(managementGw='10.190.0.1')
         for k, v in original_dict.items():
@@ -81,21 +85,22 @@ def test_guest_no_creation_args(self, vcmp_host):
         assert 'name' in ex.value.message
 
     def test_guest_bad_creation_args(self, vcmp_host):
-        with pytest.raises(iControlUnexpectedHTTPError) as ex:
+        with pytest.raises(DisallowedCreationParameter) as ex:
             vcmp_host.tm.vcmp.guests.guest.create(
                 name='test', partition='Common')
-        assert '(/Common/test) is invalid' in ex.value.message
+        assert "'partition' is not allowed as a create parameter" in \
+            ex.value.message
 
     def test_guest_no_load_args(self, vcmp_host):
         with pytest.raises(MissingRequiredReadParameter) as ex:
             vcmp_host.tm.vcmp.guests.guest.load()
         assert 'name' in ex.value.message
 
     def test_guest_bad_load_args(self, vcmp_host):
-        with pytest.raises(iControlUnexpectedHTTPError) as ex:
+        with pytest.raises(DisallowedReadParameter) as ex:
             vcmp_host.tm.vcmp.guests.guest.load(
                 name='test', partition='test-bad-arg')
-        assert 'The requested VCMP (/test-bad-arg/test) was not found' in \
+        assert "'partition' is not allowed as a load parameter" in \
             ex.value.message
 
     def test_guest_bad_modify(self, setup_guest_test):