Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove mocket #173

Merged
merged 6 commits into from
Jul 16, 2024
Merged

Remove mocket #173

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8a58936
Remove mocket
shadromani Jul 4, 2024
fb95083
Simplify url setting based on suggestions
shadromani Jul 8, 2024
2d92b56
Remove custom handler and use header matching
shadromani Jul 8, 2024
94c3584
Set method to get explicitly
shadromani Jul 8, 2024
c18578d
Use correct syntax for header matching
shadromani Jul 10, 2024
fa73af1
Use headers and a matcher
shadromani Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ jobs:

strategy:
matrix:
# We don't test on Windows currently as it appears mocket may not
# work there.
# TODO: add windows-latest also
platform: [ubuntu-latest, macos-latest]
python-version: [3.8, 3.9, "3.10", 3.11, 3.12]

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ classifiers = [

[project.optional-dependencies]
test = [
"mocket>=3.12.8",
"pytest-httpserver>=1.0.10",
]

[tool.setuptools.package-data]
Expand Down
4 changes: 3 additions & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ python =

[testenv:{py38,py39,py310,py311,py312}-test]
deps =
mocket
pytest-httpserver
pytest
commands = pytest tests

Expand All @@ -43,6 +43,8 @@ commands = flake8 geoip2
[testenv:py312-mypy]
deps =
mypy
pytest_httpserver
pytest
types-requests
voluptuous-stubs
commands = mypy geoip2 tests
188 changes: 88 additions & 100 deletions tests/webservice_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@
import sys
from typing import cast, Dict
import unittest
from pytest_httpserver import HeaderValueMatcher
import pytest_httpserver
import pytest

sys.path.append("..")

# httpretty currently doesn't work, but mocket with the compat interface
# does.
from mocket import Mocket # type: ignore
from mocket.plugins.httpretty import httpretty, httprettified # type: ignore
import geoip2
from geoip2.errors import (
AddressNotFoundError,
Expand All @@ -29,7 +27,6 @@


class TestBaseClient(unittest.TestCase):
base_uri = "https://geoip.maxmind.com/geoip/v2.1/"
country = {
"continent": {"code": "NA", "geoname_id": 42, "names": {"en": "North America"}},
"country": {
Expand Down Expand Up @@ -64,12 +61,15 @@ def _content_type(self, endpoint):
+ "+json; charset=UTF-8; version=1.0"
)

@httprettified
@pytest.fixture(autouse=True)
def setup_httpserver(self, httpserver: pytest_httpserver.HTTPServer):
self.httpserver = httpserver

def test_country_ok(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/1.2.3.4",
body=json.dumps(self.country),
self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.4", method="GET"
).respond_with_json(
self.country,
status=200,
content_type=self._content_type("country"),
)
Expand Down Expand Up @@ -111,12 +111,11 @@ def test_country_ok(self):
self.assertTrue(country.traits.is_anycast)
self.assertEqual(country.raw, self.country, "raw response is correct")

@httprettified
def test_me(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/me",
body=json.dumps(self.country),
self.httpserver.expect_request(
"/geoip/v2.1/country/me", method="GET"
).respond_with_json(
self.country,
status=200,
content_type=self._content_type("country"),
)
Expand All @@ -131,33 +130,31 @@ def test_me(self):
"country('me') returns Country object",
)

@httprettified
def test_200_error(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/1.1.1.1",
body="",
self.httpserver.expect_request(
"/geoip/v2.1/country/1.1.1.1", method="GET"
).respond_with_data(
"",
status=200,
content_type=self._content_type("country"),
)

with self.assertRaisesRegex(
GeoIP2Error, "could not decode the response as JSON"
):
self.run_client(self.client.country("1.1.1.1"))

@httprettified
def test_bad_ip_address(self):
with self.assertRaisesRegex(
ValueError, "'1.2.3' does not appear to be an IPv4 " "or IPv6 address"
):
self.run_client(self.client.country("1.2.3"))

@httprettified
def test_no_body_error(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/" + "1.2.3.7",
body="",
self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.7", method="GET"
).respond_with_data(
"",
status=400,
content_type=self._content_type("country"),
)
Expand All @@ -166,27 +163,28 @@ def test_no_body_error(self):
):
self.run_client(self.client.country("1.2.3.7"))

@httprettified
def test_weird_body_error(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/" + "1.2.3.8",
body='{"wierd": 42}',

self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.8", method="GET"
).respond_with_json(
{"wierd": 42},
status=400,
content_type=self._content_type("country"),
)

with self.assertRaisesRegex(
HTTPError,
"Response contains JSON but it does not " "specify code or error keys",
):
self.run_client(self.client.country("1.2.3.8"))

@httprettified
def test_bad_body_error(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/" + "1.2.3.9",
body="bad body",

self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.9", method="GET"
).respond_with_data(
"bad body",
status=400,
content_type=self._content_type("country"),
)
Expand All @@ -195,19 +193,23 @@ def test_bad_body_error(self):
):
self.run_client(self.client.country("1.2.3.9"))

@httprettified
def test_500_error(self):
httpretty.register_uri(
httpretty.GET, self.base_uri + "country/" + "1.2.3.10", status=500
self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.10", method="GET"
).respond_with_data(
"",
status=500,
content_type=self._content_type("country"),
)
with self.assertRaisesRegex(HTTPError, r"Received a server error \(500\) for"):
self.run_client(self.client.country("1.2.3.10"))

@httprettified
def test_300_error(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/" + "1.2.3.11",

self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.11", method="GET"
).respond_with_data(
"",
status=300,
content_type=self._content_type("country"),
)
Expand All @@ -216,115 +218,100 @@ def test_300_error(self):
):
self.run_client(self.client.country("1.2.3.11"))

@httprettified
def test_ip_address_required(self):
self._test_error(400, "IP_ADDRESS_REQUIRED", InvalidRequestError)

@httprettified
def test_ip_address_not_found(self):
self._test_error(404, "IP_ADDRESS_NOT_FOUND", AddressNotFoundError)

@httprettified
def test_ip_address_reserved(self):
self._test_error(400, "IP_ADDRESS_RESERVED", AddressNotFoundError)

@httprettified
def test_permission_required(self):
self._test_error(403, "PERMISSION_REQUIRED", PermissionRequiredError)

@httprettified
def test_auth_invalid(self):
self._test_error(400, "AUTHORIZATION_INVALID", AuthenticationError)

@httprettified
def test_license_key_required(self):
self._test_error(401, "LICENSE_KEY_REQUIRED", AuthenticationError)

@httprettified
def test_account_id_required(self):
self._test_error(401, "ACCOUNT_ID_REQUIRED", AuthenticationError)

@httprettified
def test_user_id_required(self):
self._test_error(401, "USER_ID_REQUIRED", AuthenticationError)

@httprettified
def test_account_id_unkown(self):
self._test_error(401, "ACCOUNT_ID_UNKNOWN", AuthenticationError)

@httprettified
def test_user_id_unkown(self):
self._test_error(401, "USER_ID_UNKNOWN", AuthenticationError)

@httprettified
def test_out_of_queries_error(self):
self._test_error(402, "OUT_OF_QUERIES", OutOfQueriesError)

def _test_error(self, status, error_code, error_class):
msg = "Some error message"
body = {"error": msg, "code": error_code}
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/1.2.3.18",
body=json.dumps(body),
self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.18", method="GET"
).respond_with_json(
body,
status=status,
content_type=self._content_type("country"),
)
with self.assertRaisesRegex(error_class, msg):
self.run_client(self.client.country("1.2.3.18"))

