Add test fixtures and basic Github tests.

Author: jmcarp

dev-requirements.txt

@@ -1,4 +1,6 @@
+decorator
 ipython
 jinja2
+pytest
 pyzmq
 -r requirements.txt

tests/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+from tests.mocking import aiopretty
+
+
+def pytest_configure(config):
+    config.addinivalue_line(
+        'markers',
+        'aiopretty: mark tests to activate aiopretty'
+    )
+
+
+def pytest_runtest_setup(item):
+    marker = item.get_marker('aiopretty')
+    if marker is not None:
+        aiopretty.clear()
+        aiopretty.activate()
+
+
+def pytest_runtest_teardown(item, nextitem):
+    marker = item.get_marker('aiopretty')
+    if marker is not None:
+        aiopretty.deactivate()

tests/conftest.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+
+import json
+import asyncio
+
+import aiohttp
+
+
+class _AioPretty:
+    def __init__(self):
+        self.request = None
+        self.registry = {}
+        self.calls = []
+
+
+aiopretty = _AioPretty()
+
+
+def make_call(**kwargs):
+    return kwargs
+
+
+def fake_request(method, uri, **kwargs):
+    try:
+        options = aiopretty.registry[(method, uri)]
+    except KeyError:
+        raise Exception('NO')
+    aiopretty.calls.append(make_call(method=method, uri=uri, **kwargs))
+    mock_response = aiohttp.client.ClientResponse(method, uri)
+    mock_response.headers = aiohttp.client.CaseInsensitiveMultiDict(options.get('headers', {}))
+    mock_response._content = options.get('body', 'aiopretty')
+    future = asyncio.Future()
+    future.set_result(mock_response)
+    return future
+
+
+def register_uri(method, uri, **options):
+    aiopretty.registry[(method, uri)] = options
+
+
+def register_json_uri(method, uri, **options):
+    body = json.dumps(options.pop('body', None)).encode('utf-8')
+    headers = {'Content-Type': 'application/json'}
+    headers.update(options.pop('headers', {}))
+    register_uri(method, uri, body=body, headers=headers, **options)
+
+
+def activate():
+    aiohttp.request, aiopretty.request = fake_request, aiohttp.request
+
+
+def deactivate():
+    aiohttp.request, aiopretty.request = aiopretty.request, None
+
+
+def clear():
+    aiopretty.registry = {}
+
+
+def compare_call(first, second):
+    for key, value in first.items():
+        if second.get(key) != value:
+            return False
+    return True
+
+
+def has_call(**kwargs):
+    for call in aiopretty.calls:
+        if compare_call(kwargs, call):
+            return True
+    return False

tests/mocking/aiopretty.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+
+import pytest
+from . import aiopretty
+
+
+def pytest_configure(config):
+    config.addinivalue_line(
+        'markers',
+        'aiopretty: mark tests to activate aiopretty'
+    )
+
+
+def pytest_runtest_setup(item):
+    import pdb; pdb.set_trace()
+    marker = item.get_marker('aiopretty')
+    if marker is not None:
+        aiopretty.clear()
+        aiopretty.activate()
+
+
+def pytest_runtest_teardown(item, nextitem):
+    marker = item.get_marker('aiopretty')
+    if marker is not None:
+        aiopretty.deactivate()

tests/mocking/pypretty.py

