Convert all test cases to pytest

.github/workflows/unit-testing-and-coverage.yml

@@ -23,63 +23,78 @@ jobs:
   qa_docs:
     runs-on: ubuntu-20.04
     steps:
-      - name: "Checkout latest commit"
+      - name: "Checkout latest PR commit"
         uses: actions/checkout@v2
-      - name: "Set up Python 3.8"
+      - name: "Set up Python"
         uses: actions/setup-python@v2
         with:
+          # 3.8 is chosen because it seems to be the fastest for <3.9
+          # (3.9 excluded because it seems to be still very unstable)
           python-version: 3.8
-      - name: "Install dependencies"
+      - name: "Update modules & install deps"
+        # language=bash
         run: |
-          python -m pip install --upgrade pip
-          pip install tox
-      - name: "Execute tox -e qa,docs"
+          python -m pip install --upgrade pip setuptools wheel
+          python setup.py develop
+      - name: "flake8 Style Checking"
+        # language=bash
         run: |
-          tox -e qa,docs
+          pip install colorama flake8
+          python -m flake8 aiosmtpd setup.py housekeep.py release.py
+      - name: "Docs Checking"
+        # language=bash
+        run: |
+          pip install colorama pytest pytest-mock sphinx sphinx-autofixture sphinx_rtd_theme
+          pytest -v aiosmtpd/docs
+          python setup.py build_sphinx
+      - name: "Static Type Checking"
+        # language=bash
+        run: |
+          pip install pytype
+          pytype --keep-going --jobs auto .
+      - name: "Other QA Checks"
+        # language=bash
+        run: |
+          pip install pytest pytest-mock check-manifest
+          git fetch --no-tags --prune --no-recurse-submodules --depth=1 origin master:master
+          pytest -v aiosmtpd/qa
+          check-manifest -v
   testing:
     needs: qa_docs
     strategy:
       # If a matrix fail, do NOT stop other matrix, let them run to completion
       fail-fast: false
       matrix:
-        os: [ "ubuntu-18.04", "ubuntu-20.04", "macos-10.15" ]
-        platform: [ "posix" ]
+        os: [ "ubuntu-18.04", "ubuntu-20.04", "macos-10.15", "windows-latest" ]
         python-version: [ "3.6", "3.7", "3.8", "3.9", "pypy3" ]
-        include:
-          - os: "windows-latest"
-            platform: "mswin"
-            # Only the latest frozen branch as indicated on
-            # https://devguide.python.org/#branchstatus
-            # ('frozen' means Status == "security")
-            # Reason being that Windows users can change their Python anytime,
-            # so there is no benefit in testing all released Python versions.
-            # Plus pypy3 implementation in Windows is ... complicated. We
-            # should stay away from all those complications; users choosing to
-            # run aiosmtpd on pypy3 on Windows should be considered advanced
-            # and know what they're doing.
-            python-version: "3.7"
     runs-on: ${{ matrix.os }}
     steps:
     - name: "Checkout latest commit"
       uses: actions/checkout@v2
+      with:
+        fetch-depth: 0  # Required by codecov/codecov-action@v1
     - name: "Set up Python ${{ matrix.python-version }}"
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
     - name: "Install dependencies"
+      # language=bash
       run: |
-        python -m pip install --upgrade pip
-        pip install tox
-    - name: "Execute tox"
-      env:
-        PLATFORM: ${{ matrix.platform }}
-      # "py" testenv means we'll use whatever Python provided by GA,
-      # as specified in 'matrix' above. No need to specify exact version.
+        python -m pip install --upgrade pip setuptools wheel
+        # Test deps
+        pip install colorama coverage[toml] coverage-conditional-plugin packaging pytest pytest-cov pytest-mock
+        # Package deps
+        python setup.py develop
+        # Fetch master because some test cases might need its existence
+        git fetch --no-tags --prune --no-recurse-submodules --depth=1 origin master:master
+    - name: "Execute testing"
+      shell: bash
+      # language=bash
       run: |
-        tox -e py-cov
+        pytest --cov --cov-report=xml --cov-report=term
     - name: "Report to codecov"
       # Ubuntu 18.04 came out of the box with 3.6, and LOTS of system are still running
       # 18.04 happily, so we choose this as the 'canonical' code coverage testing.
       # One day we'll have to revisit this and bump the version ...
-      if: always() && matrix.python-version == '3.6' && matrix.os == 'ubuntu-latest'
+      if: matrix.python-version == '3.6' && matrix.os == 'ubuntu-18.04'
       uses: codecov/codecov-action@v1

.gitignore

@@ -4,7 +4,7 @@ parts
 coverage
 eggs
 sources
-build
+build/
 dist
 venv
 .installed.cfg
@@ -32,5 +32,6 @@ coverage-*.xml
 diffcov.html
 diffcov-*.html
 .python-version
+prof/
 .pytype/
 ~temp*

MANIFEST.in

@@ -1,3 +1,3 @@
 graft aiosmtpd
