Recreate the examples to solve common user problems regarding cov data aggregation and layout.

Author: ionelmc

MANIFEST.in

@@ -1,5 +1,5 @@
 graft docs
-graft example
+graft examples
 graft src
 graft ci
 graft tests

example/.coveragerc

@@ -0,0 +1,15 @@
+Simple examples with ``tox.ini``
+================================
+
+These examples provide necessary configuration to:
+
+* aggregate coverage from multiple interpreters
+* support tox parallel mode
+* run tests on installed code
+
+The `adhoc` layout is the old and problematic layout where you can mix up the installed code
+with the source code. However, these examples will provide correct configuration even for
+the `adhoc` layout.
+
+The `src` layout configuration is less complicated, have that in mind when picking a layout
+for your project.

example/setup.py

@@ -0,0 +1,15 @@
+[paths]
+source =
+    ../example
+    */site-packages/example
+
+[run]
+branch = true
+parallel = true
+source =
+    example
+    .
+
+[report]
+show_missing = true
+precision = 2

example/tests/test_mylib.py

@@ -0,0 +1,7 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name='example',
+    packages=find_packages(include=['example'])
+)

example/tox.ini

@@ -0,0 +1,6 @@
+import example
+
+
+def test_add():
+    assert example.add(1, 1) == 2
+    assert not example.add(0, 1) == 2

examples/README.rst

@@ -0,0 +1,23 @@
+[tox]
+envlist = clean,py27,py36,report
+
+[testenv]
+commands = pytest --cov --cov-config={toxinidir}/.coveragerc --cov-report=term-missing --cov-append {posargs:-vv}
+deps =
+    pytest
+    pytest-cov
+depends =
+    {py27,py36}: clean
+    report: py27,py36
+changedir = tests
+
+[testenv:report]
+deps = coverage
+skip_install = true
+commands =
+    coverage report
+    coverage html
+
+[testenv:clean]
+commands = coverage erase
+skip_install = true

examples/adhoc-layout/.coveragerc

@@ -0,0 +1,15 @@
+[paths]
+source =
+   src
+   */site-packages
+
+[run]
+branch = true
+parallel = true
+source =
+    example
+    tests
+
+[report]
+show_missing = true
+precision = 2

example/mylib/__init__.py renamed to examples/adhoc-layout/example/__init__.py

@@ -0,0 +1,8 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name='example',
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+)

examples/adhoc-layout/setup.py

@@ -0,0 +1,13 @@
+
+import sys
+
+PY3 = sys.version_info[0] == 3
+
+
+if PY3:
+    def add(a, b):
+        return a + b
+
+else:
+    def add(a, b):
+        return b + a

examples/adhoc-layout/tests/test_example.py

@@ -0,0 +1,6 @@
+import example
+
+
+def test_add():
+    assert example.add(1, 1) == 2
+    assert not example.add(0, 1) == 2

examples/adhoc-layout/tox.ini

@@ -0,0 +1,25 @@
+[tox]
+envlist = clean,py27,py36,report
+
+[tool:pytest]
+testpaths = tests
+
+[testenv]
+commands = pytest --cov --cov-report=term-missing --cov-append {posargs:-vv}
+deps =
+    pytest
+    pytest-cov
+depends = 
+    {py27,py36}: clean
+    report: py27,py36
+
+[testenv:report]
+deps = coverage
+skip_install = true
+commands =
+    coverage report
+    coverage html
+
+[testenv:clean]
+commands = coverage erase
+skip_install = true