robotframework-mock 0.1.0__tar.gz → 0.3.0__tar.gz

{robotframework_mock-0.1.0/src/robotframework_mock.egg-info → robotframework_mock-0.3.0}/PKG-INFO

@@ -1,179 +1,209 @@
-Metadata-Version: 2.4
-Name: robotframework-mock
-Version: 0.1.0
-Summary: A Robot Framework library for mocking keywords in unit tests
-Home-page: https://github.com/olesz/robotframework-mock
-Author: Lajos Olah
-Author-email: lajos.olah.jr@gmail.com
-License: Apache-2.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: Framework :: Robot Framework
-Classifier: Framework :: Robot Framework :: Library
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: robotframework>=7.0
-Dynamic: license-file
-
-# robotframework-mock
-
-A Robot Framework library for mocking keywords in unit tests.
-
-## Installation
-
-### From PyPI (once published)
-
-```bash
-pip install robotframework-mock
-```
-
-### From source
-
-```bash
-git clone https://github.com/yourusername/robotframework-mock.git
-cd robotframework-mock
-pip install .
-```
-
-### For development
-
-```bash
-pip install -e .
-pip install -r requirements-dev.txt
-```
-
-## Features
-
-- Mock keywords from any Robot Framework library
-- Mock Robot Framework's BuiltIn keywords
-- Support for keywords with custom names via @keyword decorator
-- Verify keyword calls and call counts
-- Simple API with three main keywords
-
-## Usage
-
-### Mock Library Keywords
-
-Import the library you want to mock, then create a MockLibrary instance for it:
-
-```robot
-*** Settings ***
-Library    DatabaseLibrary
-Library    MockLibrary    DatabaseLibrary    WITH NAME    MockDB
-
-*** Test Cases ***
-Test With Mocked Keyword
-    MockDB.Mock Keyword    query    return_value=test_data
-    ${result}=    DatabaseLibrary.Query    SELECT * FROM users
-    Should Be Equal    ${result}    test_data
-    MockDB.Reset Mocks
-```
-
-### Verify Calls
-
-Verify that a keyword was called and optionally check the call count:
-
-```robot
-*** Test Cases ***
-Test Keyword Was Called
-    MockDB.Mock Keyword    execute_sql    return_value=${None}
-    Process User Registration
-    MockDB.Verify Keyword Called    execute_sql    times=1
-    MockDB.Reset Mocks
-```
-
-### Mock BuiltIn Keywords
-
-Mock Robot Framework's built-in keywords using the same MockLibrary with "BuiltIn" as the library name:
-
-```robot
-*** Settings ***
-Library    MockLibrary    BuiltIn    WITH NAME    MockBin
-
-*** Test Cases ***
-Test BuiltIn Mock
-    MockBin.Mock Keyword    Convert To Binary    return_value=test_data
-    ${result}=    Convert To Binary    aaa
-    Should Be Equal    ${result}    test_data
-    MockBin.Reset Mocks
-```
-
-### Mock Multiple Libraries
-
-You can mock multiple libraries in the same test:
-
-```robot
-*** Settings ***
-Library    DatabaseLibrary
-Library    RequestsLibrary
-Library    MockLibrary    DatabaseLibrary    WITH NAME    MockDB
-Library    MockLibrary    RequestsLibrary    WITH NAME    MockReq
-
-*** Test Cases ***
-Test Multiple Mocks
-    MockDB.Mock Keyword    query    return_value=user_data
-    MockReq.Mock Keyword    get    return_value=api_response
-    # Your test code here
-    MockDB.Reset Mocks
-    MockReq.Reset Mocks
-```
-
-## Keywords
-
-### Mock Keyword
-
-Mock a keyword with a return value or side effect.
-
-**Arguments:**
-- `keyword_name` - Name of the keyword to mock
-- `return_value` - Value to return when called (optional)
-- `side_effect` - Callable to execute instead (optional)
-
-**Example:**
-```robot
-MockDB.Mock Keyword    query    return_value=test_data
-```
-
-### Reset Mocks
-
-Restore all mocked keywords to their original implementations.
-
-**Example:**
-```robot
-MockDB.Reset Mocks
-```
-
-### Verify Keyword Called
-
-Verify a keyword was called, optionally checking call count.
-
-**Arguments:**
-- `keyword_name` - Name of the keyword to verify
-- `times` - Expected number of calls (optional)
-
-**Example:**
-```robot
-MockDB.Verify Keyword Called    execute_sql    times=1
-```
-
-## How It Works
-
-MockLibrary dynamically replaces keyword implementations:
-1. Wraps the target library instance
-2. Resolves keyword names to function names (handles @keyword decorator)
-3. Stores original methods before mocking
-4. Replaces methods with mock implementations using Python's unittest.mock.Mock
-5. Returns mocked values or executes side effects
-6. Tracks call counts for verification
-7. Raises AttributeError if attempting to mock a non-existent keyword
-
-## Notes
-
-- The library uses `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
-- Built on Python's unittest.mock.Mock for robust mocking capabilities
-- Supports any Robot Framework library, including BuiltIn
-
-## License
-
-See LICENSE file for details.
+Metadata-Version: 2.4
+Name: robotframework-mock
+Version: 0.3.0
+Summary: A Robot Framework library for mocking keywords in unit tests
+Home-page: https://github.com/olesz/robotframework-mock
+Author: Lajos Olah
+Author-email: lajos.olah.jr@gmail.com
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Robot Framework
+Classifier: Framework :: Robot Framework :: Library
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: robotframework>=7.0
+Dynamic: license-file
+
+# robotframework-mock
+
+A Robot Framework library for mocking keywords in unit tests.
+
+## Installation
+
+### From PyPI (once published)
+
+```bash
+pip install robotframework-mock
+```
+
+### From source
+
+```bash
+git clone https://github.com/yourusername/robotframework-mock.git
+cd robotframework-mock
+pip install .
+```
+
+### For development
+
+```bash
+pip install -e .
+pip install -r requirements-dev.txt
+```
+
+## Features
+
+- Mock keywords from any Robot Framework library
+- Mock keywords from Robot Framework resource files
+- Mock Robot Framework's BuiltIn keywords
+- Support for keywords with custom names via @keyword decorator
+- Verify keyword calls and call counts
+- Simple API with three main keywords
+
+## Usage
+
+### Mock Library Keywords
+
+Import the library you want to mock, then create a MockLibrary instance for it:
+
+```robot
+*** Settings ***
+Library    DatabaseLibrary
+Library    MockLibrary    DatabaseLibrary    WITH NAME    MockDB
+
+*** Test Cases ***
+Test With Mocked Keyword
+    MockDB.Mock Keyword    query    return_value=test_data
+    ${result}=    DatabaseLibrary.Query    SELECT * FROM users
+    Should Be Equal    ${result}    test_data
+    MockDB.Reset Mocks
+```
+
+### Verify Calls
+
+Verify that a keyword was called and optionally check the call count:
+
+```robot
+*** Test Cases ***
+Test Keyword Was Called
+    MockDB.Mock Keyword    execute_sql    return_value=${None}
+    Process User Registration
+    MockDB.Verify Keyword Called    execute_sql    times=1
+    MockDB.Reset Mocks
+```
+
+### Mock BuiltIn Keywords
+
+Mock Robot Framework's built-in keywords using the same MockLibrary with "BuiltIn" as the library name:
+
+```robot
+*** Settings ***
+Library    MockLibrary    BuiltIn    WITH NAME    MockBin
+
+*** Test Cases ***
+Test BuiltIn Mock
+    MockBin.Mock Keyword    Convert To Binary    return_value=test_data
+    ${result}=    Convert To Binary    aaa
+    Should Be Equal    ${result}    test_data
+    MockBin.Reset Mocks
+```
+
+### Mock Multiple Libraries
+
+You can mock multiple libraries in the same test:
+
+```robot
+*** Settings ***
+Library    DatabaseLibrary
+Library    RequestsLibrary
+Library    MockLibrary    DatabaseLibrary    WITH NAME    MockDB
+Library    MockLibrary    RequestsLibrary    WITH NAME    MockReq
+
+*** Test Cases ***
+Test Multiple Mocks
+    MockDB.Mock Keyword    query    return_value=user_data
+    MockReq.Mock Keyword    get    return_value=api_response
+    # Your test code here
+    MockDB.Reset Mocks
+    MockReq.Reset Mocks
+```
+
+### Mock Resource Keywords
+
+Mock keywords from Robot Framework resource files:
+
+```robot
+*** Settings ***
+Resource    my_resource.robot
+Library     MockResource    my_resource.robot    WITH NAME    MockRes
+
+*** Test Cases ***
+Test Resource Keyword Mock
+    MockRes.Mock Keyword    My Custom Keyword    return_value=mocked_value
+    ${result}=    My Custom Keyword
+    Should Be Equal    ${result}    mocked_value
+    MockRes.Reset Mocks
+```
+
+## Keywords
+
+### Mock Keyword
+
+Mock a keyword with a return value or side effect.
+
+**Arguments:**
+- `keyword_name` - Name of the keyword to mock
+- `return_value` - Value to return when called (optional)
+- `side_effect` - Callable to execute instead (optional)
+
+**Example:**
+```robot
+MockDB.Mock Keyword    query    return_value=test_data
+```
+
+### Reset Mocks
+
+Restore all mocked keywords to their original implementations.
+
+**Example:**
+```robot
+MockDB.Reset Mocks
+```
+
+### Verify Keyword Called
+
+Verify a keyword was called, optionally checking call count.
+
+**Arguments:**
+- `keyword_name` - Name of the keyword to verify
+- `times` - Expected number of calls (optional)
+
+**Example:**
+```robot
+MockDB.Verify Keyword Called    execute_sql    times=1
+```
+
+## How It Works
+
+### MockLibrary
+
+MockLibrary dynamically replaces keyword implementations:
+1. Wraps the target library instance
+2. Resolves keyword names to function names (handles @keyword decorator)
+3. Stores original methods before mocking
+4. Replaces methods with mock implementations using Python's unittest.mock.Mock
+5. Returns mocked values or executes side effects
+6. Tracks call counts for verification
+7. Raises AttributeError if attempting to mock a non-existent keyword
+
+### MockResource
+
+MockResource patches Robot Framework's keyword execution:
+1. Patches the Namespace.get_runner method
+2. Intercepts keyword execution for the specified resource file
+3. Replaces keyword body with Return statement containing mocked value
+4. Tracks call counts for verification
+5. Restores original keyword body on reset
+
+## Notes
+
+- Both libraries use `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
+- Built on Python's unittest.mock.Mock for robust mocking capabilities
+- MockLibrary supports any Robot Framework library, including BuiltIn
+- MockResource works with resource files by patching the keyword execution pipeline
+
+## License
+
+See LICENSE file for details.

