Use responses in filelink and utils tests (#65)

Author: bkwi

tests/filelink_test.py

@@ -1,10 +1,12 @@
 import io
+import re
 from unittest.mock import mock_open, patch, ANY
 
 import pytest
+import responses
+
 from httmock import urlmatch, HTTMock, response
 
-from tests.helpers import DummyHttpResponse
 from filestack import Filelink, Security
 from filestack import config
 
@@ -93,25 +95,27 @@ def api_bad(url, request):
         }
     ),
 ])
-@patch('filestack.models.filelink.requests.get')
-def test_metadata(get_mock, attributes, security, expected_params, filelink):
-    get_mock.return_value = DummyHttpResponse(json_dict={'metadata': 'content'})
+@responses.activate
+def test_metadata(attributes, security, expected_params, filelink):
+    responses.add(
+        responses.GET,
+        re.compile('https://cdn.filestackcontent.com/SOMEHANDLE/metadata.*'),
+        json={'metadata': 'content'}
+    )
     metadata_response = filelink.metadata(attributes_list=attributes, security=security)
     assert metadata_response == {'metadata': 'content'}
-    expected_url = '{}/SOMEHANDLE/metadata'.format(config.CDN_URL)
-    get_mock.assert_called_once_with(expected_url, params=expected_params)
+    assert responses.calls[0].request.params == expected_params
 
 
+@responses.activate
 def test_download(filelink):
-    @urlmatch(netloc=r'cdn\.filestackcontent\.com', method='get', scheme='https')
-    def api_download(url, request):
-        return response(200, b'file-content')
-
+    responses.add(
+        responses.GET, 'https://cdn.filestackcontent.com/{}'.format(HANDLE), body=b'file-content'
+    )
     m = mock_open()
     with patch('filestack.mixins.common.open', m):
-        with HTTMock(api_download):
-            file_size = filelink.download('tests/data/test_download.jpg')
-            assert file_size == 12
+        file_size = filelink.download('tests/data/test_download.jpg')
+        assert file_size == 12
     m().write.assert_called_once_with(b'file-content')
 
 
@@ -120,22 +124,27 @@ def test_tags_without_security(filelink):
         filelink.tags()
 
 
-@patch('filestack.utils.requests.get')
-def test_tags(get_mock, secure_filelink):
-    image_tags = {'tags': {'cat': 99}}
-    get_mock.return_value = DummyHttpResponse(json_dict=image_tags)
-    assert secure_filelink.tags() == image_tags
-    get_mock.assert_called_once_with('{}/tags/{}/{}'.format(config.CDN_URL, SECURITY.as_url_string(), HANDLE))
+@responses.activate
+def test_tags(secure_filelink):
+    responses.add(
+        responses.GET, re.compile('https://cdn.filestackcontent.com/tags/.*/{}$'.format(HANDLE)),
+        json={'tags': {'cat': 98}}
+    )
+    assert secure_filelink.tags() == {'tags': {'cat': 98}}
+    assert responses.calls[0].request.url == '{}/tags/{}/{}'.format(config.CDN_URL, SECURITY.as_url_string(), HANDLE)
 
 
-@patch('filestack.utils.requests.get')
-def test_tags_on_transformation(get_mock, secure_filelink):
+@responses.activate
+def test_tags_on_transformation(secure_filelink):
     transformation = secure_filelink.resize(width=100)
     image_tags = {'tags': {'cat': 99}}
-    get_mock.return_value = DummyHttpResponse(json_dict=image_tags)
+    responses.add(
+        responses.GET, re.compile('{}/resize.*/{}$'.format(config.CDN_URL, HANDLE)),
+        json=image_tags
+    )
     assert transformation.tags() == image_tags
