From ce6dd697ac18362fd24b5555b514d887edb0144d Mon Sep 17 00:00:00 2001 From: Shawn Hartsock Date: Tue, 29 Jul 2014 16:51:19 -0400 Subject: [PATCH] Malformed Faults: introduces test for fault handler This initial patch introduces a test to demonstrate current fault handling in the VmomiSupport and SoapAdapter components. partial: https://github.com/vmware/pyvmomi/issues/72 --- pyVmomi/SoapAdapter.py | 13 +- pyVmomi/VmomiSupport.py | 5 +- tests/fixtures/test_unknown_fault.yaml | 274 +++++++++++++++++++++++++ tests/test_fault_deserializer.py | 37 ++++ 4 files changed, 317 insertions(+), 12 deletions(-) create mode 100644 tests/fixtures/test_unknown_fault.yaml create mode 100644 tests/test_fault_deserializer.py diff --git a/pyVmomi/SoapAdapter.py b/pyVmomi/SoapAdapter.py index de50e1583..336bbfeff 100644 --- a/pyVmomi/SoapAdapter.py +++ b/pyVmomi/SoapAdapter.py @@ -582,11 +582,7 @@ def StartElementHandler(self, tag, attr): if not self.stack: if self.isFault: ns, name = self.SplitTag(tag) - try: - objType = self.LookupWsdlType(ns, name[:-5]) - except KeyError: - message = "{0} was not found in the WSDL".format(name[:-5]) - raise VmomiMessageFault(message) + objType = self.LookupWsdlType(ns, name[:-5]) # Only top level soap fault should be deserialized as method fault deserializeAsLocalizedMethodFault = False else: @@ -1257,12 +1253,13 @@ def InvokeMethod(self, mo, info, args, outerStub=None): fd = GzipReader(resp, encoding=GzipReader.GZIP) elif encoding == 'deflate': fd = GzipReader(resp, encoding=GzipReader.DEFLATE) - obj = SoapResponseDeserializer(outerStub).Deserialize(fd, info.result) - except: + deserializer = SoapResponseDeserializer(outerStub) + obj = deserializer.Deserialize(fd, info.result) + except Exception as exc: conn.close() # The server might be sick, drop all of the cached connections. self.DropConnections() - raise + raise exc else: resp.read() self.ReturnConnection(conn) diff --git a/pyVmomi/VmomiSupport.py b/pyVmomi/VmomiSupport.py index a0de125ad..7ab804149 100644 --- a/pyVmomi/VmomiSupport.py +++ b/pyVmomi/VmomiSupport.py @@ -1023,10 +1023,7 @@ def GuessWsdlType(name): # in multiple namespaces, we will load the first type that we # encounter and return it. for ns in _wsdlTypeMapNSs: - try: - return GetWsdlType(ns, name) - except KeyError: - pass + return GetWsdlType(ns, name) raise KeyError(name) ## Return a map that contains all the wsdl types diff --git a/tests/fixtures/test_unknown_fault.yaml b/tests/fixtures/test_unknown_fault.yaml new file mode 100644 index 000000000..8c99ba404 --- /dev/null +++ b/tests/fixtures/test_unknown_fault.yaml @@ -0,0 +1,274 @@ +interactions: +- request: + body: ' + + + + <_this type="ServiceInstance">ServiceInstance + + ' + headers: + Accept-Encoding: ['gzip, deflate'] + Content-Type: [text/xml; charset=UTF-8] + Cookie: [''] + SOAPAction: ['"urn:vim25/4.1"'] + method: POST + uri: https://vcsa:443/sdk + response: + body: {string: "\n\n\ngroup-d1propertyCollectorViewManagerVMware vCenter + ServerVMware vCenter Server 5.5.0 build-1750787 (Sim)VMware, + Inc.5.5.01750787 (Sim)INTL000linux-x64vpxVirtualCenter5.5EAB4D846-C243-426B-A021-0547644CE59DVMware + VirtualCenter Server5.0VpxSettingsUserDirectorySessionManagerAuthorizationManagerPerfMgrScheduledTaskManagerAlarmManagerEventManagerTaskManagerExtensionManagerCustomizationSpecManagerCustomFieldsManagerDiagMgrLicenseManagerSearchIndexFileManagervirtualDiskManagerSnmpSystemProvCheckerCompatCheckerOvfManagerIpPoolManagerDVSManagerHostProfileManagerClusterProfileManagerMoComplianceManagerLocalizationManagerStorageResourceManager\n\n"} + headers: + Cache-Control: [no-cache] + Connection: [Keep-Alive] + Content-Length: ['3332'] + Content-Type: [text/xml; charset=utf-8] + Date: ['Tue, 29 Jul 2014 18:58:40 GMT'] + Set-Cookie: ['vmware_soap_session="52d6ea56-0052-259f-e3f6-8ea7a7f349cb"; Path=/; + HttpOnly; Secure; '] + status: {code: 200, message: OK} +- request: + body: ' + + + + <_this type="SessionManager">SessionManagermy_usermy_password + + ' + headers: + Accept-Encoding: ['gzip, deflate'] + Content-Type: [text/xml; charset=UTF-8] + Cookie: ['vmware_soap_session="52d6ea56-0052-259f-e3f6-8ea7a7f349cb"; Path=/; + HttpOnly; Secure; '] + SOAPAction: ['"urn:vim25/4.1"'] + method: POST + uri: https://vcsa:443/sdk + response: + body: {string: "\n\n\n52c20b61-24c3-f233-a549-d36d3ae68e14my_usermy_user + 2014-07-29T18:58:41.001537Z2014-07-29T18:58:41.001537Zenen\n\n"} + headers: + Cache-Control: [no-cache] + Connection: [Keep-Alive] + Content-Length: ['665'] + Content-Type: [text/xml; charset=utf-8] + Date: ['Tue, 29 Jul 2014 18:58:41 GMT'] + status: {code: 200, message: OK} +- request: + body: ' + + + + <_this type="ServiceInstance">ServiceInstance + + ' + headers: + Accept-Encoding: ['gzip, deflate'] + Content-Type: [text/xml; charset=UTF-8] + Cookie: ['vmware_soap_session="52d6ea56-0052-259f-e3f6-8ea7a7f349cb"; Path=/; + HttpOnly; Secure; '] + SOAPAction: ['"urn:vim25/4.1"'] + method: POST + uri: https://vcsa:443/sdk + response: + body: {string: "\n\n\ngroup-d1propertyCollectorViewManagerVMware vCenter + ServerVMware vCenter Server 5.5.0 build-1750787 (Sim)VMware, + Inc.5.5.01750787 (Sim)INTL000linux-x64vpxVirtualCenter5.5EAB4D846-C243-426B-A021-0547644CE59DVMware + VirtualCenter Server5.0VpxSettingsUserDirectorySessionManagerAuthorizationManagerPerfMgrScheduledTaskManagerAlarmManagerEventManagerTaskManagerExtensionManagerCustomizationSpecManagerCustomFieldsManagerDiagMgrLicenseManagerSearchIndexFileManagervirtualDiskManagerSnmpSystemProvCheckerCompatCheckerOvfManagerIpPoolManagerDVSManagerHostProfileManagerClusterProfileManagerMoComplianceManagerLocalizationManagerStorageResourceManager\n\n"} + headers: + Cache-Control: [no-cache] + Connection: [Keep-Alive] + Content-Length: ['3332'] + Content-Type: [text/xml; charset=utf-8] + Date: ['Tue, 29 Jul 2014 18:58:41 GMT'] + status: {code: 200, message: OK} +- request: + body: ' + + + + <_this type="ServiceInstance">ServiceInstance + + ' + headers: + Accept-Encoding: ['gzip, deflate'] + Content-Type: [text/xml; charset=UTF-8] + Cookie: ['vmware_soap_session="52d6ea56-0052-259f-e3f6-8ea7a7f349cb"; Path=/; + HttpOnly; Secure; '] + SOAPAction: ['"urn:vim25/4.1"'] + method: POST + uri: https://vcsa:443/sdk + response: + body: {string: "\n\n\ngroup-d1propertyCollectorViewManagerVMware vCenter + ServerVMware vCenter Server 5.5.0 build-1750787 (Sim)VMware, + Inc.5.5.01750787 (Sim)INTL000linux-x64vpxVirtualCenter5.5EAB4D846-C243-426B-A021-0547644CE59DVMware + VirtualCenter Server5.0VpxSettingsUserDirectorySessionManagerAuthorizationManagerPerfMgrScheduledTaskManagerAlarmManagerEventManagerTaskManagerExtensionManagerCustomizationSpecManagerCustomFieldsManagerDiagMgrLicenseManagerSearchIndexFileManagervirtualDiskManagerSnmpSystemProvCheckerCompatCheckerOvfManagerIpPoolManagerDVSManagerHostProfileManagerClusterProfileManagerMoComplianceManagerLocalizationManagerStorageResourceManager\n\n"} + headers: + Cache-Control: [no-cache] + Connection: [Keep-Alive] + Content-Length: ['3332'] + Content-Type: [text/xml; charset=utf-8] + Date: ['Tue, 29 Jul 2014 18:58:41 GMT'] + status: {code: 200, message: OK} +- request: + body: ' + + + + <_this type="PropertyCollector">propertyCollectorLicenseManagerfalselicenseAssignmentManagerLicenseManagerfalse1 + + ' + headers: + Accept-Encoding: ['gzip, deflate'] + Content-Type: [text/xml; charset=UTF-8] + Cookie: ['vmware_soap_session="52d6ea56-0052-259f-e3f6-8ea7a7f349cb"; Path=/; + HttpOnly; Secure; '] + SOAPAction: ['"urn:vim25/4.1"'] + method: POST + uri: https://vcsa:443/sdk + response: + body: {string: "\n\n\nLicenseManagerlicenseAssignmentManagerLicenseAssignmentManager\n\n"} + headers: + Cache-Control: [no-cache] + Connection: [Keep-Alive] + Content-Length: ['652'] + Content-Type: [text/xml; charset=utf-8] + Date: ['Tue, 29 Jul 2014 18:58:41 GMT'] + status: {code: 200, message: OK} +- request: + body: ' + + + + <_this type="LicenseAssignmentManager">LicenseAssignmentManager + + ' + headers: + Accept-Encoding: ['gzip, deflate'] + Content-Type: [text/xml; charset=UTF-8] + Cookie: ['vmware_soap_session="52d6ea56-0052-259f-e3f6-8ea7a7f349cb"; Path=/; + HttpOnly; Secure; '] + SOAPAction: ['"urn:vim25/4.1"'] + method: POST + uri: https://vcsa:443/sdk + response: + body: {string: " + + + + ServerFaultCode + + + + unknownReason + + + +"} + headers: + Cache-Control: [no-cache] + Connection: [Keep-Alive] + Content-Type: [text/xml; charset=utf-8] + Date: ['Tue, 29 Jul 2014 18:58:41 GMT'] + Transfer-Encoding: [chunked] + status: {code: 500, message: Internal Server Error} +version: 1 diff --git a/tests/test_fault_deserializer.py b/tests/test_fault_deserializer.py new file mode 100644 index 000000000..f99892267 --- /dev/null +++ b/tests/test_fault_deserializer.py @@ -0,0 +1,37 @@ +# VMware vSphere Python SDK +# Copyright (c) 2008-2014 VMware, Inc. All Rights Reserved. +# +# 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 tests import fixtures_path +import unittest +import vcr + +from pyVim import connect +from pyVmomi import SoapStubAdapter +from pyVmomi import vim + +class DeserializerTests(unittest.TestCase): + + @vcr.use_cassette('test_unknown_fault.yaml', + cassette_library_dir=fixtures_path, record_mode='once') + def test_unknown_fault(self): + # see: http://python3porting.com/noconv.html + si = connect.Connect(host='vcsa', + user='my_user', + pwd='my_password') + content = si.RetrieveContent() + lm = content.licenseManager + # NOTE (hartsock): assertIsNotNone does not work in Python 2.6 + self.assertTrue(lm is not None) + # cassette is altered to raise a fault here: + lm.licenseAssignmentManager.QueryAssignedLicenses() \ No newline at end of file