converted tests to use pytest-mock

Pipfile

@@ -43,3 +43,4 @@ pytest-random-order = "==1.0.0"
 pytest = "==3.9.3"
 sip = "==4.19.8"
 six = "==1.11.0"
+pytest-mock = "==1.10.0"

tests/gui/test_main.py

@@ -5,218 +5,220 @@
 from securedrop_client.gui.main import Window
 from securedrop_client.resources import load_icon
 from securedrop_client.models import Submission
-from unittest import mock
 
 
 app = QApplication([])
 
 
-def test_init():
+def test_init(mocker):
     """
     Ensure the Window instance is setup in the expected manner.
     """
-    mock_li = mock.MagicMock(return_value=load_icon('icon.png'))
-    mock_lo = mock.MagicMock(return_value=QVBoxLayout())
-    mock_lo().addWidget = mock.MagicMock()
-    with mock.patch('securedrop_client.gui.main.load_icon', mock_li), \
-            mock.patch('securedrop_client.gui.main.ToolBar') as mock_tb, \
-            mock.patch('securedrop_client.gui.main.MainView') as mock_mv, \
-            mock.patch('securedrop_client.gui.main.QVBoxLayout', mock_lo), \
-            mock.patch('securedrop_client.gui.main.QMainWindow'):
-        w = Window()
-        mock_li.assert_called_once_with(w.icon)
-        mock_tb.assert_called_once_with(w.widget)
-        mock_mv.assert_called_once_with(w.widget)
-        assert mock_lo().addWidget.call_count == 2
+    mock_li = mocker.MagicMock(return_value=load_icon('icon.png'))
+    mock_lo = mocker.MagicMock(return_value=QVBoxLayout())
+    mock_lo().addWidget = mocker.MagicMock()
 
+    mocker.patch('securedrop_client.gui.main.load_icon', mock_li)
+    mock_tb = mocker.patch('securedrop_client.gui.main.ToolBar')
+    mock_mv = mocker.patch('securedrop_client.gui.main.MainView')
+    mocker.patch('securedrop_client.gui.main.QVBoxLayout', mock_lo)
+    mocker.patch('securedrop_client.gui.main.QMainWindow')
 
-def test_setup():
+    w = Window()
+    mock_li.assert_called_once_with(w.icon)
+    mock_tb.assert_called_once_with(w.widget)
+    mock_mv.assert_called_once_with(w.widget)
+    assert mock_lo().addWidget.call_count == 2
+
+
+def test_setup(mocker):
     """
     Ensure the passed in controller is referenced and the various views are
     instantiated as expected.
     """
     w = Window()
-    mock_controller = mock.MagicMock()
+    mock_controller = mocker.MagicMock()
     w.setup(mock_controller)
     assert w.controller == mock_controller
 
 
-def test_autosize_window():
+def test_autosize_window(mocker):
     """
     Check the autosizing fits to the full screen size.
     """
     w = Window()
-    w.resize = mock.MagicMock()
-    mock_screen = mock.MagicMock()
+    w.resize = mocker.MagicMock()
+    mock_screen = mocker.MagicMock()
     mock_screen.width.return_value = 1024
     mock_screen.height.return_value = 768
-    mock_sg = mock.MagicMock()
+    mock_sg = mocker.MagicMock()
     mock_sg.screenGeometry.return_value = mock_screen
-    mock_qdw = mock.MagicMock(return_value=mock_sg)
-    with mock.patch('securedrop_client.gui.main.QDesktopWidget', mock_qdw):
-        w.autosize_window()
+    mock_qdw = mocker.MagicMock(return_value=mock_sg)
+    mocker.patch('securedrop_client.gui.main.QDesktopWidget', mock_qdw)
+    w.autosize_window()
     w.resize.assert_called_once_with(1024, 768)
 
 
-def test_show_login():
+def test_show_login(mocker):
     """
     The login dialog is displayed with a clean state.
     """
-    mock_controller = mock.MagicMock()
+    mock_controller = mocker.MagicMock()
     w = Window()
     w.setup(mock_controller)
