octokit.py/tests/test_octokit.py

import pytest


class MockHeaders(object):
    def __init__(self, requested_page, **kwargs):
        link = 'Links <https://api.github.com/installation/repositories?page={}another=%2Cwith+a+space>; rel="next", <https://api.github.com/installation/repositories?page=4>; rel="last"'.format(  # noqa E501
            min(requested_page + 1, 4)
        )
        self.headers = {"Link": kwargs.get("link", link)}


class MockObject(object):
    def __init__(self, page, kwargs):
        self._response = MockHeaders(page, **kwargs)
        self.json = {"page": page, "kwargs": kwargs}


def MockResponse(page=None, **kwargs):
    return MockObject(page, kwargs)


def MockResponseWithoutLinks(page=None, **kwargs):
    kwargs["link"] = ""
    return MockObject(page, kwargs)


class TestOctokit(object):
    def test_can_instantiate_class(self):
        import octokit

        assert isinstance(octokit.Octokit, object)
        octo = octokit.Octokit()
        assert isinstance(octo, object)

    def test_can_import_class(self):
        from octokit import Octokit

        assert isinstance(Octokit, object)
        octokit = Octokit()
        assert isinstance(octokit, object)

    def test_clients_are_lower_case(self):
        from octokit import Octokit

        assert all(client.islower() for client in Octokit.__dict__)

    def test_pagination(self):
        from octokit import Octokit

        sut_obj = MockResponse
        p = Octokit().paginate(sut_obj, param="value")
        assert next(p) == {"page": 1, "kwargs": {"param": "value"}}
        assert next(p) == {"page": 2, "kwargs": {"param": "value"}}
        assert next(p) == {"page": 3, "kwargs": {"param": "value"}}
        assert next(p) == {"page": 4, "kwargs": {"param": "value"}}

    def test_pagination_does_break_when_iterating_over_a_single_page(self):
        from octokit import Octokit

        sut_obj = MockResponseWithoutLinks
        p = Octokit().paginate(sut_obj, param="value")
        assert next(p) == {"page": 1, "kwargs": {"param": "value", "link": ""}}
        with pytest.raises(StopIteration):
            assert next(p)

    def test_can_speficy_the_route_specifications_used(self):
        from octokit import Octokit

        octokit = Octokit(routes="ghe-2.18")
        assert "/enterprise/2.18" in octokit.issues.create.__doc__
        octokit = Octokit()
        assert "/developer.github.com" in octokit.issues.create.__doc__
        octokit = Octokit(routes="api.github.com")
        assert "/developer.github.com" in octokit.issues.create.__doc__