Merge pull request #82 from kwist-sgr/master

Add `form` to Predicate

Author: brunns

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 2.13.2
+
+* Enhancement - add form to Predicate.
+* Fix - added the `imurl` package to dependencies
+
 ## 2.13.1
 
 * Re-release
@@ -58,7 +63,7 @@
 * Add [dynamic predicates and responses](http://www.mbtest.org/docs/api/injection). This feature requires Mountebank 2.0 or later, but all other features should continue to work with older version.
 * Add MountebankServer.query_all_imposters() method to retrieve all imposters from a running MB server, including those not created locally.
 
-## 2.4 
+## 2.4
 
 * Allow MountebankServer to attach to an already running MB instance on another host.
 * Make has_request() a builder style matcher, and use builder matcher construction wherever possible.

setup.py

@@ -53,7 +53,7 @@
 setup(
     name="mbtest",
     zip_safe=False,
-    version="2.13.1",
+    version="2.13.2",
     description="Python wrapper & utils for the Mountebank over the wire test double tool.",
     long_description=long_description,
     long_description_content_type="text/markdown",

src/mbtest/imposters/predicates.py

@@ -44,6 +44,7 @@ class Predicate(LogicallyCombinablePredicate):
     :param query: Query arguments, keys and values.
     :param body: Body text. Can be a string, or a JSON serialisable data structure.
     :param headers: Headers, keys and values.
+    :param form: Form-encoded key-value pairs in the body.
     :param xpath: xpath query
     :param jsonpath: jsonpath query
     :param operator:
@@ -88,6 +89,7 @@ def __init__(
         headers: Optional[Mapping[str, str]] = None,
         xpath: Optional[str] = None,
         jsonpath: Optional[str] = None,
+        form: Optional[Mapping[str, str]] = None,
         operator: Union[Operator, str] = Operator.EQUALS,
         case_sensitive: bool = True,  # noqa: FBT001,FBT002
     ) -> None:
@@ -98,6 +100,7 @@ def __init__(
         self.headers = headers
         self.xpath = xpath
         self.jsonpath = jsonpath
+        self.form = form
         self.operator = operator if isinstance(operator, Predicate.Operator) else Predicate.Operator(operator)
         self.case_sensitive = case_sensitive
 
@@ -132,6 +135,7 @@ def fields_from_structure(self, inner):
         self.set_if_in_dict(inner, "query", "query")
         self.set_if_in_dict(inner, "body", "body")
         self.set_if_in_dict(inner, "headers", "headers")
+        self.set_if_in_dict(inner, "form", "form")
         if "method" in inner:
             self.method = Predicate.Method(inner["method"])
 
@@ -141,6 +145,7 @@ def fields_as_structure(self):
         self.add_if_true(fields, "query", self.query)
         self.add_if_true(fields, "body", self.body)
         self.add_if_true(fields, "headers", self.headers)
+        self.add_if_true(fields, "form", self.form)
         if self.method:
             fields["method"] = self.method.value
         return fields

tests/unit/mbtest/test_predicate.py

@@ -71,6 +71,13 @@ def test_structure_headers():
     assert predicate.headers == expected_predicate.headers
 
 
+def test_structure_form():
+    expected_predicate = Predicate(form={"key": "value"})
+    predicate_structure = expected_predicate.as_structure()
+    predicate = BasePredicate.from_structure(predicate_structure)
+    assert predicate.headers == expected_predicate.headers
+
+
 def test_structure_operator():
     expected_predicate = Predicate(operator="deepEquals")
     predicate_structure = expected_predicate.as_structure()