-    with mock.patch('securedrop_client.gui.main.LoginDialog') as mock_ld:
-        w.show_login()
-        mock_ld.assert_called_once_with(w)
+
+    mock_ld = mocker.patch('securedrop_client.gui.main.LoginDialog')
+    w.show_login()
+
+    mock_ld.assert_called_once_with(w)
     w.login_dialog.reset.assert_called_once_with()
     w.login_dialog.exec.assert_called_once_with()
 
 
-def test_show_login_error():
+def test_show_login_error(mocker):
     """
     Ensures that an error message is displayed in the login dialog.
     """
-    mock_controller = mock.MagicMock()
+    mock_controller = mocker.MagicMock()
     w = Window()
     w.setup(mock_controller)
-    w.login_dialog = mock.MagicMock()
+    w.login_dialog = mocker.MagicMock()
     w.show_login_error('boom')
     w.login_dialog.error.assert_called_once_with('boom')
 
 
-def test_hide_login():
+def test_hide_login(mocker):
     """
     Ensure the login dialog is closed and hidden.
     """
-    mock_controller = mock.MagicMock()
+    mock_controller = mocker.MagicMock()
     w = Window()
     w.setup(mock_controller)
-    ld = mock.MagicMock()
+    ld = mocker.MagicMock()
     w.login_dialog = ld
     w.hide_login()
     ld.accept.assert_called_once_with()
     assert w.login_dialog is None
 
 
-def test_show_sources():
+def test_show_sources(mocker):
     """
     Ensure the sources list is passed to the source list widget to be updated.
     """
     w = Window()
-    w.main_view = mock.MagicMock()
+    w.main_view = mocker.MagicMock()
     w.show_sources([1, 2, 3])
     w.main_view.source_list.update.assert_called_once_with([1, 2, 3])
 
 
-def test_update_error_status():
+def test_update_error_status(mocker):
     """
     Ensure that the error to be shown in the error status sidebar will
     be passed to the left sidebar for display.
     """
     error_message = "this is a bad thing!"
     w = Window()
-    w.main_view = mock.MagicMock()
+    w.main_view = mocker.MagicMock()
     w.update_error_status(error=error_message)
     w.main_view.update_error_status.assert_called_once_with(error_message)
 
 
-def test_show_sync():
+def test_show_sync(mocker):
     """
     If there's a value display the result of its "humanize" method.
     """
     w = Window()
-    w.main_view = mock.MagicMock()
-    updated_on = mock.MagicMock()
+    w.main_view = mocker.MagicMock()
+    updated_on = mocker.MagicMock()
     w.show_sync(updated_on)
-    w.main_view.status.setText.assert_called_once_with('Last refresh: ' +
-                                                       updated_on.humanize())
+    w.main_view.status.setText.assert_called_once_with('Last refresh: ' + updated_on.humanize())
 
 
-def test_show_sync_no_sync():
+def test_show_sync_no_sync(mocker):
     """
     If there's no value to display, default to a "waiting" message.
     """
     w = Window()
-    w.main_view = mock.MagicMock()
+    w.main_view = mocker.MagicMock()
     w.show_sync(None)
-    w.main_view.status.setText.\
-        assert_called_once_with('Waiting to refresh...')
+    w.main_view.status.setText.assert_called_once_with('Waiting to refresh...')
 
 
-def test_set_logged_in_as():
+def test_set_logged_in_as(mocker):
     """
     Given a username, the toolbar is appropriately called to update.
     """
     w = Window()
-    w.tool_bar = mock.MagicMock()
+    w.tool_bar = mocker.MagicMock()
     w.set_logged_in_as('test')
     w.tool_bar.set_logged_in_as.assert_called_once_with('test')
 
 
-def test_logout():
+def test_logout(mocker):
     """
     Ensure the toolbar updates to the logged out state.
     """
     w = Window()
-    w.tool_bar = mock.MagicMock()
+    w.tool_bar = mocker.MagicMock()
     w.logout()
     w.tool_bar.set_logged_out.assert_called_once_with()
 
 
-def test_on_source_changed():
+def test_on_source_changed(mocker):
     """
     Ensure the event handler for when a source is changed calls the
     show_conversation_for method with the expected source object.
     """
     w = Window()
-    w.main_view = mock.MagicMock()
+    w.main_view = mocker.MagicMock()
     w.main_view.source_list.currentItem()
     mock_sw = w.main_view.source_list.itemWidget()
