Merge pull request #1619 from rackerlabs/PUC-1442

fix: bmc password validation fails incorrectly.

Author: stevekeay

python/understack-workflows/tests/test_bmc_credentials.py

@@ -1,8 +1,6 @@
-from unittest.mock import MagicMock
-
 import pytest
 
-from understack_workflows.bmc import RedfishRequestError
+from understack_workflows.bmc import AuthException
 from understack_workflows.bmc_credentials import set_bmc_password
 
 
@@ -14,17 +12,28 @@ def mock_getsession(mocker):
 
 
 @pytest.fixture
-def mock_close(mocker):
-    mock = mocker.patch("understack_workflows.bmc_credentials.Bmc.close_session")
+def mock_sleep(mocker):
+    mock = mocker.patch("understack_workflows.bmc_credentials.sleep", return_value=None)
+    return mock
+
+
+@pytest.fixture
+def mock_getsession_failed(mocker):
+    mock = mocker.patch("understack_workflows.bmc_credentials.Bmc.get_session")
+    mock.side_effect = [
+        (None, None),
+        (None, None),
+        (None, None),
+        (None, None),
+        (None, None),
+    ]  # patching 5 requests for session attempts.
     return mock
 
 
 @pytest.fixture
-def mock_fail_auth(mocker):
-    mock_response = MagicMock()
-    mock_response.status_code = 402
-    mock_response.json.return_value = {"message": "Failure"}
-    mock = mocker.patch("requests.request", return_value=mock_response)
+def mock_close(mocker):
+    mock = mocker.patch("understack_workflows.bmc_credentials.Bmc.close_session")
+    mock.return_value = None
     return mock
 
 
@@ -34,6 +43,6 @@ def test_set_bmc_password_noop(mock_getsession, mock_close):
     mock_close.assert_called_with(session="/path/to/session/1234", token="tOkEn")
 
 
-def test_set_bmc_password_failed(mock_fail_auth):
-    with pytest.raises(RedfishRequestError):
+def test_set_bmc_password_failed(mock_getsession_failed, mock_sleep):
+    with pytest.raises(AuthException):
         set_bmc_password("1.2.3.4", "qwertyuiop")

python/understack-workflows/understack_workflows/bmc_credentials.py

@@ -3,6 +3,7 @@
 
 from understack_workflows.bmc import AuthException
 from understack_workflows.bmc import Bmc
+from understack_workflows.bmc import RedfishRequestError
 from understack_workflows.helpers import setup_logger
 
 FACTORY_B64 = b"Y2FsdmluLGNhbHZpbmNhbHZpbixjYWx2aW4xLGNhbHZpbmNhbHZpbjE="
@@ -33,7 +34,11 @@ def set_bmc_password(
     """
     bmc = Bmc(ip_address=ip_address, username=username, password=new_password)
 
-    token, session = bmc.get_session(new_password)
+    try:
+        token, session = bmc.get_session(new_password)
+    except RedfishRequestError as e:
+        logger.debug("Password test for %s failed. %s", ip_address, e)
+        token, session = None, None
     if token and session:
         logger.info("Production BMC credentials are working on this BMC.")
         bmc.close_session(session=session, token=token)
@@ -45,7 +50,11 @@ def set_bmc_password(
     )
 
     for test_password in filter(None, [old_password, *FACTORY_PASSWORDS]):
-        token, session = bmc.get_session(test_password)
+        try:
+            token, session = bmc.get_session(test_password)
+        except RedfishRequestError as e:
+            logger.debug("Password test for %s failed. %s", ip_address, e)
+            token, session = None, None
         if token and session:
             break
         # Go Slow, or else the BMC will lock us out for a