Add pytest plugin

Move the betamax fixtures to an installable pytest plugin, so
that dependent applications can also make use of them.

Author: jmoldow

HISTORY.rst

@@ -116,6 +116,9 @@ Release History
   ``DefaultNetwork`` as an alias for backwards-compatibility), and added an
   optional ``session`` argument, for clients to pass a custom
   ``requests.Session`` object.
+- Added a pytest plugin (which can be installed with ``pip install
+  boxsdk[pytest]``) that defines ``betamax``-powered fixtures that clients can
+  use to test their ``boxsdk``-based applications.
 - Added ``network_response_constructor`` as an optional property on the
   ``Network`` interface. Implementations are encouraged to override this
   property, and use it to construct ``NetworkResponse`` instances. That way,

boxsdk/pytest_plugin/__init__.py

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+from __future__ import absolute_import, unicode_literals
+
+
+__doc__ = """pytest fixtures that can help with testing boxsdk-powered applications."""   # pylint:disable=redefined-builtin
+
+
+pytest_plugins = ['boxsdk.pytest_plugin.betamax']   # pylint:disable=invalid-name

boxsdk/pytest_plugin/betamax.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+from __future__ import absolute_import, unicode_literals
+
+import os
+
+from betamax import Betamax
+import pytest
+import requests
+
+from boxsdk import Client
+from boxsdk.network.default_network import RequestsSessionNetwork
+from boxsdk.session.box_session import BoxSession
+
+
+# pylint:disable=redefined-outer-name
+
+
+@pytest.fixture
+def real_requests_session():
+    return requests.Session()
+
+
+@pytest.fixture(scope='module')
+def betamax_cassette_library_dir(request):
+    """Each directory test/foo/bar that uses betamax has a directory test/foo/bar/cassettes to hold cassettes."""
+    return os.path.join(request.fspath.dirname, 'cassettes')
+
+
+@pytest.fixture
+def configure_betamax(betamax_cassette_library_dir):
+    if not os.path.exists(betamax_cassette_library_dir):
+        os.makedirs(betamax_cassette_library_dir)
+    with Betamax.configure() as config:
+        config.cassette_library_dir = betamax_cassette_library_dir
+        config.default_cassette_options['re_record_interval'] = 100
+        config.default_cassette_options['record'] = 'none' if os.environ.get('IS_CI') else 'once'
+
+
+@pytest.fixture
+def betamax_cassette_name(request):
+    """The betamax cassette name to use for the test.
+
+    The name is the same as the pytest nodeid (e.g.
+    module_path::parametrized_test_name or
+    module_path::class_name::parametrized_test_name), but replacing the full
+    module-path with just the base filename, e.g. test_foo::test_bar[0].
+    """
+    node_ids = request.node.nodeid.split('::')
+    node_ids[0] = request.fspath.purebasename
+    return '::'.join(node_ids)
+
+
+@pytest.fixture(scope='module')
+def betamax_use_cassette_kwargs():
+    return {}
+
+
+@pytest.fixture
+def betamax_recorder(configure_betamax, real_requests_session):   # pylint:disable=unused-argument
+    return Betamax(real_requests_session)
+
+
+@pytest.fixture
+def betamax_cassette_recorder(betamax_recorder, betamax_cassette_name, betamax_use_cassette_kwargs):
+    """Including this fixture causes the test to use a betamax cassette for network requests."""
+    with betamax_recorder.use_cassette(betamax_cassette_name, **betamax_use_cassette_kwargs) as cassette_recorder:
+        yield cassette_recorder
+
+
+@pytest.fixture
+def betamax_session(betamax_cassette_recorder):
+    """A betamax-enabled requests.Session instance."""
+    return betamax_cassette_recorder.session
+
+
+@pytest.fixture
+def betamax_boxsdk_network(betamax_session):
+    """A betamax-enabled boxsdk.Network instance."""
+    return RequestsSessionNetwork(session=betamax_session)
+
+
+@pytest.fixture
+def betamax_boxsdk_session(betamax_boxsdk_network, betamax_boxsdk_auth):
+    """A betamax-enabled boxsdk.BoxSession instance.
+
+    Requires an implementation of the abstract `betamax_boxsdk_auth` fixture,
+    of type `boxsdk.OAuth2`.
+    """
+    return BoxSession(oauth=betamax_boxsdk_auth, network_layer=betamax_boxsdk_network)
+
+
+@pytest.fixture
+def betamax_boxsdk_client(betamax_boxsdk_session, betamax_boxsdk_auth):
+    """A betamax-enabled boxsdk.Client instance.
+
+    Requires an implementation of the abstract `betamax_boxsdk_auth` fixture,
+    of type `boxsdk.OAuth2`.
+    """
+    return Client(oauth=betamax_boxsdk_auth, session=betamax_boxsdk_session)

requirements-dev.txt

