CP-49689: load error defs from sibling file

Signed-off-by: Mark Syms <[email protected]>

drivers/xs_errors.py

@@ -22,7 +22,8 @@
 import util
 import xmlrpc.client
 
-XML_DEFS = '/opt/xensource/sm/XE_SR_ERRORCODES.xml'
+DEF_LOC = os.path.dirname(__file__)
+XML_DEFS = os.path.join(DEF_LOC, 'XE_SR_ERRORCODES.xml')
 
 
 class SRException(Exception):
@@ -33,7 +34,8 @@ def __init__(self, reason):
         Exception.__init__(self, reason)
 
     def toxml(self):
-        return xmlrpc.client.dumps(xmlrpc.client.Fault(int(self.errno), str(self)), "", True)
+        return xmlrpc.client.dumps(xmlrpc.client.Fault(
+            int(self.errno), str(self)), "", True)
 
 
 class SROSError(SRException):
@@ -68,7 +70,8 @@ def __new__(self, key, opterr=None):
             errormessage = subdict['description']
             if opterr is not None:
                 errormessage += " [opterr=%s]" % opterr
-            util.SMlog("Raising exception [%d, %s]" % (errorcode, errormessage))
+            util.SMlog("Raising exception [%d, %s]" %
+                       (errorcode, errormessage))
             return SROSError(errorcode, errormessage)
 
         # development error

tests/test_BaseISCSI.py

@@ -85,7 +85,6 @@ def test_attach_tgt_present_path_found(self, mock_init_paths):
         self.subject.attach(self.sr_uuid)
 
     @mock.patch('BaseISCSI.BaseISCSISR._initPaths', autospec=True)
-    @mock.patch('BaseISCSI.xs_errors.XML_DEFS', "drivers/XE_SR_ERRORCODES.xml")
     def test_attach_tgt_present_path_not_found(self, mock_init_paths):
         # Arrange
         self.mock_util._testHost.return_value = None

tests/test_FileSR.py

@@ -47,10 +47,6 @@ def setUp(self):
         gethidden_patch = mock.patch('FileSR.vhdutil.getHidden')
         self.mock_gethidden = gethidden_patch.start()
 
