Tests Package

Submodules

Test Avatar Class

class game.test_suite.tests.test_avatar.TestAvatar(methodName='runTest')

Bases: TestCase

Test Avatar Notes:

This class tests the different methods in the Avatar class.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_avatar_json_with_item()

test_avatar_json_with_none_item()

test_avatar_set_item()

test_avatar_set_item_fail()

test_avatar_set_position()

test_avatar_set_position_None()

test_avatar_set_position_fail()

test_avatar_set_score()

test_avatar_set_score_fail()

Test Avatar Inventory

class game.test_suite.tests.test_avatar_inventory.TestAvatarInventory(methodName='runTest')

Bases: TestCase

Test Avatar Inventory Notes:

This class tests the different methods in the Avatar class related to the inventory system. This is its own file since the inventory system has a lot of functionality. Look extensively at the different cases that are tested to better understand how it works if there is still confusion.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_avatar_drop_held_item()

test_avatar_drop_held_item_none()

test_avatar_pick_up()

test_avatar_pick_up_extra()

test_avatar_pick_up_full_inventory()

test_avatar_pick_up_return_none()

test_avatar_pick_up_surplus()

test_avatar_set_inventory()

test_avatar_set_inventory_fail_1()

test_avatar_set_inventory_fail_2()

test_avatar_set_max_inventory_size()

test_avatar_set_max_inventory_size_fail()

test_take()

Take method test:

When this test is performed, it works properly, but because the Item class is used and is very generic, it may not seem to be the case. However, it does work in the end. The first item in the inventory has its quantity decrease to 2 after the take method is executed. Then, the helper method, clean_inventory, consolidates all similar Items with each other. This means that inventory[1] will add its quantity to inventory[0], making it have a quantity of 5; inventory[1] now has a quantity of 4 instead of 7. Then, inventory[2] will add its quantity to inventory[1], making it have a quantity of 7; inventory[2] now has a quantity of 7.

To recap: When the take method is used, it will work properly with more specific Item classes being created to consolidate the same Item object types together

When more subclasses of Item are created, more specific tests can be created if needed.

test_take_fail()

test_take_none()

Test Example Class

class game.test_suite.tests.test_example.TestExample(methodName='runTest')

Bases: TestCase

Test Example Notes:

This is a mock test class to model tests after. The setUp method MUST be in camel-case for every test file. Everything else can be in snake_case as normal.

The command to run tests is:

python -m game.test_suite.runner

setUp()

Hook method for setting up the test fixture before exercising it.

test_dict_array()

test_dict_bool()

test_dict_integer()

test_dict_string()

Test Gameboard Class

class game.test_suite.tests.test_game_board.TestGameBoard(methodName='runTest')

Bases: TestCase

Test Gameboard Notes:

This class tests the different methods in the Gameboard class. This file is worthwhile to look at to understand the GamebBoard class better if there is still confusion on it.

This class tests the Gameboard specifically when the map is generated.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_game_board_json()

test_get_objects_avatar()

test_get_objects_occupiable_station()

test_get_objects_occupiable_station_2()

test_get_objects_station()

test_get_objects_wall()

test_locations_fail()

test_locations_incorrect_fail()

test_map_size_fail()

test_seed_fail()

test_walled_fail()

Test Gameboard (No Generation)

class game.test_suite.tests.test_game_board_no_gen.TestGameBoard(methodName='runTest')

Bases: TestCase

Test Gameboard Without Generation Notes:

This class tests the different methods in the Gameboard class when the map is not generated.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_game_board_json()

test_generate_map()

test_locations()

test_locations_fail_type()

test_map_size()

test_map_size_fail()

test_seed()

test_seed_fail()

test_walled()

test_walled_fail()

Test Initialization Class

class game.test_suite.tests.test_initialization.TestInitialization(methodName='runTest')

Bases: TestCase

Test Avatar Notes:

This class tests the instantiation of different Objects within the project. Recall that every new class created needs a respective ObjectType enum created for it.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_object_init()

Test Interact Controller Class

class game.test_suite.tests.test_interact_controller.TestInteractController(methodName='runTest')

Bases: TestCase

Test Avatar Notes:

This class tests the different methods in the InteractController class.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_interact_dump_item()

test_interact_item_occupiable_station()

test_interact_item_station()

test_interact_nothing()

Test Inventory Controller Class

class game.test_suite.tests.test_inventory_controller.TestInventoryController(methodName='runTest')

Bases: TestCase

Test Inventory Controller Notes:

This class tests the different methods in the Avatar class’ inventory.

check_inventory_item()

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_select_slot_0()

test_select_slot_1()

test_select_slot_2()

test_select_slot_3()

test_select_slot_4()

test_select_slot_5()

test_select_slot_6()

test_select_slot_7()

test_select_slot_8()

test_select_slot_9()

test_with_out_of_bounds()

test_with_wrong_action_type()

Test Item Class

class game.test_suite.tests.test_item.TestItem(methodName='runTest')

Bases: TestCase

Test Item Notes:

This class tests the different methods in the Item class.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_item_json()

test_pick_up()

test_pick_up_surplus()

test_pick_up_wrong_object_type()

test_set_durability()

test_set_durability_fail()

test_set_durability_none()

test_set_durability_stack_size_fail()

test_set_quantity()

test_set_quantity_fail()

test_set_quantity_fail_greater_than_0()

test_set_quantity_fail_stack_size()

test_set_value()

test_set_value_fail()

test_stack_size()

test_stack_size_fail()

test_stack_size_fail_quantity()

Test Master Controller Class

