def test_propagate_content_sync():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[
MessageSerializer().serialize(
ContentSync('/path/to/file', 'new content', 17, 21)),
BlockingIOError
])
mock_clientsocket.send = mock.MagicMock()
mock_listener = mock.MagicMock()
backend = Backend([mock_listener])
mock_content_monitor = mock.MagicMock()
mock_content_monitor.synchronize = mock.MagicMock(
return_value=SynchronizationResult.Updated)
backend.connection[mock_clientsocket] = FrontendConnection(
backend, mock_clientsocket, content_monitor=mock_content_monitor)
backend._receive(mock_clientsocket)
# listeners are called:
assert mock_listener.on_content_sync.call_count == 1
mock_content_monitor.synchronize.assert_called_once_with(
'/path/to/file', 'new content', 17, 21)
assert not mock_clientsocket.send.called
arg = mock_listener.on_content_sync.call_args[0][0]
assert isinstance(arg, ContentSync)
assert arg.file == '/path/to/file'
assert arg.data == 'new content'
assert arg.start == 17
assert arg.end == 21
def test_propagate_content_sync_out_of_sync():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[
MessageSerializer().serialize(
ContentSync('/path/to/file', 'new content', 17, 21)),
BlockingIOError
])
mock_clientsocket.send = mock.MagicMock()
mock_listener = mock.MagicMock()
backend = Backend([mock_listener])
mock_content_monitor = mock.MagicMock()
mock_content_monitor.synchronize = mock.MagicMock(
return_value=SynchronizationResult.OutOfSync)
backend.connection[mock_clientsocket] = FrontendConnection(
backend, mock_clientsocket, content_monitor=mock_content_monitor)
backend._receive(mock_clientsocket)
# listeners are called:
assert mock_listener.on_content_sync.call_count == 1
mock_content_monitor.synchronize.assert_called_once_with(
'/path/to/file', 'new content', 17, 21)
assert mock_clientsocket.send.call_count == 1
arg = mock_clientsocket.send.call_args[0][0]
assert b'OutOfSync' in arg
def test_on_static_syntax_request_found():
mock_syntax_fileset = mock.MagicMock()
mock_context = mock.MagicMock()
mock_context.send_message = mock.MagicMock()
backend = Backend(syntax_fileset=mock_syntax_fileset)
mock_syntax_file = mock.MagicMock()
mock_syntax_file.name = mock.sentinel.NAME1
mock_syntax_file.extensions = mock.sentinel.EXTENSIONS
mock_syntax_file.definition = mock.sentinel.DEFINITION
mock_syntax_fileset.filtered = mock.MagicMock(
return_value=(mock_syntax_file, ))
mock_syntax_fileset.format = mock.sentinel.FORMAT
backend.on_static_syntax_request(mock.sentinel.FORMAT, ['ext1', 'ext2'],
mock_context)
assert mock_context.send_message.call_count == 1
arg = mock_context.send_message.call_args[0][0]
assert isinstance(arg, StaticSyntaxList)
assert arg.format is mock.sentinel.FORMAT
assert len(arg.syntaxes) == 1
syntax = arg.syntaxes[0]
assert isinstance(syntax, StaticSyntax)
assert syntax.name == mock.sentinel.NAME1
assert syntax.fileExtensions is mock.sentinel.EXTENSIONS
assert syntax.definition is mock.sentinel.DEFINITION
def test_on_static_syntax_request_found():
mock_syntax_fileset = mock.MagicMock()
mock_context = mock.MagicMock()
mock_context.send_message = mock.MagicMock()
backend = Backend(syntax_fileset=mock_syntax_fileset)
mock_syntax_file = mock.MagicMock()
mock_syntax_file.name = mock.sentinel.NAME1
mock_syntax_file.extensions = mock.sentinel.EXTENSIONS
mock_syntax_file.definition = mock.sentinel.DEFINITION
mock_syntax_fileset.filtered = mock.MagicMock(return_value=(mock_syntax_file,))
mock_syntax_fileset.format = mock.sentinel.FORMAT
backend.on_static_syntax_request(mock.sentinel.FORMAT, ['ext1', 'ext2'], mock_context)
assert mock_context.send_message.call_count == 1
arg = mock_context.send_message.call_args[0][0]
assert isinstance(arg, StaticSyntaxList)
assert arg.format is mock.sentinel.FORMAT
assert len(arg.syntaxes) == 1
syntax = arg.syntaxes[0]
assert isinstance(syntax, StaticSyntax)
assert syntax.name == mock.sentinel.NAME1
assert syntax.fileExtensions is mock.sentinel.EXTENSIONS
assert syntax.definition is mock.sentinel.DEFINITION
def test_backend_alive_cycle(mock_datetime_mod):
now = datetime.datetime.now()
mock_datetime_mod.datetime.now = mock.MagicMock(side_effect=lambda: now)
assert TIMEOUT_BACKEND_ALIVE > datetime.timedelta(0)
mock_clientsocket1 = mock.MagicMock()
mock_clientsocket2 = mock.MagicMock()
backend = Backend()
backend.sockets = [mock.sentinel.SERVER_SOCKET, mock_clientsocket1, mock_clientsocket2]
backend.connection[mock_clientsocket1] = FrontendConnection(backend, mock_clientsocket1)
backend.connection[mock_clientsocket2] = FrontendConnection(backend, mock_clientsocket2)
# cycle must send alive for all newly connected frontends:
backend._cyclic()
assert b'BackendAlive' in mock_clientsocket1.send.call_args[0][0]
assert b'BackendAlive' in mock_clientsocket2.send.call_args[0][0]
# no new alive message before timeout has expired:
now += TIMEOUT_BACKEND_ALIVE * 0.9
mock_clientsocket1.send.reset_mock()
mock_clientsocket2.send.reset_mock()
backend._cyclic()
assert not mock_clientsocket1.called
assert not mock_clientsocket2.called
# but right after:
now += TIMEOUT_BACKEND_ALIVE * 0.15
mock_clientsocket1.send.reset_mock()
mock_clientsocket2.send.reset_mock()
backend._cyclic()
assert b'BackendAlive' in mock_clientsocket1.send.call_args[0][0]
assert b'BackendAlive' in mock_clientsocket2.send.call_args[0][0]
def test_on_static_syntax_request_none():
mock_syntax_fileset = mock.MagicMock()
mock_context = mock.MagicMock()
backend = Backend(syntax_fileset=mock_syntax_fileset)
mock_syntax_fileset.filtered = mock.MagicMock(return_value=None)
backend.on_static_syntax_request(mock.sentinel.FORMAT, ['ext1', 'ext2'], mock_context)
mock_syntax_fileset.filtered.assert_called_once_with(mock.sentinel.FORMAT, ['ext1', 'ext2'])
assert not mock_context.send_message.called
def test_receive_empty():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(return_value=None)
backend = Backend()
backend.connection[mock_clientsocket] = FrontendConnection(backend, mock_clientsocket)
backend.sockets.append(mock_clientsocket)
backend._receive(mock_clientsocket)
assert mock_clientsocket.close.call_count == 1
def test_receive_empty():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(return_value=None)
backend = Backend()
backend.connection[mock_clientsocket] = FrontendConnection(
backend, mock_clientsocket)
backend.sockets.append(mock_clientsocket)
backend._receive(mock_clientsocket)
assert mock_clientsocket.close.call_count == 1
def test_static_syntax_registration():
mock_syntax_fileset = mock.MagicMock()
backend = Backend(syntax_fileset=mock_syntax_fileset)
backend.register_static_syntax(mock.sentinel.NAME1, mock.sentinel.PATH1,
mock.sentinel.FORMAT1,
mock.sentinel.extensions)
mock_syntax_fileset.add_syntax_file.assert_called_once_with(
mock.sentinel.NAME1, mock.sentinel.PATH1, mock.sentinel.FORMAT1,
(mock.sentinel.extensions, ))
def test_on_static_syntax_request_none():
mock_syntax_fileset = mock.MagicMock()
mock_context = mock.MagicMock()
backend = Backend(syntax_fileset=mock_syntax_fileset)
mock_syntax_fileset.filtered = mock.MagicMock(return_value=None)
backend.on_static_syntax_request(mock.sentinel.FORMAT, ['ext1', 'ext2'],
mock_context)
mock_syntax_fileset.filtered.assert_called_once_with(
mock.sentinel.FORMAT, ['ext1', 'ext2'])
assert not mock_context.send_message.called
def main():
parser = argparse.ArgumentParser(description='JEP backend providing CMake editing support.')
parser.add_argument('--version', help='CMake version to be supported, mainly used for completion of built-in commands.', choices=['2.8.12', '3.4'], default='3.4')
parser.add_argument('--builtin-cmake', help='If specified, built-in CMake commands are part of code completion.', action='store_true')
parser.add_argument('--builtin-ctest', help='If specified, built-in ctest commands are part of code completion.', action='store_true')
parser.add_argument('--builtin-deprecated', help='If specified, built-in CMake commands that have been deprecated are part of code completion.', action='store_true')
args = parser.parse_args()
backend = Backend([Listener(cmake_version=args.version,
builtin_commands=args.builtin_cmake,
ctest_commands=args.builtin_ctest,
deprecated_commands=args.builtin_deprecated)])
_logger.info('CMake backend starting up.')
backend.start()
def test_message_context():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[MessageSerializer().serialize(Shutdown()), BlockingIOError])
mock_listener = mock.MagicMock()
backend = Backend([mock_listener])
backend.connection[mock_clientsocket] = FrontendConnection(backend, mock_clientsocket)
backend._receive(mock_clientsocket)
message_context = mock_listener.on_shutdown.call_args[0][0]
assert message_context.service is backend
assert message_context.sock is mock_clientsocket
message_context.send_message(BackendAlive())
assert mock_clientsocket.send.call_count == 1
def test_find_server_port(mock_socket_mod):
# deny binding to any port:
mock_socket_mod.socket().bind = mock.MagicMock(side_effect=OSError)
backend = Backend()
with pytest.raises(NoPortFoundError):
backend.start()
assert PORT_RANGE[0] < PORT_RANGE[1], 'At lest one port should be testable.'
# check if all ports have been tested:
for port in range(PORT_RANGE[0], PORT_RANGE[1]):
assert mock.call(('localhost', port)) in mock_socket_mod.socket().bind.call_args_list
assert backend.state is State.Stopped
def test_bind_and_listen_and_accept_and_disconnect(mock_select_mod, mock_socket_mod, capsys):
backend = Backend()
server_socket = mock_socket_mod.socket()
# mock a connecting frontend:
mock_select_mod.select = mock.MagicMock(return_value=([server_socket], [], []))
client_socket = mock.MagicMock()
server_socket.accept = mock.MagicMock(side_effect=set_backend_state(backend, State.ShutdownPending, [client_socket]))
backend.start()
assert backend.state is State.Stopped
assert server_socket.close.call_count == 1
assert client_socket.close.call_count == 1
out, *_ = capsys.readouterr()
assert 'JEP service, listening on port 9001' in out
def test_find_server_port(mock_socket_mod):
# deny binding to any port:
mock_socket_mod.socket().bind = mock.MagicMock(side_effect=OSError)
backend = Backend()
with pytest.raises(NoPortFoundError):
backend.start()
assert PORT_RANGE[0] < PORT_RANGE[1], 'At lest one port should be testable.'
# check if all ports have been tested:
for port in range(PORT_RANGE[0], PORT_RANGE[1]):
assert mock.call(
('localhost',
port)) in mock_socket_mod.socket().bind.call_args_list
assert backend.state is State.Stopped
def test_message_context():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[
MessageSerializer().serialize(Shutdown()), BlockingIOError
])
mock_listener = mock.MagicMock()
backend = Backend([mock_listener])
backend.connection[mock_clientsocket] = FrontendConnection(
backend, mock_clientsocket)
backend._receive(mock_clientsocket)
message_context = mock_listener.on_shutdown.call_args[0][0]
assert message_context.service is backend
assert message_context.sock is mock_clientsocket
message_context.send_message(BackendAlive())
assert mock_clientsocket.send.call_count == 1
def test_receive_shutdown():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[MessageSerializer().serialize(Shutdown()), BlockingIOError])
mock_listener1 = mock.MagicMock()
mock_listener2 = mock.MagicMock()
backend = Backend([mock_listener1, mock_listener2])
backend.connection[mock_clientsocket] = FrontendConnection(backend, mock_clientsocket)
assert backend.state is not State.ShutdownPending
backend._receive(mock_clientsocket)
# listeners are called:
assert mock_listener1.on_shutdown.call_count == 1
assert mock_listener2.on_shutdown.call_count == 1
# backend reacted to shutdown:
assert backend.state is State.ShutdownPending
def test_bind_and_listen_and_accept_and_disconnect(mock_select_mod,
mock_socket_mod, capsys):
backend = Backend()
server_socket = mock_socket_mod.socket()
# mock a connecting frontend:
mock_select_mod.select = mock.MagicMock(return_value=([server_socket], [],
[]))
client_socket = mock.MagicMock()
server_socket.accept = mock.MagicMock(side_effect=set_backend_state(
backend, State.ShutdownPending, [client_socket]))
backend.start()
assert backend.state is State.Stopped
assert server_socket.close.call_count == 1
assert client_socket.close.call_count == 1
out, *_ = capsys.readouterr()
assert 'JEP service, listening on port 9001' in out
def test_propagate_content_sync_out_of_sync():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[MessageSerializer().serialize(ContentSync('/path/to/file', 'new content', 17, 21)), BlockingIOError])
mock_clientsocket.send = mock.MagicMock()
mock_listener = mock.MagicMock()
backend = Backend([mock_listener])
mock_content_monitor = mock.MagicMock()
mock_content_monitor.synchronize = mock.MagicMock(return_value=SynchronizationResult.OutOfSync)
backend.connection[mock_clientsocket] = FrontendConnection(backend, mock_clientsocket, content_monitor=mock_content_monitor)
backend._receive(mock_clientsocket)
# listeners are called:
assert mock_listener.on_content_sync.call_count == 1
mock_content_monitor.synchronize.assert_called_once_with('/path/to/file', 'new content', 17, 21)
assert mock_clientsocket.send.call_count == 1
arg = mock_clientsocket.send.call_args[0][0]
assert b'OutOfSync' in arg
def test_receive_shutdown():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[
MessageSerializer().serialize(Shutdown()), BlockingIOError
])
mock_listener1 = mock.MagicMock()
mock_listener2 = mock.MagicMock()
backend = Backend([mock_listener1, mock_listener2])
backend.connection[mock_clientsocket] = FrontendConnection(
backend, mock_clientsocket)
assert backend.state is not State.ShutdownPending
backend._receive(mock_clientsocket)
# listeners are called:
assert mock_listener1.on_shutdown.call_count == 1
assert mock_listener2.on_shutdown.call_count == 1
# backend reacted to shutdown:
assert backend.state is State.ShutdownPending
def test_propagate_content_sync():
mock_clientsocket = mock.MagicMock()
mock_clientsocket.recv = mock.MagicMock(side_effect=[MessageSerializer().serialize(ContentSync('/path/to/file', 'new content', 17, 21)), BlockingIOError])
mock_clientsocket.send = mock.MagicMock()
mock_listener = mock.MagicMock()
backend = Backend([mock_listener])
mock_content_monitor = mock.MagicMock()
mock_content_monitor.synchronize = mock.MagicMock(return_value=SynchronizationResult.Updated)
backend.connection[mock_clientsocket] = FrontendConnection(backend, mock_clientsocket, content_monitor=mock_content_monitor)
backend._receive(mock_clientsocket)
# listeners are called:
assert mock_listener.on_content_sync.call_count == 1
mock_content_monitor.synchronize.assert_called_once_with('/path/to/file', 'new content', 17, 21)
assert not mock_clientsocket.send.called
arg = mock_listener.on_content_sync.call_args[0][0]
assert isinstance(arg, ContentSync)
assert arg.file == '/path/to/file'
assert arg.data == 'new content'
assert arg.start == 17
assert arg.end == 21
def test_initial_state():
backend = Backend()
assert not backend.serversocket
assert backend.state is State.Stopped
def test_static_syntax_registration():
mock_syntax_fileset = mock.MagicMock()
backend = Backend(syntax_fileset=mock_syntax_fileset)
backend.register_static_syntax(mock.sentinel.NAME1, mock.sentinel.PATH1, mock.sentinel.FORMAT1, mock.sentinel.extensions)
mock_syntax_fileset.add_syntax_file.assert_called_once_with(mock.sentinel.NAME1, mock.sentinel.PATH1, mock.sentinel.FORMAT1, (mock.sentinel.extensions,))
def test_frontend_timeout(mock_datetime_mod):
now = datetime.datetime.now()
mock_datetime_mod.datetime.now = mock.MagicMock(side_effect=lambda: now)
mock_clientsocket1 = mock.MagicMock()
mock_clientsocket2 = mock.MagicMock()
backend = Backend()
backend.sockets = [mock.sentinel.SERVER_SOCKET, mock_clientsocket1, mock_clientsocket2]
backend.connection[mock_clientsocket1] = FrontendConnection(backend, mock_clientsocket1)
backend.connection[mock_clientsocket2] = FrontendConnection(backend, mock_clientsocket2)
assert TIMEOUT_LAST_MESSAGE > datetime.timedelta(0)
# prevent alive message is mixed into communication:
backend.ts_alive_sent = now
backend._cyclic()
assert not mock_clientsocket1.close.called
assert not mock_clientsocket2.close.called
now += 0.9 * TIMEOUT_LAST_MESSAGE
backend.ts_alive_sent = now
backend._cyclic()
assert not mock_clientsocket1.close.called
assert not mock_clientsocket2.close.called
# now receive a message from one frontend:
mock_clientsocket1.recv = mock.MagicMock(side_effect=[MessageSerializer().serialize(CompletionRequest('t', 'g', 10)), BlockingIOError])
backend._receive(mock_clientsocket1)
now += 0.2 * TIMEOUT_LAST_MESSAGE
backend.ts_alive_sent = now
backend._cyclic()
assert not mock_clientsocket1.close.called
assert mock_clientsocket2.close.called
now += TIMEOUT_LAST_MESSAGE
backend.ts_alive_sent = now
backend._cyclic()
assert mock_clientsocket1.close.called
def test_backend_alive_cycle(mock_datetime_mod):
now = datetime.datetime.now()
mock_datetime_mod.datetime.now = mock.MagicMock(side_effect=lambda: now)
assert TIMEOUT_BACKEND_ALIVE > datetime.timedelta(0)
mock_clientsocket1 = mock.MagicMock()
mock_clientsocket2 = mock.MagicMock()
backend = Backend()
backend.sockets = [
mock.sentinel.SERVER_SOCKET, mock_clientsocket1, mock_clientsocket2
]
backend.connection[mock_clientsocket1] = FrontendConnection(
backend, mock_clientsocket1)
backend.connection[mock_clientsocket2] = FrontendConnection(
backend, mock_clientsocket2)
# cycle must send alive for all newly connected frontends:
backend._cyclic()
assert b'BackendAlive' in mock_clientsocket1.send.call_args[0][0]
assert b'BackendAlive' in mock_clientsocket2.send.call_args[0][0]
# no new alive message before timeout has expired:
now += TIMEOUT_BACKEND_ALIVE * 0.9
mock_clientsocket1.send.reset_mock()
mock_clientsocket2.send.reset_mock()
backend._cyclic()
assert not mock_clientsocket1.called
assert not mock_clientsocket2.called
# but right after:
now += TIMEOUT_BACKEND_ALIVE * 0.15
mock_clientsocket1.send.reset_mock()
mock_clientsocket2.send.reset_mock()
backend._cyclic()
assert b'BackendAlive' in mock_clientsocket1.send.call_args[0][0]
assert b'BackendAlive' in mock_clientsocket2.send.call_args[0][0]
'jep': {
'handlers': ['console'],
'propagate': False,
'level': 'DEBUG'
}
},
'root': {
'level': 'WARNING',
'handlers': ['console']
}
})
_logger = logging.getLogger('jep.backend.sample')
class Listener(FrontendListener):
def on_shutdown(self, context):
_logger.info('Received shutdown in listener.')
def on_completion_request(self, completion_request: CompletionRequest, context):
context.send_message(CompletionResponse(completion_request.pos,
0,
False,
[CompletionOption('cpltextthatisveryverylongmuchlongerthan', 'Something', 'Something to complete')],
completion_request.token))
b = Backend([Listener()])
b.register_static_syntax('mcmake', os.path.join(moduledir, '../input/syntax/mcmake.tmLanguage'), SyntaxFormatType.textmate, '.mcmake')
b.start()
def test_frontend_timeout(mock_datetime_mod):
now = datetime.datetime.now()
mock_datetime_mod.datetime.now = mock.MagicMock(side_effect=lambda: now)
mock_clientsocket1 = mock.MagicMock()
mock_clientsocket2 = mock.MagicMock()
backend = Backend()
backend.sockets = [
mock.sentinel.SERVER_SOCKET, mock_clientsocket1, mock_clientsocket2
]
backend.connection[mock_clientsocket1] = FrontendConnection(
backend, mock_clientsocket1)
backend.connection[mock_clientsocket2] = FrontendConnection(
backend, mock_clientsocket2)
assert TIMEOUT_LAST_MESSAGE > datetime.timedelta(0)
# prevent alive message is mixed into communication:
backend.ts_alive_sent = now
backend._cyclic()
assert not mock_clientsocket1.close.called
assert not mock_clientsocket2.close.called
now += 0.9 * TIMEOUT_LAST_MESSAGE
backend.ts_alive_sent = now
backend._cyclic()
assert not mock_clientsocket1.close.called
assert not mock_clientsocket2.close.called
# now receive a message from one frontend:
mock_clientsocket1.recv = mock.MagicMock(side_effect=[
MessageSerializer().serialize(CompletionRequest('t', 'g', 10)),
BlockingIOError
])
backend._receive(mock_clientsocket1)
now += 0.2 * TIMEOUT_LAST_MESSAGE
backend.ts_alive_sent = now
backend._cyclic()
assert not mock_clientsocket1.close.called
assert mock_clientsocket2.close.called
now += TIMEOUT_LAST_MESSAGE
backend.ts_alive_sent = now
backend._cyclic()
assert mock_clientsocket1.close.called