-include LICENSE *.cfg *.ini *.py *.rst *.yml *.toml
+include LICENSE NOTICE *.cfg *.ini *.py *.rst *.yml *.toml
 global-exclude *.py[oc]

README.rst

@@ -142,6 +142,10 @@ You can also add the ``-s``/``--capture=no`` option to show output, e.g.::
 
     $ tox -e py36-nocov -- -s
 
+and these options can be combined::
+
+    $ tox -e py36-nocov -- -x -s <testname>
+
 (The ``-e`` parameter is explained in the next section about 'testenvs'.
 In general, you'll want to choose the ``nocov`` testenvs if you want to show output,
 so you can see which test is generating which output.)
@@ -194,23 +198,22 @@ have been configured and tested:
 
 * ``docs``
 
-  Builds HTML documentation using Sphinx
+  Builds HTML documentation using Sphinx. A `pytest doctest`_ will run prior to
+  actual building of the documentation.
 
 
 Environment Variables
 -------------------------
 
-``PLATFORM``
-~~~~~~~~~~~~~~~~
+``ASYNCIO_CATCHUP_DELAY``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Used on non-POSIX operating systems to specify tests to skip.
-    Valid values:
+    Due to how asyncio event loop works, some actions do not instantly get
+    responded to. This is especially so on slower / overworked systems.
+    In consideration of such situations, some test cases invoke a slight
+    delay to let the event loop catch up.
 
-    +-----------+-------------------------------------------------------+
-    | ``mswin`` | when running tox on Microsoft Windows (non-Cygwin)    |
-    +-----------+-------------------------------------------------------+
-    | ``wsl``   | when running tox on Windows Subsystem for Linux (WSL) |
-    +-----------+-------------------------------------------------------+
+    Defaults to `0.1` and can be set to any float value you want.
 
 
 Different Python Versions
@@ -233,27 +236,36 @@ versions on your system by using ``pyenv``. General steps:
    Python interpreter versions you want to make available to tox (see pyenv's
    documentation about this file)
 
+   **Tip:** The 1st line of ``.python-version`` indicates your *preferred* Python version
+   which will be used to run tox.
+
 5. Invoke tox with the option ``--tox-pyenv-no-fallback`` (see tox-pyenv's
    documentation about this option)
 
 
 ``housekeep.py``
--------------------
+----------------
 
 If you ever need to 'reset' your repo, you can use the ``housekeep.py`` utility
 like so::
 
     $ python housekeep.py superclean
 
-It is `strongly` recommended to NOT do superclean too often, though.
+It is *strongly* recommended to NOT do superclean too often, though.
 Every time you invoke ``superclean``,
 tox will have to recreate all its testenvs,
-and this will make testing `much` longer to finish.
+and this will make testing *much* longer to finish.
 
 ``superclean`` is typically only needed when you switch branches,
 or if you want to really ensure that artifacts from previous testing sessions
 won't interfere with your next testing sessions.
 
+For example, you want to force Sphinx to rebuild all documentation.
+Or, you're sharing a repo between environments (say, PSCore and Cygwin)
+and the cached Python bytecode messes up execution
+(e.g., sharing the exact same directory between Windows PowerShell and Cygwin
+will cause problems as Python becomes confused about the locations of the source code).
+
 
 License
 =======

_static/aiosmtpd.css

