Removing sessionID from credentials when not specified since it is sent in the POST body for authentication, updating README and adding other unit tests at test_oneview_client

Author: adriane-cardozo

README.md

@@ -69,7 +69,7 @@ Connection properties for accessing the OneView appliance can be set in a JSON f
 Before running the samples or your own scripts, you must create the JSON file.
 An example can be found at: [OneView configuration sample](examples/config-rename.json).
 
-Note: If you have an active and valid login session and want to use it, define the sessionID in the Credentials. When sessionID is defined, username and password will be disregarded. 
+Note: If you have an active and valid login session and want to use it, define the sessionID in the Credentials. When sessionID is defined, you can remove username and password from your JSON (they will be disregarded anyway).
 
 Once you have created the JSON file, you can initialize the OneViewClient:
 
@@ -101,7 +101,7 @@ export ONEVIEWSDK_PROXY='<proxy_host>:<proxy_port>'
 
 :lock: Tip: Make sure no unauthorized person has access to the environment variables, since the password is stored in clear-text.
 
-Note: If you have an active and valid login session and want to use it, define the ONEVIEWSDK_SESSIONID. When sessionID is defined, username and password will be disregarded.
+Note: If you have an active and valid login session and want to use it, define the ONEVIEWSDK_SESSIONID. When sessionID is defined, it will be used for authentication and username and password will be disregarded.
 
 Once you have defined the environment variables, you can initialize the OneViewClient using the following code snippet:
 
@@ -111,23 +111,33 @@ oneview_client = OneViewClient.from_environment_variables()
 
 ### Dictionary
 
-You can also set the configuration using a dictionary:
+You can also set the configuration using a dictionary. As described above, for authentication you can use username/password:
+
 
 ```python
 config = {
     "ip": "172.16.102.82",
     "credentials": {
         "userName": "Administrator",
-        "password": "secret123",
-        "sessionID": ""
+        "password": "secret123"
+    }
+}
+```
+
+ or if you have an active and valid login session and want to use it, define the sessionID in the Credentials:
+
+
+```python
+config = {
+    "ip": "172.16.102.82",
+    "credentials": {
+        "sessionID": "123"
     }
 }
 
 oneview_client = OneViewClient(config)
 ```
 
-Note: If you have an active and valid login session and want to use it, define the sessionID in the Credentials. When sessionID is defined, username and password will be disregarded.
-
 :lock: Tip: Check the file permissions because the password is stored in clear-text.
 
 ### Proxy

hpOneView/connection.py

@@ -443,6 +443,7 @@ def login(self, cred, verbose=False):
                 self.set_session_id(self._cred["sessionID"])
                 task, body = self.put(uri['loginSessions'], None)
             else:
+                self._cred.pop("sessionID", None)
                 task, body = self.post(uri['loginSessions'], self._cred)
         except HPOneViewException:
             logger.exception('Login failed')

tests/unit/test_oneview_client.py

@@ -179,6 +179,21 @@ def test_from_json_file_with_sessionID(self, mock_open, mock_login):
         self.assertIsInstance(oneview_client, OneViewClient)
         self.assertEqual("172.16.102.59", oneview_client.connection.get_host())
 
+    @mock.patch.object(connection, 'login')
+    @mock.patch(mock_builtin('open'))
+    def test_from_json_file_with_only_sessionID(self, mock_open, mock_login):
+        json_config_content = u"""{
+          "ip": "172.16.102.59",
+          "credentials": {
+            "sessionID": "123"
+          }
+        }"""
+        mock_open.return_value = self.__mock_file_open(json_config_content)
+        oneview_client = OneViewClient.from_json_file("config.json")
+
+        self.assertIsInstance(oneview_client, OneViewClient)
+        self.assertEqual("172.16.102.59", oneview_client.connection.get_host())
+
     @mock.patch.object(connection, 'login')
     @mock.patch(mock_builtin('open'))
     def test_default_api_version(self, mock_open, mock_login):
@@ -302,6 +317,21 @@ def test_from_environment_variables_is_passing_right_arguments_to_the_constructo
                                                'authLoginDomain': '',
                                                'sessionID': '123'}})
 
+    @mock.patch.dict('os.environ', OS_ENVIRON_CONFIG_MINIMAL_WITH_SESSIONID)
+    @mock.patch.object(OneViewClient, '__init__')
+    def test_from_environment_variables_is_passing_right_arguments_to_the_constructor_with_only_sessionID(self, mock_cls):
+        mock_cls.return_value = None
+        OneViewClient.from_environment_variables()
+        mock_cls.assert_called_once_with({'api_version': 300,
+                                          'proxy': '',
+                                          'ip': '172.16.100.199',
+                                          'image_streamer_ip': '',
+                                          'credentials':
+                                              {'userName': '',
+                                               'password': '',
+                                               'authLoginDomain': '',
+                                               'sessionID': '123'}})
+
     @mock.patch.object(connection, 'login')
     def test_create_image_streamer_client_without_image_streamer_ip(self, mock_login):