-    get_mock.assert_called_once_with(
-        '{}/resize=width:100/tags/{}/{}'.format(config.CDN_URL, SECURITY.as_url_string(), HANDLE)
+    assert responses.calls[0].request.url == '{}/resize=width:100/tags/{}/{}'.format(
+        config.CDN_URL, SECURITY.as_url_string(), HANDLE
     )
 
 
@@ -144,22 +153,22 @@ def test_sfw_without_security(filelink):
         filelink.sfw()
 
 
-@patch('filestack.utils.requests.get')
-def test_sfw(get_mock, secure_filelink):
+@responses.activate
+def test_sfw(secure_filelink):
     sfw_response = {'sfw': False}
-    get_mock.return_value = DummyHttpResponse(json_dict=sfw_response)
+    responses.add(responses.GET, re.compile('{}.*'.format(config.CDN_URL)), json=sfw_response)
     assert secure_filelink.sfw() == sfw_response
-    get_mock.assert_called_once_with('{}/sfw/{}/{}'.format(config.CDN_URL, SECURITY.as_url_string(), HANDLE))
+    assert responses.calls[0].request.url == '{}/sfw/{}/{}'.format(config.CDN_URL, SECURITY.as_url_string(), HANDLE)
 
 
-@patch('filestack.utils.requests.get')
-def test_sfw_on_transformation(get_mock, secure_filelink):
+@responses.activate
+def test_sfw_on_transformation(secure_filelink):
     transformation = secure_filelink.resize(width=100)
     sfw_response = {'sfw': True}
-    get_mock.return_value = DummyHttpResponse(json_dict=sfw_response)
+    responses.add(responses.GET, re.compile('{}/resize.*'.format(config.CDN_URL)), json=sfw_response)
     assert transformation.sfw() == sfw_response
-    get_mock.assert_called_once_with(
-        '{}/resize=width:100/sfw/{}/{}'.format(config.CDN_URL, SECURITY.as_url_string(), HANDLE)
+    assert responses.calls[0].request.url == '{}/resize=width:100/sfw/{}/{}'.format(
+        config.CDN_URL, SECURITY.as_url_string(), HANDLE
     )
 
 

tests/utils_test.py

@@ -1,38 +1,36 @@
-import re
-from unittest.mock import patch
-
 import pytest
+import responses
 
-from tests.helpers import DummyHttpResponse
 from filestack import __version__
 from filestack.utils import requests
 
-TEST_URL = 'http://just.some.url'
+TEST_URL = 'http://just.some.url/'
 
 
-@patch('filestack.utils.original_requests.post')
-def test_req_wrapper_overwrite_headers(post_mock):
+@responses.activate
+def test_req_wrapper_overwrite_headers():
+    responses.add(responses.POST, TEST_URL)
     requests.post(TEST_URL)
-    post_args, post_kwargs = post_mock.call_args
-    headers_sent = post_kwargs['headers']
-    assert post_args[0] == TEST_URL
-    assert headers_sent['User-Agent'] == 'filestack-python {}'.format(__version__)
-    assert headers_sent['Filestack-Source'] == 'Python-{}'.format(__version__)
-    assert re.match(r'\d+-[a-zA-Z0-9]{10}', headers_sent['Filestack-Trace-Id'])
-    assert re.match(r'pythonsdk-[a-zA-Z0-9]{10}', headers_sent['Filestack-Trace-Span'])
+    mocked_request = responses.calls[0].request
+    assert mocked_request.url == TEST_URL
+    assert 'Filestack-Trace-Id' in mocked_request.headers
+    assert 'Filestack-Trace-Span' in mocked_request.headers
+    assert 'filestack-python {}'.format(__version__) == mocked_request.headers['User-Agent']
+    assert 'Python-{}'.format(__version__) == mocked_request.headers['Filestack-Source']
 
 
-@patch('filestack.utils.original_requests.post')
-def test_req_wrapper_use_provided_headers(post_mock):
+@responses.activate
+def test_req_wrapper_use_provided_headers():
+    responses.add(responses.POST, TEST_URL)
     custom_headers = {'something': 'used explicitly'}
     requests.post(TEST_URL, headers=custom_headers)
-    post_args, post_kwargs = post_mock.call_args
-    assert post_args[0] == TEST_URL
-    assert post_kwargs['headers'] == custom_headers
+    print(responses.calls[0].request.headers)
+    assert responses.calls[0].request.url == TEST_URL
+    assert responses.calls[0].request.headers['something'] == 'used explicitly'
 
 
-@patch('filestack.utils.original_requests.post')
-def test_req_wrapper_raise_exception(post_mock):
-    post_mock.return_value = DummyHttpResponse(ok=False, content=b'oops!')
+@responses.activate
+def test_req_wrapper_raise_exception():
+    responses.add(responses.POST, TEST_URL, status=500, body=b'oops!')
     with pytest.raises(Exception, match='oops!'):
         requests.post(TEST_URL)