Merge pull request #379 from HewlettPackard/api500/600/planscripts

Api500/600/planscripts

Author: AnushaY1916

CHANGELOG.md

@@ -8,6 +8,7 @@ Extends support of the SDK to OneView Rest API version 600 (OneView v4.0).
 - Interconnect
 - Network set
 - OS deployment plan
+- Plan script
 - Storage pool
 - Storage volume
 

endpoints-support.md

@@ -615,10 +615,10 @@
 |<sub> /rest/os-volumes/{id}</sub>                                         | GET              | :white_check_mark: |
 |<sub> /rest/os-volumes/archive/{id}</sub>                                 | GET              | :white_check_mark: |
 |     **Plan Scripts**                                                                                             |
-|<sub> /rest/plan-scripts</sub>                                            | POST             | :white_check_mark: |
-|<sub> /rest/plan-scripts/differences/{id}</sub>                           | POST             | :white_check_mark: |
-|<sub> /rest/plan-scripts</sub>                                            | GET              | :white_check_mark: |
-|<sub> /rest/plan-scripts/{id}</sub>                                       | GET              | :white_check_mark: |
-|<sub> /rest/plan-scripts/{id}</sub>                                       | PUT              | :white_check_mark: |
-|<sub> /rest/plan-scripts/{id}</sub>                                       | DELETE           | :white_check_mark: |
-
+|<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: |
+|<sub> /rest/plan-scripts</sub>                                            | GET              | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|<sub> /rest/plan-scripts/{id}</sub>                                       | GET              | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|<sub> /rest/plan-scripts/{id}</sub>                                       | PUT              | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|<sub> /rest/plan-scripts/{id}</sub>                                       | DELETE           | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|<sub> /rest/plan-scripts/{id}/usedby/readonly</sub>                       | GET              | :heavy_minus_sign: | :heavy_minus_sign: | :white_check_mark: |

examples/image_streamer/plan_scripts.py

@@ -39,6 +39,9 @@
     "content": 'echo "test script"'
 }
 
+# plan script which is used by buils plans and is readonly
+plan_script_id_readyonly = "590746df-7354-42aa-8887-e1ea122f7ed6"
+
 # Create a Plan Script
 print("Create a Plan Script")
 plan_script = image_streamer_client.plan_scripts.create(plan_script_information)
@@ -72,6 +75,13 @@
     print(plan_script_item['name'])
 print("***** done *****\n")
 
+# Get used by and read only
+print("Gets builds plans which uses a particular read only plan script")
+build_plans = image_streamer_client.plan_scripts.get_usedby_and_readonly(plan_script_id_readyonly)
+for build_plan_item in build_plans:
+    print(build_plan_item["name"])
+print("**********done***********\n")
+
 # Delete the Plan Script
 print("Delete the Plan Script")
 image_streamer_client.plan_scripts.delete(plan_script)

hpOneView/image_streamer/resources/plan_scripts.py

@@ -168,3 +168,16 @@ def retrieve_differences(self, id_or_uri, content, timeout=-1):
         """
         uri = self.URI + "/differences/" + extract_id_from_uri(id_or_uri)
         return self._client.create(content, uri=uri, timeout=timeout)
+
+    def get_usedby_and_readonly(self, id):
+        """
+        Gets the build plans details os teh selected plan script as per the selected attributes.
+
+        Args:
+            id: ID of the Plan Script.
+
+        Returns:
+            array of build plans
+        """
+        uri = self.URI + "/" + id + "/usedby/readonly"
+        return self._client.get(uri)

tests/unit/image_streamer/resources/test_plan_scripts.py

@@ -125,3 +125,10 @@ def test_retrieve_differences_with_id(self, mock_create):
         mock_create.assert_called_once_with("content",
                                             timeout=-1,
                                             uri='/rest/plan-scripts/differences/3518be0e-17c1-4189-8f81-83f3724f6155')
+
+    @mock.patch.object(ResourceClient, 'get')
+    def test_get_usedby_and_readonly(self, mock_get):
+        self._client.get_usedby_and_readonly('cbfd487e-3d92-4eb4-b877-f9ea7c16a271')
+
+        mock_get.assert_called_once_with(
+            '/rest/plan-scripts/cbfd487e-3d92-4eb4-b877-f9ea7c16a271/usedby/readonly')