有人有使用 Python Zeep 和 Mock 对 SOAP API 进行单元测试的示例吗? [英] Does someone have an example of Unit-Testing a SOAP API with Python Zeep and Mock?

问题描述

我正在构建一个 Python 应用程序，该应用程序使用 Python-zeep 访问第 3 方 SOAP API.我想使用模拟响应来实现一些单元测试，因为我并不总是有一个实时服务器来运行我的测试.

I'm building a Python app that accesses a 3rd party SOAP API with Python-zeep. I want to implement some unit-tests using mocked responses as I don't always have a live server to run my tests against.

我是单元测试的新手，不太确定从哪里开始.我已经看到在请求库中使用模拟的示例，但不确定如何将其转换为 Zeep.

I'm new to unit-testing and not quite sure where to start. I've seen examples of using mock with the requests library, but not really sure how to translate this into Zeep.

在我的一个模型上，我有一种方法可以从 SOAP API 获取所有 DevicePool.这是相关代码的摘录(我使用辅助方法来提供服务对象，因为我计划在许多其他方法中使用它).

On one of my Models I have a method to get all DevicePools from a SOAP API. Here's an excerpt of the relevant code (I use a helper method to provide the service object as I plan on using this in many other methods).

# Get Zeep Service Object to make AXL API calls
service = get_axl_client(self)

# Get list of all DevicePools present in the cluster
resp = service.listDevicePool(searchCriteria={'name': '%'},
                              returnedTags={'name': '', 'uuid': ''})

我想模拟 resp 对象，但是这是 zeep.objects.ListDevicePoolRes 类型(一种基于 WSDL 解析的动态类型)，我不能只用静态值实例化一个对象.

I want to mock the resp object, however this is of type zeep.objects.ListDevicePoolRes (a dynamic type based on the parsing of the WSDL) and I can't just instantiate an object with static values.

也许我在这里走错了路，必须更深入地模拟 zeep 库的一些内部结构并在 zeep 解析 XML 之前替换请求响应?

Maybe I'm on the wrong track here and would have to go a bit deeper and actually mock some internals of the zeep library and replace the requests response before zeep parses the XML?

如果有人有类似的例子，将不胜感激.

If someone had an example of something similar it would be greatly appreciated.

推荐答案

在查看 Python Zeep 源代码后，我发现了一些使用 requests-mock 库的测试示例，我能够将这些示例应用到我的解决方案中.这是一个工作示例，以防其他人尝试做类似的事情.

After looking through the Python Zeep source code, I found some examples of tests using the requests-mock library which I was able to work into my solution. Here's a working example in case anyone else is trying to do something similar.

在这个例子中我没有做任何断言，因为我首先想证明我可以让 zeep 正确解析模拟响应的概念.

I'm not doing any assertions in this example as I first wanted to prove the concept that I could get zeep to parse a mock response correctly.

# -*- coding: utf-8 -*-

from zeep import Client
from zeep.cache import SqliteCache
from zeep.transports import Transport
from zeep.exceptions import Fault
from zeep.plugins import HistoryPlugin
from requests import Session
from requests.auth import HTTPBasicAuth
from urllib3 import disable_warnings
from urllib3.exceptions import InsecureRequestWarning
from lxml import etree
import requests_mock

disable_warnings(InsecureRequestWarning)

username = 'administrator'
password = 'password'
host = 'cucm-pub'

wsdl = 'file://C:/path/to/axlsqltoolkit/schema/current/AXLAPI.wsdl'
location = 'https://{host}:8443/axl/'.format(host=host)
binding = "{http://www.cisco.com/AXLAPIService/}AXLAPIBinding"

session = Session()
session.verify = False
session.auth = HTTPBasicAuth(username, password)

transport = Transport(cache=SqliteCache(), session=session, timeout=20)
history = HistoryPlugin()
client = Client(wsdl=wsdl, transport=transport, plugins=[history])
service = client.create_service(binding, location)

def test_listPhone():
    text = """<?xml version="1.0" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ns:listDevicePoolResponse xmlns:ns="http://www.cisco.com/AXL/API/11.5">
      <return>
        <devicePool uuid="{1B1B9EB6-7803-11D3-BDF0-00108302EAD1}">
          <name>AU_PER_DP</name>
        </devicePool>
        <devicePool uuid="{BEF5605B-1DB0-4157-0176-6C07814C47AE}">
          <name>DE_BLN_DP</name>
        </devicePool>
        <devicePool uuid="{B4C65CAB-86CB-30FB-91BE-6F6E712CACB9}">
          <name>US_NYC_DP</name>
        </devicePool>
      </return>
    </ns:listDevicePoolResponse>
  </soapenv:Body>
</soapenv:Envelope>
    """


    with requests_mock.Mocker() as m:
        m.post(location, text=text)
        resp = service.listDevicePool(searchCriteria={'name': '%'},
                                      returnedTags={'name': '',
                                                    'uuid': ''})

    return resp

test_listPhone()

这给了我以下结果(为了简洁起见，手动删除了 Zeep 包含的所有带有none"的属性):

This then gives me the following result (have manually removed all the attributes with "none" that Zeep includes for brevity):

{
    'return': {
        'devicePool': [
            {
                'name': 'AU_PER_DP',
                'uuid': '{1B1B9EB6-7803-11D3-BDF0-00108302EAD1}'
            },
            {
                'name': 'DE_BLN_DP',
                'uuid': '{BEF5605B-1DB0-4157-0176-6C07814C47AE}'
            },
            {
                'name': 'US_NYC_DP',
                'uuid': '{B4C65CAB-86CB-30FB-91BE-6F6E712CACB9}'
            }
        ]
    },
    'sequence': None
}

这篇关于有人有使用 Python Zeep 和 Mock 对 SOAP API 进行单元测试的示例吗?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！