Merge branch 'ci'

vmuriart · vmuriart · commit b23acab481d8 · 2017-02-16T20:03:33.000-07:00
- Adds requirements.txt - Closes #282 on d319f4e - Add support for Codecov flags - Add color output to AppVeyor pytest - Clean-up conftest.py - Misc CI clean-up
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,5 @@
 sudo: false
 
-# language: csharp installs mono/dotnet but has limited python.
 language: python
 python:
   - 2.7
@@ -19,6 +18,7 @@ env:
     - LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so
     - SEGFAULT_SIGNALS=all
     - PYTHONUNBUFFERED=True
+    - CODECOV_ENV=TRAVIS_PYTHON_VERSION
 
 addons:
   apt:
@@ -29,31 +29,32 @@ addons:
       - mono-devel
       - ca-certificates-mono
 
+before_install:
+  # Set-up location where `Python.Test.dll` will be output
+  - export PYTHONPATH=`pwd`:$PYTHONPATH
+
+  # Set-up dll path for embedded tests
+  - PY_LIBDIR=$(python -c 'import sysconfig; print(sysconfig.get_config_var("LIBDIR"))')
+  - export LD_LIBRARY_PATH=$PY_LIBDIR:$LD_LIBRARY_PATH
+
 install:
-  - pip install --upgrade pycparser coverage codecov pytest
-  # setup.py install works too, but need to deal w Python.test then
+  - pip install --upgrade -r requirements.txt
+  # `setup.py install` works too, but need to deal with `Python.Test` PATH
   - coverage run setup.py build_ext --inplace
 
 script:
-  # Set-up and run python tests
-  - export PYTHONPATH=`pwd`:$PYTHONPATH
   - python -m pytest
 
-  # Set-up dll path for embedded tests
-  - OUTPUT=$(python --version 2>&1)
-  - PY_VER=${OUTPUT:7:9}
-  - export LD_LIBRARY_PATH=/opt/python/$PY_VER/lib:$LD_LIBRARY_PATH
-  - echo $LD_LIBRARY_PATH
-  - cp Python.Runtime.dll.config src/embed_tests/bin/Python.Runtime.dll.config
-  # Run embedded tests
+  - cp Python.Runtime.dll.config src/embed_tests/bin/
   # - mono ./packages/NUnit.*/tools/nunit3-console.exe src/embed_tests/bin/Python.EmbeddingTest.dll
 
-after_success:
+after_script:
   # Uncomment if need to geninterop, ie. py37 final
   # - python tools/geninterop/geninterop.py
 
-  # Waiting on mono-cov support or SharpCover
-  - codecov
+  # Waiting on mono-coverage, SharpCover or xr.Baboon
+  - coverage xml -i
+  - codecov --file coverage.xml --flags Setup_Linux
 
 notifications:
   email: false
diff --git a/appveyor.yml b/appveyor.yml
@@ -9,9 +9,7 @@ environment:
   global:
     PYTHONUNBUFFERED: True
     PYTHONWARNINGS: 'ignore:::wheel.pep425tags:'
-    PYTHONPATH: C:\testdir
-    NUNIT: nunit3-console
-    CONDA_BLD: C:\miniconda35
+    CODECOV_ENV: PYTHON_VERSION, PLATFORM
 
   matrix:
     - PYTHON_VERSION: 2.7
@@ -21,50 +19,41 @@ environment:
     - PYTHON_VERSION: 3.6
 
 init:
-  # Prepare environment
+  # Prepare Environment
   - mkdir C:\testdir
 
-  # Set environment variables depending based on build cfg
-  - set CONDA_PY=%PYTHON_VERSION:.=%
-  - set CONDA_BLD_ARCH=%PLATFORM:x=%
-  - set PYTHON=C:\PYTHON%PYTHON_VERSION:.=%
-  - if %PLATFORM%==x86 (set CONDA_BLD_ARCH=32)
-  # - if %PLATFORM%==x86 (set NUNIT=%NUNIT%-x86)
+  # Update Environment Variables based on matrix/platform
+  - set PY_VER=%PYTHON_VERSION:.=%
+  - set PYTHON=C:\PYTHON%PY_VER%
   - if %PLATFORM%==x64 (set PYTHON=%PYTHON%-x64)
