aiosmtpd 1.4.2

介绍

概念

命令行用法

编程方式用法

SMTP 模块

LMTP 类

处理程序

身份验证系统

PROXY 协议支持

从 smtpd 迁移到 aiosmtpd

测试

• 测试框架： pytest
  • 插件
  • Fixtures
  • Markers

aiosmtpd

aiosmtpd 新闻

1. 首页
2. aiosmtpd 1.4.2
3. 测试

测试 ¶

Testing (which includes unit testing, integration testing, and regression testing) is very important for quality code; extremely so if the code is a library that will be used in other software.

测试框架： pytest ¶

aiosmtpd 使用 pytest testing framework. Advanced features of pytest are widely used throughout.

插件 ¶

The one required plugin is pytest-mock ; it is used extensively throughout the test suite.

Other plugins that are used, to various degrees, in the aiosmtpd test suite are:

• pytest-cov to integrate with coverage-py

• pytest-sugar to provide better ux

• pytest-print to give some progress indicator and to assist test troubleshooting

• pytest-profiling 以实现 *-profile testenv, although to be honest this is not really useful as the profiling gets ‘muddied’ by pytest runner.

Fixtures ¶

Below is a list of fixtures defined throught the test suite, in alphabetical order:

fixture aiosmtpd.tests.conftest. client ¶

Scope: function

Generic SMTP Client, will connect to the host:port defined in Global.SrvAddr unless overriden using client_data() 标记。

fixture aiosmtpd.tests.conftest. get_controller ¶

Scope: function

Provides a function that will return an instance of a controller.

Default class of the controller is Controller, but can be changed via the class_ parameter to the function, or via the class_ 参数对于 controller_data()

用法范例：

def test_case(get_controller):
    handler = SomeHandler()
    controller = get_controller(handler, class_=SomeController)
    ...
						

参数

class_ – The class of the controller to be instantiated. If given, overrides class_ arg of controller_data() . If not specified and no class_ from controller_data , defaults to ExposingController .

返回

实例化的 Controller (or a subclass of)

In addition to explicitly-specified parameters, get_controller also fetches all *args and **kwargs parameters from controller_data() 标记。

fixture aiosmtpd.tests.conftest. get_handler ¶

Scope: function

Provides a function that will return an instance of a handler class .

Default class of the handler is Sink, but can be changed via the class_ parameter to the function, or via the class_ 参数对于 handler_data()

用法范例：

def test_case(get_handler):
    handler = get_handler(class_=SomeHandler)
    controller = Controller(handler)
    ...
						

参数

class_ – The class of the handler to be instantiated. If given, overrides class_ arg of handler_data() . If not specified and no class_ from handler_data , defaults to Sink .

返回

an instance of the handler class.

In addition to explicitly-specified parameters, get_handler also fetches all *args and **kwargs parameters from handler_data() 标记。

fixture aiosmtpd.tests.conftest. nodecode_controller ¶

Scope: function

如同 plain_controller ，除了 decode_data=False is enforced.

This is actually identical to using plain_controller with marker @controller_data(decode_data=False) . But because this is used in a lot of test cases, it’s tidier to just make this into a dedicated fixture.

fixture aiosmtpd.tests.conftest. plain_controller ¶

Scope: function

Returns a Controller that, by default, gets invoked with no optional args. Hence the moniker “plain”.

Internally uses the get_controller and get_handler fixtures, so optional args/kwargs can be specified for the Controller and the handler via the controller_data() and handler_data() markers, respectively.

fixture aiosmtpd.tests.conftest. silence_event_loop_closed ¶

Scope: 模块

Mostly used to suppress “unhandled exception” error due to _ProactorBasePipeTransport raising an exception when doing __del__

fixture aiosmtpd.tests.conftest. ssl_context_client ¶

Scope: function

Provides a client-side SSL Context

fixture aiosmtpd.tests.conftest. ssl_context_server ¶

Scope: function

Provides a server-side SSL Context

重要

As long as you create your test module(s) inside the aiosmtpd/tests directory, you do not need to import the above fixtures; they will automatically be available for use as they are defined in the conftest.py 文件。

注意

Individual test modules may define their own module-specific fixtures; please refer to their respective docstrings for description / usage guide.

Markers ¶

@ client_data ( ... ) ¶

Provides parameters to the client fixture.

参数

connect_to ( HostPort ) – Address to connect to. Defaults to Global.SrvAddr

@ controller_data ( ... ) ¶

Provides parameters to the get_controller fixture.

参数

• class_ – The class to be instantiated by get_controller . Will be overridden if get_controller is invoked with the class_ 自变量。

• host_port ( str ) – The “host:port” to bound to

• **kwargs – Keyworded arguments given to the marker.

@ handler_data ( ... ) ¶

Provides parameters to the get_handler fixture.

参数

• args_ – A tuple containing values that will be passed as positional arguments to the controller constructor

• class_ – The class to be instantiated by get_controller

• *args – Positional arguments given to the marker. Will override the args_ 关键词自变量

• **kwargs – Keyworded arguments given to the marker.