@@ -0,0 +1,200 @@
+# -*- coding: utf-8 -*-
+
+import pytest
+
+from tests.utils import async
+from tests.mocking import aiopretty, pypretty
+
+import io
+import os
+import json
+import base64
+import asyncio
+
+from waterbutler.providers import core
+from waterbutler.providers.contrib.github import GithubProvider
+
+
+@pytest.fixture
+def auth():
+    return {
+        'name': 'cat',
+        'email': 'cat@cat.com',
+    }
+
+
+@pytest.fixture
+def identity():
+    return {
+        'owner': 'cat',
+        'repo': 'food',
+        'token': 'naps',
+    }
+
+
+@pytest.fixture
+def provider(auth, identity):
+    return GithubProvider(auth, identity)
+
+
+@pytest.fixture
+def file_content():
+    return b'hungry'
+
+
+@pytest.fixture
+def file_like(file_content):
+    return io.BytesIO(file_content)
+
+
+@pytest.fixture
+def file_wrapper(file_like):
+    return core.FileWrapper(file_like)
+
+
+@async
+@pytest.mark.aiopretty
+def test_download(provider):
+    url = provider.build_repo_url('git', 'blobs', 'mysha')
+    aiopretty.register_uri('GET', url, body=b'delicious')
+    result = yield from provider.download('mysha')
+    content = yield from result.response.read()
+    assert content == b'delicious'
+
+
+@pytest.fixture
+def repo_contents():
+    return [
+        {
+            'type': 'file',
+            'size': 625,
+            'name': 'octokit.rb',
+            'path': 'lib/octokit.rb',
+            'sha': 'fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b',
+            'url': 'https://api.github.com/repos/pengwynn/octokit/contents/lib/octokit.rb',
+            'git_url': 'https://api.github.com/repos/pengwynn/octokit/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b',
+            'html_url': 'https://github.com/pengwynn/octokit/blob/master/lib/octokit.rb',
+            '_links': {
+                'self': 'https://api.github.com/repos/pengwynn/octokit/contents/lib/octokit.rb',
+                'git': 'https://api.github.com/repos/pengwynn/octokit/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b',
+                'html': 'https://github.com/pengwynn/octokit/blob/master/lib/octokit.rb',
+            },
+        },
+        {
+            'type': 'dir',
+            'size': 0,
+            'name': 'octokit',
+            'path': 'lib/octokit',
+            'sha': 'a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d',
+            'url': 'https://api.github.com/repos/pengwynn/octokit/contents/lib/octokit',
+            'git_url': 'https://api.github.com/repos/pengwynn/octokit/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d',
+            'html_url': 'https://github.com/pengwynn/octokit/tree/master/lib/octokit',
+            '_links': {
+                'self': 'https://api.github.com/repos/pengwynn/octokit/contents/lib/octokit',
+                'git': 'https://api.github.com/repos/pengwynn/octokit/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d',
+                'html': 'https://github.com/pengwynn/octokit/tree/master/lib/octokit',
+            },
+        },
+    ]
+
+
+class TestGithubHelpers:
+
+    def test_build_repo_url(self, identity, provider):
+        expected = provider.build_url('repos', identity['owner'], identity['repo'], 'contents')
+        assert provider.build_repo_url('contents') == expected
+
+    def test_committer(self, auth, provider):
+        expected = {
+            'name': auth['name'],
+            'email': auth['email'],
+        }
+        assert provider.committer == expected
+
+
+@async
+@pytest.mark.aiopretty
+def test_metadata(provider, repo_contents):
+    path = 'snacks'
+    url = provider.build_repo_url('contents', path)
+    aiopretty.register_uri('GET', url, body=json.dumps(repo_contents).encode('utf-8'), headers={'Content-Type': 'application/json'})
+    result = yield from provider.metadata(path)
+    assert result == [provider._serialize_metadata(item) for item in repo_contents]
+
+
+@async
+@pytest.mark.aiopretty
+def test_upload_create(provider, repo_contents, file_content, file_wrapper):
+    message = 'so hungry'
+    path = repo_contents[0]['path'][::-1]
+    metadata_url = provider.build_repo_url('contents', os.path.dirname(path))
+    aiopretty.register_json_uri('GET', metadata_url, body=repo_contents)
+    upload_url = provider.build_repo_url('contents', path)
+    aiopretty.register_uri('PUT', upload_url)
+    result = yield from provider.upload(file_wrapper, path, message)
+    expected_data = {
+        'path': path,
+        'message': message,
+        'content': base64.b64encode(file_content).decode('utf-8'),
+        'committer': provider.committer,
+    }
+    assert aiopretty.has_call(method='GET', uri=metadata_url)
+    assert aiopretty.has_call(method='PUT', uri=upload_url, data=json.dumps(expected_data))
+
+
+@async
+@pytest.mark.aiopretty
+def test_upload_update(provider, repo_contents, file_content, file_wrapper):
+    path = repo_contents[0]['path']
+    sha = repo_contents[0]['sha']
+    message = 'so hungry'
+    metadata_url = provider.build_repo_url('contents', os.path.dirname(path))
+    aiopretty.register_json_uri('GET', metadata_url, body=repo_contents)
+    upload_url = provider.build_repo_url('contents', path)
+    aiopretty.register_uri('PUT', upload_url)
+    result = yield from provider.upload(file_wrapper, path, message)
+    expected_data = {
+        'path': path,
+        'message': message,
+        'content': base64.b64encode(file_content).decode('utf-8'),
+        'committer': provider.committer,
+        'sha': sha,
+    }
+    assert aiopretty.has_call(method='GET', uri=metadata_url)
+    assert aiopretty.has_call(method='PUT', uri=upload_url, data=json.dumps(expected_data))
+
+
+@async
+@pytest.mark.aiopretty
+def test_delete_with_branch(provider, repo_contents):
+    path = repo_contents[0]['path']
+    sha = repo_contents[0]['sha']
+    branch = 'master'
+    message = 'deleted'
+    url = provider.build_repo_url('contents', path)
+    aiopretty.register_json_uri('DELETE', url)
+    result = yield from provider.delete(path, message, sha, branch=branch)
+    expected_data = {
+        'message': message,
+        'sha': sha,
+        'committer': provider.committer,
+        'branch': branch,
+    }
+    assert aiopretty.has_call(method='DELETE', uri=url, data=json.dumps(expected_data))
+
+
+@async
+@pytest.mark.aiopretty
+def test_delete_without_branch(provider, repo_contents):
+    path = repo_contents[0]['path']
+    sha = repo_contents[0]['sha']
+    message = 'deleted'
+    url = provider.build_repo_url('contents', path)
+    aiopretty.register_json_uri('DELETE', url)
+    result = yield from provider.delete(path, message, sha)
+    expected_data = {
+        'message': message,
+        'sha': sha,
+        'committer': provider.committer,
+    }
+    assert aiopretty.has_call(method='DELETE', uri=url, data=json.dumps(expected_data))

tests/providers/__init__.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+import asyncio
+
+from decorator import decorator
+
+
+@decorator
+def async(func, *args, **kwargs):
+    future = func(*args, **kwargs)
+    asyncio.get_event_loop().run_until_complete(future)