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.

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

Fix Mock constructor params/url order mishandling #111

Merged
merged 2 commits into from
Dec 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 27 additions & 4 deletions src/pook/helpers.py
Original file line number Diff line number Diff line change
@@ -1,27 +1,50 @@
import re

from inspect import ismethod, isfunction
from .exceptions import PookInvalidArgument


def trigger_methods(instance, args):
reply_response_re = re.compile("^(response|reply)_")


def _get_key(key_order):
def key(x):
raw = reply_response_re.sub("", x)
try:
return key_order.index(raw)
except KeyError:
raise PookInvalidArgument("Unsupported argument: {}".format(x))

return key


def trigger_methods(instance, args, key_order=None):
"""
Triggers specific class methods using a simple reflection
mechanism based on the given input dictionary params.

Arguments:
instance (object): target instance to dynamically trigger methods.
args (iterable): input arguments to trigger objects to
key_order (None|iterable): optional order in which to process keys; falls back to `sorted`'s default behaviour if not present

Returns:
None
"""
# Start the magic
for name in sorted(args):
if key_order:
key = _get_key(key_order)
sorted_args = sorted(args, key=key)
else:
sorted_args = sorted(args)

for name in sorted_args:
value = args[name]
target = instance

# If response attibutes
if name.startswith("response_") or name.startswith("reply_"):
name = name.replace("response_", "").replace("reply_", "")
if reply_response_re.match(name):
name = reply_response_re.sub("", name)
# If instance has response attribute, use it
if hasattr(instance, "_response"):
target = instance._response
Expand Down
42 changes: 41 additions & 1 deletion src/pook/mock.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,46 @@ class Mock(object):
pook.Mock
"""

_KEY_ORDER = (
"add_matcher",
"body",
"callback",
"calls",
"content",
"delay",
"done",
"error",
"file",
"filter",
"header",
"header_present",
"headers",
"headers_present",
"isdone",
"ismatched",
"json",
"jsonschema",
"map",
"match",
"matched",
"matches",
"method",
"url",
"param",
"param_exists",
"params",
"path",
"persist",
"reply",
"response",
"status",
"times",
"total_matches",
"type",
"use",
"xml",
)

def __init__(self, request=None, response=None, **kw):
# Stores the number of times the mock should live
self._times = 1
Expand Down Expand Up @@ -126,7 +166,7 @@ def __init__(self, request=None, response=None, **kw):
self.callbacks = []

# Triggers instance methods based on argument names
trigger_methods(self, kw)
trigger_methods(self, kw, self._KEY_ORDER)

# Trigger matchers based on predefined request object, if needed
if request:
Expand Down
2 changes: 1 addition & 1 deletion src/pook/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def __init__(self, method="GET", **kw):
self._extra = kw.get("extra")
self._headers = HTTPHeaderDict()

trigger_methods(self, kw)
trigger_methods(self, kw, self.keys)

@property
def method(self):
Expand Down
16 changes: 15 additions & 1 deletion src/pook/response.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,20 @@ class Response(object):
mock (pook.Mock): reference to mock instance.
"""

_KEY_ORDER = (
"body",
"content",
"file",
"header",
"headers",
"json",
"mock",
"set",
"status",
"type",
"xml",
)

def __init__(self, **kw):
self._status = 200
self._mock = None
Expand All @@ -31,7 +45,7 @@ def __init__(self, **kw):
self._headers = HTTPHeaderDict()

# Trigger response method based on input arguments
trigger_methods(self, kw)
trigger_methods(self, kw, self._KEY_ORDER)

def status(self, code=200):
"""
Expand Down
47 changes: 47 additions & 0 deletions tests/unit/mock_test.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import pytest
import json
import re

import pook
from pook.mock import Mock
from pook.request import Request
from urllib.request import urlopen
from urllib.parse import urlencode


@pytest.fixture
Expand All @@ -17,6 +23,47 @@ def test_mock_url(mock):
assert str(matcher(mock)) == "http://google.es"


@pytest.mark.parametrize(
("param_kwargs", "query_string"),
(
pytest.param({"params": {"x": "1"}}, "?x=1", id="params"),
pytest.param(
{"param": ("y", "pook")},
"?y=pook",
marks=pytest.mark.xfail(
condition=True,
reason="Constructor does not correctly handle multi-argument methods from kwargs",
),
id="param",
),
pytest.param(
{"param_exists": "z"},
# This complexity is needed until https://github.com/h2non/pook/issues/110
# is resolved
f'?{urlencode({"z": re.compile("(.*)")})}',
id="param_exists",
),
),
)
def test_constructor(param_kwargs, query_string):
# Should not raise
mock = Mock(
url="https://httpbin.org/404",
reply_status=200,
response_json={"hello": "from pook"},
**param_kwargs,
)

expected_url = f"https://httpbin.org/404{query_string}"
assert mock._request.rawurl == expected_url

with pook.use():
pook.engine().add_mock(mock)
res = urlopen(expected_url)
assert res.status == 200
assert json.loads(res.read()) == {"hello": "from pook"}


@pytest.mark.parametrize(
"url, params, req, expected",
[
Expand Down