# Mocker Builder
Testing tools for mocking and patching based on pytest_mock mocker features but with improvements.
### Installation
```bash
$ pip install mocker-builder
```
### Initializer
To start using mucker-builder features just create your Test class, inherit from `MockerBuilder` class,
implement the required abstract method mocker_builder_setup decorating it with the `@MockerBuilder.initializer`
decorator and start building your mocks and fixtures, adding mocks from your test_... methods,
but you must declare the `mocker_builder_setup` method and decorate it with the
`@MockerBuilder.initializer` decorator to be able to use `MockerBuilder` features.
```python
...
def print_io_test():
print("Ouieh!!!")
class TestMyHeroes(MockerBuilder):
@MockerBuilder.initializer
def mocker_builder_setup(self):
pass
...
def test_io(self):
print_test_io = self.patch(
target='sys.stdout',
new_callable=StringIO
)
print_io_test()
assert print_test_io.mock.getvalue() == 'Ouieh!!!\n'
```
If you wanna use print_test_io all over your tests just patch it into `mocker_builder_setup`:
```python
...
def print_io_test():
print("Ouieh!!!")
class TestMyHeroes(MockerBuilder):
@MockerBuilder.initializer
def mocker_builder_setup(self):
self.print_test_io = self.patch(
target='sys.stdout',
new_callable=StringIO
)
...
def test_print_io(self):
print_io_test()
assert self.print_test_io.mock.getvalue() == 'Ouieh!!!\n'
def test_another_print_io(self):
patched_print_io_test = self.patch(
'__main__.print_io_test',
side_effect=[print("Ooouuiieeh!!")]
)
print_io_test()
assert not self.print_test_io.mock.getvalue() == 'Ouieh!!!\n'
assert self.print_test_io.mock.getvalue() == 'Ooouuiieeh!!!\n'
```
### The self.patch TMocker.PatchType properties
The `self.patch` method creates a new patch/mock object. It is a patch/mock because by doing:
```python
my_patched_thing = self.patch(...)
```
`my_patched_thing` has some properties of a mock.patch object, like start, stop and set_result.
To get access to the patched mock we can just access the `mock` patched attribute:
```Python
assert my_patched_thing.mock.called
Or
assert my_patched_thing().called
```
Both ways return an MagicMock or an AsyncMock (Not yet really but still working on this feature)
if the tested method is async.
### Setting result after already been patched
For a complete exemple flow just have a look bellow:
```python
from io import StringIO
from unittest.mock import PropertyMock
import pytest
from mocker_builder import MockerBuilder
from my_heroes import them
from my_heroes.them import (
Batman,
HobbyHero,
IHero,
JusticeLeague,
OtherHero,
PeakyBlinder,
MyHeroes,
Robin
)
def print_io_test():
print("Ouieh!!!")
class Foo(IHero):
nickname: str = "Bob"
def eating_banana(self) -> str:
return "have no banana"
def wearing_pyjama(self) -> str:
return "have no pyjama"
def just_call_for(self) -> str:
return "Bob Foo"
def just_says(self) -> str:
return "foo foo"
class TestMyHeroes(MockerBuilder):
@MockerBuilder.initializer
def mocker_builder_setup(self):
# ================== Setting fixtures ===================
# TODO We will work on this feature to implement a real fixture
self.my_hero = self.add_fixture(
content=PeakyBlinder(
bananas=12,
pyjamas=7,
nickname="Thomas Shelby"
)
)
# =================== Setting mocks ======================
self.what_i_do_when_nobody_is_looking = self.patch(
PeakyBlinder,
'what_i_do_when_nobody_is_looking',
return_value=HobbyHero("I just drink wisky")
)
self.get_my_hero_hobby = self.patch(
Robin,
'get_my_hero_hobby',
return_value=HobbyHero("I just watch TV")
)
self.mock_my_heroes_module = self.patch(
target=them.initialize_other_hero
)
self.mock_my_hero_attribue = self.patch(
target=MyHeroes,
attribute='_my_hero',
mock_configure={
'eating_banana.return_value': "Banana Noooo!",
'just_says.side_effect': ["Nothing to say!"]
}
)
self.mock_other_hero = self.patch(
target=OtherHero,
mock_configure={
'return_value.just_says.return_value': "He feels good!"
}
)
self.my_hero_batman = self.patch(
# XXX or target='main.Batman' to mock the Batman class imported from here.
target=Batman,
mock_configure={
'return_value.nickname': 'Bat Mock',
'return_value.eating_banana.return_value': "doesn't like banana",
'return_value.wearing_pyjama.return_value': "doesn't wear pyjama",
'return_value.just_call_for.return_value': "just calls for Mocker",
'return_value.just_says.return_value': "I'm gonna mock you babe!",
}
)
self.mock_justice_league__init__ = self.patch(
target=JusticeLeague.__init__
)
# ========================================================
@pytest.mark.asyncio
async def test_what_i_do_when_nobody_is_looking(self):
# ----------------------- PeakyBlinder ----------------------
him = MyHeroes()
him.my_hero = PeakyBlinder(
my_hobby=HobbyHero(
what_i_do="Shot someone"
)
)
peaky_blinder = await him.what_my_hero_does_when_nobody_is_looking()
assert self.what_i_do_when_nobody_is_looking.mock.called
assert not peaky_blinder.what_i_do == "Shot someone"
assert peaky_blinder.what_i_do == "I just drink wisky"
assert him.does() == "Shot someone"
assert not him.does() == "I just drink wisky"
self.what_i_do_when_nobody_is_looking.set_result(
return_value=HobbyHero("Just relax!")
)
peaky_blinder = await him.what_my_hero_does_when_nobody_is_looking()
assert not peaky_blinder.what_i_do == "I just drink wisky"
assert peaky_blinder.what_i_do == "Just relax!"
assert him.does() == "Shot someone"
assert not him.does() == "just relax!"
# ----------------------- Robin ----------------------
robs = MyHeroes()
robs.my_hero = Robin(
my_hobby=HobbyHero(
what_i_do="I catch bad guys"
)
)
robin = await robs.what_my_hero_does_when_nobody_is_looking()
assert not self.get_my_hero_hobby.mock.called
assert not robin.what_i_do == "I just watch TV"
assert robin.what_i_do == "I catch bad guys"
# calling does() method calls mocked Robin.get_my_hero_hobby method so get the mocked value
assert not robs.does() == "I catch bad guys"
assert robs.does() == "I just watch TV"
assert self.get_my_hero_hobby.mock.called
assert self.get_my_hero_hobby.mock.call_count == 2
# ================================================================================
# -------------------- Robin -> Batman --------------------
self.robin_becomes_batman = self.patch(
Robin,
new=Batman
)
self.get_my_hero_hobby.stop()
# Here now we will actually mock Batman.get_my_hero_hobby calling
self.get_my_hero_hobby = self.patch(
Robin,
'get_my_hero_hobby',
return_value=HobbyHero("I just watch TV")
)
robs = MyHeroes()
robs.my_hero = Robin(
my_hobby=HobbyHero(
what_i_do="I catch bad guys"
)
)
robin = await robs.what_my_hero_does_when_nobody_is_looking()
assert not self.get_my_hero_hobby.mock.called
assert not robin.what_i_do == "I just watch TV"
assert robin.what_i_do == "I catch bad guys"
# calling does() method calls mocked Batman.get_my_hero_hobby method so get the mocked value
assert robs.does() == "I catch bad guys"
assert not robs.does() == "I just watch TV"
assert not self.get_my_hero_hobby.mock.called
assert self.get_my_hero_hobby.mock.call_count == 0
# ----------------------------------------------------------------
# remember we mocked robin as batman => self.robin_becomes_batman
# ----------------------------------------------------------------
bats = MyHeroes()
bats.my_hero = Batman(
my_hobby=HobbyHero(
what_i_do="I catch bad guys"
)
)
batman = await robs.what_my_hero_does_when_nobody_is_looking()
assert not self.get_my_hero_hobby.mock.called
assert not batman.what_i_do == "I just watch TV"
assert batman.what_i_do == "I catch bad guys"
assert bats.does() == "I just watch TV"
assert not bats.does() == "I catch bad guys"
assert self.get_my_hero_hobby.mock.called
assert self.get_my_hero_hobby.mock.call_count == 2
def test_io(self):
self.mock_test_io = self.patch(
target='sys.stdout',
new_callable=StringIO
)
print_io_test()
assert self.mock_test_io().getvalue() == 'Ouieh!!!\n'
@pytest.mark.asyncio
async def test_heroes_sleeping(self):
justce_league = JusticeLeague()
assert self.mock_justice_league__init__().called
async def hero_names():
yield Batman().nickname
yield Robin().nickname
_hero_names = hero_names()
async for result in justce_league.are_heroes_sleeping():
assert result == "=== Heroes are awakened ==="
self.mock_justice_league__init__.stop()
justce_league = JusticeLeague()
async for result in justce_league.are_heroes_sleeping():
_hero_name = await _hero_names.__anext__()
print(result, _hero_name)
assert result == f"MagicMock=>({_hero_name}): ZZzzzz"
@pytest.mark.asyncio
async def test_call_heroes(self):
# Remember that JusticeLeague.__init__ still mocked, so calling JusticeLeague() doesn't
# initialize JusticeLeague._heroes attribute.
justce_league = JusticeLeague()
assert await justce_league.call_everybody() == "Uuhmm! Nobody here!"
with pytest.raises(AttributeError) as ex:
justce_league.join_hero(Batman())
assert "'JusticeLeague' object has no attribute '_heroes'" == str(ex.value)
# We just stop mocking JusticeLeague.__init__ to test a different behavior below
self.mock_justice_league__init__.stop()
del justce_league
with self.patch(
JusticeLeague,
'_heroes',
create=True,
return_value=PropertyMock(spec=list, return_value=[])
):
justce_league = JusticeLeague()
justce_league.join_hero(Batman())
# my_heroes.Batman() still mocked
justce_league.join_hero(them.Batman())
assert await justce_league.call_everybody() == [
('Batman', 'Come on', 'Big Fat Bat'),
('MagicMock', 'Come on', 'Bat Mock')
]
def test_mock_my_heroes_class(self):
mock_my_heroes_class = self.patch(
target=MyHeroes
)
them.who_is_the_best_hero()
assert mock_my_heroes_class().called
def test_mock_my_heroes_module(self):
self.mock_my_heroes_module.stop()
them.who_is_the_best_hero()
assert not self.mock_my_heroes_module().called
self.mock_my_heroes_module.start()
them.who_is_the_best_hero()
assert self.mock_my_heroes_module().called
def test_mock_my_hero_attribute(self):
assert self.mock_my_hero_attribue().eating_banana() == "Banana Noooo!"
assert self.mock_my_hero_attribue.mock.just_says() == "Nothing to say!"
def test_mock_my_class(self):
response = them.asks_what_other_hero_have_to_say_about_been_hero()
assert response == "He feels good!"
def test_my_hero_batman(self):
them.who_is_my_hero(Batman())
testing = MyHeroes()
testing.my_hero = them.Batman()
testing.who_is_my_hero()
assert self.my_hero_batman.mock.return_value.nickname == 'Bat Mock'
assert testing.my_hero.nickname == 'Bat Mock'
def test_mock_justice_league__init__(self):
justce_league = JusticeLeague()
assert justce_league.show_heroes() == "Opss! No heroes over here!"
assert justce_league.what_heroes_does() == "Eita! Heroes are doing nothing!"
self.mock_justice_league__init__.stop()
justce_league = JusticeLeague()
# my_heroes.Batman() is mocked
justce_league.join_hero(them.Batman())
justce_league.join_hero(Robin())
mock_test_io = self.patch(
target='sys.stdout',
new_callable=StringIO
)
justce_league.show_heroes()
expected = """MagicMock just calls for Mocker
Robin just calls for Little Bastard\n"""
assert mock_test_io().getvalue() == expected
justce_league.what_heroes_does()
expected += """===========================
Bat Mock
doesn't like banana
doesn't wear pyjama
I'm gonna mock you babe!
===========================
Little Bastard
is eating 1 banana(s)
is wearing 4 pyjama(s)
I'm gonna have a pint!\n"""
assert mock_test_io().getvalue() == expected
mock_test_io.stop()
self.mock_justice_league__init__.start()
justce_league = JusticeLeague()
assert justce_league.show_heroes() == "Opss! No heroes over here!"
assert justce_league.what_heroes_does() == "Eita! Heroes are doing nothing!"
def test_mock_ugly_hero(self):
assert them.UGLY_HERO == 'Me'
mock_ugly_hero = self.patch(
target=them,
attribute='UGLY_HERO',
mock_configure={
'third': 'You',
'who_is_the_most_ugly.return_value': 'Me again'
},
first='Batman',
second='Robin',
call_me_a_hero=lambda: PeakyBlinder().nickname
)
mock_ugly_hero().configure_mock(
fourth='Me',
**{
'who_is_my_hero.return_value': Batman().nickname,
'who_is_the_most_beautiful.side_effect': ValueError("There isn't any beautiful hero")
}
)
assert mock_ugly_hero().first == 'Batman'
assert mock_ugly_hero().second == 'Robin'
assert mock_ugly_hero().third == 'You'
assert mock_ugly_hero().fourth == 'Me'
assert mock_ugly_hero().who_is_the_most_ugly() == 'Me again'
assert mock_ugly_hero().call_me_a_hero() == "Bart Burp"
assert mock_ugly_hero().who_is_my_hero() == "Big Fat Bat"
with pytest.raises(ValueError) as ex:
mock_ugly_hero().who_is_the_most_beautiful()
assert "There isn't any beautiful hero" == str(ex.value)
def test_how_can_we_call_for_heores(self):
self.mock_justice_league__init__.stop()
self.my_hero_batman.stop()
justce_league = JusticeLeague()
# my_heroes.Batman() is mocked but was stopped
justce_league.join_hero(them.Batman())
justce_league.join_hero(Robin())
assert justce_league.how_can_we_call_for_heores() == [
("Batman", "just calls for Big Fat Bat"),
("Robin", "just calls for Little Bastard")
]
self.mock_justice_league__init__.start()
justce_league = JusticeLeague()
assert self.mock_justice_league__init__().called
assert justce_league.how_can_we_call_for_heores() == "Opss! No heroes over here to call for!"
self.my_hero_batman.start()
self.mock_justice_league__init__.stop()
justce_league = JusticeLeague()
# my_heroes.Batman() is mocked and was started again
justce_league.join_hero(them.Batman())
justce_league.join_hero(Robin())
assert justce_league.how_can_we_call_for_heores() == [
("MagicMock", "just calls for Mocker"),
("Robin", "just calls for Little Bastard")
]
assert self.my_hero_batman.mock.called
def test_my_hero_robin(self):
my_hero_robin = self.patch(
target=Robin(), # XXX we can mock from object instance! Ouieh!
return_value=PropertyMock(
nickname='Bastard Mock',
eating_banana=lambda: "eat a lot of bananas",
wearing_pyjama=lambda: "likes to be naked",
just_call_for=lambda: "Little Mocker",
just_says=lambda: "Mock me baby!"
)
)
them.who_is_my_hero(Robin())
testing = MyHeroes()
testing.my_hero = them.Robin()
testing.who_is_my_hero()
assert my_hero_robin.mock.called
assert my_hero_robin.mock.return_value.nickname == 'Bastard Mock'
assert my_hero_robin.mock.return_value.eating_banana() == "eat a lot of bananas"
assert my_hero_robin.mock.return_value.wearing_pyjama() == "likes to be naked"
assert my_hero_robin.mock.return_value.just_call_for() == "Little Mocker"
assert my_hero_robin.mock.return_value.just_says() == "Mock me baby!"
def test_set_result_return_value(self):
my_hero_robin = self.patch(
target=Robin,
return_value=Foo()
)
print("--------------------------------------------------------------------------")
print("Who is my hero:")
print("--------------------------------------------------------------------------")
them.who_is_my_hero(Robin())
testing = MyHeroes()
testing.my_hero = them.Robin()
print("--------------------------------------------------------------------------")
print("Who is my mocked hero with return_value = Foo():")
print("--------------------------------------------------------------------------")
testing.who_is_my_hero()
assert my_hero_robin.mock.called
assert isinstance(my_hero_robin.mock.return_value, Foo)
print("--------------------------------------------------------------------------")
print("Setting mock result return_value=PeakyBlinder()")
print("--------------------------------------------------------------------------")
my_hero_robin.set_result(
return_value=PeakyBlinder()
)
assert not isinstance(my_hero_robin.mock.return_value, Foo)
assert isinstance(my_hero_robin.mock.return_value, PeakyBlinder)
testing = MyHeroes()
testing.my_hero = them.Robin()
print("--------------------------------------------------------------------------")
print("Who is my mocked hero with return_value = PeakyBlinder():")
print("--------------------------------------------------------------------------")
testing.who_is_my_hero()
def test_set_result_side_effect(self):
my_hero_robin = self.patch(
target=PeakyBlinder,
side_effect=lambda: Foo()
)
print("--------------------------------------------------------------------------")
print("Who is my hero:")
print("--------------------------------------------------------------------------")
them.who_is_my_hero(PeakyBlinder())
testing = MyHeroes()
testing.my_hero = them.PeakyBlinder()
print("--------------------------------------------------------------------------")
print("Who is my mocked hero with side_effect = Foo():")
print("--------------------------------------------------------------------------")
testing.who_is_my_hero()
assert my_hero_robin.mock.called
assert isinstance(testing.my_hero, Foo)
print("--------------------------------------------------------------------------")
print("""Setting mock result side_effect=[
OtherHero(),
TypeError('Ops! No hero like that!')
]""")
print("--------------------------------------------------------------------------")
my_hero_robin.set_result(
side_effect=[OtherHero(), TypeError("Ops! No hero like that!")]
)
testing.my_hero = them.PeakyBlinder()
assert not isinstance(testing.my_hero, Foo)
assert isinstance(testing.my_hero, OtherHero)
print("--------------------------------------------------------------------------")
print("Who is my mocked hero with side_effect = OtherHero():")
print("--------------------------------------------------------------------------")
testing.who_is_my_hero()
print("--------------------------------------------------------------------------")
print("Testing side_effect = TypeError('Ops! No hero like that!')")
print("--------------------------------------------------------------------------")
with pytest.raises(TypeError) as ex:
testing.my_hero = them.PeakyBlinder()
testing.who_is_my_hero()
assert "Ops! No hero like that!" == str(ex.value)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/tgc77/mocker_builder",
"name": "mocker-builder",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pytest mock mocker",
"author": "Tiago G Cunha",
"author_email": "tikx.batera@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/63/fe/fcb1eb3a2c415d863495165b25d30411fd998da3809ef3204bdee330172d/mocker-builder-0.2.0.tar.gz",
"platform": null,
"description": "# Mocker Builder\nTesting tools for mocking and patching based on pytest_mock mocker features but with improvements.\n\n### Installation\n```bash\n$ pip install mocker-builder\n```\n\n### Initializer\nTo start using mucker-builder features just create your Test class, inherit from `MockerBuilder` class,\nimplement the required abstract method mocker_builder_setup decorating it with the `@MockerBuilder.initializer`\ndecorator and start building your mocks and fixtures, adding mocks from your test_... methods, \nbut you must declare the `mocker_builder_setup` method and decorate it with the \n`@MockerBuilder.initializer` decorator to be able to use `MockerBuilder` features.\n\n```python\n...\ndef print_io_test():\n print(\"Ouieh!!!\")\n\nclass TestMyHeroes(MockerBuilder):\n\n @MockerBuilder.initializer\n def mocker_builder_setup(self):\n pass\n...\ndef test_io(self):\n print_test_io = self.patch(\n target='sys.stdout',\n new_callable=StringIO\n )\n print_io_test()\n assert print_test_io.mock.getvalue() == 'Ouieh!!!\\n'\n```\n\nIf you wanna use print_test_io all over your tests just patch it into `mocker_builder_setup`:\n```python\n...\ndef print_io_test():\n print(\"Ouieh!!!\")\n\nclass TestMyHeroes(MockerBuilder):\n\n @MockerBuilder.initializer\n def mocker_builder_setup(self):\n self.print_test_io = self.patch(\n target='sys.stdout',\n new_callable=StringIO\n )\n...\ndef test_print_io(self):\n print_io_test()\n assert self.print_test_io.mock.getvalue() == 'Ouieh!!!\\n'\n\ndef test_another_print_io(self):\n patched_print_io_test = self.patch(\n '__main__.print_io_test',\n side_effect=[print(\"Ooouuiieeh!!\")]\n )\n print_io_test()\n assert not self.print_test_io.mock.getvalue() == 'Ouieh!!!\\n'\n assert self.print_test_io.mock.getvalue() == 'Ooouuiieeh!!!\\n'\n```\n\n### The self.patch TMocker.PatchType properties\nThe `self.patch` method creates a new patch/mock object. It is a patch/mock because by doing:\n```python\nmy_patched_thing = self.patch(...)\n```\n`my_patched_thing` has some properties of a mock.patch object, like start, stop and set_result. \nTo get access to the patched mock we can just access the `mock` patched attribute:\n```Python\nassert my_patched_thing.mock.called\nOr\nassert my_patched_thing().called\n```\nBoth ways return an MagicMock or an AsyncMock (Not yet really but still working on this feature) \nif the tested method is async.\n\n\n### Setting result after already been patched\n\nFor a complete exemple flow just have a look bellow:\n\n```python\nfrom io import StringIO\nfrom unittest.mock import PropertyMock\nimport pytest\n\nfrom mocker_builder import MockerBuilder\nfrom my_heroes import them\nfrom my_heroes.them import (\n Batman,\n HobbyHero,\n IHero,\n JusticeLeague,\n OtherHero,\n PeakyBlinder,\n MyHeroes,\n Robin\n)\n\n\ndef print_io_test():\n print(\"Ouieh!!!\")\n\n\nclass Foo(IHero):\n nickname: str = \"Bob\"\n\n def eating_banana(self) -> str:\n return \"have no banana\"\n\n def wearing_pyjama(self) -> str:\n return \"have no pyjama\"\n\n def just_call_for(self) -> str:\n return \"Bob Foo\"\n\n def just_says(self) -> str:\n return \"foo foo\"\n\n\nclass TestMyHeroes(MockerBuilder):\n\n @MockerBuilder.initializer\n def mocker_builder_setup(self):\n # ================== Setting fixtures ===================\n # TODO We will work on this feature to implement a real fixture\n self.my_hero = self.add_fixture(\n content=PeakyBlinder(\n bananas=12,\n pyjamas=7,\n nickname=\"Thomas Shelby\"\n )\n )\n # =================== Setting mocks ======================\n self.what_i_do_when_nobody_is_looking = self.patch(\n PeakyBlinder,\n 'what_i_do_when_nobody_is_looking',\n return_value=HobbyHero(\"I just drink wisky\")\n )\n self.get_my_hero_hobby = self.patch(\n Robin,\n 'get_my_hero_hobby',\n return_value=HobbyHero(\"I just watch TV\")\n )\n self.mock_my_heroes_module = self.patch(\n target=them.initialize_other_hero\n )\n self.mock_my_hero_attribue = self.patch(\n target=MyHeroes,\n attribute='_my_hero',\n mock_configure={\n 'eating_banana.return_value': \"Banana Noooo!\",\n 'just_says.side_effect': [\"Nothing to say!\"]\n }\n )\n self.mock_other_hero = self.patch(\n target=OtherHero,\n mock_configure={\n 'return_value.just_says.return_value': \"He feels good!\"\n }\n )\n self.my_hero_batman = self.patch(\n # XXX or target='main.Batman' to mock the Batman class imported from here.\n target=Batman,\n mock_configure={\n 'return_value.nickname': 'Bat Mock',\n 'return_value.eating_banana.return_value': \"doesn't like banana\",\n 'return_value.wearing_pyjama.return_value': \"doesn't wear pyjama\",\n 'return_value.just_call_for.return_value': \"just calls for Mocker\",\n 'return_value.just_says.return_value': \"I'm gonna mock you babe!\",\n }\n )\n self.mock_justice_league__init__ = self.patch(\n target=JusticeLeague.__init__\n )\n # ========================================================\n\n @pytest.mark.asyncio\n async def test_what_i_do_when_nobody_is_looking(self):\n # ----------------------- PeakyBlinder ----------------------\n him = MyHeroes()\n him.my_hero = PeakyBlinder(\n my_hobby=HobbyHero(\n what_i_do=\"Shot someone\"\n )\n )\n peaky_blinder = await him.what_my_hero_does_when_nobody_is_looking()\n\n assert self.what_i_do_when_nobody_is_looking.mock.called\n assert not peaky_blinder.what_i_do == \"Shot someone\"\n assert peaky_blinder.what_i_do == \"I just drink wisky\"\n assert him.does() == \"Shot someone\"\n assert not him.does() == \"I just drink wisky\"\n\n self.what_i_do_when_nobody_is_looking.set_result(\n return_value=HobbyHero(\"Just relax!\")\n )\n peaky_blinder = await him.what_my_hero_does_when_nobody_is_looking()\n\n assert not peaky_blinder.what_i_do == \"I just drink wisky\"\n assert peaky_blinder.what_i_do == \"Just relax!\"\n assert him.does() == \"Shot someone\"\n assert not him.does() == \"just relax!\"\n\n # ----------------------- Robin ----------------------\n robs = MyHeroes()\n robs.my_hero = Robin(\n my_hobby=HobbyHero(\n what_i_do=\"I catch bad guys\"\n )\n )\n robin = await robs.what_my_hero_does_when_nobody_is_looking()\n\n assert not self.get_my_hero_hobby.mock.called\n assert not robin.what_i_do == \"I just watch TV\"\n assert robin.what_i_do == \"I catch bad guys\"\n\n # calling does() method calls mocked Robin.get_my_hero_hobby method so get the mocked value\n assert not robs.does() == \"I catch bad guys\"\n assert robs.does() == \"I just watch TV\"\n assert self.get_my_hero_hobby.mock.called\n assert self.get_my_hero_hobby.mock.call_count == 2\n\n # ================================================================================\n # -------------------- Robin -> Batman --------------------\n self.robin_becomes_batman = self.patch(\n Robin,\n new=Batman\n )\n self.get_my_hero_hobby.stop()\n\n # Here now we will actually mock Batman.get_my_hero_hobby calling\n self.get_my_hero_hobby = self.patch(\n Robin,\n 'get_my_hero_hobby',\n return_value=HobbyHero(\"I just watch TV\")\n )\n robs = MyHeroes()\n robs.my_hero = Robin(\n my_hobby=HobbyHero(\n what_i_do=\"I catch bad guys\"\n )\n )\n robin = await robs.what_my_hero_does_when_nobody_is_looking()\n\n assert not self.get_my_hero_hobby.mock.called\n assert not robin.what_i_do == \"I just watch TV\"\n assert robin.what_i_do == \"I catch bad guys\"\n\n # calling does() method calls mocked Batman.get_my_hero_hobby method so get the mocked value\n assert robs.does() == \"I catch bad guys\"\n assert not robs.does() == \"I just watch TV\"\n assert not self.get_my_hero_hobby.mock.called\n assert self.get_my_hero_hobby.mock.call_count == 0\n\n # ----------------------------------------------------------------\n # remember we mocked robin as batman => self.robin_becomes_batman\n # ----------------------------------------------------------------\n bats = MyHeroes()\n bats.my_hero = Batman(\n my_hobby=HobbyHero(\n what_i_do=\"I catch bad guys\"\n )\n )\n batman = await robs.what_my_hero_does_when_nobody_is_looking()\n\n assert not self.get_my_hero_hobby.mock.called\n assert not batman.what_i_do == \"I just watch TV\"\n assert batman.what_i_do == \"I catch bad guys\"\n assert bats.does() == \"I just watch TV\"\n assert not bats.does() == \"I catch bad guys\"\n assert self.get_my_hero_hobby.mock.called\n assert self.get_my_hero_hobby.mock.call_count == 2\n\n def test_io(self):\n self.mock_test_io = self.patch(\n target='sys.stdout',\n new_callable=StringIO\n )\n print_io_test()\n assert self.mock_test_io().getvalue() == 'Ouieh!!!\\n'\n\n @pytest.mark.asyncio\n async def test_heroes_sleeping(self):\n justce_league = JusticeLeague()\n assert self.mock_justice_league__init__().called\n\n async def hero_names():\n yield Batman().nickname\n yield Robin().nickname\n _hero_names = hero_names()\n\n async for result in justce_league.are_heroes_sleeping():\n assert result == \"=== Heroes are awakened ===\"\n\n self.mock_justice_league__init__.stop()\n justce_league = JusticeLeague()\n\n async for result in justce_league.are_heroes_sleeping():\n _hero_name = await _hero_names.__anext__()\n print(result, _hero_name)\n assert result == f\"MagicMock=>({_hero_name}): ZZzzzz\"\n\n @pytest.mark.asyncio\n async def test_call_heroes(self):\n # Remember that JusticeLeague.__init__ still mocked, so calling JusticeLeague() doesn't\n # initialize JusticeLeague._heroes attribute.\n\n justce_league = JusticeLeague()\n assert await justce_league.call_everybody() == \"Uuhmm! Nobody here!\"\n\n with pytest.raises(AttributeError) as ex:\n justce_league.join_hero(Batman())\n assert \"'JusticeLeague' object has no attribute '_heroes'\" == str(ex.value)\n\n # We just stop mocking JusticeLeague.__init__ to test a different behavior below\n self.mock_justice_league__init__.stop()\n del justce_league\n\n with self.patch(\n JusticeLeague,\n '_heroes',\n create=True,\n return_value=PropertyMock(spec=list, return_value=[])\n ):\n\n justce_league = JusticeLeague()\n justce_league.join_hero(Batman())\n # my_heroes.Batman() still mocked\n justce_league.join_hero(them.Batman())\n\n assert await justce_league.call_everybody() == [\n ('Batman', 'Come on', 'Big Fat Bat'),\n ('MagicMock', 'Come on', 'Bat Mock')\n ]\n\n def test_mock_my_heroes_class(self):\n mock_my_heroes_class = self.patch(\n target=MyHeroes\n )\n them.who_is_the_best_hero()\n assert mock_my_heroes_class().called\n\n def test_mock_my_heroes_module(self):\n self.mock_my_heroes_module.stop()\n them.who_is_the_best_hero()\n assert not self.mock_my_heroes_module().called\n\n self.mock_my_heroes_module.start()\n them.who_is_the_best_hero()\n assert self.mock_my_heroes_module().called\n\n def test_mock_my_hero_attribute(self):\n assert self.mock_my_hero_attribue().eating_banana() == \"Banana Noooo!\"\n assert self.mock_my_hero_attribue.mock.just_says() == \"Nothing to say!\"\n\n def test_mock_my_class(self):\n response = them.asks_what_other_hero_have_to_say_about_been_hero()\n assert response == \"He feels good!\"\n\n def test_my_hero_batman(self):\n them.who_is_my_hero(Batman())\n\n testing = MyHeroes()\n testing.my_hero = them.Batman()\n testing.who_is_my_hero()\n\n assert self.my_hero_batman.mock.return_value.nickname == 'Bat Mock'\n assert testing.my_hero.nickname == 'Bat Mock'\n\n def test_mock_justice_league__init__(self):\n justce_league = JusticeLeague()\n assert justce_league.show_heroes() == \"Opss! No heroes over here!\"\n assert justce_league.what_heroes_does() == \"Eita! Heroes are doing nothing!\"\n\n self.mock_justice_league__init__.stop()\n\n justce_league = JusticeLeague()\n # my_heroes.Batman() is mocked\n justce_league.join_hero(them.Batman())\n justce_league.join_hero(Robin())\n\n mock_test_io = self.patch(\n target='sys.stdout',\n new_callable=StringIO\n )\n justce_league.show_heroes()\n expected = \"\"\"MagicMock just calls for Mocker\nRobin just calls for Little Bastard\\n\"\"\"\n assert mock_test_io().getvalue() == expected\n\n justce_league.what_heroes_does()\n expected += \"\"\"===========================\nBat Mock\ndoesn't like banana\ndoesn't wear pyjama\nI'm gonna mock you babe!\n===========================\nLittle Bastard\nis eating 1 banana(s)\nis wearing 4 pyjama(s)\nI'm gonna have a pint!\\n\"\"\"\n assert mock_test_io().getvalue() == expected\n\n mock_test_io.stop()\n self.mock_justice_league__init__.start()\n\n justce_league = JusticeLeague()\n assert justce_league.show_heroes() == \"Opss! No heroes over here!\"\n assert justce_league.what_heroes_does() == \"Eita! Heroes are doing nothing!\"\n\n def test_mock_ugly_hero(self):\n\n assert them.UGLY_HERO == 'Me'\n\n mock_ugly_hero = self.patch(\n target=them,\n attribute='UGLY_HERO',\n mock_configure={\n 'third': 'You',\n 'who_is_the_most_ugly.return_value': 'Me again'\n },\n first='Batman',\n second='Robin',\n call_me_a_hero=lambda: PeakyBlinder().nickname\n )\n mock_ugly_hero().configure_mock(\n fourth='Me',\n **{\n 'who_is_my_hero.return_value': Batman().nickname,\n 'who_is_the_most_beautiful.side_effect': ValueError(\"There isn't any beautiful hero\")\n }\n )\n\n assert mock_ugly_hero().first == 'Batman'\n assert mock_ugly_hero().second == 'Robin'\n assert mock_ugly_hero().third == 'You'\n assert mock_ugly_hero().fourth == 'Me'\n assert mock_ugly_hero().who_is_the_most_ugly() == 'Me again'\n assert mock_ugly_hero().call_me_a_hero() == \"Bart Burp\"\n assert mock_ugly_hero().who_is_my_hero() == \"Big Fat Bat\"\n\n with pytest.raises(ValueError) as ex:\n mock_ugly_hero().who_is_the_most_beautiful()\n assert \"There isn't any beautiful hero\" == str(ex.value)\n\n def test_how_can_we_call_for_heores(self):\n self.mock_justice_league__init__.stop()\n self.my_hero_batman.stop()\n\n justce_league = JusticeLeague()\n # my_heroes.Batman() is mocked but was stopped\n justce_league.join_hero(them.Batman())\n justce_league.join_hero(Robin())\n assert justce_league.how_can_we_call_for_heores() == [\n (\"Batman\", \"just calls for Big Fat Bat\"),\n (\"Robin\", \"just calls for Little Bastard\")\n ]\n self.mock_justice_league__init__.start()\n justce_league = JusticeLeague()\n assert self.mock_justice_league__init__().called\n assert justce_league.how_can_we_call_for_heores() == \"Opss! No heroes over here to call for!\"\n\n self.my_hero_batman.start()\n self.mock_justice_league__init__.stop()\n\n justce_league = JusticeLeague()\n # my_heroes.Batman() is mocked and was started again\n justce_league.join_hero(them.Batman())\n justce_league.join_hero(Robin())\n assert justce_league.how_can_we_call_for_heores() == [\n (\"MagicMock\", \"just calls for Mocker\"),\n (\"Robin\", \"just calls for Little Bastard\")\n ]\n assert self.my_hero_batman.mock.called\n\n def test_my_hero_robin(self):\n my_hero_robin = self.patch(\n target=Robin(), # XXX we can mock from object instance! Ouieh!\n return_value=PropertyMock(\n nickname='Bastard Mock',\n eating_banana=lambda: \"eat a lot of bananas\",\n wearing_pyjama=lambda: \"likes to be naked\",\n just_call_for=lambda: \"Little Mocker\",\n just_says=lambda: \"Mock me baby!\"\n )\n )\n\n them.who_is_my_hero(Robin())\n testing = MyHeroes()\n testing.my_hero = them.Robin()\n testing.who_is_my_hero()\n\n assert my_hero_robin.mock.called\n assert my_hero_robin.mock.return_value.nickname == 'Bastard Mock'\n assert my_hero_robin.mock.return_value.eating_banana() == \"eat a lot of bananas\"\n assert my_hero_robin.mock.return_value.wearing_pyjama() == \"likes to be naked\"\n assert my_hero_robin.mock.return_value.just_call_for() == \"Little Mocker\"\n assert my_hero_robin.mock.return_value.just_says() == \"Mock me baby!\"\n\n def test_set_result_return_value(self):\n my_hero_robin = self.patch(\n target=Robin,\n return_value=Foo()\n )\n\n print(\"--------------------------------------------------------------------------\")\n print(\"Who is my hero:\")\n print(\"--------------------------------------------------------------------------\")\n them.who_is_my_hero(Robin())\n\n testing = MyHeroes()\n testing.my_hero = them.Robin()\n print(\"--------------------------------------------------------------------------\")\n print(\"Who is my mocked hero with return_value = Foo():\")\n print(\"--------------------------------------------------------------------------\")\n testing.who_is_my_hero()\n\n assert my_hero_robin.mock.called\n assert isinstance(my_hero_robin.mock.return_value, Foo)\n\n print(\"--------------------------------------------------------------------------\")\n print(\"Setting mock result return_value=PeakyBlinder()\")\n print(\"--------------------------------------------------------------------------\")\n my_hero_robin.set_result(\n return_value=PeakyBlinder()\n )\n assert not isinstance(my_hero_robin.mock.return_value, Foo)\n assert isinstance(my_hero_robin.mock.return_value, PeakyBlinder)\n\n testing = MyHeroes()\n testing.my_hero = them.Robin()\n print(\"--------------------------------------------------------------------------\")\n print(\"Who is my mocked hero with return_value = PeakyBlinder():\")\n print(\"--------------------------------------------------------------------------\")\n testing.who_is_my_hero()\n\n def test_set_result_side_effect(self):\n my_hero_robin = self.patch(\n target=PeakyBlinder,\n side_effect=lambda: Foo()\n )\n\n print(\"--------------------------------------------------------------------------\")\n print(\"Who is my hero:\")\n print(\"--------------------------------------------------------------------------\")\n them.who_is_my_hero(PeakyBlinder())\n\n testing = MyHeroes()\n testing.my_hero = them.PeakyBlinder()\n print(\"--------------------------------------------------------------------------\")\n print(\"Who is my mocked hero with side_effect = Foo():\")\n print(\"--------------------------------------------------------------------------\")\n testing.who_is_my_hero()\n\n assert my_hero_robin.mock.called\n assert isinstance(testing.my_hero, Foo)\n\n print(\"--------------------------------------------------------------------------\")\n print(\"\"\"Setting mock result side_effect=[\n OtherHero(),\n TypeError('Ops! No hero like that!')\n]\"\"\")\n print(\"--------------------------------------------------------------------------\")\n my_hero_robin.set_result(\n side_effect=[OtherHero(), TypeError(\"Ops! No hero like that!\")]\n )\n testing.my_hero = them.PeakyBlinder()\n\n assert not isinstance(testing.my_hero, Foo)\n assert isinstance(testing.my_hero, OtherHero)\n\n print(\"--------------------------------------------------------------------------\")\n print(\"Who is my mocked hero with side_effect = OtherHero():\")\n print(\"--------------------------------------------------------------------------\")\n testing.who_is_my_hero()\n\n print(\"--------------------------------------------------------------------------\")\n print(\"Testing side_effect = TypeError('Ops! No hero like that!')\")\n print(\"--------------------------------------------------------------------------\")\n with pytest.raises(TypeError) as ex:\n testing.my_hero = them.PeakyBlinder()\n testing.who_is_my_hero()\n assert \"Ops! No hero like that!\" == str(ex.value)\n\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library to build mock tests dynamicaly using the mocker feature from pytest-mock lib",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://mocker-builder.readthedocs.io",
"Homepage": "https://github.com/tgc77/mocker_builder",
"Source": "https://github.com/tgc77/mocker_builder"
},
"split_keywords": [
"pytest",
"mock",
"mocker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7e5c227f107323004c260ea9ee9fae04c2015dc8645221249372288f3acd7f4",
"md5": "af924ea3713be9dcbfcd8df58bc4ddab",
"sha256": "12af4a25ee94496cd3317e7008d9b3e5adb1e657c8dd0e6de43b8a3eec626119"
},
"downloads": -1,
"filename": "mocker_builder-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af924ea3713be9dcbfcd8df58bc4ddab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14379,
"upload_time": "2023-06-22T12:50:30",
"upload_time_iso_8601": "2023-06-22T12:50:30.082883Z",
"url": "https://files.pythonhosted.org/packages/a7/e5/c227f107323004c260ea9ee9fae04c2015dc8645221249372288f3acd7f4/mocker_builder-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63fefcb1eb3a2c415d863495165b25d30411fd998da3809ef3204bdee330172d",
"md5": "8c6a41bf12d1967dc24c2a4b95fc1cfc",
"sha256": "cc3262460238c9fcc62ad09deabf9be8c47c178790e471d61dc08bcf11d47351"
},
"downloads": -1,
"filename": "mocker-builder-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8c6a41bf12d1967dc24c2a4b95fc1cfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18440,
"upload_time": "2023-06-22T12:50:32",
"upload_time_iso_8601": "2023-06-22T12:50:32.534041Z",
"url": "https://files.pythonhosted.org/packages/63/fe/fcb1eb3a2c415d863495165b25d30411fd998da3809ef3204bdee330172d/mocker-builder-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-22 12:50:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tgc77",
"github_project": "mocker_builder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "mocker-builder"
}
JSON
