class TestTFTPHandler(TriblerCoreTest):
"""
This class contains tests for the TFTP handler class.
"""
@blocking_call_on_reactor_thread
@inlineCallbacks
def setUp(self, annotate=True):
yield TriblerCoreTest.setUp(self, annotate=annotate)
self.handler = TftpHandler(None, None, None)
@blocking_call_on_reactor_thread
@inlineCallbacks
def tearDown(self, annotate=True):
self.handler.cancel_all_pending_tasks()
yield TriblerCoreTest.tearDown(self, annotate=annotate)
@blocking_call_on_reactor_thread
def test_download_file_not_running(self):
"""
Testing whether we do nothing if we are not running a session
"""
def mocked_add_new_session(_):
raise RuntimeError("_add_new_session not be called")
self.handler._add_new_session = mocked_add_new_session
self.handler.download_file("test", "127.0.0.1", 1234)
def test_check_session_timeout(self):
"""
Testing whether we fail if we exceed our maximum amount of retries
"""
mock_session = MockObject()
mock_session.retries = 2
mock_session.timeout = 1
mock_session.last_contact_time = 2
self.handler._max_retries = 1
self.assertTrue(self.handler._check_session_timeout(mock_session))
def test_schedule_callback_processing(self):
"""
Testing whether scheduling a TFTP callback works correctly
"""
self.assertFalse(self.handler.is_pending_task_active("tftp_process_callback"))
self.handler._callback_scheduled = True
self.handler._schedule_callback_processing()
self.assertFalse(self.handler.is_pending_task_active("tftp_process_callback"))
def test_cleanup_session(self):
"""
Testing whether a tftp session is correctly cleaned up
"""
self.handler._session_id_dict["c"] = 1
self.handler._session_dict = {"abc": "test"}
self.handler._cleanup_session("abc")
self.assertFalse('c' in self.handler._session_id_dict)
def test_data_came_in(self):
"""
Testing whether we do nothing when data comes in and the handler is not running
"""
def mocked_process_packet(_dummy1, _dummy2):
raise RuntimeError("_process_packet may not be called")
self.handler._process_packet = mocked_process_packet
self.handler._is_running = False
self.handler.data_came_in(None, None)
def test_data_came_in_invalid_candidate(self):
"""
Testing whether we do nothing when data comes in from an invalid candidate
"""
setattr(self.handler, "_process_packet",
lambda x, y: (_ for _ in ()).throw(RuntimeError("_process_packet may not be called")))
self.handler.data_came_in(('182.30.65.219', 0), None)
def test_handle_new_request_no_metadata(self):
"""
When the metadata_store from LaunchManyCore is not available, return
from the function rather than trying to load the metadata.
:return:
"""
# Make sure the packet appears to have the correct attributes
fake_packet = {"opcode": OPCODE_RRQ,
"file_name": METADATA_PREFIX + "abc",
"options": {"blksize": 1,
"timeout": 1},
"session_id": 1}
self.handler._load_metadata = lambda _: self.fail("This line should not be called")
def test_function():
test_function.is_called = True
return False
test_function.is_called = False
self.handler.session = MockObject()
self.handler.session.config = MockObject()
self.handler.session.config.get_metadata_enabled = test_function
self.handler._handle_new_request("123", "456", fake_packet)
self.assertTrue(test_function.is_called)
def test_handle_new_request_no_torrent_store(self):
"""
When the torrent_store from LaunchManyCore is not available, return
from the function rather than trying to load the metadata.
:return:
"""
self.handler.session = MockObject()
# Make sure the packet appears to have the correct attributes
fake_packet = {"opcode": OPCODE_RRQ,
"file_name": "abc",
"options": {"blksize": 1,
"timeout": 1},
"session_id": 1}
self.handler._load_metadata = lambda _: self.fail("This line should not be called")
def test_function():
test_function.is_called = True
return False
test_function.is_called = False
self.handler.session.config = MockObject()
self.handler.session.config.get_torrent_store_enabled = test_function
self.handler._handle_new_request("123", "456", fake_packet)
self.assertTrue(test_function.is_called)
@raises(FileNotFound)
def test_load_metadata_not_found(self):
"""
Testing whether a FileNotFound exception is raised when metadata cannot be found
"""
self.handler.session = MockObject()
self.handler.session.lm = MockObject()
self.handler.session.lm.metadata_store = MockObject()
self.handler.session.lm.metadata_store.get = lambda _: None
self.handler._load_metadata("abc")
@raises(FileNotFound)
def test_load_torrent_not_found(self):
"""
Testing whether a FileNotFound exception is raised when a torrent cannot be found
"""
self.handler.session = MockObject()
self.handler.session.lm = MockObject()
self.handler.session.lm.torrent_store = MockObject()
self.handler.session.lm.torrent_store.get = lambda _: None
self.handler._load_torrent("abc")
def test_handle_packet_as_receiver(self):
"""
Testing the handle_packet_as_receiver method
"""
def mocked_handle_error(_dummy1, _dummy2, error_msg=None):
mocked_handle_error.called = True
mocked_handle_error.called = False
self.handler._handle_error = mocked_handle_error
mock_session = MockObject()
mock_session.last_received_packet = None
mock_session.block_size = 42
mock_session.timeout = 44
packet = {'opcode': OPCODE_OACK, 'options': {'blksize': 43, 'timeout': 45}}
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
mocked_handle_error.called = False
packet['options']['blksize'] = 42
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
mock_session.last_received_packet = True
mocked_handle_error.called = False
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
packet['options']['timeout'] = 44
packet['opcode'] = OPCODE_ERROR
mocked_handle_error.called = False
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
def test_handle_packet_as_sender(self):
"""
Testing the handle_packet_as_sender method
"""
def mocked_handle_error(_dummy1, _dummy2, error_msg=None):
mocked_handle_error.called = True
mocked_handle_error.called = False
self.handler._handle_error = mocked_handle_error
packet = {'opcode': OPCODE_ERROR}
self.handler._handle_packet_as_sender(None, packet)
self.assertTrue(mocked_handle_error.called)
def test_handle_error(self):
"""
Testing the error handling of a tftp handler
"""
mock_session = MockObject()
mock_session.is_failed = False
self.handler._send_error_packet = lambda _dummy1, _dummy2, _dummy3: None
self.handler._handle_error(mock_session, None)
self.assertTrue(mock_session.is_failed)
def test_send_error_packet(self):
"""
Testing whether a correct error message is sent in the tftp handler
"""
def mocked_send_packet(_, packet):
self.assertEqual(packet['session_id'], 42)
self.assertEqual(packet['error_code'], 43)
self.assertEqual(packet['error_msg'], "test")
self.handler._send_packet = mocked_send_packet
mock_session = MockObject()
mock_session.session_id = 42
self.handler._send_error_packet(mock_session, 43, "test")
class TestTFTPHandler(TriblerCoreTest):
"""
This class contains tests for the TFTP handler class.
"""
def setUp(self, annotate=True):
TriblerCoreTest.setUp(self, annotate=annotate)
self.handler = TftpHandler(None, None, None)
def tearDown(self, annotate=True):
TriblerCoreTest.tearDown(self, annotate=annotate)
self.handler.cancel_all_pending_tasks()
@blocking_call_on_reactor_thread
def test_download_file_not_running(self):
"""
Testing whether we do nothing if we are not running a session
"""
def mocked_add_new_session(_):
raise RuntimeError("_add_new_session not be called")
self.handler._add_new_session = mocked_add_new_session
self.handler.download_file("test", "127.0.0.1", 1234)
def test_check_session_timeout(self):
"""
Testing whether we fail if we exceed our maximum amount of retries
"""
mock_session = MockObject()
mock_session.retries = 2
mock_session.timeout = 1
mock_session.last_contact_time = 2
self.handler._max_retries = 1
self.assertTrue(self.handler._check_session_timeout(mock_session))
def test_schedule_callback_processing(self):
"""
Testing whether we do not register a tftp process task again
"""
self.assertFalse(
self.handler.is_pending_task_active("tftp_process_callback"))
self.handler._schedule_callback_processing()
self.assertTrue(self.handler._callback_scheduled)
self.handler.cancel_all_pending_tasks()
self.handler._schedule_callback_processing()
self.assertFalse(
self.handler.is_pending_task_active("tftp_process_callback"))
def test_cleanup_session(self):
"""
Testing whether a tftp session is correctly cleaned up
"""
self.handler._session_id_dict["c"] = 1
self.handler._session_dict = {"abc": "test"}
self.handler._cleanup_session("abc")
self.assertFalse('c' in self.handler._session_id_dict)
def test_data_came_in(self):
"""
Testing whether we do nothing when data comes in and the handler is not running
"""
def mocked_process_packet(_dummy1, _dummy2):
raise RuntimeError("_process_packet may not be called")
self.handler._process_packet = mocked_process_packet
self.handler._is_running = False
self.handler.data_came_in(None, None)
@raises(FileNotFound)
def test_load_metadata_not_found(self):
"""
Testing whether a FileNotFound exception is raised when metadata cannot be found
"""
self.handler.session = MockObject()
self.handler.session.lm = MockObject()
self.handler.session.lm.metadata_store = MockObject()
self.handler.session.lm.metadata_store.get = lambda _: None
self.handler._load_metadata("abc")
@raises(FileNotFound)
def test_load_torrent_not_found(self):
"""
Testing whether a FileNotFound exception is raised when a torrent cannot be found
"""
self.handler.session = MockObject()
self.handler.session.lm = MockObject()
self.handler.session.lm.torrent_store = MockObject()
self.handler.session.lm.torrent_store.get = lambda _: None
self.handler._load_torrent("abc")
def test_handle_packet_as_receiver(self):
"""
Testing the handle_packet_as_receiver method
"""
def mocked_handle_error(_dummy1, _dummy2, error_msg=None):
mocked_handle_error.called = True
mocked_handle_error.called = False
self.handler._handle_error = mocked_handle_error
mock_session = MockObject()
mock_session.last_received_packet = None
mock_session.block_size = 42
mock_session.timeout = 44
packet = {
'opcode': OPCODE_OACK,
'options': {
'blksize': 43,
'timeout': 45
}
}
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
mocked_handle_error.called = False
packet['options']['blksize'] = 42
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
mock_session.last_received_packet = True
mocked_handle_error.called = False
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
packet['options']['timeout'] = 44
packet['opcode'] = OPCODE_ERROR
mocked_handle_error.called = False
self.handler._handle_packet_as_receiver(mock_session, packet)
self.assertTrue(mocked_handle_error.called)
def test_handle_packet_as_sender(self):
"""
Testing the handle_packet_as_sender method
"""
def mocked_handle_error(_dummy1, _dummy2, error_msg=None):
mocked_handle_error.called = True
mocked_handle_error.called = False
self.handler._handle_error = mocked_handle_error
packet = {'opcode': OPCODE_ERROR}
self.handler._handle_packet_as_sender(None, packet)
self.assertTrue(mocked_handle_error.called)
def test_handle_error(self):
"""
Testing the error handling of a tftp handler
"""
mock_session = MockObject()
mock_session.is_failed = False
self.handler._send_error_packet = lambda _dummy1, _dummy2, _dummy3: None
self.handler._handle_error(mock_session, None)
self.assertTrue(mock_session.is_failed)
def test_send_error_packet(self):
"""
Testing whether a correct error message is sent in the tftp handler
"""
def mocked_send_packet(_, packet):
self.assertEqual(packet['session_id'], 42)
self.assertEqual(packet['error_code'], 43)
self.assertEqual(packet['error_msg'], "test")
self.handler._send_packet = mocked_send_packet
mock_session = MockObject()
mock_session.session_id = 42
self.handler._send_error_packet(mock_session, 43, "test")