@@ -1,3 +1,4 @@
+-e .[pytest]
 -r requirements.txt
 betamax
 bottle

setup.py

@@ -61,6 +61,7 @@ def main():
     jwt_requires = ['pyjwt>=1.3.0', 'cryptography>=0.9.2']
     extra_requires = defaultdict(list)
     extra_requires.update({'jwt': jwt_requires, 'redis': redis_requires, 'all': jwt_requires + redis_requires})
+    extra_requires['pytest'] = ['betamax', 'pytest>=3.0.0']
     conditional_dependencies = {
         # Newer versions of pip and wheel, which support PEP 426, allow
         # environment markers for conditional dependencies to use operators
@@ -97,6 +98,12 @@ def main():
         install_requires=install_requires,
         extras_require=extra_requires,
         tests_require=['betamax', 'pytest', 'pytest-xdist', 'mock', 'sqlalchemy', 'bottle', 'jsonpatch'],
+        entry_points={
+            'pytest11': [
+                # pytest fixtures that can help with testing boxsdk-powered applications.
+                'boxsdk = boxsdk.pytest_plugin [pytest]',
+            ],
+        },
         cmdclass={'test': PyTest},
         classifiers=CLASSIFIERS,
         keywords='box oauth2 sdk',

test/conftest.py

@@ -4,16 +4,17 @@
 
 import json
 import logging
-import os
 import sys
 
-from betamax import Betamax
 from mock import Mock
 import pytest
 import requests
 from six import binary_type
 
-from boxsdk.network.default_network import DefaultNetworkResponse, RequestsSessionNetwork
+from boxsdk.network.default_network import DefaultNetworkResponse
+
+
+pytest_plugins = ['boxsdk']   # pylint:disable=invalid-name
 
 
 class RealRequestsSession(requests.Session):
@@ -278,63 +279,3 @@ def mock_user_id():
 @pytest.fixture(scope='module')
 def mock_group_id():
     return 'fake-group-99'
-
-
-# betamax integration
-
-
-@pytest.fixture(scope='module')
-def betamax_cassette_library_dir(request):
-    """Each directory test/foo/bar that uses betamax has a directory test/foo/bar/cassettes to hold cassettes."""
-    return os.path.join(request.fspath.dirname, 'cassettes')
-
-
-@pytest.fixture
-def configure_betamax(betamax_cassette_library_dir):
-    with Betamax.configure() as config:
-        config.cassette_library_dir = betamax_cassette_library_dir
-        config.default_cassette_options['re_record_interval'] = 100
-        config.default_cassette_options['record'] = 'none' if os.environ.get('IS_CI') else 'once'
-
-
-@pytest.fixture
-def betamax_cassette_name(request):
-    """The betamax cassette name to use for the test.
-
-    The name is the same as the pytest nodeid (e.g.
-    module_path::parametrized_test_name or
-    module_path::class_name::parametrized_test_name), but replacing the full
-    module-path with just the base filename, e.g. test_foo::test_bar[0].
-    """
-    node_ids = request.node.nodeid.split('::')
-    node_ids[0] = request.fspath.purebasename
-    return '::'.join(node_ids)
-
-
-@pytest.fixture(scope='module')
-def betamax_use_cassette_kwargs():
-    return {}
-
-
-@pytest.fixture
-def betamax_recorder(configure_betamax, real_requests_session):   # pylint:disable=unused-argument
-    return Betamax(real_requests_session)
-
-
-@pytest.fixture
-def betamax_cassette_recorder(betamax_recorder, betamax_cassette_name, betamax_use_cassette_kwargs):
-    """Including this fixture causes the test to use a betamax cassette for network requests."""
-    with betamax_recorder.use_cassette(betamax_cassette_name, **betamax_use_cassette_kwargs) as cassette_recorder:
-        yield cassette_recorder
-
-
-@pytest.fixture
-def betamax_session(betamax_cassette_recorder):
-    """A betamax-enabled requests.Session instance."""
-    return betamax_cassette_recorder.session
-
-
-@pytest.fixture
-def betamax_network(betamax_session):
-    """A betamax-enabled boxsdk.Network instance."""
-    return RequestsSessionNetwork(session=betamax_session)

test/unit/network/test_network.py

@@ -80,7 +80,7 @@ def test_requests_session_network_accepts_custom_session():
     mock_requests_session.request.assert_called_once_with('method', 'url')
 
 
-def test_requests_session_network_works_with_betamax(betamax_network):
-    response = betamax_network.request(method='GET', url='https://api.box.com/2.0/users/me', access_token='access_token')
+def test_requests_session_network_works_with_betamax(betamax_boxsdk_network):
+    response = betamax_boxsdk_network.request(method='GET', url='https://api.box.com/2.0/users/me', access_token='access_token')
     assert response.ok is False
     assert response.status_code == 401