Merge pull request #334 from HewlettPackard/new_resource/version

soodpr · web-flow · commit e274761bfb88 · 2017-11-06T15:16:05.000+05:30
Add support to the Version resource
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 4.4.0(Unreleased)
+#### New Resources:
+- Version
+
 # 4.3.0
 #### Notes
 Added endpoints-support.md to track the supported and tested endpoints for the different HPE OneView REST APIs
@@ -130,7 +134,7 @@ Bugfixes and corrections.
    - Developer friendly interface
    - Standardization for building new endpoint clients
    - Core client implementation
-   - Support for Python�s logging library
+   - Support for Python's logging library
    - Added possibility to load connection settings from configuration file
    - Simple access to OneView API endpoints through OneViewClient module
  3. Added developer-focused samples
diff --git a/endpoints-support.md b/endpoints-support.md
@@ -251,7 +251,7 @@
 |<sub>/rest/logical-switches/{id}</sub>                                                   |DELETE    | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |<sub>/rest/logical-switches/{id}/refresh</sub>                                           |PUT       | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |     **Login Details**                                                                                                                                                   |
-|<sub>/rest/logindetails</sub>                                                            | GET      | :white_check_mark:   | :white_check_mark:   | :white_check_mark: 
+|<sub>/rest/logindetails</sub>                                                            | GET      | :white_check_mark:   | :white_check_mark:   | :white_check_mark:
 |     **Managed SANs**                                                                                                                             |
 |<sub>/rest/fc-sans/managed-sans</sub>                                                    | GET      | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |<sub>/rest/fc-sans/managed-sans/{id}</sub>                                               | GET      | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
@@ -511,7 +511,7 @@
 |<sub>/rest/uplink-sets/{id}</sub>                                                        | PUT      | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |<sub>/rest/uplink-sets/{id}</sub>                                                        | DELETE   | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 |     **Version**                                                                                                                         |
-|<sub>/rest/version</sub>                                                                 | GET      |                      |                      |                      |
+|<sub>/rest/version</sub>                                                                 | GET      | :white_check_mark:   | :white_check_mark:   | :white_check_mark:   |
 
 
 ## HPE Synergy Image Streamer
diff --git a/examples/versions.py b/examples/versions.py
@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+###
+# (C) Copyright (2012-2017) Hewlett Packard Enterprise Development LP
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+###
+
+from pprint import pprint
+from hpOneView.oneview_client import OneViewClient
+from config_loader import try_load_from_file
+
+config = {
+    "ip": "<oneview_ip>",
+    "credentials": {
+        "userName": "<username>",
+        "password": "<password>"
+    }
+}
+
+# Try load config from a file (if there is a config file)
+config = try_load_from_file(config)
+
+oneview_client = OneViewClient(config)
+
+# Get the current version and the minimum version
+print("Get the current version and the minimum version")
+version = oneview_client.versions.get_version()
+pprint(version)
diff --git a/hpOneView/oneview_client.py b/hpOneView/oneview_client.py
@@ -107,6 +107,7 @@
 from hpOneView.resources.security.users import Users
 from hpOneView.resources.settings.appliance_node_information import ApplianceNodeInformation
 from hpOneView.resources.settings.appliance_time_and_locale_configuration import ApplianceTimeAndLocaleConfiguration
+from hpOneView.resources.settings.versions import Versions
 
 ONEVIEW_CLIENT_INVALID_PROXY = 'Invalid Proxy format'
 
@@ -189,6 +190,7 @@ def __init__(self, config):
         self.__users = None
         self.__appliance_time_and_locale_configuration = None
         self.__appliance_node_information = None
+        self.__versions = None
         self.__backups = None
         self.__login_details = None
         # TODO: Implement: con.set_trusted_ssl_bundle(args.cert)
@@ -1132,6 +1134,18 @@ def appliance_time_and_locale_configuration(self):
             self.__appliance_time_and_locale_configuration = ApplianceTimeAndLocaleConfiguration(self.__connection)
         return self.__appliance_time_and_locale_configuration
 
+    @property
+    def versions(self):
+        """
+        Gets the Version API client.
+
+        Returns:
+            Version:
+        """
+        if not self.__versions:
+            self.__versions = Versions(self.__connection)
+        return self.__versions
+
     @property
     def backups(self):
         """
diff --git a/hpOneView/resources/settings/versions.py b/hpOneView/resources/settings/versions.py
@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+###
+# (C) Copyright (2012-2017) Hewlett Packard Enterprise Development LP
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+###
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from future import standard_library
+
+standard_library.install_aliases()
+
+from hpOneView.resources.resource import ResourceClient
+
+
+class Versions(object):
+    """
+    Version API client. It indicates the range of API versions supported by the appliance.
+
+    """
+    URI = '/rest/version'
+
+    def __init__(self, con):
+        self._client = ResourceClient(con, self.URI)
+
+    def get_version(self):
+        """
+        Returns the range of possible API versions supported by the appliance.
+        The response contains the current version and the minimum version.
+        The current version is the recommended version to specify in the REST header.
+        The other versions are supported for backward compatibility, but might not support the most current features.
+
+        Returns:
+            dict: The minimum and maximum supported API versions.
+        """
+        version = self._client.get(self.URI)
+        return version
diff --git a/tests/unit/resources/settings/test_versions.py b/tests/unit/resources/settings/test_versions.py
@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+###
+# (C) Copyright (2012-2017) Hewlett Packard Enterprise Development LP
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+###
+import mock
+import unittest
+
+from hpOneView.connection import connection
+from hpOneView.resources.settings.versions import Versions
+from hpOneView.resources.resource import ResourceClient
+
+
+class VersionsTest(unittest.TestCase):
+    def setUp(self):
+        self.host = '127.0.0.1'
+        self.connection = connection(self.host)
+        self._client = Versions(self.connection)
+
+    @mock.patch.object(ResourceClient, 'get')
+    def test_get_with_uri_called_once(self, mock_get):
+        self._client.get_version()
+        mock_get.assert_called_once_with('/rest/version')
diff --git a/tests/unit/test_oneview_client.py b/tests/unit/test_oneview_client.py
@@ -78,6 +78,7 @@
 from hpOneView.resources.security.users import Users
 from hpOneView.resources.settings.appliance_node_information import ApplianceNodeInformation
 from hpOneView.resources.settings.appliance_time_and_locale_configuration import ApplianceTimeAndLocaleConfiguration
+from hpOneView.resources.settings.versions import Versions
 from tests.test_utils import mock_builtin
 
 OS_ENVIRON_CONFIG_MINIMAL = {
@@ -883,3 +884,11 @@ def test_appliance_time_and_locale_configuration_has_right_type(self):
     def test_lazy_loading_appliance_time_and_locale_configuration(self):
         appliance_time_and_locale_configuration = self._oneview.appliance_time_and_locale_configuration
         self.assertEqual(appliance_time_and_locale_configuration, self._oneview.appliance_time_and_locale_configuration)
+
+    def test_should_get_appliance_current_version_and_minimum_version(self):
+        self.assertIsInstance(self._oneview.versions,
+                              Versions)
+
+    def test_lazy_loading_appliance_version_information(self):
+        versions = self._oneview.versions
+        self.assertEqual(versions, self._oneview.versions)
