tests.test_http_requests

Complexity

Total Complexity

6

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes

0

6 Functions

Rating	Name	Duplication	Size	Complexity
A	mock_requests_get()	0	9	1
A	request_rnd_wiki_artcl()	0	8	1
A	test_mock_param_call_inspection()	0	23	1
A	test_mock_gets_called()	0	23	1
A	test_mock_result_inspection()	0	8	1
A	test_fail_on_request_error()	0	12	1

# tests/test_http_requests.py
"""Module to test https request calls using the request package.

Targets are mostly mocked using pytest-mock plugin::

    poetry add --dev pytest-mock

Meant to serve as template in case the package uses url based api calls.
"""
# third party packages
import pytest
import requests

from .test_connectivity import request_url

# pylint: disable=redefined-outer-name
# disabled here, sind redefinition is how fixtures work and they are used here
# extensively


@pytest.fixture
def mock_requests_get(mocker):
    """Fixture to mock reqeust.get calls."""
    mock = mocker.patch("requests.get")
    mock.return_value.__enter__.return_value.json.return_value = {
        "title": "Lorem Ipsum",
        "extract": "Lorem ipsum dolor sit amet",
    }
    return mock


@pytest.fixture
def request_rnd_wiki_artcl():
    """Try reaching the wikipedia site to get a random article."""
    api_url = "https://en.wikipedia.org/api/rest_v1/page/random/summary"
    response = request_url(api_url)
    json_response = response.json()

    return json_response


def test_mock_gets_called(mock_requests_get, request_rnd_wiki_artcl):
    """
    Assert the requests.get was actually called.

    random_wiki_article gets called by fixutre wrap around mock object so
    the mock object is "requests.get" instead of the url.
    Fixture order is important!

    Since the data content is not of importance calling the fixture alone
    suffices.

    Parameters
    ----------
    mock_requests_get
        mock_requests_get fixture from above
    request_rnd_wiki_artcl
        request_random_wiki_article fixture from above
    """
    # pylint: disable=unused-argument
    # disabled here since the fixture is needed for successful mocking
    # but unsued in the traditional argument sense of a = b; print(2*a)

    assert mock_requests_get.called


def test_mock_result_inspection(mock_requests_get, request_rnd_wiki_artcl):
    """Test successful mock result inspection."""
    # pylint: disable=unused-argument
    # disabled here since the fixture is needed for successful mocking
    # but unsued in the traditional argument sense of a = b; print(2*a)

    http_json_response = request_rnd_wiki_artcl
    assert "Lorem Ipsum" in http_json_response["title"]


def test_mock_param_call_inspection(mock_requests_get, request_rnd_wiki_artcl):
    """
    Assert the requests.get was called properly.

    Random_wiki_article gets called by fixutre wrap around mock object so
    the mock object is "requests.get" instead of the url.
    Fixture order is implortant!
    Since the data content is not of importance calling the fixture alone
    suffices.

    Parameters
    ----------
    mock_requests_get
        mock_requests_get fixture from above
    request_rnd_wiki_artcl
        request_random_wiki_article fixture from above
    """
    # pylint: disable=unused-argument
    # disabled here since the fixture is needed for successful mocking
    # but unsued in the traditional argument sense of a = b; print(2*a)

    args, _ = mock_requests_get.call_args
    assert "en.wikipedia.org" in args[0]


def test_fail_on_request_error(mock_requests_get, request_rnd_wiki_artcl):
    """Test on failing the https request."""
    # pylint: disable=unused-argument
    # disabled here since the fixture is needed for successful mocking
    # but unsued in the traditional argument sense of a = b; print(2*a)

    mock_requests_get.side_effect = requests.RequestException

    api_url = "https://en.wikipedia.org/api/rest_v1/page/random/summary"
    mock_response = request_url(api_url)

    assert "Error" in mock_response