class game.test_suite.tests.test_master_controller.TestMasterController(methodName='runTest')

Bases: TestCase

Test Master Controller Notes:

Add tests to this class to tests any new functionality added to the Master Controller.

setUp() → None

Hook method for setting up the test fixture before exercising it.

Test Movement Controller Class

class game.test_suite.tests.test_movement_controller.TestMovementControllerIfWall(methodName='runTest')

Bases: TestCase

Test Movement Controller if Wall Notes:

This class tests the Movement Controller specifically for when there are walls – or other impassable objects – near the Avatar.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_move_down()

test_move_left()

test_move_right()

test_move_up()

Test Movement Controller with Occupiable Stations the Avatar can Occupy

class game.test_suite.tests.test_movement_controller_if_occupiable_station_is_occupiable.TestMovementControllerIfOccupiableStationIsOccupiable(methodName='runTest')

Bases: TestCase

Test Movement Controller if Occupiable Stations are Occupiable Notes:

This class tests the different methods in the Movement Controller class and the Avatar moving onto Occupiable Stations so that the Avatar can occupy it.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_move_down()

test_move_left()

test_move_right()

test_move_up()

Test Movement Controller with Occupiable Stations

class game.test_suite.tests.test_movement_controller_if_occupiable_stations.TestMovementControllerIfOccupiableStations(methodName='runTest')

Bases: TestCase

Test Movement Controller with Occupiable Stations that are Occupied Notes:

This class tests the different methods in the Movement Controller and that the Avatar can’t move onto an Occupiable Station that is occupied by an unoccupiable object (e.g., a Wall or Station object).

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_move_down()

test_move_down_fail()

test_move_left()

test_move_left_fail()

test_move_right()

test_move_right_fail()

test_move_up()

test_move_up_fail()

Test Movement Controller with Stations the Avatar Can’t Occupy

class game.test_suite.tests.test_movement_controller_if_stations.TestMovementControllerIfStations(methodName='runTest')

Bases: TestCase

Test Movement Controller with Stations Notes:

This class tests the different methods in the Movement Controller and that the Avatar can’t move onto a Station object (an example of an impassable object).

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_move_down()

test_move_down_fail()

test_move_left()

test_move_left_fail()

test_move_right()

test_move_right_fail()

test_move_up_fail()

Test Movement Controller with Walls

class game.test_suite.tests.test_movement_controller_if_wall.TestMovementControllerIfWall(methodName='runTest')

Bases: TestCase

Test Movement Controller with Stations Notes:

This class tests the different methods in the Movement Controller and that the Avatar can’t pass Wall objects.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_move_down()

test_move_down_fail()

test_move_left()

test_move_left_fail()

test_move_right()

test_move_right_fail()

test_move_up()

test_move_up_fail()

Test Occupiable Class

class game.test_suite.tests.test_occupiable.TestOccupiable(methodName='runTest')

Bases: TestCase

test_is_occupied_by_game_obj() → None

test_is_occupied_by_game_object() → None

test_is_occupied_by_object_type() → None

test_on_station() → None

test_on_top_of_stack() → None

test_place_on_stack() → None

test_remove_form_occupied_by_2_stack() → None

test_remove_from_occupied_by_duplicates() → None

test_remove_from_occupied_by_duplicates_2() → None

test_remove_from_occupied_twice() → None

test_remove_game_obj_from_occupied_by() → None

test_remove_obj_type_from_occupied_by() → None

Test Occupiable Station Class

class game.test_suite.tests.test_occupiable_station.TestOccupiableStation(methodName='runTest')

Bases: TestCase

Test Item Notes:

This class tests the different methods in the OccupiableStation class and ensures the objects that occupy them are properly set.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_avatar_occ()

test_item_occ()

test_nested_occ_json()

test_occ_json()

test_station_occ()

test_wall_occ()

Test Place Controller Class

class game.test_suite.tests.test_place_controller.place_controller(methodName='runTest')

Bases: TestCase

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_place_down() → None

test_place_left() → None

test_place_right() → None

test_place_up() → None

Test Player Class

class game.test_suite.tests.test_player.TestPlayer(methodName='runTest')

Bases: TestCase

Test Player Notes:

This class tests the different methods in the Player class.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_actions()

test_actions_empty_list()

test_actions_fail_none()

test_avatar()

test_avatar_fail_string()

test_avatar_none()

test_functional_fail_int()

test_functional_false()

test_functional_true()

test_object_type()

test_object_type_fail_int()

test_object_type_fail_none()

test_player_json()

test_team_name()

test_team_name_fail_int()

test_team_name_none()

Test Station Class

class game.test_suite.tests.test_station.TestStation(methodName='runTest')

Bases: TestCase

Test Station Example Notes:

This class tests the different methods in the Station Example class. This is used to show how Stations could work and how they can be tested.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_item_occ()

test_item_occ_fail()

test_json()

test_take_action()

Test Tile Class

class game.test_suite.tests.test_tile.TestTile(methodName='runTest')

Bases: TestCase

Test Tile Notes:

This class tests the different methods in the Tile class.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_avatar_tile()

test_nested_tile_json()

test_occupiable_station_tile()

test_station_tile()

test_tile_json()

test_wall_tile()

Test Utils Class

class game.test_suite.tests.test_utils.TestUtils(methodName='runTest')

Bases: TestCase

Test Utils Notes:

This class tests the functionality of the utils.py file.

setUp()

Hook method for setting up the test fixture before exercising it.

test_diff_len()

test_double_space_entry()

test_invalid_input()

test_long_strings()

test_long_strings_fail()

test_valid_input()

Module contents