-    w.show_conversation_for = mock.MagicMock()
+    w.show_conversation_for = mocker.MagicMock()
     w.on_source_changed()
     w.show_conversation_for.assert_called_once_with(mock_sw.source)
 
 
-def test_conversation_for():
+def test_conversation_for(mocker):
     """
     Test that the source collection is displayed in the conversation view.
     """
     w = Window()
-    w.controller = mock.MagicMock()
-    w.main_view = mock.MagicMock()
-    mock_conview = mock.MagicMock()
-    mock_source = mock.MagicMock()
+    w.controller = mocker.MagicMock()
+    w.main_view = mocker.MagicMock()
+    mock_conview = mocker.MagicMock()
+    mock_source = mocker.MagicMock()
     mock_source.journalistic_designation = 'Testy McTestface'
-    mock_file = mock.MagicMock()
+    mock_file = mocker.MagicMock()
     mock_file.filename = '1-my-source-doc.gpg'
-    mock_message = mock.MagicMock()
+    mock_message = mocker.MagicMock()
     mock_message.filename = '2-my-source-msg.gpg'
-    mock_reply = mock.MagicMock()
+    mock_reply = mocker.MagicMock()
     mock_reply.filename = '3-my-source-reply.gpg'
     mock_source.collection = [mock_file, mock_message, mock_reply]
-    with mock.patch(
-        'securedrop_client.gui.main.ConversationView', mock_conview
-    ), \
-            mock.patch('securedrop_client.gui.main.QVBoxLayout'), \
-            mock.patch('securedrop_client.gui.main.QWidget'):
-        w.show_conversation_for(mock_source)
+
+    mocker.patch('securedrop_client.gui.main.ConversationView', mock_conview)
+    mocker.patch('securedrop_client.gui.main.QVBoxLayout')
+    mocker.patch('securedrop_client.gui.main.QWidget')
+
+    w.show_conversation_for(mock_source)
     conv = mock_conview()
+
     assert conv.add_message.call_count > 0
     assert conv.add_reply.call_count > 0
     assert conv.add_file.call_count > 0
 
 
-def test_conversation_pending_message():
+def test_conversation_pending_message(mocker):
     """
     Test that a conversation with a message that's not yet downloaded
     shows the right placeholder text
     """
     w = Window()
-    w.controller = mock.MagicMock()
-    w.main_view = mock.MagicMock()
-    w._add_item_content_or = mock.MagicMock()
-    mock_conview = mock.MagicMock()
-    mock_source = mock.MagicMock()
+    w.controller = mocker.MagicMock()
+    w.main_view = mocker.MagicMock()
+    w._add_item_content_or = mocker.MagicMock()
+    mock_conview = mocker.MagicMock()
+    mock_source = mocker.MagicMock()
     mock_source.journalistic_designation = 'Testy McTestface'
 
     submission = Submission(source=mock_source, uuid="test", size=123,
@@ -227,26 +229,24 @@ def test_conversation_pending_message():
 
     mock_source.collection = [submission]
 
-    with mock.patch(
-        'securedrop_client.gui.main.ConversationView', mock_conview
-    ), \
-            mock.patch('securedrop_client.gui.main.QVBoxLayout'), \
-            mock.patch('securedrop_client.gui.main.QWidget'):
-        w.show_conversation_for(mock_source)
-        conv = mock_conview()
+    mocker.patch('securedrop_client.gui.main.ConversationView', mock_conview)
+    mocker.patch('securedrop_client.gui.main.QVBoxLayout')
+    mocker.patch('securedrop_client.gui.main.QWidget')
+
+    w.show_conversation_for(mock_source)
+    conv = mock_conview()
 
-        # once for source name, once for message
-        assert conv.add_message.call_count == 2
-        assert conv.add_message.call_args == \
-            mock.call("<Message not yet downloaded>")
+    # once for source name, once for message
+    assert conv.add_message.call_count == 2
+    assert conv.add_message.call_args == mocker.call("<Message not yet downloaded>")
 
 
-def test_set_status():
+def test_set_status(mocker):
 
     """
     Ensure the status bar's text is updated.
     """
     w = Window()
-    w.status_bar = mock.MagicMock()
+    w.status_bar = mocker.MagicMock()
     w.set_status('hello', 100)
     w.status_bar.showMessage.assert_called_once_with('hello', 100)