Merge pull request #382 from HewlettPackard/upgrade/600/os_volumes

Upgrade/600/os volumes

Author: sijeesh

CHANGELOG.md

@@ -9,6 +9,7 @@ Updated support for HPE Synergy Image Streamer REST API 500/600.
 - Interconnect
 - Network set
 - OS deployment plan
+- OS volume
 - Plan script
 - Storage pool
 - Storage system

endpoints-support.md

@@ -611,9 +611,10 @@
 |<sub> /rest/build-plans/{id}</sub>                                        | PUT              | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |<sub> /rest/build-plans/{id}</sub>                                        | DELETE           | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |     **OS Volumes**                                                                                               |
-|<sub> /rest/os-volumes</sub>                                              | GET              | :white_check_mark: |
-|<sub> /rest/os-volumes/{id}</sub>                                         | GET              | :white_check_mark: |
-|<sub> /rest/os-volumes/archive/{id}</sub>                                 | GET              | :white_check_mark: |
+|<sub> /rest/os-volumes</sub>                                              | GET              | :white_check_mark: |  :white_check_mark:  | :white_check_mark: |
+|<sub> /rest/os-volumes/{id}</sub>                                         | GET              | :white_check_mark: |  :white_check_mark:  | :white_check_mark: |
+|<sub> /rest/os-volumes/archive/{name}</sub>                               | GET              | :white_check_mark: |  :white_check_mark:  | :white_check_mark: |
+|<sub> /rest/os-volumes/{id}/storage</sub>                                 | GET              | :heavy_minus_sign: |  :heavy_minus_sign:  | :white_check_mark: |
 |     **Plan Scripts**                                                                                             |
 |<sub> /rest/plan-scripts</sub>                                            | POST             | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 |<sub> /rest/plan-scripts/differences/{id}</sub>                           | POST             | :white_check_mark: | :white_check_mark: | :white_check_mark: |

examples/image_streamer/os_volumes.py

@@ -55,10 +55,14 @@
 os_volume = image_streamer_client.os_volumes.get_by_name(os_volumes_information['name'])
 pprint(os_volume)
 
+# Get storage details (available only with API version 600 and above)
+print("Get storage details")
+storage = image_streamer_client.os_volumes.get_storage(os_volumes_information['id'])
+pprint(storage)
 
 # Retrieve archived logs of the OS Volume
 print("Retrieve archived logs of the OS Volume")
-if image_streamer_client.os_volumes.download_archive(os_volume['uri'], destination_archive_path):
+if image_streamer_client.os_volumes.download_archive(os_volume['name'], destination_archive_path):
     print("  File downloaded successfully.")
 else:
     print("  Error downloading the file.")

hpOneView/image_streamer/resources/os_volumes.py

@@ -107,16 +107,29 @@ def get_by_name(self, name):
         """
         return self._client.get_by_name(name)
 
-    def download_archive(self, id_or_uri, file_path):
+    def download_archive(self, name, file_path):
         """
-        Download the details of the archived OS Volume.
+        Download archived logs of the OS Volume.
 
         Args:
-            id_or_uri: ID or URI of the OS Volume.
+            name: Name of the OS Volume.
             file_path (str): Destination file path.
 
         Returns:
             bool: Indicates if the resource was successfully downloaded.
         """
-        uri = self.URI + "/archive/" + extract_id_from_uri(id_or_uri)
+        uri = self.URI + "/archive/" + name
         return self._client.download(uri, file_path)
+
+    def get_storage(self, id_or_uri):
+        """
+        Get storage details of an OS Volume.
+
+        Args:
+            id_or_uri: ID or URI of the OS Volume.
+
+        Returns:
+            dict: Storage details
+        """
+        uri = self.URI + "/{}/storage".format(extract_id_from_uri(id_or_uri))
+        return self._client.get(uri)

tests/unit/image_streamer/resources/test_os_volumes.py

@@ -82,9 +82,14 @@ def test_download_archive_called_once_with_id(self, mock_download):
 
     @mock.patch.object(ResourceClient, 'download')
     def test_download_archive_called_once_with_uri(self, mock_download):
-        uri = '/rest/os-volumes/archive/3518be0e-17c1-4189-8f81-83f3724f6155'
+        name = "fake"
+        uri = '/rest/os-volumes/archive/fake'
 
-        self._client.download_archive(uri, "~/archive.log")
+        self._client.download_archive(name, "~/archive.log")
+        mock_download.assert_called_once_with(uri, '~/archive.log')
 
-        mock_download.assert_called_once_with('/rest/os-volumes/archive/3518be0e-17c1-4189-8f81-83f3724f6155',
-                                              '~/archive.log')
+    @mock.patch.object(ResourceClient, 'get')
+    def test_get_storage(self, mock_get):
+        volume_id = '3518be0e-17c1-4189-8f81-83f3724f6155'
+        self._client.get_storage(volume_id)
+        mock_get.assert_called_once_with('/rest/os-volumes/3518be0e-17c1-4189-8f81-83f3724f6155/storage')