{robotframework_mock-0.1.0 → robotframework_mock-0.3.0}/README.md

@@ -28,6 +28,7 @@ pip install -r requirements-dev.txt
 ## Features
 
 - Mock keywords from any Robot Framework library
+- Mock keywords from Robot Framework resource files
 - Mock Robot Framework's BuiltIn keywords
 - Support for keywords with custom names via @keyword decorator
 - Verify keyword calls and call counts
@@ -101,6 +102,23 @@ Test Multiple Mocks
     MockReq.Reset Mocks
 ```
 
+### Mock Resource Keywords
+
+Mock keywords from Robot Framework resource files:
+
+```robot
+*** Settings ***
+Resource    my_resource.robot
+Library     MockResource    my_resource.robot    WITH NAME    MockRes
+
+*** Test Cases ***
+Test Resource Keyword Mock
+    MockRes.Mock Keyword    My Custom Keyword    return_value=mocked_value
+    ${result}=    My Custom Keyword
+    Should Be Equal    ${result}    mocked_value
+    MockRes.Reset Mocks
+```
+
 ## Keywords
 
 ### Mock Keyword
@@ -141,6 +159,8 @@ MockDB.Verify Keyword Called    execute_sql    times=1
 
 ## How It Works
 
+### MockLibrary
+
 MockLibrary dynamically replaces keyword implementations:
 1. Wraps the target library instance
 2. Resolves keyword names to function names (handles @keyword decorator)
@@ -150,11 +170,21 @@ MockLibrary dynamically replaces keyword implementations:
 6. Tracks call counts for verification
 7. Raises AttributeError if attempting to mock a non-existent keyword
 
+### MockResource
+
+MockResource patches Robot Framework's keyword execution:
+1. Patches the Namespace.get_runner method
+2. Intercepts keyword execution for the specified resource file
+3. Replaces keyword body with Return statement containing mocked value
+4. Tracks call counts for verification
+5. Restores original keyword body on reset
+
 ## Notes
 
-- The library uses `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
+- Both libraries use `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
 - Built on Python's unittest.mock.Mock for robust mocking capabilities
-- Supports any Robot Framework library, including BuiltIn
+- MockLibrary supports any Robot Framework library, including BuiltIn
+- MockResource works with resource files by patching the keyword execution pipeline
 
 ## License
 

{robotframework_mock-0.1.0 → robotframework_mock-0.3.0}/setup.cfg

@@ -1,31 +1,31 @@
-[metadata]
-name = robotframework-mock
-version = 0.1.0
-author = Lajos Olah
-author_email = lajos.olah.jr@gmail.com
-description = A Robot Framework library for mocking keywords in unit tests
-long_description = file: README.md
-long_description_content_type = text/markdown
-url = https://github.com/olesz/robotframework-mock
-license = Apache-2.0
-classifiers = 
-	Programming Language :: Python :: 3
-	Operating System :: OS Independent
-	Framework :: Robot Framework
-	Framework :: Robot Framework :: Library
-
-[options]
-package_dir = 
-	= src
-packages = find:
-python_requires = >=3.7
-install_requires = 
-	robotframework>=7.0
-
-[options.packages.find]
-where = src
-
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[metadata]
+name = robotframework-mock
+version = 0.3.0
+author = Lajos Olah
+author_email = lajos.olah.jr@gmail.com
+description = A Robot Framework library for mocking keywords in unit tests
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/olesz/robotframework-mock
+license = Apache-2.0
+classifiers = 
+	Programming Language :: Python :: 3
+	Operating System :: OS Independent
+	Framework :: Robot Framework
+	Framework :: Robot Framework :: Library
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.7
+install_requires = 
+	robotframework>=7.0
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+