def test_search_garbage_raises_exception(self, test_input,
rat_board_fx: RatBoard,
rescue_plain_fx: Rescue):
rescue_plain_fx.uuid = UUID('12345678-9876-53d1-ea5e-0000deadbeef')
rat_board_fx.append(rescue_plain_fx)
with pytest.raises((
TypeError,
ValueError,
)):
rat_board_fx.search(test_input)
def setUp(self):
"""
Set up for each test
"""
super().setUp()
self.board = RatBoard()
self.some_rescue = Rescue(uuid4(),
"unit_test[BOT]",
"snafu",
"unit_test",
board_index=-42)
def board(self) -> RatBoard:
"""
Rat Board property
"""
if not self._rat_board:
self._rat_board = RatBoard() # Create Rat Board Object
return self._rat_board
def test_contains_by_key_attributes(self, rescue_sop_fx: Rescue,
rat_board_fx: RatBoard):
"""
Verifies `Ratboard.__contains__` returns true when looking for a case by
key attributes only
Args:
rescue_sop_fx (Rescue): rescue fixture
rat_board_fx (RatBoard): RatBoard fixture
"""
# add our rescue to the board
rat_board_fx.append(rescue=rescue_sop_fx)
# overwrite our local rescue objects id
rescue_sop_fx._api_id = None
assert rescue_sop_fx in rat_board_fx
def rat_board_fx() -> RatBoard:
"""
Provides a RatBoard object
Returns:
RatBoard: initialized ratboard object
"""
return RatBoard()
def test_rescue_setter_garbage(self, rat_board_fx: RatBoard, garbage):
"""
Tests Ratboard.rescue
Args:
rat_board_fx (RatBoard): Ratboard fixture
garbage (): Garbage to throw at property
"""
with pytest.raises(TypeError):
rat_board_fx.rescues = garbage
def test_search_garbage_returns_none(self, test_input,
rat_board_fx: RatBoard,
rescue_plain_fx: Rescue):
rescue_plain_fx.uuid = UUID('12345678-9876-53d1-ea5e-0000deadbeef')
rat_board_fx.append(rescue_plain_fx)
assert rat_board_fx.search(test_input) is None
def test_search_valid(self, test_input, rat_board_fx: RatBoard,
rescue_plain_fx: Rescue):
rescue_plain_fx.uuid = UUID('12345678-9876-53d1-ea5e-0000deadbeef')
rat_board_fx.append(rescue_plain_fx)
assert rat_board_fx.search(test_input) == rescue_plain_fx
class RatBoardTests(TestCase):
"""
Tests for RatBoard
"""
def setUp(self):
"""
Set up for each test
"""
super().setUp()
self.board = RatBoard()
self.some_rescue = Rescue(uuid4(),
"unit_test[BOT]",
"snafu",
"unit_test",
board_index=-42)
def test_rescue_creation_existing_good_index(self):
"""
verifies a rescue can be added to the board when it already has an index
"""
# spawn a new rescue with a ID
self.board.append(rescue=self.some_rescue)
self.assertEqual(self.board.rescues[-42], self.some_rescue)
def test_rescue_creation_existing_bad_index(self):
"""
Verifies a rescue cannot be added when its defined index is already in use.
"""
# add it once
self.board.append(rescue=self.some_rescue)
# and try to add it again
with self.assertRaises(IndexNotFreeError):
self.board.append(rescue=self.some_rescue)
def test_rescue_Creation_without_index(self):
"""
Verifies a Rescue can be added without a defined index.
the board should give our rescue one.
"""
guid = uuid4()
name = "SicklyTadPole"
my_rescue = Rescue(guid, name, "NLTT 48288", name)
self.board.append(my_rescue)
found = self.board.find_by_uuid(guid)
self.assertIsNotNone(found)
self.assertEqual(found.client, name)
def test_rescue_creation_with_overwrite(self):
"""
Verifies a rescue can be added as to overwrite an existing entry.
"""
self.board.append(rescue=self.some_rescue)
my_rescue = Rescue(uuid4(), "foo", "bar", "foo", board_index=-42)
self.board.append(rescue=my_rescue, overwrite=True)
self.assertEqual(self.board.rescues[-42], my_rescue)
def test_find_by_client_name(self):
"""
Verifies an existing rescue can be found via `RescueBoard.find_by_name`
"""
self.board.append(self.some_rescue)
with self.subTest(condition="existing"):
found = self.board.find_by_name(self.some_rescue.client)
self.assertIsNotNone(found)
with self.subTest(condition="not found"):
found = self.board.find_by_name("foobar")
self.assertIsNone(found)
def test_find_by_case_number(self):
"""
Verifies an existing rescue can be found via `RescueBoard.find_by_index`
"""
self.board.append(self.some_rescue)
with self.subTest(condition="existing"):
found = self.board.find_by_index(self.some_rescue.board_index)
self.assertIsNotNone(found)
with self.subTest(condition="not found"):
found = self.board.find_by_index(9001)
self.assertIsNone(found)
def test_find_by_uuid_offline(self):
"""
Verifies an existing rescue can be found by uuid, without consulting the API
"""
self.board.append(self.some_rescue)
with self.subTest(condition="existing"):
found = self.board.find_by_uuid(self.some_rescue.uuid)
self.assertIsNotNone(found)
with self.subTest(condition="not found"):
found = self.board.find_by_uuid(uuid4())
self.assertIsNone(found)
def test_clear_board(self) -> None:
"""
Verifies `RatBoard.clearBoard` functions as expected.
"""
# make sure we have something on the board
self.board.append(self.some_rescue)
self.assertNotEqual(self.board.rescues, {})
# if it is this test will prove nothing
self.board.clear_board()
self.assertEqual(self.board.rescues, {})
# moved to PyTest module
# def test_remove(self):
# """
# Verfies `RatBoard.remove()` correctly removes cases.
# """
# with self.subTest(conditon="existing"):
# # add the case
# self.board.append(self.some_rescue)
# self.assertNotEqual(self.board.rescues, {})
# self.board.remove(self.some_rescue)
# self.assertEqual(self.board.rescues, {})
#
# with self.subTest(condition="not existing"):
# with self.assertRaises(KeyError):
# self.board.remove(self.some_rescue)
def test_contains_existing_by_uuid(self):
"""
Verifies `RatBoard.__contains__` returns true when the a case with the same api UUID
is known and tracked by the board
Notes:
This branch should only verify a rescue exists *with the same uuid*,
it should do no further checks.
"""
# add a case
self.board.append(self.some_rescue)
# make our assertion
self.assertTrue(
# spawn a case with the same uuid, and make our check
Rescue(self.some_rescue.uuid, "nope", "i have no idea!", "nope") in
self.board)
def test_contains_non_existing(self):
"""
Verifies `Ratboard.__contains__` returns false when the desired rescue does not exist
on the given board
"""
self.assertFalse(self.some_rescue in self.board)