Add deprecation warning.

Author: alexcouper

abe/mocks.py

@@ -1,4 +1,5 @@
 import json
+import warnings
 
 from supermutes.dot import dotify
 
@@ -10,6 +11,14 @@ def __init__(self, data):
         Initialise an ABE mock from data.
 
         """
+        if not isinstance(data, dict):
+            msg = ('Instanciating an AbeMock by filename is deprecated and '
+                   'will be removed in an upcoming release. '
+                   'Use AbeMock.from_filename instead'.format(data))
+            warnings.warn(msg, DeprecationWarning)
+            with open(data, 'r') as f:
+                data = json.load(f)
+
         # map JSON fields to attributes
         self.__dict__ = data
 

tests/data/sample.json

@@ -0,0 +1,34 @@
+{
+    "description": "Retrieve profile of logged in user",
+    "url": "/accounts/me",
+    "method": "GET",
+    "examples": {
+        "OK": {
+            "request": {
+                "url": "/accounts/me"
+            },
+            "response": {
+                "status": 200,
+                "body": {
+                    "id": 1,
+                    "username": "user-0",
+                    "first_name": "",
+                    "last_name": "",
+                    "email": "user-0@example.com"
+                }
+            }
+        },
+        "unauthenticated": {
+            "description": "I am not logged in",
+            "request": {
+                "url": "/accounts/me"
+            },
+            "response": {
+                "status": 403,
+                "body": {
+                    "detail": "Authentication credentials were not provided."
+                }
+            }
+        }
+    }
+}

tests/test_assertions.py

@@ -1,9 +1,14 @@
+from os.path import abspath, dirname, join
 from unittest import TestCase
+import warnings
+
 from mock import Mock
 
 from abe.mocks import AbeMock
 from abe.unittest import AbeTestMixin
 
+DATA_DIR = join(dirname(abspath(__file__)), 'data')
+
 
 class TestDataListEqual(TestCase, AbeTestMixin):
 
@@ -134,3 +139,21 @@ def test_assertion_error_if_post_data_mismatch(self):
             self.assert_matches_request(
                 self.sample_request, self.mock_wsgi_request
             )
+
+
+class TestFilenameInstantiation(TestCase):
+
+    def setUp(self):
+        self.filename = join(DATA_DIR, 'sample.json')
+
+    def test_can_still_use_deprecated_instantiation(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+
+            mock = AbeMock(self.filename)
+
+            self.assertEqual(len(w), 1)
+            self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
+
+    def test_from_filename(self):
+        mock = AbeMock.from_filename(self.filename)