-  - if %PLATFORM%==x64 (set CONDA_BLD=%CONDA_BLD%-x64)
 
-  # Prepend newly installed Python to the PATH of this build
+  # Put desired Python version first in PATH
   - set PATH=%PYTHON%;%PYTHON%\Scripts;%PATH%
 
-  # Check that we have the expected version, architecture for Python
-  - python --version
-  - python -c "import struct; print(struct.calcsize('P') * 8)"
-  - python -c "import ctypes; print(ctypes.sizeof(ctypes.c_wchar))"
-
 install:
-  # install for wheels & coverage
-  - pip install --upgrade pip wheel coverage codecov pytest
+  - pip install --upgrade -r requirements.txt
 
-  # Install OpenCover. Can't put on packages.config; not Linux/Mono compatible
+  # Install OpenCover. Can't put on `packages.config`, not Mono compatible
   - .\tools\nuget\nuget.exe install OpenCover -OutputDirectory packages
 
 build_script:
-  # build clean sdist & wheel with coverage of setup.py, install local wheel
-  - coverage run setup.py sdist bdist_wheel
+  # Create clean `sdist`. Only used for releases
+  - python setup.py --quiet sdist
+  # Build `wheel` with coverage of `setup.py`
+  - coverage run setup.py bdist_wheel
 
 test_script:
   - pip install --no-index --find-links=.\dist\ pythonnet
-  - ps: Copy-Item (Resolve-Path .\build\*\Python.Test.dll) C:\testdir
+  - ps: Copy-Item .\src\testing\bin\Python.Test.dll C:\testdir\
 
-  # Test runner
   - ps: .\ci\appveyor_run_tests.ps1
-
-  # Build conda-recipe on Pull Requests
   - ps: .\ci\appveyor_build_recipe.ps1
 
 on_finish:
-  # Upload coverage
-  - codecov
+  - coverage xml -i
+  - codecov --file coverage.xml --flags Setup_Windows
+  - codecov --file py.coverage --flags Python_Tests
+  - codecov --file cs.coverage --flags Embedded_Tests
 
 artifacts:
   - path: dist\*
diff --git a/ci/appveyor_build_recipe.ps1 b/ci/appveyor_build_recipe.ps1
@@ -1,21 +1,35 @@
+# Build `conda.recipe` only if this is a Pull_Request. Saves time for CI.
+
+$env:CONDA_PY = "$env:PY_VER"
+# Use pre-installed miniconda. Note that location differs if 64bit
+$env:CONDA_BLD = "C:\miniconda35"
+
+if ($env:PLATFORM -eq "x86"){
+    $env:CONDA_BLD_ARCH=32
+} else {
+    $env:CONDA_BLD_ARCH=64
+    $env:CONDA_BLD = "$env:CONDA_BLD" + "-x64"
+}
+
 if ($env:APPVEYOR_PULL_REQUEST_NUMBER) {
     # Update PATH, and keep a copy to restore at end of this PowerShell script
     $old_path = $env:path
     $env:path = "$env:CONDA_BLD;$env:CONDA_BLD\Scripts;" + $env:path
 
-    Write-Host "Starting Conda Update/Install" -ForegroundColor "Green"
-    conda update conda -q -y
-    conda install conda-build jinja2 anaconda-client -q -y
+    Write-Host "Starting conda install" -ForegroundColor "Green"
+    conda config --set always_yes True
+    conda config --set changeps1 False
+    conda install conda-build jinja2 anaconda-client --quiet
 
-    Write-Host "Starting Conda Recipe build" -ForegroundColor "Green"
-    conda build conda.recipe -q --dirty
+    Write-Host "Starting conda build recipe" -ForegroundColor "Green"
+    conda build conda.recipe --dirty --quiet
 
-    $CONDA_PKG=(conda build conda.recipe -q --output)
-    Copy-Item $CONDA_PKG "$env:APPVEYOR_BUILD_FOLDER\dist\"
-    Write-Host "Completed Conda Recipe build" -ForegroundColor "Green"
+    $CONDA_PKG=(conda build conda.recipe --output)
+    Copy-Item $CONDA_PKG .\dist\
+    Write-Host "Completed conda build recipe" -ForegroundColor "Green"
 
     # Restore PATH back to original
     $env:path = $old_path
 } else {
-    Write-Host "Skipping Conda Recipe build" -ForegroundColor "Green"
+    Write-Host "Skipping conda build recipe" -ForegroundColor "Green"
 }
