def main() -> int:
command_line_args = parse_commandline()
exit_code_str = command_line_args.exit_code
exit_code = int(exit_code_str)
if mantid.config['usagereports.enabled'] != '1':
return exit_code
# On Windows/macOS the plugin locations need to be known before starting
# QApplication
if command_line_args.qtdir is not None:
QCoreApplication.addLibraryPath(command_line_args.qtdir)
# Qt resources must be imported before QApplication starts
importlib.import_module(
f'mantidqt.dialogs.errorreports.resources_qt{QT_VERSION[0]}')
from qtpy.QtWidgets import QApplication
app = QApplication(sys.argv)
form = CrashReportPage(show_continue_terminate=False)
presenter = ErrorReporterPresenter(form, exit_code_str,
command_line_args.application)
presenter.show_view()
app.exec_()
return exit_code
def main(argv: Sequence[str] = None) -> int:
argv = argv if argv is not None else sys.argv
command_line_args = parse_commandline(argv)
exit_code_str = command_line_args.exit_code
exit_code = int(exit_code_str)
if mantid.config['usagereports.enabled'] != '1':
return exit_code
# On Windows/macOS the plugin locations need to be known before starting
# QApplication
if command_line_args.qtdir is not None:
QCoreApplication.addLibraryPath(command_line_args.qtdir)
# Qt resources must be imported before QApplication starts
importlib.import_module(f'mantidqt.dialogs.errorreports.resources_qt{QT_VERSION[0]}')
if sys.platform == 'darwin':
qtutils.force_layer_backing_BigSur()
from qtpy.QtWidgets import QApplication
app = QApplication(argv)
# The strings APPNAME, ORG_DOMAIN, ORGANIZATION are duplicated from workbench.config
app.setOrganizationName(command_line_args.org_name)
app.setOrganizationDomain(command_line_args.org_domain)
app.setApplicationName(command_line_args.application)
QSettings.setDefaultFormat(QSettings.IniFormat)
form = CrashReportPage(show_continue_terminate=False)
presenter = ErrorReporterPresenter(form, exit_code_str, command_line_args.application)
presenter.show_view()
app.exec_()
return exit_code
def exception_logger(main_window, exc_type, exc_value, exc_traceback):
"""
Captures ALL EXCEPTIONS.
Prevents the Workbench from crashing silently, instead it logs the error on ERROR level.
:param main_window: A reference to the main window, that will be used to close it in case of the user
choosing to terminate the execution.
:param exc_type: The type of the exception
:param exc_value: Value of the exception, typically contains the error message.
:param exc_traceback: Stack trace of the exception.
"""
logger.error("".join(
traceback.format_exception(exc_type, exc_value, exc_traceback)))
if UsageService.isEnabled():
page = CrashReportPage(show_continue_terminate=True)
presenter = ErrorReporterPresenter(
page, '', 'workbench',
traceback.format_exception(exc_type, exc_value, exc_traceback))
presenter.show_view_blocking()
if not page.continue_working:
main_window.close()
else:
# show the exception message without the traceback
WorkbenchErrorMessageBox(
main_window,
"".join(traceback.format_exception_only(exc_type,
exc_value))).exec_()
def setUp(self):
self.logger_mock_instance = mock.MagicMock()
logger_patcher = mock.patch(f'{self.PRESENTER_CLS_PATH}.Logger')
self.addCleanup(logger_patcher.stop)
self.logger_mock = logger_patcher.start()
self.logger_mock.return_value = self.logger_mock_instance
self.errorreport_mock_instance = mock.MagicMock()
errorreport_patcher = mock.patch(
f'{self.PRESENTER_CLS_PATH}.ErrorReporter')
self.addCleanup(errorreport_patcher.stop)
self.errorreport_mock = errorreport_patcher.start()
self.errorreport_mock.return_value = self.errorreport_mock_instance
self.view = mock.MagicMock()
self.exit_code = 255
self.app_name = 'ErrorReportPresenterTest'
self.error_report_presenter = ErrorReporterPresenter(
self.view, self.exit_code, application=self.app_name)
def setUp(self):
self.logger_mock_instance = mock.MagicMock()
logger_patcher = mock.patch(f'{self.PRESENTER_CLS_PATH}.Logger')
self.addCleanup(logger_patcher.stop)
self.logger_mock = logger_patcher.start()
self.logger_mock.return_value = self.logger_mock_instance
self.errorreport_mock_instance = mock.MagicMock()
errorreport_patcher = mock.patch(
f'{self.PRESENTER_CLS_PATH}.ErrorReporter')
self.addCleanup(errorreport_patcher.stop)
self.errorreport_mock = errorreport_patcher.start()
self.errorreport_mock.return_value = self.errorreport_mock_instance
self.view = mock.MagicMock()
self.exit_code = 255
self.app_name = 'ErrorReportPresenterTest'
self.error_report_presenter = ErrorReporterPresenter(
self.view, self.exit_code, application=self.app_name)
self.view.CONTACT_INFO = "ContactInfo"
self.view.NAME = 'John Smith'
self.view.EMAIL = '*****@*****.**'
class ErrorReportPresenterTest(unittest.TestCase):
PRESENTER_CLS_PATH = 'mantidqt.dialogs.errorreports.presenter'
def setUp(self):
self.logger_mock_instance = mock.MagicMock()
logger_patcher = mock.patch(f'{self.PRESENTER_CLS_PATH}.Logger')
self.addCleanup(logger_patcher.stop)
self.logger_mock = logger_patcher.start()
self.logger_mock.return_value = self.logger_mock_instance
self.errorreport_mock_instance = mock.MagicMock()
errorreport_patcher = mock.patch(
f'{self.PRESENTER_CLS_PATH}.ErrorReporter')
self.addCleanup(errorreport_patcher.stop)
self.errorreport_mock = errorreport_patcher.start()
self.errorreport_mock.return_value = self.errorreport_mock_instance
self.view = mock.MagicMock()
self.exit_code = 255
self.app_name = 'ErrorReportPresenterTest'
self.error_report_presenter = ErrorReporterPresenter(
self.view, self.exit_code, application=self.app_name)
def test_sets_logger_view_and_exit_code_upon_construction(self):
self.assertEqual(self.error_report_presenter._exit_code,
self.exit_code)
self.assertEqual(self.error_report_presenter._view, self.view)
self.assertEqual(self.error_report_presenter.error_log,
self.logger_mock_instance)
def test_do_not_share_with_continue_performs_appropriate_logging(self):
self.error_report_presenter.do_not_share(continue_working=True)
self.logger_mock_instance.notice.assert_called_once_with(
"No information shared")
self.logger_mock_instance.error.assert_called_once_with(
"Continue working.")
self.assertEqual(self.view.quit.call_count, 0)
def test_do_not_share_without_continue_performs_appropriate_logging(self):
self.error_report_presenter.do_not_share(continue_working=False)
self.logger_mock_instance.notice.assert_called_once_with(
"No information shared")
self.logger_mock_instance.error.assert_called_once_with(
"Terminated by user.")
self.assertEqual(self.view.quit.call_count, 1)
def test_send_error_report_to_server_calls_ErrorReport_correctly(self):
name = 'John Smith'
email = '*****@*****.**'
text_box = 'details of error'
uptime = 'time_string'
self.errorreport_mock_instance.sendErrorReport.return_value = 201
self.error_report_presenter._send_report_to_server(False,
name=name,
email=email,
uptime=uptime,
text_box=text_box)
self.errorreport_mock.assert_called_once_with(self.app_name, uptime,
self.exit_code, False,
name, email, text_box,
'')
self.errorreport_mock_instance.sendErrorReport.assert_called_once_with(
)
def test_send_error_report_to_server_calls_ErrorReport_correctly_and_triggers_view_upon_failure(
self):
name = 'John Smith'
email = '*****@*****.**'
uptime = 'time_string'
text_box = 'details of error'
self.errorreport_mock_instance.sendErrorReport.return_value = 500
self.error_report_presenter._send_report_to_server(True,
name=name,
email=email,
uptime=uptime,
text_box=text_box)
self.errorreport_mock.assert_called_once_with(self.app_name, uptime,
self.exit_code, True,
name, email, text_box,
'')
self.errorreport_mock_instance.sendErrorReport.assert_called_once_with(
)
self.view.display_message_box.assert_called_once_with(
'Error contacting server',
ErrorReporterPresenter.SENDING_ERROR_MESSAGE,
'http request returned with status 500')
def test_error_handler_share_all_sunny_day_case(self):
name = 'John Smith'
email = '*****@*****.**'
text_box = 'Details about error'
continue_working = False
share = 0
self.error_report_presenter._send_report_to_server = mock.MagicMock(
return_value=201)
self.error_report_presenter._handle_exit = mock.MagicMock()
self.error_report_presenter.error_handler(continue_working, share,
name, email, text_box)
self.error_report_presenter._send_report_to_server.called_once_with(
share_identifiable=True,
name=name,
email=email,
uptime=mock.ANY,
text_box=text_box)
self.error_report_presenter._handle_exit.assert_called_once_with(False)
def test_error_handler_share_non_id_sunny_day_case(self):
name = 'John Smith'
email = '*****@*****.**'
text_box = 'Details about error'
continue_working = True
share = 1
self.error_report_presenter._send_report_to_server = mock.MagicMock()
self.error_report_presenter._handle_exit = mock.MagicMock()
self.error_report_presenter.error_handler(continue_working, share,
name, email, text_box)
self.error_report_presenter._send_report_to_server.called_once_with(
share_identifiable=False, uptime=mock.ANY)
self.error_report_presenter._handle_exit.assert_called_once_with(True)
def test_error_handler_share_nothing_sunny_day_case(self):
name = 'John Smith'
email = '*****@*****.**'
text_box = 'Details about error'
continue_working = True
share = 2
self.error_report_presenter._send_report_to_server = mock.MagicMock()
self.error_report_presenter._handle_exit = mock.MagicMock()
self.error_report_presenter.error_handler(continue_working, share,
name, email, text_box)
self.assertEqual(
self.error_report_presenter._send_report_to_server.call_count, 0)
self.error_report_presenter._handle_exit.assert_called_once_with(True)