@@ -24,7 +24,8 @@ div.body h4 {
 }
 
 .pre, pre, code {
-    font-family: Menlo,Consolas,"Ubuntu Mono",Inconsolata,"Bitstream Vera Sans Mono","lucida console","Courier New",monospace;
+    font-family: "Fira Code",Menlo,Consolas,"Ubuntu Mono",Inconsolata,"Bitstream Vera Sans Mono","lucida console","Courier New",monospace;
+    font-size: 90%;
 }
 
 div.highlight pre {
@@ -51,3 +52,7 @@ div#news-for-aiosmtpd h3 {
 em.sig-param > span.default_value, em.sig-param > span.o {
     color: rgb(128, 128, 128);
 }
+
+a {
+    text-decoration: underline dotted !important;
+}

aiosmtpd/__init__.py

@@ -1,4 +1,4 @@
 # Copyright 2014-2021 The aiosmtpd Developers
 # SPDX-License-Identifier: Apache-2.0
 
-__version__ = "1.3.0a4"
+__version__ = "1.3.0a9"

aiosmtpd/__main__.py

@@ -1,5 +1,4 @@
 from aiosmtpd.main import main
 
-
 if __name__ == '__main__':
     main()

aiosmtpd/controller.py

@@ -1,17 +1,18 @@
 # Copyright 2014-2021 The aiosmtpd Developers
 # SPDX-License-Identifier: Apache-2.0
 
+import asyncio
 import os
 import ssl
-import asyncio
 import threading
-
-from aiosmtpd.smtp import SMTP
 from contextlib import ExitStack
-from public import public
 from socket import create_connection
 from typing import Any, Coroutine, Dict, Optional
+from warnings import warn
 
+from public import public
+
+from aiosmtpd.smtp import SMTP
 
 AsyncServer = asyncio.base_events.Server
 
@@ -50,9 +51,11 @@ def __init__(
         port=8025,
         *,
         ready_timeout=1.0,
-        enable_SMTPUTF8=None,
         ssl_context: ssl.SSLContext = None,
-        server_kwargs: Dict[str, Any] = None
+        # SMTP parameters
+        server_hostname: str = None,
+        server_kwargs: Dict[str, Any] = None,
+        **SMTP_parameters,
     ):
         """
         `Documentation can be found here
@@ -64,23 +67,28 @@ def __init__(
         self.port = port
         self.ssl_context = ssl_context
         self.loop = asyncio.new_event_loop() if loop is None else loop
-        self.ready_timeout = os.getenv("AIOSMTPD_CONTROLLER_TIMEOUT", ready_timeout)
-        self.server_kwargs: Dict[str, Any] = server_kwargs or {}
-        if enable_SMTPUTF8 is not None:
-            # Uncomment next lines when we hit 1.3
-            # warn("enable_SMTPUTF8 will be removed in the future. "
-            #      "Please use server_kwargs instead.", DeprecationWarning)
-            self.server_kwargs["enable_SMTPUTF8"] = enable_SMTPUTF8
-        else:
-            # This line emulates previous behavior of defaulting enable_SMTPUTF8 to
-            # True. Which actually kinda conflicts with SMTP class's default, but it's
-            # explained in the documentation.
-            self.server_kwargs.setdefault("enable_SMTPUTF8", True)
+        self.ready_timeout = os.getenv(
+            'AIOSMTPD_CONTROLLER_TIMEOUT', ready_timeout)
+        if server_kwargs:
+            warn(
+                "server_kwargs will be removed in version 2.0. "
+                "Just specify the keyword arguments to forward to SMTP "
+                "as kwargs to this __init__ method.",
+                DeprecationWarning
+            )
+        self.SMTP_kwargs: Dict[str, Any] = server_kwargs or {}
+        self.SMTP_kwargs.update(SMTP_parameters)
+        if server_hostname:
+            self.SMTP_kwargs["hostname"] = server_hostname
+        # Emulate previous behavior of defaulting enable_SMTPUTF8 to True
+        # It actually conflicts with SMTP class's default, but the reasoning is
+        # discussed in the docs.
+        self.SMTP_kwargs.setdefault("enable_SMTPUTF8", True)
 
     def factory(self):
         """Allow subclasses to customize the handler/server creation."""
         return SMTP(
-            self.handler, **self.server_kwargs
+            self.handler, **self.SMTP_kwargs
         )
 
     def _factory_invoker(self):
@@ -112,14 +120,14 @@ def _run(self, ready_event):
                 srv_coro
             )
             self.server = srv
-        except Exception as error:  # pragma: nowsl
+        except Exception as error:  # pragma: on-wsl
             # Usually will enter this part only if create_server() cannot bind to the
             # specified host:port.
             #
-            # Somehow WSL1.0 (Windows Subsystem for Linux) allows multiple
+            # Somehow WSL 1.0 (Windows Subsystem for Linux) allows multiple
             # listeners on one port?!
-            # That is why we add "pragma: nowsl" there, so when testing on
-            # WSL we can specify "PLATFORM=wsl".
+            # That is why we add "pragma: on-wsl" there, so this block will not affect
+            # coverage on WSL 1.0.
             self._thread_exception = error
             return
         self.loop.call_soon(ready_event.set)
@@ -149,8 +157,9 @@ def start(self):
         self._thread.start()
         # Wait a while until the server is responding.
         ready_event.wait(self.ready_timeout)
-        if self._thread_exception is not None:  # pragma: nowsl
+        if self._thread_exception is not None:  # pragma: on-wsl
             # See comment about WSL1.0 in the _run() method
+            assert self._thread is not None  # Stupid LGTM.com; see github/codeql#4918
             raise self._thread_exception
         # Apparently create_server invokes factory() "lazily", so exceptions in
         # factory() go undetected. To trigger factory() invocation we need to open
@@ -171,7 +180,7 @@ def _stop(self):
         self.loop.stop()
         try:
             _all_tasks = asyncio.all_tasks
-        except AttributeError:  # pragma: skipif_gt_py36
+        except AttributeError:  # pragma: py-gt-36
             _all_tasks = asyncio.Task.all_tasks
         for task in _all_tasks(self.loop):
             task.cancel()

aiosmtpd/docs/NEWS.rst

@@ -24,6 +24,7 @@ Fixed/Improved
   (It gets reimported to ``aiosmtpd.smtp``,
   so programs relying on ``aiosmtpd.smtp.__version__`` should still work.)
   (Closes #241)
+* Uses pure ``pytest`` for all test cases
 
 
 1.2.4 (2021-01-24)