pytest: package conftest (#576)

closes #563

* Package the conftest file.
* This changes the test command to `pytest jupyter_server`.
* Import the `jupyter_server.conftest` in the examples to inherit the
  plugin.

Author: oliver-sanders

.github/workflows/integration-tests.yml

@@ -44,4 +44,4 @@ jobs:
           pip check
       - name: Run the tests
         run: |
-          pytest -vv --integration_tests=true
+          pytest -vv --integration_tests=true jupyter_server

.github/workflows/python-linux.yml

@@ -69,17 +69,17 @@ jobs:
       - name: Run the tests
         if: ${{ matrix.python-version != 'pypy3' }}
         run: |
-          pytest -vv --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered
+          pytest -vv jupyter_server --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered
       - name: Run the tests on pypy
         if: ${{ matrix.python-version == 'pypy3' }}
         run: |
-          pytest -vv
+          pytest -vv jupyter_server
       - name: Install the Python dependencies for the examples
         run: |
           cd examples/simple && pip install -e .
       - name: Run the tests for the examples
         run: |
-          pytest examples/simple/tests/test_handlers.py --confcutdir=$PWD
+          pytest examples/simple
       - name: Coverage
         if: ${{ matrix.python-version != 'pypy3' }}
         run: |

.github/workflows/python-macos.yml

@@ -46,17 +46,17 @@ jobs:
       - name: Run the tests
         if: ${{ !startsWith( matrix.python-version, 'pypy' ) }}
         run: |
-          pytest -vv --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered
+          pytest -vv jupyter_server --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered
       - name: Run the tests on pypy
         if: ${{ startsWith( matrix.python-version, 'pypy' ) }}
         run: |
-          pytest -vv
+          pytest -vv jupyter_server
       - name: Install the Python dependencies for the examples
         run: |
           cd examples/simple && pip install -e .
       - name: Run the tests for the examples
         run: |
-          pytest examples/simple/tests/test_handlers.py --confcutdir=$PWD
+          pytest examples/simple
       - name: Coverage
         if: ${{ !startsWith( matrix.python-version, 'pypy' ) }}
         run: |

.github/workflows/python-windows.yml

@@ -49,10 +49,10 @@ jobs:
           # the file descriptions opened by the asyncio IOLoop.
           # This leads to a nasty, flaky race condition that we haven't
           # been able to solve.
-          pytest -vv -s
+          pytest -vv -s jupyter_server
       - name: Install the Python dependencies for the examples
         run: |
           cd examples/simple && pip install -e .
       - name: Run the tests for the examples
         run: |
-          pytest examples/simple/tests/test_handlers.py --confcutdir=$PWD
+          pytest examples/simple

CONTRIBUTING.rst

@@ -85,12 +85,12 @@ Running Tests
 Install dependencies::
 
     pip install -e .[test]
-    pip install -e examples/simple
+    pip install -e examples/simple  # to test the examples
 
 To run the Python tests, use::
 
-    pytest
-    pytest examples/simple --confcutdir=$PWD
+    pytest jupyter_server
+    pytest examples/simple  # to test the examples
 
 Building the Docs
 =================

examples/simple/conftest.py

@@ -0,0 +1 @@
+from jupyter_server.conftest import *

conftest.py renamed to jupyter_server/conftest.py

@@ -11,7 +11,7 @@ ignore = ["tbump.toml", ".*", "*.yml", "package-lock.json", "bootstrap*", "conft
 [tool.pytest.ini_options]
 addopts = "--doctest-modules"
 testpaths = [
-    "jupyter_server"
+    "jupyter_server/"
 ]
 
 [tool.jupyter-releaser]