Added the Appliance Node Information resource

- Added get_status and get_version methods, binding to the respective
uris
- Added unit tests
- Added new resource to CHANGELOG

Author: fgbulsoni

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v4.1.0 (Unreleased)
+
+#### New Resources:
+   - Appliance node information
 
 # v4.0.0
 #### Notes

examples/appliance_node_information.py

@@ -0,0 +1,49 @@
+# -*- 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 node status information from appliance
+print("\nGet node status information from appliance:\n ")
+node_status = oneview_client.appliance_node_information.get_status()
+pprint(node_status)
+
+# Get node version information from appliance
+print("\nGet node version information from appliance\n")
+node_version = oneview_client.appliance_node_information.get_version()
+pprint(node_version)

hpOneView/oneview_client.py

@@ -103,6 +103,7 @@
 from hpOneView.resources.uncategorized.os_deployment_servers import OsDeploymentServers
 from hpOneView.resources.security.certificate_rabbitmq import CertificateRabbitMQ
 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
 
 ONEVIEW_CLIENT_INVALID_PROXY = 'Invalid Proxy format'
@@ -184,6 +185,7 @@ def __init__(self, config):
         self.__certificate_rabbitmq = None
         self.__users = None
         self.__appliance_time_and_locale_configuration = None
+        self.__appliance_node_information = None
         self.__backups = None
         # TODO: Implement: con.set_trusted_ssl_bundle(args.cert)
 
@@ -1089,6 +1091,18 @@ def users(self):
             self.__users = Users(self.__connection)
         return self.__users
 
+    @property
+    def appliance_node_information(self):
+        """
+        Gets the ApplianceNodeInformation API client.
+
+        Returns:
+            ApplianceNodeInformation:
+        """
+        if not self.__appliance_node_information:
+            self.__appliance_node_information = ApplianceNodeInformation(self.__connection)
+        return self.__appliance_node_information
+
     @property
     def appliance_time_and_locale_configuration(self):
         """

hpOneView/resources/settings/appliance_node_information.py

@@ -0,0 +1,64 @@
+# -*- 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 ApplianceNodeInformation(object):
+    """
+    ApplianceNodeInformation API client.
+
+    """
+    URI = '/rest/appliance/nodeinfo'
+
+    def __init__(self, con):
+        self._client = ResourceClient(con, self.URI)
+
+    def get_status(self):
+        """
+        Retrieves node's status information
+
+        Returns:
+            dict: Node's status information
+        """
+        uri = self.URI + '/status'
+        return self._client.get(uri)
+
+    def get_version(self):
+        """
+        Retrieves node's version information
+
+        Returns:
+            dict: Node's version information
+        """
+        uri = self.URI + '/version'
+        return self._client.get(uri)

tests/unit/resources/settings/test_appliance_node_information.py

@@ -0,0 +1,47 @@
+# -*- 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 unittest
+
+import mock
+
+from hpOneView.connection import connection
+from hpOneView.resources.settings.appliance_node_information import ApplianceNodeInformation
+from hpOneView.resources.resource import ResourceClient
+
+
+class ApplianceTimeAndLocaleConfigurationTest(unittest.TestCase):
+    def setUp(self):
+        self.host = '127.0.0.1'
+        self.connection = connection(self.host)
+        self._node_information = ApplianceNodeInformation(self.connection)
+
+    @mock.patch.object(ResourceClient, 'get')
+    def test_get_status_called_once(self, mock_get):
+        self._node_information.get_status()
+        mock_get.assert_called_once_with('/rest/appliance/nodeinfo/status')
+
+    @mock.patch.object(ResourceClient, 'get')
+    def test_get_version_called_once(self, mock_get):
+        self._node_information.get_version()
+        mock_get.assert_called_once_with('/rest/appliance/nodeinfo/version')

tests/unit/test_oneview_client.py

@@ -74,6 +74,7 @@
 from hpOneView.resources.activity.events import Events
 from hpOneView.resources.security.certificate_rabbitmq import CertificateRabbitMQ
 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 tests.test_utils import mock_builtin
 
@@ -741,6 +742,14 @@ def test_lazy_loading_users(self):
         user = self._oneview.users
         self.assertEqual(user, self._oneview.users)
 
+    def test_appliance_node_information_has_right_type(self):
+        self.assertIsInstance(self._oneview.appliance_node_information,
+                              ApplianceNodeInformation)
+
+    def test_lazy_loading_appliance_node_information(self):
+        appliance_node_information = self._oneview.appliance_node_information
+        self.assertEqual(appliance_node_information, self._oneview.appliance_node_information)
+
     def test_appliance_time_and_locale_configuration_has_right_type(self):
         self.assertIsInstance(self._oneview.appliance_time_and_locale_configuration,
                               ApplianceTimeAndLocaleConfiguration)