diff --git a/ci/appveyor_run_tests.ps1 b/ci/appveyor_run_tests.ps1
@@ -1,42 +1,46 @@
-# Script to simplify appveyor configuration and resolve path to tools
+# Script to simplify AppVeyor configuration and resolve path to tools
+
+# Test Runner framework being used for embedded tests
+$CS_RUNNER = "nunit3-console"
+
+# Needed for ARCH specific runners(NUnit2/XUnit3). Skip for NUnit3
+if ($FALSE -and $env:PLATFORM -eq "x86"){
+    $CS_RUNNER = $CS_RUNNER + "-x86"
+}
 
 # Executable paths for OpenCover
 # Note if OpenCover fails, it won't affect the exit codes.
 $OPENCOVER = Resolve-Path .\packages\OpenCover.*\tools\OpenCover.Console.exe
-$NUNIT = Resolve-Path .\packages\NUnit.*\tools\"$env:NUNIT".exe
+$CS_RUNNER = Resolve-Path .\packages\NUnit.*\tools\"$CS_RUNNER".exe
 $PY = Get-Command python
 
 # Can't use ".\build\*\Python.EmbeddingTest.dll". Missing framework files.
 $CS_TESTS = ".\src\embed_tests\bin\Python.EmbeddingTest.dll"
 $RUNTIME_DIR = ".\src\runtime\bin\"
 
 # Run python tests with C# coverage
-# why `2>&1 | %{ "$_" }`? see: http://stackoverflow.com/a/20950421/5208670
 Write-Host ("Starting Python tests") -ForegroundColor "Green"
 .$OPENCOVER -register:user -searchdirs:"$RUNTIME_DIR" -output:py.coverage `
             -target:"$PY" -targetargs:"-m pytest" `
-            -returntargetcode `
-            2>&1 | %{ "$_" }
+            -returntargetcode
 $PYTHON_STATUS = $LastExitCode
 if ($PYTHON_STATUS -ne 0) {
     Write-Host "Python tests failed, continuing to embedded tests" -ForegroundColor "Red"
 }
 
 # Run Embedded tests with C# coverage
-# Powershell continuation: http://stackoverflow.com/a/2608186/5208670
-# Powershell options splatting: http://stackoverflow.com/a/24313253/5208670
 Write-Host ("Starting embedded tests") -ForegroundColor "Green"
 .$OPENCOVER -register:user -searchdirs:"$RUNTIME_DIR" -output:cs.coverage `