-        errors_patcher = mock.patch('FileSR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
-        errors_patcher.start()
-
         fist_patcher = mock.patch('FileSR.util.FistPoint.is_active',
                                   autospec=True)
         self.mock_fist = fist_patcher.start()
@@ -254,7 +250,8 @@ def my_stat(tgt):
             return real_stat(tgt)
 
         # Act
-        with self.assertRaises(xs_errors.SROSError) as srose, mock.patch('FileSR.os.stat') as mock_stat:
+        with self.assertRaises(xs_errors.SROSError), \
+                mock.patch('FileSR.os.stat') as mock_stat:
             mock_stat.side_effect = my_stat
             clone_xml = vdi.clone(sr_uuid, vdi_uuid)
 
@@ -301,7 +298,8 @@ def my_stat(tgt):
             return real_stat(tgt)
 
         # Act
-        with self.assertRaises(xs_errors.SROSError) as srose, mock.patch('FileSR.os.stat') as mock_stat:
+        with self.assertRaises(xs_errors.SROSError), \
+                mock.patch('FileSR.os.stat') as mock_stat:
             mock_stat.side_effect = my_stat
             clone_xml = vdi.clone(sr_uuid, vdi_uuid)
 
@@ -520,9 +518,7 @@ def test_attach_fist_active(self):
         self.mock_session.xenapi.message.create.assert_called_with(
             'sr_does_not_support_hardlinks', 2, "SR", self.sr_uuid, mock.ANY)
 
-    @testlib.with_context
-    def test_attach_not_writable(self, context):
-        context.setup_error_codes()
+    def test_attach_not_writable(self):
         test_sr = self.create_test_sr()
 
         with mock.patch('FileSR.open') as mock_open:
@@ -566,10 +562,6 @@ def setUp(self):
         pread_patcher = mock.patch('FileSR.util.pread')
         self.mock_pread = pread_patcher.start()
 
-        errors_patcher = mock.patch('FileSR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
-        errors_patcher.start()
-
         sr_init_patcher = mock.patch('SR.SR.__init__')
         def fake_sr_init(self, srcmd, sr_uuid):
             self.sr_ref = False

tests/test_HBASR.py

@@ -145,8 +145,6 @@ def test__init_hbadict(self, mock_cacheSCSIidentifiers,
         self.assertEqual(sr2.devs, "123445")
 
     @mock.patch('HBASR.HBASR.__init__', mock_init)
-    @mock.patch('LVHDoHBASR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
     @mock.patch('HBASR.HBASR._probe_hba', autospec=True)
     @mock.patch('HBASR.xml.dom.minidom.parseString', autospec=True)
     def test__init_hbahostname_assert(self, mock_parseString, mock_probe_hba):
@@ -167,8 +165,6 @@ def test__init_hbahostname(self):
         self.assertEqual(res, "20-00-00-e0-8b-18-20-8b")
 
     @mock.patch('HBASR.HBASR.__init__', mock_init)
-    @mock.patch('LVHDoHBASR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
     @mock.patch('HBASR.HBASR._probe_hba', autospec=True)
     @mock.patch('HBASR.xml.dom.minidom.parseString', autospec=True)
     def test__init_hbas_assert(self, mock_parseString, mock_probe_hba):
@@ -190,8 +186,6 @@ def test__init_hbas(self):
                                'host1': '50-01-43-80-24-26-ba-f4'})
 
     @mock.patch('HBASR.HBASR.__init__', mock_init)
-    @mock.patch('LVHDoHBASR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
     @mock.patch('HBASR.util.pread', autospec=True)
     def test__probe_hba_assert(self, mock_pread):
         sr = HBASR.HBASR()
@@ -203,8 +197,6 @@ def test__probe_hba_assert(self, mock_pread):
                          "[opterr=HBA probe failed]")
 
     @mock.patch('HBASR.HBASR.__init__', mock_init)
-    @mock.patch('LVHDoHBASR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
     @mock.patch('HBASR.util.pread', autospec=True)
     @mock.patch('HBASR.util.listdir', autospec=True)
     def test__probe_hba(self, mock_listdir, mock_pread):

tests/test_ISOSR.py

@@ -155,14 +155,14 @@ def test_attach_nfs_no_server(
                                   sr_uuid='asr_uuid')
 
         _checkmount.side_effect = [False]
-        testHost.side_effect = xs_errors.SROSError(140, 'Incorrect DNS name, unable to resolve.')
+        testHost.side_effect = xs_errors.SROSError(
+            140, 'Incorrect DNS name, unable to resolve.')
 
         with self.assertRaises(xs_errors.SROSError) as ose:
             isosr.attach(None)
 
         self.assertEqual(140, ose.exception.errno)
 
-    @testlib.with_context
     @mock.patch('util.gen_uuid', autospec=True)
     @mock.patch('nfs.soft_mount', autospec=True)
     @mock.patch('util._convertDNS', autospec=True)
@@ -173,10 +173,8 @@ def test_attach_nfs_no_server(
     # Can't use autospec due to http://bugs.python.org/issue17826
     @mock.patch('ISOSR.ISOSR._checkmount')
     def test_attach_nfs_wrong_version(
-            self, context, _checkmount, check_server_tcp, testHost, makedirs,
+            self, _checkmount, check_server_tcp, testHost, makedirs,
             validate_nfsversion, convertDNS, soft_mount, gen_uuid):
-        context.setup_error_codes()
-
         isosr = self.create_isosr(location='aServer:/aLocation', atype='nfs_iso',
                                   sr_uuid='asr_uuid')
 
@@ -231,7 +229,6 @@ def test_attach_with_smb_version_1(self, context, _checkmount, pread,
         """
         Positive case, over XC/XE CLI with version 1.0.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs', vers='1.0')
         _checkmount.side_effect = [False, True]
         smbsr.attach(None)
@@ -250,7 +247,6 @@ def test_attach_with_smb_credentials(self, context, _checkmount, pread,
         """
         Positive case, over XC/XE CLI with version 1.0.
         """
-        context.setup_error_codes()
         update = {'username': 'dot', 'cifspassword': 'winter2019'}
         smbsr = self.create_smbisosr(atype='cifs', vers='1.0',
                                      dconf_update=update)
@@ -272,7 +268,6 @@ def test_attach_with_smb_credentials_domain(self, context,
         """
         Positive case, over XC/XE CLI with version 1.0.
         """
-        context.setup_error_codes()
         update = {'username': r'citrix\jsmith', 'cifspassword': 'winter2019'}
         smbsr = self.create_smbisosr(atype='cifs', vers='1.0',
                                      dconf_update=update)
@@ -293,7 +288,6 @@ def test_attach_with_smb_version_3(self, context, _checkmount, pread,
         """
         Positive case, over XC/XE CLI with version 3.0.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs', vers='3.0')
         _checkmount.side_effect = [False, True]
         smbsr.attach(None)
@@ -314,7 +308,6 @@ def test_attach_with_smb_no_version(self, context,
         """
         Positive case, over XC/XE CLI without version.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs')
         _checkmount.side_effect = [False, True]
         smbsr.attach(None)
@@ -333,7 +326,6 @@ def test_attach_smb_via_xemount_version_1(self, context, pread, _checkmount,
         """
         Positive case, over xe-sr-mount CLI with version 1.0.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(options='-o username=administrator,password=password,vers=1.0')
         smbsr.attach(None)
         self.assertEqual(0, pread.call_count)
@@ -350,7 +342,6 @@ def test_attach_smb_via_xemount_version_3(self, context, pread,
         """
         Positive case, over xe-sr-mount CLI with version 3.0.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(options='-o username=administrator,password=password,vers=3.0')
         smbsr.attach(None)
         self.assertEqual(0, pread.call_count)
@@ -370,24 +361,20 @@ def test_attach_smb_via_xemount_no_version(self, context, pread,
         """
         Positive case, without version from xe-sr-mount.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(options='-o username=administrator,password=password')
         smbsr.attach(None)
         self.assertEqual(0, pread.call_count)
 
-    @testlib.with_context
     @mock.patch('util.gen_uuid')
     @mock.patch('util.makedirs')
     @mock.patch('ISOSR.ISOSR._checkTargetStr')
     @mock.patch('util.pread', autospec=True)
-    def test_attach_smb_wrongversion(self, context, pread, _checkTargetStr,
+    def test_attach_smb_wrongversion(self, pread, _checkTargetStr,
                                      makedirs, gen_uuid):
         """
         Unsupported version from XC/XE CLI.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs', vers='2.0')
-        raised_exception = None
         with self.assertRaises(xs_errors.SROSError) as context:
             smbsr.attach(None)
         self.assertEqual(context.exception.errno, 227)
@@ -396,17 +383,15 @@ def test_attach_smb_wrongversion(self, context, pread, _checkTargetStr,
             'Given SMB version is not allowed. Choose either 1.0 or 3.0'
         )
 
-    @testlib.with_context
     @mock.patch('util.gen_uuid')
     @mock.patch('util.makedirs')
     @mock.patch('ISOSR.ISOSR._checkTargetStr')
-    def test_attach_smb_wrongversion_via_xemount(self, context,
+    def test_attach_smb_wrongversion_via_xemount(self,
                                                  _checkTargetStr, makedirs,
                                                  gen_uuid):
         """
         Unsupported version from xe-sr-mount.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(options='-o vers=2.0')
         with self.assertRaises(xs_errors.SROSError) as context:
             smbsr.attach(None)
@@ -428,7 +413,6 @@ def test_attach_smb_version_fallback_with_smb_3_disabled(self, context,
         """
         Fall back scenario from XC/XE CLI with smb3 diabled and smb1 enabled.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs')
         pread.side_effect = iter([util.CommandException(errno.EHOSTDOWN), " "])
         _checkmount.side_effect = [False, True]
@@ -437,13 +421,12 @@ def test_attach_smb_version_fallback_with_smb_3_disabled(self, context,
                                   '/var/run/sr-mount/asr_uuid', '-o',
                                   'cache=none,guest,vers=1.0'], True, new_env=None)
 
-    @testlib.with_context
     @mock.patch('util.gen_uuid')
     @mock.patch('util.makedirs')
     @mock.patch('ISOSR.ISOSR._checkTargetStr')
     @mock.patch('util.pread', autospec=True)
     @mock.patch('ISOSR.ISOSR._checkmount')
-    def test_attach_smb_version_fallback_with_smb_1_3_disabled(self, context,
+    def test_attach_smb_version_fallback_with_smb_1_3_disabled(self,
                                                                _checkmount,
                                                                pread,
                                                                _checkTargetStr,
@@ -452,7 +435,6 @@ def test_attach_smb_version_fallback_with_smb_1_3_disabled(self, context,
         """
         Fall back scenario from XC/XE CLI with smb3 diabled and smb1 disabled.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs')
         pread.side_effect = iter([util.CommandException(errno.EHOSTDOWN), \
                 util.CommandException(errno.EHOSTDOWN), util.CommandException(errno.EHOSTDOWN)])
@@ -465,20 +447,18 @@ def test_attach_smb_version_fallback_with_smb_1_3_disabled(self, context,
             'Could not mount the directory specified in Device Configuration [opterr=exec failed]'
         )
 
-    @testlib.with_context
     @mock.patch('util.gen_uuid')
     @mock.patch('util.makedirs')
     @mock.patch('ISOSR.ISOSR._checkTargetStr')
     @mock.patch('util.pread', autospec=True)
     @mock.patch('ISOSR.ISOSR._checkmount')
-    def test_attach_smb_via_xemount_no_version_fallback(self, context,
+    def test_attach_smb_via_xemount_no_version_fallback(self,
                                                         _checkmount, pread,
                                                         _checkTargetStr,
                                                         makedirs, gen_uuid):
         """
         Fall back scenario from xe-sr-mount with smb3 diabled and smb1 enabled.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(options='-o username=administrator,password=password')
         pread.side_effect = iter([util.CommandException(errno.EHOSTDOWN), " "])
 
@@ -493,31 +473,29 @@ def test_attach_smb_version_fallback_error(self, context, _checkmount,
         """
         Fall back scenario negative case from xe-sr-mount with smb3 diabled and smb1 disabled.
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs')
         pread.side_effect = iter([util.CommandException(errno.EHOSTDOWN),
                              util.CommandException(errno.EHOSTDOWN)])
         _checkmount.side_effect = [False, True]
         with self.assertRaises(Exception):
             smbsr.attach(None)
 
-    @testlib.with_context
     @mock.patch('util.makedirs')
     @mock.patch('ISOSR.ISOSR._checkTargetStr')
     @mock.patch('util.pread', autospec=True)
     @mock.patch('util.find_my_pbd')
     @mock.patch('ISOSR.ISOSR._checkmount')
-    def test_mountoversmb_will_raise_on_error(self, context, _checkmount, find_my_pbd, pread, _checkTargetStr, makedirs):
+    def test_mountoversmb_will_raise_on_error(
+            self, _checkmount, find_my_pbd, pread, _checkTargetStr, makedirs):
         """
         Test failure to store SMB version inside PBD config will raise exception
         """
-        context.setup_error_codes()
         smbsr = self.create_smbisosr(atype='cifs')
         find_my_pbd.return_value = None
         _checkmount.side_effect = [False, True]
         with self.assertRaises(xs_errors.SROSError) as exp:
             smbsr.attach(None)
-        self.assertEqual(exp.exception.errno, context.get_error_code("SMBMount"))
+        self.assertEqual(exp.exception.errno, 111)
 
 
 class TestISOSR_functions(unittest.TestCase):

tests/test_LVHDoFCoESR.py

@@ -41,13 +41,12 @@ def create_fcoesr(self, path="/dev/example", SCSIid="abcd",
     @mock.patch('SR.driver', autospec=True)
     @mock.patch('util.find_my_pbd', autospec=True)
     @mock.patch('LVHDoFCoESR.LVHDoHBASR.HBASR.HBASR.print_devs', autospec=True)
-    @testlib.with_context
-    def test_load_no_scsiid(self, context, print_devs, find_my_pbd, driver):
-        context.setup_error_codes()
+    def test_load_no_scsiid(self, print_devs, find_my_pbd, driver):
         find_my_pbd.return_value = ['pbd_ref', 'pbd']
         parameters = {}
         parameters['device_config'] = ""
-        self.assertRaises(xs_errors.SROSError, self.create_fcoesr, SCSIid="", params=parameters)
+        self.assertRaises(xs_errors.SROSError, self.create_fcoesr,
+                          SCSIid="", params=parameters)
 
     @mock.patch('SR.driver', autospec=True)
     @mock.patch('util.find_my_pbd', autospec=True)

tests/test_LVHDoHBASR.py

@@ -47,8 +47,6 @@ def test_generate_config(self,
                          mpath_handle)
 
     @mock.patch('LVHDoHBASR.LVHDoHBASR', autospec=True)
-    @mock.patch('LVHDoHBASR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
     @mock.patch('LVHDoHBASR.LVHDoHBAVDI.__init__', mock_init)
     @mock.patch('LVHDoHBASR.lvutil._checkLV', autospec=True)
     def test_generate_config_bad_path_assert(self,
@@ -125,8 +123,6 @@ def mock_parse(self):
             srcmd.parse()
         return srcmd
 
-    @mock.patch('LVHDoHBASR.xs_errors.XML_DEFS',
-                "drivers/XE_SR_ERRORCODES.xml")
     @mock.patch("builtins.open", new_callable=mock.mock_open())
     @mock.patch('LVHDoHBASR.glob.glob', autospec=True)
     def test_sr_delete_no_multipath(self, mock_glob, mock_open):