Merge pull request #143 from networktocode/develop

Author: jmcgill298

CHANGELOG.md

@@ -13,6 +13,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/)
 ### Security
 
 
+##  [0.0.11]
+
+### Added
+- AIREOSDevice property, ``peer_redundancy_state`` for standby device status
+
+### Changed
+- AIREOSDevice ``os_install`` method verifies standby device is in same state as before install
+
 ## [0.0.10]
 ### Added
 - Cisco WLC/AireOS Driver

pyntc/__init__.py

@@ -12,7 +12,7 @@
 except ImportError:
     from ConfigParser import SafeConfigParser
 
-__version__ = "0.0.10"
+__version__ = "0.0.11"
 
 LIB_PATH_ENV_VAR = "PYNTC_CONF"
 LIB_PATH_DEFAULT = "~/.ntc.conf"

pyntc/devices/aireos_device.py

@@ -417,11 +417,14 @@ def install_os(self, image_name, controller="both", save_config=True, **vendor_s
         """
         timeout = vendor_specifics.get("timeout", 3600)
         if not self._image_booted(image_name):
+            peer_redundancy = self.peer_redundancy_state
             self.set_boot_options(image_name, **vendor_specifics)
             self.reboot(confirm=True, controller=controller, save_config=save_config)
             self._wait_for_device_reboot(timeout=timeout)
             if not self._image_booted(image_name):
                 raise OSInstallError(hostname=self.host, desired_boot=image_name)
+            if not self.peer_redundancy_state == peer_redundancy:
+                raise OSInstallError(hostname=f"{self.host}-standby", desired_boot=image_name)
 
             return True
 
@@ -456,6 +459,24 @@ def open(self):
         if not self.redundancy_state:
             self.close()
 
+    @property
+    def peer_redundancy_state(self):
+        """
+        Determine the state of the peer device.
+
+        Returns:
+            str: The Peer State from the local device's perspective.
+
+        Example:
+            >>> device = AIREOSDevice(**connection_args)
+            >>> device.peer_redundancy_state
+            'standby hot'
+            >>>
+        """
+        ha = self.show("show redundancy summary")
+        ha_peer_state = re.search(r"^\s*Peer\s+State\s*=\s*(.+?)\s*$", ha, re.M)
+        return ha_peer_state.group(1).lower()
+
     def reboot(self, timer=0, confirm=False, controller="self", save_config=True):
         """
         Reload the controller or controller pair.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "pyntc"
-version = "0.0.10"
+version = "0.0.11"
 description = "SDK to simplify common workflows for Network Devices."
 authors = ["NTC <[email protected]>"]
 readme = "README.md"

test/unit/test_devices/device_mocks/aireos/show_redundancy_summary_standalone.txt

@@ -1,6 +1,9 @@
  Redundancy Mode = SSO DISABLED 
      Local State = ACTIVE 
+      Peer State = N/A
             Unit = Primary
          Unit ID = AB:12:CD:34:EF:56
-Redundancy State = SSO DISABLED
+Redundancy State = N/A
     Mobility MAC = AB:12:CD:34:EF:56
+Redundancy Port = DOWN
+ Link Encryption = Enabled

test/unit/test_devices/test_aireos_device.py

@@ -264,12 +264,14 @@ def test_file_copy_error(mock_cftv, aireos_device_path, aireos_send_command_timi
 @mock.patch.object(AIREOSDevice, "set_boot_options")
 @mock.patch.object(AIREOSDevice, "reboot")
 @mock.patch.object(AIREOSDevice, "_wait_for_device_reboot")
-def test_install_os(mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
+@mock.patch.object(AIREOSDevice, "peer_redundancy_state", new_callable=mock.PropertyMock)
+def test_install_os(mock_prs, mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
     device = aireos_image_booted([False, True])
     assert device.install_os(aireos_boot_image) is True
     device._image_booted.assert_has_calls([mock.call(aireos_boot_image)] * 2)
     mock_sbo.assert_has_calls([mock.call(aireos_boot_image)])
     mock_reboot.assert_called_with(confirm=True, controller="both", save_config=True)
+    mock_prs.assert_called()
 
 
 def test_install_os_no_install(aireos_image_booted, aireos_boot_image):
@@ -281,17 +283,33 @@ def test_install_os_no_install(aireos_image_booted, aireos_boot_image):
 @mock.patch.object(AIREOSDevice, "set_boot_options")
 @mock.patch.object(AIREOSDevice, "reboot")
 @mock.patch.object(AIREOSDevice, "_wait_for_device_reboot")
-def test_install_os_error(mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
+@mock.patch.object(AIREOSDevice, "peer_redundancy_state", new_callable=mock.PropertyMock)
+def test_install_os_error(mock_prs, mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
     device = aireos_image_booted([False, False])
-    with pytest.raises(OSInstallError):
+    with pytest.raises(OSInstallError) as boot_error:
         device.install_os(aireos_boot_image)
+    assert boot_error.value.message == f"{device.host} was unable to boot into {aireos_boot_image}"
     device._image_booted.assert_has_calls([mock.call(aireos_boot_image)] * 2)
 
 
 @mock.patch.object(AIREOSDevice, "set_boot_options")
 @mock.patch.object(AIREOSDevice, "reboot")
 @mock.patch.object(AIREOSDevice, "_wait_for_device_reboot")
-def test_install_os_pass_args(mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
+@mock.patch.object(AIREOSDevice, "peer_redundancy_state", new_callable=mock.PropertyMock)
+def test_install_os_error_peer(mock_prs, mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
+    mock_prs.side_effect = ["standby hot", "unknown"]
+    device = aireos_image_booted([False, True])
+    with pytest.raises(OSInstallError) as boot_error:
+        device.install_os(aireos_boot_image)
+    assert boot_error.value.message == f"{device.host}-standby was unable to boot into {aireos_boot_image}"
+    device._image_booted.assert_has_calls([mock.call(aireos_boot_image)] * 2)
+
+
+@mock.patch.object(AIREOSDevice, "set_boot_options")
+@mock.patch.object(AIREOSDevice, "reboot")
+@mock.patch.object(AIREOSDevice, "_wait_for_device_reboot")
+@mock.patch.object(AIREOSDevice, "peer_redundancy_state", new_callable=mock.PropertyMock)
+def test_install_os_pass_args(mock_prs, mock_wait, mock_reboot, mock_sbo, aireos_image_booted, aireos_boot_image):
     device = aireos_image_booted([False, True])
     assert device.install_os(aireos_boot_image, controller="self", save_config=False) is True
     mock_reboot.assert_called_with(confirm=True, controller="self", save_config=False)
@@ -340,6 +358,16 @@ def test_open_standby(mock_ch, aireos_device, aireos_redundancy_state_path):
     assert aireos_device.connected is False
 
 
+def test_peer_redundancy_state_standby_hot(aireos_show):
+    device = aireos_show(["show_redundancy_summary_sso_enabled.txt"])
+    assert device.peer_redundancy_state == "standby hot"
+
+
+def test_peer_redundancy_state_standalone(aireos_show):
+    device = aireos_show(["show_redundancy_summary_standalone.txt"])
+    assert device.peer_redundancy_state == "n/a"
+
+
 @mock.patch("pyntc.devices.aireos_device.RebootSignal")
 @mock.patch.object(AIREOSDevice, "save")
 def test_reboot_confirm(mock_save, mock_reboot, aireos_send_command_timing, aireos_redundancy_mode_path):