robotframework-mock 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,2 @@
1
+ include README.md
2
+ include LICENSE
@@ -0,0 +1,179 @@
1
+ Metadata-Version: 2.4
2
+ Name: robotframework-mock
3
+ Version: 0.1.0
4
+ Summary: A Robot Framework library for mocking keywords in unit tests
5
+ Home-page: https://github.com/olesz/robotframework-mock
6
+ Author: Lajos Olah
7
+ Author-email: lajos.olah.jr@gmail.com
8
+ License: Apache-2.0
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Framework :: Robot Framework
12
+ Classifier: Framework :: Robot Framework :: Library
13
+ Requires-Python: >=3.7
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: robotframework>=7.0
17
+ Dynamic: license-file
18
+
19
+ # robotframework-mock
20
+
21
+ A Robot Framework library for mocking keywords in unit tests.
22
+
23
+ ## Installation
24
+
25
+ ### From PyPI (once published)
26
+
27
+ ```bash
28
+ pip install robotframework-mock
29
+ ```
30
+
31
+ ### From source
32
+
33
+ ```bash
34
+ git clone https://github.com/yourusername/robotframework-mock.git
35
+ cd robotframework-mock
36
+ pip install .
37
+ ```
38
+
39
+ ### For development
40
+
41
+ ```bash
42
+ pip install -e .
43
+ pip install -r requirements-dev.txt
44
+ ```
45
+
46
+ ## Features
47
+
48
+ - Mock keywords from any Robot Framework library
49
+ - Mock Robot Framework's BuiltIn keywords
50
+ - Support for keywords with custom names via @keyword decorator
51
+ - Verify keyword calls and call counts
52
+ - Simple API with three main keywords
53
+
54
+ ## Usage
55
+
56
+ ### Mock Library Keywords
57
+
58
+ Import the library you want to mock, then create a MockLibrary instance for it:
59
+
60
+ ```robot
61
+ *** Settings ***
62
+ Library DatabaseLibrary
63
+ Library MockLibrary DatabaseLibrary WITH NAME MockDB
64
+
65
+ *** Test Cases ***
66
+ Test With Mocked Keyword
67
+ MockDB.Mock Keyword query return_value=test_data
68
+ ${result}= DatabaseLibrary.Query SELECT * FROM users
69
+ Should Be Equal ${result} test_data
70
+ MockDB.Reset Mocks
71
+ ```
72
+
73
+ ### Verify Calls
74
+
75
+ Verify that a keyword was called and optionally check the call count:
76
+
77
+ ```robot
78
+ *** Test Cases ***
79
+ Test Keyword Was Called
80
+ MockDB.Mock Keyword execute_sql return_value=${None}
81
+ Process User Registration
82
+ MockDB.Verify Keyword Called execute_sql times=1
83
+ MockDB.Reset Mocks
84
+ ```
85
+
86
+ ### Mock BuiltIn Keywords
87
+
88
+ Mock Robot Framework's built-in keywords using the same MockLibrary with "BuiltIn" as the library name:
89
+
90
+ ```robot
91
+ *** Settings ***
92
+ Library MockLibrary BuiltIn WITH NAME MockBin
93
+
94
+ *** Test Cases ***
95
+ Test BuiltIn Mock
96
+ MockBin.Mock Keyword Convert To Binary return_value=test_data
97
+ ${result}= Convert To Binary aaa
98
+ Should Be Equal ${result} test_data
99
+ MockBin.Reset Mocks
100
+ ```
101
+
102
+ ### Mock Multiple Libraries
103
+
104
+ You can mock multiple libraries in the same test:
105
+
106
+ ```robot
107
+ *** Settings ***
108
+ Library DatabaseLibrary
109
+ Library RequestsLibrary
110
+ Library MockLibrary DatabaseLibrary WITH NAME MockDB
111
+ Library MockLibrary RequestsLibrary WITH NAME MockReq
112
+
113
+ *** Test Cases ***
114
+ Test Multiple Mocks
115
+ MockDB.Mock Keyword query return_value=user_data
116
+ MockReq.Mock Keyword get return_value=api_response
117
+ # Your test code here
118
+ MockDB.Reset Mocks
119
+ MockReq.Reset Mocks
120
+ ```
121
+
122
+ ## Keywords
123
+
124
+ ### Mock Keyword
125
+
126
+ Mock a keyword with a return value or side effect.
127
+
128
+ **Arguments:**
129
+ - `keyword_name` - Name of the keyword to mock
130
+ - `return_value` - Value to return when called (optional)
131
+ - `side_effect` - Callable to execute instead (optional)
132
+
133
+ **Example:**
134
+ ```robot
135
+ MockDB.Mock Keyword query return_value=test_data
136
+ ```
137
+
138
+ ### Reset Mocks
139
+
140
+ Restore all mocked keywords to their original implementations.
141
+
142
+ **Example:**
143
+ ```robot
144
+ MockDB.Reset Mocks
145
+ ```
146
+
147
+ ### Verify Keyword Called
148
+
149
+ Verify a keyword was called, optionally checking call count.
150
+
151
+ **Arguments:**
152
+ - `keyword_name` - Name of the keyword to verify
153
+ - `times` - Expected number of calls (optional)
154
+
155
+ **Example:**
156
+ ```robot
157
+ MockDB.Verify Keyword Called execute_sql times=1
158
+ ```
159
+
160
+ ## How It Works
161
+
162
+ MockLibrary dynamically replaces keyword implementations:
163
+ 1. Wraps the target library instance
164
+ 2. Resolves keyword names to function names (handles @keyword decorator)
165
+ 3. Stores original methods before mocking
166
+ 4. Replaces methods with mock implementations using Python's unittest.mock.Mock
167
+ 5. Returns mocked values or executes side effects
168
+ 6. Tracks call counts for verification
169
+ 7. Raises AttributeError if attempting to mock a non-existent keyword
170
+
171
+ ## Notes
172
+
173
+ - The library uses `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
174
+ - Built on Python's unittest.mock.Mock for robust mocking capabilities
175
+ - Supports any Robot Framework library, including BuiltIn
176
+
177
+ ## License
178
+
179
+ See LICENSE file for details.
@@ -0,0 +1,161 @@
1
+ # robotframework-mock
2
+
3
+ A Robot Framework library for mocking keywords in unit tests.
4
+
5
+ ## Installation
6
+
7
+ ### From PyPI (once published)
8
+
9
+ ```bash
10
+ pip install robotframework-mock
11
+ ```
12
+
13
+ ### From source
14
+
15
+ ```bash
16
+ git clone https://github.com/yourusername/robotframework-mock.git
17
+ cd robotframework-mock
18
+ pip install .
19
+ ```
20
+
21
+ ### For development
22
+
23
+ ```bash
24
+ pip install -e .
25
+ pip install -r requirements-dev.txt
26
+ ```
27
+
28
+ ## Features
29
+
30
+ - Mock keywords from any Robot Framework library
31
+ - Mock Robot Framework's BuiltIn keywords
32
+ - Support for keywords with custom names via @keyword decorator
33
+ - Verify keyword calls and call counts
34
+ - Simple API with three main keywords
35
+
36
+ ## Usage
37
+
38
+ ### Mock Library Keywords
39
+
40
+ Import the library you want to mock, then create a MockLibrary instance for it:
41
+
42
+ ```robot
43
+ *** Settings ***
44
+ Library DatabaseLibrary
45
+ Library MockLibrary DatabaseLibrary WITH NAME MockDB
46
+
47
+ *** Test Cases ***
48
+ Test With Mocked Keyword
49
+ MockDB.Mock Keyword query return_value=test_data
50
+ ${result}= DatabaseLibrary.Query SELECT * FROM users
51
+ Should Be Equal ${result} test_data
52
+ MockDB.Reset Mocks
53
+ ```
54
+
55
+ ### Verify Calls
56
+
57
+ Verify that a keyword was called and optionally check the call count:
58
+
59
+ ```robot
60
+ *** Test Cases ***
61
+ Test Keyword Was Called
62
+ MockDB.Mock Keyword execute_sql return_value=${None}
63
+ Process User Registration
64
+ MockDB.Verify Keyword Called execute_sql times=1
65
+ MockDB.Reset Mocks
66
+ ```
67
+
68
+ ### Mock BuiltIn Keywords
69
+
70
+ Mock Robot Framework's built-in keywords using the same MockLibrary with "BuiltIn" as the library name:
71
+
72
+ ```robot
73
+ *** Settings ***
74
+ Library MockLibrary BuiltIn WITH NAME MockBin
75
+
76
+ *** Test Cases ***
77
+ Test BuiltIn Mock
78
+ MockBin.Mock Keyword Convert To Binary return_value=test_data
79
+ ${result}= Convert To Binary aaa
80
+ Should Be Equal ${result} test_data
81
+ MockBin.Reset Mocks
82
+ ```
83
+
84
+ ### Mock Multiple Libraries
85
+
86
+ You can mock multiple libraries in the same test:
87
+
88
+ ```robot
89
+ *** Settings ***
90
+ Library DatabaseLibrary
91
+ Library RequestsLibrary
92
+ Library MockLibrary DatabaseLibrary WITH NAME MockDB
93
+ Library MockLibrary RequestsLibrary WITH NAME MockReq
94
+
95
+ *** Test Cases ***
96
+ Test Multiple Mocks
97
+ MockDB.Mock Keyword query return_value=user_data
98
+ MockReq.Mock Keyword get return_value=api_response
99
+ # Your test code here
100
+ MockDB.Reset Mocks
101
+ MockReq.Reset Mocks
102
+ ```
103
+
104
+ ## Keywords
105
+
106
+ ### Mock Keyword
107
+
108
+ Mock a keyword with a return value or side effect.
109
+
110
+ **Arguments:**
111
+ - `keyword_name` - Name of the keyword to mock
112
+ - `return_value` - Value to return when called (optional)
113
+ - `side_effect` - Callable to execute instead (optional)
114
+
115
+ **Example:**
116
+ ```robot
117
+ MockDB.Mock Keyword query return_value=test_data
118
+ ```
119
+
120
+ ### Reset Mocks
121
+
122
+ Restore all mocked keywords to their original implementations.
123
+
124
+ **Example:**
125
+ ```robot
126
+ MockDB.Reset Mocks
127
+ ```
128
+
129
+ ### Verify Keyword Called
130
+
131
+ Verify a keyword was called, optionally checking call count.
132
+
133
+ **Arguments:**
134
+ - `keyword_name` - Name of the keyword to verify
135
+ - `times` - Expected number of calls (optional)
136
+
137
+ **Example:**
138
+ ```robot
139
+ MockDB.Verify Keyword Called execute_sql times=1
140
+ ```
141
+
142
+ ## How It Works
143
+
144
+ MockLibrary dynamically replaces keyword implementations:
145
+ 1. Wraps the target library instance
146
+ 2. Resolves keyword names to function names (handles @keyword decorator)
147
+ 3. Stores original methods before mocking
148
+ 4. Replaces methods with mock implementations using Python's unittest.mock.Mock
149
+ 5. Returns mocked values or executes side effects
150
+ 6. Tracks call counts for verification
151
+ 7. Raises AttributeError if attempting to mock a non-existent keyword
152
+
153
+ ## Notes
154
+
155
+ - The library uses `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
156
+ - Built on Python's unittest.mock.Mock for robust mocking capabilities
157
+ - Supports any Robot Framework library, including BuiltIn
158
+
159
+ ## License
160
+
161
+ See LICENSE file for details.
@@ -0,0 +1,3 @@
1
+ [build-system]
2
+ requires = ["setuptools>=45", "wheel"]
3
+ build-backend = "setuptools.build_meta"
@@ -0,0 +1,31 @@
1
+ [metadata]
2
+ name = robotframework-mock
3
+ version = 0.1.0
4
+ author = Lajos Olah
5
+ author_email = lajos.olah.jr@gmail.com
6
+ description = A Robot Framework library for mocking keywords in unit tests
7
+ long_description = file: README.md
8
+ long_description_content_type = text/markdown
9
+ url = https://github.com/olesz/robotframework-mock
10
+ license = Apache-2.0
11
+ classifiers =
12
+ Programming Language :: Python :: 3
13
+ Operating System :: OS Independent
14
+ Framework :: Robot Framework
15
+ Framework :: Robot Framework :: Library
16
+
17
+ [options]
18
+ package_dir =
19
+ = src
20
+ packages = find:
21
+ python_requires = >=3.7
22
+ install_requires =
23
+ robotframework>=7.0
24
+
25
+ [options.packages.find]
26
+ where = src
27
+
28
+ [egg_info]
29
+ tag_build =
30
+ tag_date = 0
31
+
@@ -0,0 +1,4 @@
1
+ """Setup configuration for robotframework-mock package."""
2
+ from setuptools import setup
3
+
4
+ setup()
@@ -0,0 +1,116 @@
1
+ """Mock library for Robot Framework keyword mocking in unit tests."""
2
+ # pylint: disable=invalid-name
3
+ import inspect
4
+ from typing import Any, Callable
5
+ from unittest.mock import Mock
6
+ from robot.api.deco import keyword
7
+ from robot.libraries.BuiltIn import BuiltIn
8
+
9
+ __version__ = "1.0.0"
10
+
11
+
12
+ def _get_library_instance(library_name_or_alias):
13
+ lib = BuiltIn().get_library_instance(library_name_or_alias)
14
+ if not lib:
15
+ raise RuntimeError(
16
+ f"Library with name {library_name_or_alias} is not found "
17
+ f"in robot. Import it first!"
18
+ )
19
+ return lib
20
+
21
+
22
+ class MockLibrary():
23
+ """Mock keywords from any Robot Framework library for unit testing.
24
+
25
+ Example:
26
+ | Library | DatabaseLibrary |
27
+ | Library | MockLibrary | DatabaseLibrary | WITH NAME | MockDB |
28
+ | MockDB.Mock Keyword | query | return_value=test_data |
29
+ | ${result}= | DatabaseLibrary.Query | SELECT * FROM users |
30
+ | Should Be Equal | ${result} | test_data |
31
+ | MockDB.Reset Mocks |
32
+ """
33
+
34
+ ROBOT_LIBRARY_SCOPE = 'GLOBAL'
35
+
36
+ def __init__(self, library_name_or_alias: str, lib: Any = None):
37
+ self._original_methods = {}
38
+ self._mocks = {}
39
+ if lib:
40
+ self._library_instance = lib
41
+ else:
42
+ self._library_instance = _get_library_instance(library_name_or_alias)
43
+
44
+ @keyword
45
+ def mock_keyword(
46
+ self, keyword_name: str,
47
+ return_value: Any = None, side_effect: Callable = None
48
+ ):
49
+ """Mock a keyword from the wrapped library.
50
+
51
+ Example:
52
+ | MockDB.Mock Keyword | query | return_value=test_data |
53
+ """
54
+ lib = self._library_instance
55
+ method_name = keyword_name.lower().replace(' ', '_')
56
+
57
+ if method_name not in self._original_methods:
58
+ original_method = None
59
+ try:
60
+ original_method = getattr(lib, method_name)
61
+ except AttributeError:
62
+ for name, method in inspect.getmembers(
63
+ lib, inspect.ismethod
64
+ ):
65
+ if (hasattr(method, 'robot_name') and
66
+ method.robot_name.lower() == keyword_name):
67
+ original_method = getattr(lib, name)
68
+ method_name = name
69
+ break
70
+ if not original_method:
71
+ raise AttributeError(f"Keyword '{keyword_name}' not found in {lib}")
72
+ self._original_methods[method_name] = original_method
73
+
74
+ mock = Mock(return_value=return_value, side_effect=side_effect)
75
+ self._mocks[method_name] = mock
76
+
77
+ try:
78
+ owner_class = self._original_methods[method_name].__self__.__class__
79
+ setattr(owner_class, method_name, mock)
80
+ except AttributeError:
81
+ setattr(lib, method_name, mock)
82
+
83
+
84
+ return mock
85
+
86
+ @keyword
87
+ def reset_mocks(self):
88
+ """Reset all mocks to their original implementations.
89
+
90
+ Example:
91
+ | MockDB.Reset Mocks |
92
+ """
93
+ for method_name, original_method in self._original_methods.items():
94
+ try:
95
+ owner_class = original_method.__self__.__class__
96
+ setattr(owner_class, method_name, original_method)
97
+ except AttributeError:
98
+ setattr(self._library_instance, method_name, original_method)
99
+
100
+ self._mocks.clear()
101
+ self._original_methods.clear()
102
+
103
+ @keyword
104
+ def verify_keyword_called(self, keyword_name: str, times: int = None):
105
+ """Verify that a mocked keyword was called.
106
+
107
+ Example:
108
+ | MockDB.Verify Keyword Called | execute_sql | times=1 |
109
+ """
110
+ method_name = keyword_name.lower().replace(' ', '_')
111
+ if method_name not in self._mocks:
112
+ raise AssertionError(f"Keyword '{keyword_name}' was not mocked")
113
+
114
+ mock = self._mocks[method_name]
115
+ if times is not None and mock.call_count != times:
116
+ raise AssertionError(f"Expected {times} calls, got {mock.call_count}")
@@ -0,0 +1,179 @@
1
+ Metadata-Version: 2.4
2
+ Name: robotframework-mock
3
+ Version: 0.1.0
4
+ Summary: A Robot Framework library for mocking keywords in unit tests
5
+ Home-page: https://github.com/olesz/robotframework-mock
6
+ Author: Lajos Olah
7
+ Author-email: lajos.olah.jr@gmail.com
8
+ License: Apache-2.0
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Framework :: Robot Framework
12
+ Classifier: Framework :: Robot Framework :: Library
13
+ Requires-Python: >=3.7
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: robotframework>=7.0
17
+ Dynamic: license-file
18
+
19
+ # robotframework-mock
20
+
21
+ A Robot Framework library for mocking keywords in unit tests.
22
+
23
+ ## Installation
24
+
25
+ ### From PyPI (once published)
26
+
27
+ ```bash
28
+ pip install robotframework-mock
29
+ ```
30
+
31
+ ### From source
32
+
33
+ ```bash
34
+ git clone https://github.com/yourusername/robotframework-mock.git
35
+ cd robotframework-mock
36
+ pip install .
37
+ ```
38
+
39
+ ### For development
40
+
41
+ ```bash
42
+ pip install -e .
43
+ pip install -r requirements-dev.txt
44
+ ```
45
+
46
+ ## Features
47
+
48
+ - Mock keywords from any Robot Framework library
49
+ - Mock Robot Framework's BuiltIn keywords
50
+ - Support for keywords with custom names via @keyword decorator
51
+ - Verify keyword calls and call counts
52
+ - Simple API with three main keywords
53
+
54
+ ## Usage
55
+
56
+ ### Mock Library Keywords
57
+
58
+ Import the library you want to mock, then create a MockLibrary instance for it:
59
+
60
+ ```robot
61
+ *** Settings ***
62
+ Library DatabaseLibrary
63
+ Library MockLibrary DatabaseLibrary WITH NAME MockDB
64
+
65
+ *** Test Cases ***
66
+ Test With Mocked Keyword
67
+ MockDB.Mock Keyword query return_value=test_data
68
+ ${result}= DatabaseLibrary.Query SELECT * FROM users
69
+ Should Be Equal ${result} test_data
70
+ MockDB.Reset Mocks
71
+ ```
72
+
73
+ ### Verify Calls
74
+
75
+ Verify that a keyword was called and optionally check the call count:
76
+
77
+ ```robot
78
+ *** Test Cases ***
79
+ Test Keyword Was Called
80
+ MockDB.Mock Keyword execute_sql return_value=${None}
81
+ Process User Registration
82
+ MockDB.Verify Keyword Called execute_sql times=1
83
+ MockDB.Reset Mocks
84
+ ```
85
+
86
+ ### Mock BuiltIn Keywords
87
+
88
+ Mock Robot Framework's built-in keywords using the same MockLibrary with "BuiltIn" as the library name:
89
+
90
+ ```robot
91
+ *** Settings ***
92
+ Library MockLibrary BuiltIn WITH NAME MockBin
93
+
94
+ *** Test Cases ***
95
+ Test BuiltIn Mock
96
+ MockBin.Mock Keyword Convert To Binary return_value=test_data
97
+ ${result}= Convert To Binary aaa
98
+ Should Be Equal ${result} test_data
99
+ MockBin.Reset Mocks
100
+ ```
101
+
102
+ ### Mock Multiple Libraries
103
+
104
+ You can mock multiple libraries in the same test:
105
+
106
+ ```robot
107
+ *** Settings ***
108
+ Library DatabaseLibrary
109
+ Library RequestsLibrary
110
+ Library MockLibrary DatabaseLibrary WITH NAME MockDB
111
+ Library MockLibrary RequestsLibrary WITH NAME MockReq
112
+
113
+ *** Test Cases ***
114
+ Test Multiple Mocks
115
+ MockDB.Mock Keyword query return_value=user_data
116
+ MockReq.Mock Keyword get return_value=api_response
117
+ # Your test code here
118
+ MockDB.Reset Mocks
119
+ MockReq.Reset Mocks
120
+ ```
121
+
122
+ ## Keywords
123
+
124
+ ### Mock Keyword
125
+
126
+ Mock a keyword with a return value or side effect.
127
+
128
+ **Arguments:**
129
+ - `keyword_name` - Name of the keyword to mock
130
+ - `return_value` - Value to return when called (optional)
131
+ - `side_effect` - Callable to execute instead (optional)
132
+
133
+ **Example:**
134
+ ```robot
135
+ MockDB.Mock Keyword query return_value=test_data
136
+ ```
137
+
138
+ ### Reset Mocks
139
+
140
+ Restore all mocked keywords to their original implementations.
141
+
142
+ **Example:**
143
+ ```robot
144
+ MockDB.Reset Mocks
145
+ ```
146
+
147
+ ### Verify Keyword Called
148
+
149
+ Verify a keyword was called, optionally checking call count.
150
+
151
+ **Arguments:**
152
+ - `keyword_name` - Name of the keyword to verify
153
+ - `times` - Expected number of calls (optional)
154
+
155
+ **Example:**
156
+ ```robot
157
+ MockDB.Verify Keyword Called execute_sql times=1
158
+ ```
159
+
160
+ ## How It Works
161
+
162
+ MockLibrary dynamically replaces keyword implementations:
163
+ 1. Wraps the target library instance
164
+ 2. Resolves keyword names to function names (handles @keyword decorator)
165
+ 3. Stores original methods before mocking
166
+ 4. Replaces methods with mock implementations using Python's unittest.mock.Mock
167
+ 5. Returns mocked values or executes side effects
168
+ 6. Tracks call counts for verification
169
+ 7. Raises AttributeError if attempting to mock a non-existent keyword
170
+
171
+ ## Notes
172
+
173
+ - The library uses `ROBOT_LIBRARY_SCOPE = 'GLOBAL'` to maintain state across test cases
174
+ - Built on Python's unittest.mock.Mock for robust mocking capabilities
175
+ - Supports any Robot Framework library, including BuiltIn
176
+
177
+ ## License
178
+
179
+ See LICENSE file for details.
@@ -0,0 +1,12 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ README.md
4
+ pyproject.toml
5
+ setup.cfg
6
+ setup.py
7
+ src/MockLibrary/__init__.py
8
+ src/robotframework_mock.egg-info/PKG-INFO
9
+ src/robotframework_mock.egg-info/SOURCES.txt
10
+ src/robotframework_mock.egg-info/dependency_links.txt
11
+ src/robotframework_mock.egg-info/requires.txt
12
+ src/robotframework_mock.egg-info/top_level.txt
@@ -0,0 +1 @@
1
+ robotframework>=7.0