Testing via Github Actions

Author: elprans

.github/workflows/tests-reqs.txt

@@ -0,0 +1 @@
+Cython==0.29.13

.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: PR Tests
+
+on:
+  push:
+    branches:
+      - master
+      - ci
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        os: [windows-latest, ubuntu-18.04, macos-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 50
+        submodules: true
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Deps
+      run: |
+        pip install -U setuptools
+        pip install -r .github/workflows/tests-reqs.txt
+    - name: Test
+      # wdf needs to be killed or vcvarsall.bat will pick it up
+      # thinking it's the latest version of the Windows 10 SDK.
+      run: |
+        python setup.py build_ext --inplace
+        python setup.py test

.gitignore

@@ -5,6 +5,7 @@
 *.ymlc~
 *.scssc
 *.so
+*.pyd
 *~
 .#*
 .DS_Store

Makefile

@@ -2,7 +2,6 @@
 
 
 compile:
-	cython httptools/parser/parser.pyx
 	python3 setup.py build_ext --inplace
 
 
@@ -11,10 +10,10 @@ release: compile test
 
 
 test:
-	python3 -m unittest discover -s tests -v
+	python3 setup.py test
 
 
 distclean:
 	git --git-dir="./vendor/http-parser/.git" clean -dfx
-	find ./httptools/parser -name '*.c' | xargs rm
-	find ./httptools/parser -name '*.html' | xargs rm
+	find ./httptools/parser -name '*.c' | xargs rm -f
+	find ./httptools/parser -name '*.html' | xargs rm -f

httptools/__init__.py

@@ -1,4 +1,6 @@
-from .parser import *
+from .parser import parser
+from .parser import *  # NOQA
 
 
-__all__ = parser.__all__
+__all__ = parser.__all__  # NOQA
+__version__ = '0.0.13'

setup.py

@@ -1,11 +1,142 @@
+import os.path
+import sys
+
 from setuptools import setup, Extension
+from setuptools.command.build_ext import build_ext as build_ext
+
+
+vi = sys.version_info
+if vi < (3, 5):
+    raise RuntimeError('httptools require Python 3.5 or greater')
+
+CFLAGS = ['-O2']
+ROOT = os.path.dirname(__file__)
+
+
+class httptools_build_ext(build_ext):
+    user_options = build_ext.user_options + [
+        ('cython-always', None,
+            'run cythonize() even if .c files are present'),
+        ('cython-annotate', None,
+            'Produce a colorized HTML version of the Cython source.'),
+        ('cython-directives=', None,
+            'Cythion compiler directives'),
+        ('use-system-http-parser', None,
+            'Use the system provided http-parser, instead of the bundled one'),
+    ]
+
+    boolean_options = build_ext.boolean_options + [
+        'cython-always',
+        'cython-annotate',
+        'use-system-http-parser',
+    ]
+
+    def initialize_options(self):
+        # initialize_options() may be called multiple times on the
+        # same command object, so make sure not to override previously
+        # set options.
+        if getattr(self, '_initialized', False):
+            return
+
+        super().initialize_options()
+        self.use_system_http_parser = False
+        self.cython_always = False
+        self.cython_annotate = None
+        self.cython_directives = None
+
+    def finalize_options(self):
+        # finalize_options() may be called multiple times on the
+        # same command object, so make sure not to override previously
+        # set options.
+        if getattr(self, '_initialized', False):
+            return
+
+        need_cythonize = self.cython_always
+        cfiles = {}
+
+        for extension in self.distribution.ext_modules:
+            for i, sfile in enumerate(extension.sources):
+                if sfile.endswith('.pyx'):
+                    prefix, ext = os.path.splitext(sfile)
+                    cfile = prefix + '.c'
+
+                    if os.path.exists(cfile) and not self.cython_always:
+                        extension.sources[i] = cfile
+                    else:
+                        if os.path.exists(cfile):
+                            cfiles[cfile] = os.path.getmtime(cfile)
+                        else:
+                            cfiles[cfile] = 0
+                        need_cythonize = True
+
+        if need_cythonize:
+            try:
+                import Cython
+            except ImportError:
+                raise RuntimeError(
+                    'please install Cython to compile httptools from source')
 
-with open('README.md') as f:
+            if Cython.__version__ < '0.29':
+                raise RuntimeError(
+                    'httptools requires Cython version 0.29 or greater')
+
+            from Cython.Build import cythonize
+
+            directives = {}
+            if self.cython_directives:
+                for directive in self.cython_directives.split(','):
+                    k, _, v = directive.partition('=')
+                    if v.lower() == 'false':
+                        v = False
+                    if v.lower() == 'true':
+                        v = True
+
+                    directives[k] = v
+
+            self.distribution.ext_modules[:] = cythonize(
+                self.distribution.ext_modules,
+                compiler_directives=directives,
+                annotate=self.cython_annotate)
+
+        super().finalize_options()
+
+        self._initialized = True
+
+    def build_extensions(self):
+        if self.use_system_http_parser:
+            self.compiler.add_library('http_parser')
+
+            if sys.platform == 'darwin' and \
+                    os.path.exists('/opt/local/include'):
+                # Support macports on Mac OS X.
+                self.compiler.add_include_dir('/opt/local/include')
+        else:
+            self.compiler.add_include_dir(
+                    os.path.join(ROOT, 'vendor/http-parser'))
+            self.distribution.ext_modules[0].sources.append(
+                'vendor/http-parser/http_parser.c')
+
+        super().build_extensions()
+
+
+with open(os.path.join(ROOT, 'README.md')) as f:
     long_description = f.read()
 
+
+with open(os.path.join(ROOT, 'httptools', '__init__.py')) as f:
+    for line in f:
+        if line.startswith('__version__ ='):
+            _, _, version = line.partition('=')
+            VERSION = version.strip(" \n'\"")
+            break
+    else:
+        raise RuntimeError(
+            'unable to read the version from httptools/__init__.py')
+
+
 setup(
     name='httptools',
-    version='0.0.13',
+    version=VERSION,
     description='A collection of framework independent HTTP protocol utils.',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -24,12 +155,19 @@
     author_email='[email protected]',
     license='MIT',
     packages=['httptools', 'httptools.parser'],
+    cmdclass={
+        'build_ext': httptools_build_ext,
+    },
     ext_modules=[
-        Extension("httptools.parser.parser",
-                  ["httptools/parser/parser.c",
-                   "vendor/http-parser/http_parser.c"],
-                  extra_compile_args=['-O2'])
+        Extension(
+            "httptools.parser.parser",
+            sources=[
+                "httptools/parser/parser.pyx",
+            ],
+            extra_compile_args=CFLAGS,
+        ),
     ],
     provides=['httptools'],
-    include_package_data=True
+    include_package_data=True,
+    test_suite='tests.suite'
 )

tests/__init__.py

@@ -0,0 +1,17 @@
+import os.path
+import sys
+import unittest
+import unittest.runner
+
+
+def suite():
+    test_loader = unittest.TestLoader()
+    test_suite = test_loader.discover(
+        os.path.dirname(__file__), pattern='test_*.py')
+    return test_suite
+
+
+if __name__ == '__main__':
+    runner = unittest.runner.TextTestRunner()
+    result = runner.run(suite())
+    sys.exit(not result.wasSuccessful())