robotframework-mock 0.6.0__tar.gz → 0.7.1__tar.gz

{robotframework_mock-0.6.0/src/robotframework_mock.egg-info → robotframework_mock-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-mock
-Version: 0.6.0
+Version: 0.7.1
 Summary: A Robot Framework library for mocking keywords in unit tests
 Home-page: https://github.com/olesz/robotframework-mock
 Author: Lajos Olah
@@ -328,6 +328,29 @@ ${rows}=    Evaluate    [['Europe/Budapest']]
 MockRes.Mock Keyword    Run Query    return_value=${rows}
 ```
 
+### Mocked keyword setup and teardown
+
+`MockResource` replaces only a keyword's **body**. Its `[Setup]` and `[Teardown]`
+still run, which keeps them observable — a test can assert that a teardown
+released a lock, for instance.
+
+That is a problem when the teardown cleans up state the replaced body would have
+created, because it then fails on the mocked call. Suppress it per mock:
+
+```robot
+# Init Client acquires a lock in its body and releases it in its teardown.
+# Without the body there is no lock to release, so skip the teardown.
+MockRes.Mock Keyword    Init Client    return_value=alias    skip_teardown=${True}
+MockRes.Mock Keyword    Init Client    return_value=alias    skip_setup=${True}
+```
+
+Both default to `False`, so existing tests are unaffected. `Reset Mocks`
+restores a suppressed setup or teardown along with the body.
+
+Prefer the default when the setup or teardown is part of the contract you are
+testing, and skip it when it is an implementation detail of a keyword the test
+is only standing in for.
+
 ### Reset Mocks
 
 Restore all mocked keywords to their original implementations.

{robotframework_mock-0.6.0 → robotframework_mock-0.7.1}/README.md

@@ -304,6 +304,29 @@ ${rows}=    Evaluate    [['Europe/Budapest']]
 MockRes.Mock Keyword    Run Query    return_value=${rows}
 ```
 
+### Mocked keyword setup and teardown
+
+`MockResource` replaces only a keyword's **body**. Its `[Setup]` and `[Teardown]`
+still run, which keeps them observable — a test can assert that a teardown
+released a lock, for instance.
+
+That is a problem when the teardown cleans up state the replaced body would have
+created, because it then fails on the mocked call. Suppress it per mock:
+
+```robot
+# Init Client acquires a lock in its body and releases it in its teardown.
+# Without the body there is no lock to release, so skip the teardown.
+MockRes.Mock Keyword    Init Client    return_value=alias    skip_teardown=${True}
+MockRes.Mock Keyword    Init Client    return_value=alias    skip_setup=${True}
+```
+
+Both default to `False`, so existing tests are unaffected. `Reset Mocks`
+restores a suppressed setup or teardown along with the body.
+
+Prefer the default when the setup or teardown is part of the contract you are
+testing, and skip it when it is an implementation detail of a keyword the test
+is only standing in for.
+
 ### Reset Mocks
 
 Restore all mocked keywords to their original implementations.

{robotframework_mock-0.6.0 → robotframework_mock-0.7.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = robotframework-mock
-version = 0.6.0
+version = 0.7.1
 author = Lajos Olah
 author_email = lajos.olah.jr@gmail.com
 description = A Robot Framework library for mocking keywords in unit tests

{robotframework_mock-0.6.0 → robotframework_mock-0.7.1}/src/MockResource/__init__.py

@@ -74,6 +74,8 @@ class MockResource(CallInspectionMixin):
         self._source = source
         self._original_get_runner = Namespace.get_runner
         self._original_items = {}
+        self._original_setups = {}
+        self._original_teardowns = {}
         self._mocks = {}
         self._install_patch()
 
@@ -112,30 +114,53 @@ class MockResource(CallInspectionMixin):
     @keyword
     def mock_keyword(
         self, keyword_name: str,
-        return_value: Any = None, side_effect: Callable = None
+        return_value: Any = None, side_effect: Callable = None,
+        skip_setup: bool = False, skip_teardown: bool = False
     ):
         """Mock a keyword from the resource file.
-        
+
+        Only the keyword's body is replaced. Its ``[Setup]`` and ``[Teardown]``
+        still run by default, which keeps them observable - a test can assert
+        that a teardown released a lock, for example. Suppress them when the
+        mocked keyword's own setup or teardown is an implementation detail the
+        test should not depend on, typically because it cleans up state that the
+        replaced body would have created and therefore fails.
+
         Args:
             keyword_name: Name of the keyword to mock
-            return_value: Value to return when the keyword is called
+            return_value: Value to return when the keyword is called. May be any
+                Python object.
             side_effect: Callable to execute instead of returning a value.
                 Receives the call's resolved arguments, the same way a
                 ``MockLibrary`` side effect does.
+            skip_setup: Do not run the keyword's ``[Setup]`` while mocked.
+            skip_teardown: Do not run the keyword's ``[Teardown]`` while mocked.
 
         Returns:
             The :class:`unittest.mock.Mock` backing the keyword.
 
+        Raises:
+            AttributeError: If the keyword is not found in the resource file.
+
         Example:
             | MockRes.Mock Keyword | My Keyword | return_value=test_data |
+            | MockRes.Mock Keyword | Init Client | skip_teardown=${True} |
         """
         keyword_runner = BuiltIn()._namespace.get_runner(keyword_name, True)  # pylint: disable=protected-access
         resource_file = getattr(keyword_runner.keyword, "source", None)
 
         if self._source not in str(resource_file):
-            raise AttributeError("fKeyword '{keyword_name}' not found in {self._source}")
+            raise AttributeError(
+                f"Keyword '{keyword_name}' not found in {self._source}"
+            )
 
         self._original_items[keyword_name] = keyword_runner.keyword.body._items  # pylint: disable=protected-access
+        if skip_setup:
+            self._original_setups[keyword_name] = keyword_runner.keyword.setup
+            keyword_runner.keyword.setup = None
+        if skip_teardown:
+            self._original_teardowns[keyword_name] = keyword_runner.keyword.teardown
+            keyword_runner.keyword.teardown = None
         mock = Mock(return_value=return_value, side_effect=side_effect)
         self._mocks[keyword_name] = mock
         return mock
@@ -144,8 +169,9 @@ class MockResource(CallInspectionMixin):
     def reset_mocks(self):
         """Reset all mocks to their original implementations.
         
-        Restores all mocked keywords to their original behavior.
-        
+        Restores all mocked keywords to their original behavior, including any
+        ``[Setup]`` or ``[Teardown]`` that was suppressed while mocked.
+
         Example:
             | MockRes.Reset Mocks |
         """
@@ -153,7 +179,15 @@ class MockResource(CallInspectionMixin):
         for keyword_name, items in self._original_items.items():
             keyword_runner = BuiltIn()._namespace.get_runner(keyword_name, True)  # pylint: disable=protected-access
             keyword_runner.keyword.body._items = items  # pylint: disable=protected-access
+        for keyword_name, setup in self._original_setups.items():
+            keyword_runner = BuiltIn()._namespace.get_runner(keyword_name, True)  # pylint: disable=protected-access
+            keyword_runner.keyword.setup = setup
+        for keyword_name, teardown in self._original_teardowns.items():
+            keyword_runner = BuiltIn()._namespace.get_runner(keyword_name, True)  # pylint: disable=protected-access
+            keyword_runner.keyword.teardown = teardown
         self._original_items.clear()
+        self._original_setups.clear()
+        self._original_teardowns.clear()
 
     @keyword
     def verify_keyword_called(self, keyword_name: str, times: int = None):

{robotframework_mock-0.6.0 → robotframework_mock-0.7.1/src/robotframework_mock.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-mock
-Version: 0.6.0
+Version: 0.7.1
 Summary: A Robot Framework library for mocking keywords in unit tests
 Home-page: https://github.com/olesz/robotframework-mock
 Author: Lajos Olah
@@ -328,6 +328,29 @@ ${rows}=    Evaluate    [['Europe/Budapest']]
 MockRes.Mock Keyword    Run Query    return_value=${rows}
 ```
 
+### Mocked keyword setup and teardown
+
+`MockResource` replaces only a keyword's **body**. Its `[Setup]` and `[Teardown]`
+still run, which keeps them observable — a test can assert that a teardown
+released a lock, for instance.
+
+That is a problem when the teardown cleans up state the replaced body would have
+created, because it then fails on the mocked call. Suppress it per mock:
+
+```robot
+# Init Client acquires a lock in its body and releases it in its teardown.
+# Without the body there is no lock to release, so skip the teardown.
+MockRes.Mock Keyword    Init Client    return_value=alias    skip_teardown=${True}
+MockRes.Mock Keyword    Init Client    return_value=alias    skip_setup=${True}
+```
+
+Both default to `False`, so existing tests are unaffected. `Reset Mocks`
+restores a suppressed setup or teardown along with the body.
+
+Prefer the default when the setup or teardown is part of the contract you are
+testing, and skip it when it is an implementation detail of a keyword the test
+is only standing in for.
+
 ### Reset Mocks
 
 Restore all mocked keywords to their original implementations.