def main():
project_path = os.getcwd()
try:
tool_utils.validate_web_build_exists(project_path)
except InvalidWebBuildException as e:
print(str(e))
sys.exit(-1)
logging_conf_file = os.path.join(CONFIG_FOLDER, 'logging.json')
with open(logging_conf_file, 'rt') as f:
log_config = json.load(f)
file_utils.prepare_folder(LOG_FOLDER)
logging.config.dictConfig(log_config)
server_version = tool_utils.get_server_version(project_path)
logging.info('Starting Script Server' + (', v' + server_version if server_version else ' (custom version)'))
file_utils.prepare_folder(CONFIG_FOLDER)
file_utils.prepare_folder(TEMP_FOLDER)
migrations.migrate.migrate(TEMP_FOLDER, CONFIG_FOLDER, SERVER_CONF_PATH, LOG_FOLDER)
server_config = server_conf.from_json(SERVER_CONF_PATH, TEMP_FOLDER)
secret = get_secret(server_config.secret_storage_file)
tornado_client_config.initialize()
group_provider = create_group_provider(
server_config.user_groups, server_config.authenticator, server_config.admin_users)
authorizer = Authorizer(
server_config.allowed_users,
server_config.admin_users,
server_config.full_history_users,
group_provider)
config_service = ConfigService(authorizer, CONFIG_FOLDER)
alerts_service = AlertsService(server_config.alerts_config)
alerts_service = alerts_service
execution_logs_path = os.path.join(LOG_FOLDER, 'processes')
log_name_creator = LogNameCreator(
server_config.logging_config.filename_pattern,
server_config.logging_config.date_format)
execution_logging_service = ExecutionLoggingService(execution_logs_path, log_name_creator, authorizer)
existing_ids = [entry.id for entry in execution_logging_service.get_history_entries(None, system_call=True)]
id_generator = IdGenerator(existing_ids)
execution_service = ExecutionService(id_generator)
execution_logging_controller = ExecutionLoggingController(execution_service, execution_logging_service)
execution_logging_controller.start()
user_file_storage = UserFileStorage(secret)
file_download_feature = FileDownloadFeature(user_file_storage, TEMP_FOLDER)
file_download_feature.subscribe(execution_service)
file_upload_feature = FileUploadFeature(user_file_storage, TEMP_FOLDER)
alerter_feature = FailAlerterFeature(execution_service, alerts_service)
alerter_feature.start()
executions_callback_feature = ExecutionsCallbackFeature(execution_service, server_config.callbacks_config)
executions_callback_feature.start()
server.init(
server_config,
server_config.authenticator,
authorizer,
execution_service,
execution_logging_service,
config_service,
alerts_service,
file_upload_feature,
file_download_feature,
secret,
server_version)
class ExecutionLoggingInitiatorTest(unittest.TestCase):
def test_start_logging_on_execution_start(self):
execution_id = self.executor_service.start_script(
create_config_model('my_script'),
{},
'userX',
create_audit_names(ip='localhost'))
executor = self.executor_service.get_active_executor(execution_id)
executor.process_wrapper.finish(0)
entry = self.logging_service.find_history_entry(execution_id, 'userX')
self.assertIsNotNone(entry)
def test_logging_values(self):
param1 = create_script_param_config('p1')
param2 = create_script_param_config('p2', param='-x')
param3 = create_script_param_config('p3', param='-y', no_value=True)
param4 = create_script_param_config('p4', param='-z', type='int')
config_model = create_config_model(
'my_script', script_command='echo', parameters=[param1, param2, param3, param4])
execution_id = self.executor_service.start_script(
config_model,
{'p1': 'abc', 'p3': True, 'p4': 987},
'userX',
create_audit_names(ip='localhost', auth_username='******'))
executor = self.executor_service.get_active_executor(execution_id)
executor.process_wrapper._write_script_output('some text\n')
executor.process_wrapper._write_script_output('another text')
executor.process_wrapper.finish(0)
wait_observable_close_notification(executor.get_anonymized_output_stream(), 2)
entry = self.logging_service.find_history_entry(execution_id, 'userX')
self.assertIsNotNone(entry)
self.assertEqual('userX', entry.user_id)
self.assertEqual('sandy', entry.user_name)
self.assertEqual('my_script', entry.script_name)
self.assertEqual('echo abc -y -z 987', entry.command)
self.assertEqual('my_script', entry.script_name)
log = self.logging_service.find_log(execution_id)
self.assertEqual('some text\nanother text', log)
def test_exit_code(self):
config_model = create_config_model(
'my_script', script_command='ls', parameters=[])
execution_id = self.executor_service.start_script(
config_model,
{},
'userX',
create_audit_names(ip='localhost'))
executor = self.executor_service.get_active_executor(execution_id)
executor.process_wrapper._write_script_output('some text\n')
executor.process_wrapper._write_script_output('another text')
executor.process_wrapper.finish(14)
wait_observable_close_notification(executor.get_anonymized_output_stream(), 2)
entry = self.logging_service.find_history_entry(execution_id, 'userX')
self.assertEqual(14, entry.exit_code)
def setUp(self):
test_utils.setup()
executor._process_creator = _MockProcessWrapper
authorizer = Authorizer([], [], [], EmptyGroupProvider())
self.logging_service = ExecutionLoggingService(test_utils.temp_folder, LogNameCreator(), authorizer)
self.executor_service = ExecutionService(_IdGeneratorMock())
self.controller = ExecutionLoggingController(self.executor_service, self.logging_service)
self.controller.start()
def tearDown(self):
test_utils.cleanup()
executions = self.executor_service.get_active_executions('userX')
for execution_id in executions:
try:
self.executor_service.kill_script(execution_id)
self.executor_service.cleanup_execution(execution_id)
except:
traceback.print_exc()
class ExecutionLoggingInitiatorTest(unittest.TestCase):
def test_start_logging_on_execution_start(self):
execution_id = self.executor_service.start_script(
create_config_model('my_script'),
{},
'userX',
create_audit_names(ip='localhost'))
executor = self.executor_service.get_active_executor(execution_id)
executor.process_wrapper.finish(0)
entry = self.logging_service.find_history_entry(execution_id)
self.assertIsNotNone(entry)
def test_logging_values(self):
param1 = create_script_param_config('p1')
param2 = create_script_param_config('p2', param='-x')
param3 = create_script_param_config('p3', param='-y', no_value=True)
param4 = create_script_param_config('p4', param='-z', type='int')
config_model = create_config_model(
'my_script', script_command='echo', parameters=[param1, param2, param3, param4])
execution_id = self.executor_service.start_script(
config_model,
{'p1': 'abc', 'p3': True, 'p4': 987},
'userX',
create_audit_names(ip='localhost', auth_username='******'))
executor = self.executor_service.get_active_executor(execution_id)
executor.process_wrapper._write_script_output('some text\n')
executor.process_wrapper._write_script_output('another text')
executor.process_wrapper.finish(0)
wait_observable_close_notification(executor.get_anonymized_output_stream(), 2)
entry = self.logging_service.find_history_entry(execution_id)
self.assertIsNotNone(entry)
self.assertEqual('userX', entry.user_id)
self.assertEqual('sandy', entry.user_name)
self.assertEqual('my_script', entry.script_name)
self.assertEqual('echo abc -y -z 987', entry.command)
self.assertEqual('my_script', entry.script_name)
log = self.logging_service.find_log(execution_id)
self.assertEqual('some text\nanother text', log)
def test_exit_code(self):
config_model = create_config_model(
'my_script', script_command='ls', parameters=[])
execution_id = self.executor_service.start_script(
config_model,
{},
'userX',
create_audit_names(ip='localhost'))
executor = self.executor_service.get_active_executor(execution_id)
executor.process_wrapper._write_script_output('some text\n')
executor.process_wrapper._write_script_output('another text')
executor.process_wrapper.finish(14)
wait_observable_close_notification(executor.get_anonymized_output_stream(), 2)
entry = self.logging_service.find_history_entry(execution_id)
self.assertEqual(14, entry.exit_code)
def setUp(self):
test_utils.setup()
executor._process_creator = _MockProcessWrapper
self.logging_service = ExecutionLoggingService(test_utils.temp_folder, LogNameCreator())
self.executor_service = ExecutionService(_IdGeneratorMock())
self.controller = ExecutionLoggingController(self.executor_service, self.logging_service)
self.controller.start()
def tearDown(self):
test_utils.cleanup()
executions = self.executor_service.get_active_executions('userX')
for execution_id in executions:
try:
self.executor_service.kill_script(execution_id)
self.executor_service.cleanup_execution(execution_id)
except:
traceback.print_exc()