BUG: Convert pyperclip & webbrowser errors to warnings

corteva · Jul 19, 2023 · a0c3a2e · a0c3a2e
1 parent d373fdd
commit a0c3a2e
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 3 deletions.
diff --git a/msal_requests_auth/auth/device_code.py b/msal_requests_auth/auth/device_code.py
@@ -2,6 +2,7 @@
 Module for handling the Device Code flow with MSAL and credential refresh.
 """
 import os
+import warnings
 import webbrowser
 from typing import Dict, List, Optional
 
@@ -67,6 +68,15 @@ def _get_access_token(self) -> Dict[str, str]:
         print(flow["message"])
         if not self._headless:
             # copy code to clipboard
-            pyperclip.copy(flow["user_code"])
-            webbrowser.open(flow["verification_uri"])
+            try:
+                pyperclip.copy(flow["user_code"])
+                webbrowser.open(flow["verification_uri"])
+            except Exception as error:  # pylint: disable=broad-exception
+                warnings.warn(
+                    "Error encountered while copying code to clipboard "
+                    f"and opening a webbrowser ({error})."
+                    "To hide this message, set headless=True "
+                    "or set the MSAL_REQUESTS_AUTH_HEADLESS "
+                    "environment variable to 'true'."
+                )
         return self.client.acquire_token_by_device_flow(flow)
diff --git a/msal_requests_auth/cache.py b/msal_requests_auth/cache.py
@@ -113,7 +113,7 @@ def write_cache(self) -> None:
             _import_keyring().set_password(
                 "__msal_requests_auth__", "token", self.serialize()
             )
-        except Exception as error:  # pylint: disable=broad-exception-caught
+        except Exception as error:  # pylint: disable=broad-exception
             # some windows machines have issues writing to keyring
             # win32ctypes.pywin32.pywintypes.error: (1783, 'CredWrite', 'The stub received bad data')
             if getattr(error, "winerror", None) != 1783:

diff --git a/test/test_devide_code.py b/test/test_devide_code.py
@@ -168,3 +168,45 @@ def test_device_code_auth__accounts(pyperclip_patch, webbrowser_patch, pca_mock)
     assert returned_request.headers == {"Authorization": "Bearer TEST TOKEN"}
     webbrowser_patch.open.assert_not_called()
     pyperclip_patch.copy.assert_not_called()
+
+
+@patch.dict(os.environ, {}, clear=True)
+@patch("msal.PublicClientApplication", autospec=True)
+@patch("msal_requests_auth.auth.device_code.webbrowser")
+@patch("msal_requests_auth.auth.device_code.pyperclip")
+def test_device_code_auth__pyperclip_error(pyperclip_patch, webbrowser_patch, pca_mock):
+    pyperclip_patch.copy.side_effect = AttributeError
+    pca_mock.get_accounts.return_value = None
+    pca_mock.initiate_device_flow.return_value = {
+        "message": "TEST MESSAGE",
+        "verification_uri": "TEST URL",
+        "user_code": "TEST CODE",
+    }
+    pca_mock.acquire_token_by_device_flow.return_value = {
+        "token_type": "Bearer",
+        "access_token": "TEST TOKEN",
+    }
+    request_mock = MagicMock()
+    request_mock.headers = {}
+    with pytest.warns(
+        UserWarning,
+        match="Error encountered while copying code to clipboard and opening a webbrowser.",
+    ):
+        returned_request = DeviceCodeAuth(client=pca_mock, scopes=["TEST SCOPE"])(
+            request_mock
+        )
+
+    pca_mock.acquire_token_silent.assert_not_called()
+    pca_mock.initiate_device_flow.assert_called_with(scopes=["TEST SCOPE"])
+    pca_mock.acquire_token_by_device_flow.assert_called_with(
+        {
+            "message": "TEST MESSAGE",
+            "verification_uri": "TEST URL",
+            "user_code": "TEST CODE",
+        }
+    )
+
+    assert returned_request.headers == {"Authorization": "Bearer TEST TOKEN"}
+
+    pyperclip_patch.copy.assert_called_with("TEST CODE")
+    webbrowser_patch.open.assert_not_called()