@httprettified
def test_unknown_error(self):
msg = "Unknown error type"
ip = "1.2.3.19"
body = {"error": msg, "code": "UNKNOWN_TYPE"}
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/" + ip,
body=json.dumps(body),
self.httpserver.expect_request(
"/geoip/v2.1/country/" + ip, method="GET"
).respond_with_json(
body,
status=400,
content_type=self._content_type("country"),
)
with self.assertRaisesRegex(InvalidRequestError, msg):
self.run_client(self.client.country(ip))

@httprettified
def test_request(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "country/" + "1.2.3.4",
body=json.dumps(self.country),
def user_agent_compare(actual: str, expected: str) -> bool:
if actual is None:
return False
return actual.startswith("GeoIP2-Python-Client/")

def accept_compare(actual: str, expected: str) -> bool:
return actual == "application/json"

def authorization_compare(actual: str, expected: str) -> bool:
return actual == "Basic NDI6YWJjZGVmMTIzNDU2"

self.httpserver.expect_request(
"/geoip/v2.1/country/1.2.3.4",
method="GET",
header_value_matcher=HeaderValueMatcher(
{
"User-Agent": user_agent_compare,
"Accept": accept_compare,
"Authorization": authorization_compare,
}
),
Copy link
Member

@oschwald oschwald Jul 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this works either. If I change the values, the tests don't fail. I was expecting something like this:

        def user_agent_compare(actual: str, expected: str) -> bool:
            if actual is None:
                return False
            return actual.startswith(expected)

        self.httpserver.expect_request(
            "/geoip/v2.1/country/1.2.3.4",
            method="GET",
            headers={
                    "Accept": "application/json",
                    "Authorization": "Basic NDI6YWJjZGVmMTIzNDU2",
                    "User-Agent": "GeoIP2-Python-Client/"
            },
            header_value_matcher=HeaderValueMatcher(defaultdict(
                lambda: HeaderValueMatcher.default_header_value_matcher,
                {"User-Agent": user_agent_compare}
            )),
        ).respond_with_json(
            self.country,
            status=200,
            content_type=self._content_type("country"),
        )

Alternatively, you could modify the default matcher as directed in the docs.

).respond_with_json(
self.country,
status=200,
content_type=self._content_type("country"),
)
self.run_client(self.client.country("1.2.3.4"))
request = httpretty.last_request

self.assertEqual(
request.path, "/geoip/v2.1/country/1.2.3.4", "correct URI is used"
)

# This is to prevent breakage if header normalization in Mocket
# changes again in the future.
headers = {k.lower(): v for k, v in request.headers.items()}
self.assertEqual(headers["accept"], "application/json", "correct Accept header")
self.assertRegex(
headers["user-agent"],
"^GeoIP2-Python-Client/",
"Correct User-Agent",
)
self.assertEqual(
headers["authorization"],
"Basic NDI6YWJjZGVmMTIzNDU2",
"correct auth",
)

@httprettified
def test_city_ok(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "city/" + "1.2.3.4",
body=json.dumps(self.country),
self.httpserver.expect_request(
"/geoip/v2.1/city/1.2.3.4", method="GET"
).respond_with_json(
self.country,
status=200,
content_type=self._content_type("city"),
)
Expand All @@ -335,14 +322,13 @@ def test_city_ok(self):
)
self.assertTrue(city.traits.is_anycast)

@httprettified
def test_insights_ok(self):
httpretty.register_uri(
httpretty.GET,
self.base_uri + "insights/1.2.3.4",
body=json.dumps(self.insights),
self.httpserver.expect_request(
"/geoip/v2.1/insights/1.2.3.4", method="GET"
).respond_with_json(
self.insights,
status=200,
content_type=self._content_type("country"),
content_type=self._content_type("insights"),
shadromani marked this conversation as resolved.
Show resolved Hide resolved
)
insights = self.run_client(self.client.insights("1.2.3.4"))
self.assertEqual(
Expand Down Expand Up @@ -374,6 +360,7 @@ class TestClient(TestBaseClient):
def setUp(self):
self.client_class = Client
self.client = Client(42, "abcdef123456")
self.client._base_uri = self.httpserver.url_for("/geoip/v2.1")

def run_client(self, v):
return v
Expand All @@ -384,6 +371,7 @@ def setUp(self):
self._loop = asyncio.new_event_loop()
self.client_class = AsyncClient
self.client = AsyncClient(42, "abcdef123456")
self.client._base_uri = self.httpserver.url_for("/geoip/v2.1")

def tearDown(self):
self._loop.run_until_complete(self.client.close())
Expand Down
Loading