-            -target:"$NUNIT" -targetargs:"$CS_TESTS" `
+            -target:"$CS_RUNNER" -targetargs:"$CS_TESTS" `
             -filter:"+[*]Python.Runtime*" `
             -returntargetcode
-$NUNIT_STATUS = $LastExitCode
-if ($NUNIT_STATUS -ne 0) {
+$CS_STATUS = $LastExitCode
+if ($CS_STATUS -ne 0) {
     Write-Host "Embedded tests failed" -ForegroundColor "Red"
 }
 
 # Set exit code to fail if either Python or Embedded tests failed
-if ($PYTHON_STATUS -ne 0 -or $NUNIT_STATUS -ne 0) {
+if ($PYTHON_STATUS -ne 0 -or $CS_STATUS -ne 0) {
     Write-Host "Tests failed" -ForegroundColor "Red"
     $host.SetShouldExit(1)
 }
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,12 @@
+# Requirements for both Travis and AppVeyor
+pytest
+coverage
+
+# Platform specific requirements
+pip; sys_platform == 'win32'
+wheel; sys_platform == 'win32'
+pycparser; sys_platform != 'win32'
+
+# Coverage upload
+# codecov v2.0.6 isn't on PyPi
+https://github.com/codecov/codecov-python/tarball/v2.0.6
diff --git a/setup.cfg b/setup.cfg
@@ -1,2 +1,6 @@
+# Don't combine `.bumpversion.cfg` with `setup.cfg`. Messes up formatting.
+
 [tool:pytest]
 xfail_strict = True
+# -r fsxX: show extra summary info for: (f)ailed, (s)kip, (x)failed, (X)passed
+addopts = -r fsxX --color=yes
diff --git a/src/tests/conftest.py b/src/tests/conftest.py
@@ -1,57 +1,31 @@
 # -*- coding: utf-8 -*-
-# TODO: move tests one out of src. Pythonnet doesn't run...
+# TODO: move tests one out of src to project root.
+# TODO: travis has numpy on their workers. Maybe add tests?
 
 """Helpers for testing."""
 
-import io
-import os
+import ctypes
 import sys
+import sysconfig
 
-import pytest
 import clr
 
+# Add path for Python.Test & Add References
 sys.path.append('C:/testdir/')
 clr.AddReference("Python.Test")
 clr.AddReference("System.Collections")
 clr.AddReference("System.Data")
 
-DIR_PATH = os.path.dirname(__file__)
-FILES_DIR = os.path.join(DIR_PATH, 'files')
 
+def pytest_report_header(config):
+    """Generate extra report headers"""
+    # FIXME: https://github.com/pytest-dev/pytest/issues/2257
+    is_64bits = sys.maxsize > 2**32
+    arch = "x64" if is_64bits else "x86"
+    ucs = ctypes.sizeof(ctypes.c_wchar)
+    libdir = sysconfig.get_config_var("LIBDIR")
+    shared = bool(sysconfig.get_config_var("Py_ENABLE_SHARED"))
 
-@pytest.fixture()
-def filepath():
-    """Returns full file path for test files."""
-
-    def make_filepath(filename):
-        # http://stackoverflow.com/questions/18011902/parameter-to-a-fixture
-        # Alternate solution is to use paramtrization `inderect=True`
-        # http://stackoverflow.com/a/33879151
-        # Syntax is noisy and requires specific variable names
-        return os.path.join(FILES_DIR, filename)
-
-    return make_filepath
-
-
-@pytest.fixture()
-def load_file(filepath):
-    """Opens filename with encoding and return its contents."""
-
-    def make_load_file(filename, encoding='utf-8'):
-        # http://stackoverflow.com/questions/18011902/parameter-to-a-fixture
-        # Alternate solution is to use paramtrization `inderect=True`
-        # http://stackoverflow.com/a/33879151
-        # Syntax is noisy and requires specific variable names
-        # And seems to be limited to only 1 argument.
-        with io.open(filepath(filename), encoding=encoding) as f:
-            return f.read().strip()
-
-    return make_load_file
-
-
-@pytest.fixture()
-def get_stream(filepath):
-    def make_stream(filename, encoding='utf-8'):
-        return io.open(filepath(filename), encoding=encoding)
-
-    return make_stream
+    header = ("Arch: {arch}, UCS: {ucs}, LIBDIR: {libdir}, "
+              "Py_ENABLE_SHARED: {shared}".format(**locals()))
+    return header
