def validate_video_queue(self, queue, selected_video):
## Same room.
user = MockUserSession("ValidationUser")
self.room_controller.user_connect(user)
expected_response = [{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1", "ValidationUser"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": queue}]
if len(queue) > 0:
expected_response.append({"command": "change_video", "video": selected_video})
assert_equal(expected_response, user.messages)
user.messages = []
self.room_controller.user_disconnect(user)
## New room, reconstructed from model.
new_room = RoomController(self.room_id)
test_user = MockUserSession("NewValidationUser")
new_room.user_connect(test_user)
expected_response = [{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["NewValidationUser"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": queue}]
if len(queue) > 0:
expected_response.append({"command": "change_video", "video": queue[0]})
assert_equal(expected_response, test_user.messages)
test_user.messages = []
def setup(self):
database_create(k_database)
database.connect(k_database)
system = User(0)
self.room_id = Room.create("Test Room", system)
self.room_controller = RoomController(self.room_id)
def serve():
room_controller = RoomController()
thread = threading.Thread(target=room_controller.run)
thread.start()
server = grpc.server(futures.ThreadPoolExecutor(max_workers=1))
game_pb2_grpc.add_RoomControllerServicer_to_server(room_controller, server)
server.add_insecure_port('[::]:50051')
server.start()
print('RoomController started')
server.wait_for_termination()
thread.join()
ROOM_3_NAME = "Bedroom 1"
ROOM_3_LCD_E = 30
ROOM_3_SERVO_S = 11
ROOM_3_LIGHT_E = 27
ROOM_3_SENSOR = "4bcab8e"
#Room 4 Constants
ROOM_4_NO = 4
ROOM_4_NAME = "Bedroom 2"
ROOM_4_LCD_E = 29
ROOM_4_SERVO_S = 9
ROOM_4_LIGHT_E = 17
ROOM_4_SENSOR = "4bd7551"
# create room objects
room_1 = RoomController(ROOM_1_NO, ROOM_1_NAME, ROOM_1_SERVO_S, ROOM_1_LIGHT_E,
ROOM_1_LCD_E, ROOM_1_SENSOR)
room_2 = RoomController(ROOM_2_NO, ROOM_2_NAME, ROOM_2_SERVO_S, ROOM_2_LIGHT_E,
ROOM_2_LCD_E, ROOM_2_SENSOR)
room_3 = RoomController(ROOM_3_NO, ROOM_3_NAME, ROOM_3_SERVO_S, ROOM_3_LIGHT_E,
ROOM_3_LCD_E, ROOM_3_SENSOR)
room_4 = RoomController(ROOM_4_NO, ROOM_4_NAME, ROOM_4_SERVO_S, ROOM_4_LIGHT_E,
ROOM_4_LCD_E, ROOM_4_SENSOR)
# add room objects to list
rooms = [room_1, room_2, room_3, room_4]
#setup LCD for external temperature display
EXTERNAL_LCD = LCDController(EXTERNAL_LCD_E)
# other constants
INIT_MESSAGE = "Initialising"
class TestRoomController():
@classmethod
def setup_class(cls):
threaded_reactor()
def setup(self):
database_create(k_database)
database.connect(k_database)
system = User(0)
self.room_id = Room.create("Test Room", system)
self.room_controller = RoomController(self.room_id)
def teardown(self):
database.close()
os.unlink(k_database)
def validate_video_queue(self, queue, selected_video):
## Same room.
user = MockUserSession("ValidationUser")
self.room_controller.user_connect(user)
expected_response = [{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1", "ValidationUser"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": queue}]
if len(queue) > 0:
expected_response.append({"command": "change_video", "video": selected_video})
assert_equal(expected_response, user.messages)
user.messages = []
self.room_controller.user_disconnect(user)
## New room, reconstructed from model.
new_room = RoomController(self.room_id)
test_user = MockUserSession("NewValidationUser")
new_room.user_connect(test_user)
expected_response = [{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["NewValidationUser"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": queue}]
if len(queue) > 0:
expected_response.append({"command": "change_video", "video": queue[0]})
assert_equal(expected_response, test_user.messages)
test_user.messages = []
def test_basic(self):
user1 = MockUserSession("TestUser1")
user2 = MockUserSession("TestUser2")
self.room_controller.user_connect(user1)
assert_equal(
[{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": []}]
, user1.messages)
user1.messages = []
self.room_controller.process_message(
user1
, {"command": "add_video", "url": k_video1["url"]})
user1.wait_message_count(2)
assert_equal(
[{"command": "add_queue_video", "video": k_video1}
, {"command": "change_video", "video": k_video1}]
, user1.messages)
user1.messages = []
# Connect additional user.
self.room_controller.user_connect(user2)
assert_equal(
[{"command": "user_connect", "username": "******"}]
, user1.messages)
assert_equal(
[{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1", "TestUser2"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": [k_video1]}
, {"command": "change_video", "video": k_video1}]
, user2.messages)
user1.messages = []
user2.messages = []
def test_guest(self):
test_user = MockGuestUserSession("TestGuestUser")
## Validate username decoration.
self.room_controller.user_connect(test_user)
assert_equal(
[{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["*TestGuestUser*"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": []}]
, test_user.messages)
## Validate username change.
user1 = MockGuestUserSession("GuestUser")
user2 = MockUserSession("RealUser")
self.room_controller.user_connect(user1)
self.room_controller.user_connect(user2)
user1.messages = [] # Ignore initial state messages.
user2.messages = []
test_user.messages = []
# Expected to fail, username is taken by a guest.
self.room_controller.process_message(
test_user
, {"command": "guest_username"
, "username": "******"})
assert_equal(
[{"command": "command_error"
, "context": "guest_username"
, "reason": "Username already in use."}]
, test_user.messages)
test_user.messages = []
# Expected to fail, username is taken by a registered user.
self.room_controller.process_message(
test_user
, {"command": "guest_username"
, "username": "******"})
assert_equal(
[{"command": "command_error"
, "context": "guest_username"
, "reason": "Username already in use."}]
, test_user.messages)
test_user.messages = []
# Expected to succeed.
self.room_controller.process_message(
test_user
, {"command": "guest_username"
, "username": "******"})
expected_response = [
{"command": "guest_username_changed"
, "old_username": "******"
, "username": "******"}]
assert_equal(expected_response, test_user.messages)
assert_equal(expected_response, user1.messages)
assert_equal(expected_response, user2.messages)
def test_moderator(self):
## Selecting videos.
user1 = MockUserSession("TestUser1")
self.room_controller.user_connect(user1)
assert_equal(
[{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": []}]
, user1.messages)
user1.messages = []
# Add videos to queue.
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video1["url"]})
user1.wait_message_count(2)
assert_equal(
[{"command": "add_queue_video", "video": k_video1}
, {"command": "change_video", "video": k_video1}]
, user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video2["url"]})
user1.wait_message_count(1)
assert_equal([{"command": "add_queue_video", "video": k_video2}], user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video3["url"]})
user1.wait_message_count(1)
assert_equal([{"command": "add_queue_video", "video": k_video3}], user1.messages)
user1.messages = []
# Select videos.
self.room_controller.process_message(user1, {"command": "select_video", "item_id": k_video1["item_id"]})
assert_equal(
[{"command": "change_video", "video": k_video1}]
, user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "select_video", "item_id": k_video3["item_id"]})
assert_equal(
[{"command": "change_video", "video": k_video3}]
, user1.messages)
user1.messages = []
## Video status.
user2 = MockGuestUserSession("TestGuestUser")
self.room_controller.user_connect(user2)
user1.messages = []
user2.messages = []
for i in xrange(0, k_video3["duration"]):
if i == k_video3["duration"]:
state = "paused"
else:
state = "playing"
self.room_controller.process_message(
user1
, {"command": "update_video_state"
, "position": i
, "state": state})
assert_equal(
[]
, user1.messages)
assert_equal(
[{"command": "video_state"
, "position": i
, "state": state}]
, user2.messages)
user2.messages = []
def test_moderator_give(self):
user1 = MockGuestUserSession("TestGuestUser")
user2 = MockUserSession("RealUser")
## Validate username decoration.
self.room_controller.user_connect(user1)
self.room_controller.user_connect(user2)
user1.messages = [] # Ignore initial state messages.
user2.messages = []
self.room_controller.process_message(
user1
, {"command": "give_moderator"
, "username": "******"})
expected_response = [
{"command": "set_moderator"
, "username": "******"}]
assert_equal(expected_response, user1.messages)
assert_equal(expected_response, user2.messages)
def test_moderator_queue(self):
## Moving videos.
user1 = MockUserSession("TestUser1")
self.room_controller.user_connect(user1)
assert_equal(
[{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": []}]
, user1.messages)
user1.messages = []
# Add videos to queue.
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video1["url"]})
user1.wait_message_count(2)
assert_equal(
[{"command": "add_queue_video", "video": k_video1}
, {"command": "change_video", "video": k_video1}]
, user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video2["url"]})
user1.wait_message_count(1)
assert_equal([{"command": "add_queue_video", "video": k_video2}], user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video3["url"]})
user1.wait_message_count(1)
assert_equal([{"command": "add_queue_video", "video": k_video3}], user1.messages)
user1.messages = []
# Move video1 to the end.
self.room_controller.process_message(
user1
, {"command": "move_video"
, "item_id": k_video1["item_id"]
, "index": 2})
assert_equal(
[{"command": "move_queue_video"
, "item_id": k_video1["item_id"]
, "index": 2}]
, user1.messages)
self.validate_video_queue([k_video2, k_video3, k_video1], k_video1)
user1.messages = []
# Move video3 to the beginning.
self.room_controller.process_message(
user1
, {"command": "move_video"
, "item_id": k_video3["item_id"]
, "index": 0})
assert_equal(
[{"command": "move_queue_video"
, "item_id": k_video3["item_id"]
, "index": 0}]
, user1.messages)
self.validate_video_queue([k_video3, k_video2, k_video1], k_video1)
user1.messages = []
# Try moving video out of range.
self.room_controller.process_message(
user1
, {"command": "move_video"
, "item_id": k_video3["item_id"]
, "index": 3})
assert_equal(
[{"command": "command_error"
, "context": "move_video"
, "reason": "Index out of range."}]
, user1.messages)
user1.messages = []
# Move video3 from start to the center.
self.room_controller.process_message(
user1
, {"command": "move_video"
, "item_id": k_video3["item_id"]
, "index": 1})
assert_equal(
[{"command": "move_queue_video"
, "item_id": k_video3["item_id"]
, "index": 1}]
, user1.messages)
self.validate_video_queue([k_video2, k_video3, k_video1], k_video1)
user1.messages = []
# Move video1 from end to the center.
self.room_controller.process_message(
user1
, {"command": "move_video"
, "item_id": k_video1["item_id"]
, "index": 1})
assert_equal(
[{"command": "move_queue_video"
, "item_id": k_video1["item_id"]
, "index": 1}]
, user1.messages)
self.validate_video_queue([k_video2, k_video1, k_video3], k_video1)
user1.messages = []
## Removing videos.
# Remove video1.
self.room_controller.process_message(
user1
, {"command": "remove_video"
, "item_id": k_video1["item_id"]})
assert_equal(
[{"command": "remove_queue_video"
, "item_id": k_video1["item_id"]}
, {"command": "change_video"
, "video": k_video3}]
, user1.messages)
self.validate_video_queue([k_video2, k_video3], k_video3)
user1.messages = []
# Remove a video that is no longer present, expect error.
self.room_controller.process_message(
user1
, {"command": "remove_video"
, "item_id": k_video1["item_id"]})
assert_equal(
[{"command": "command_error"
, "context": "remove_video"
, "reason": "Video not found."}]
, user1.messages)
user1.messages = []
# Remove video2.
self.room_controller.process_message(
user1
, {"command": "remove_video"
, "item_id": k_video2["item_id"]})
assert_equal(
[{"command": "remove_queue_video"
, "item_id": k_video2["item_id"]}]
, user1.messages)
self.validate_video_queue([k_video3], k_video3)
user1.messages = []
# Remove video3.
self.room_controller.process_message(
user1
, {"command": "remove_video"
, "item_id": k_video3["item_id"]})
assert_equal(
[{"command": "remove_queue_video"
, "item_id": k_video3["item_id"]}]
, user1.messages)
self.validate_video_queue([], None)
user1.messages = []
def test_advance_video(self):
## Advancing videos.
user1 = MockUserSession("TestUser1")
self.room_controller.user_connect(user1)
assert_equal(
[{"command": "room_joined", "username": "******"}
, {"command": "initial_users", "users": ["TestUser1"]}
, {"command": "set_moderator", "username": "******"}
, {"command": "initial_queue", "queue": []}]
, user1.messages)
user1.messages = []
# Add videos to queue.
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video1["url"]})
user1.wait_message_count(2)
assert_equal(
[{"command": "add_queue_video", "video": k_video1}
, {"command": "change_video", "video": k_video1}]
, user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video2["url"]})
user1.wait_message_count(1)
assert_equal([{"command": "add_queue_video", "video": k_video2}], user1.messages)
user1.messages = []
self.room_controller.process_message(user1, {"command": "add_video", "url": k_video3["url"]})
user1.wait_message_count(1)
assert_equal([{"command": "add_queue_video", "video": k_video3}], user1.messages)
user1.messages = []
# Issue advance commands (internal API).
self.room_controller.advance_video()
user1.wait_message_count(1)
assert_equal([{"command": "change_video", "video": k_video2}], user1.messages)
user1.messages = []
self.room_controller.advance_video()
user1.wait_message_count(1)
assert_equal([{"command": "change_video", "video": k_video3}], user1.messages)
user1.messages = []
# Wrap back to start.
self.room_controller.advance_video()
user1.wait_message_count(1)
assert_equal([{"command": "change_video", "video": k_video1}], user1.messages)
user1.messages = []
def test_chat(self):
user1 = MockGuestUserSession("TestGuestUser")
user2 = MockUserSession("RealUser1")
user3 = MockUserSession("RealUser2")
users = [user1, user2, user3]
## Validate username decoration.
self.room_controller.user_connect(user1)
self.room_controller.user_connect(user2)
self.room_controller.user_connect(user3)
user1.messages = [] # Ignore initial state messages.
user2.messages = []
user3.messages = []
def validate_message(sender, content, expected_content=None):
if expected_content is None:
expected_content = content
self.room_controller.process_message(
sender
, {"command": "chat_message"
, "message": content})
assert_equal(
[{"command": "chat_message"
, "username": sender.username
, "message": expected_content}]
, user1.messages)
assert_equal(
[{"command": "chat_message"
, "username": sender.username
, "message": expected_content}]
, user2.messages)
user1.messages = []
user2.messages = []
validate_message(user1, "test")
validate_message(user2, "<b>html</b>")
validate_message(user1, "\"test'")
# Validate that whitespace is stripped.
validate_message(user1, "test\n", "test")
validate_message(user1, " test ", "test")
validate_message(user1, "\ttest\r\n", "test")
# Validate that sending an empty message fails.
self.room_controller.process_message(
user1
, {"command": "chat_message"
, "message": ""})
assert_equal(
[{"command": "command_error"
, "context": "chat_message"
, "reason": "Message cannot be empty."}]
, user1.messages)