Merge pull request #215 from hpe-container-platform-community/cli_k8sworker

issue with k8s worker get()

Author: snowch

Dockerfile

@@ -6,12 +6,14 @@ RUN sudo apt-get update \
     && sudo apt-get install -y software-properties-common \
     && sudo add-apt-repository -y ppa:deadsnakes/ppa \
     && sudo apt-get update \
-    && sudo apt-get install -y python3.5 python3.6 python3.7 python3.8 python3.9 tox python3-sphinx vim
+    && sudo apt-get install -y python3.5 python3.6 python3.7 python3.8 python3.9 tox python3-sphinx python-pip python3-pip python3.9-distutils vim
 
-RUN pip install -U pylint pytest mock nose flake8-docstrings flake8-per-file-ignores==0.8.1 \
-    && pip3 install -U pylint pytest mock nose black flake8-docstrings flake8-per-file-ignores==0.8.1 \
-    && pip install -r /tmp/requirements.txt \
-    && pip3 install -r /tmp/requirements.txt 
+# FIXME: Python 3.9 returns errors with pip
+RUN echo "Installing python modules" \
+    && for v in 2 3 3.5 3.6 3.7 3.8; do python${v} -m pip install -U pylint pytest mock nose flake8-docstrings flake8-per-file-ignores==0.8.1; done \
+    && for v in 3 3.5 3.6 3.7 3.8; do python${v} -m pip install -U black; done \
+    && sudo ln -s /home/theia/.local/bin//black /bin/ \
+    && for v in 2 3 3.5 3.6 3.7 3.8; do python${v} -m pip install -r /tmp/requirements.txt; done 
 
 RUN echo 'PATH=$PATH:/home/theia/.local/bin/' >> /home/theia/.bashrc
 

bin/cli.py

@@ -101,7 +101,7 @@
 def intercept_exception(wrapped, instance, args, kwargs):
     """Handle Exceptions."""  # noqa: D202
 
-    def _handle_unknown_exception(ex):
+    def _unknown_exception_handler(ex):
         """Handle unknown exceptions."""
         if _log.level == 10:  # "DEBUG"
             print(
@@ -125,7 +125,7 @@ def _handle_unknown_exception(ex):
         print(ae, file=sys.stderr)
         sys.exit(1)
     except APIUnknownException as ue:
-        _handle_unknown_exception(ue)
+        _unknown_exception_handler(ue)
     except (
         APIException,
         APIItemNotFoundException,
@@ -136,7 +136,7 @@ def _handle_unknown_exception(ex):
         print(e.message, file=sys.stderr)
         sys.exit(1)
     except Exception as ex:
-        _handle_unknown_exception(ex)
+        _unknown_exception_handler(ex)
 
 
 @intercept_exception
@@ -181,17 +181,17 @@ def get(self, id, output="yaml", params=None):
             self.client, self.client_module_name
         )
         response = self.client_module_property.get(id=id, params=params)
+        json_data = response.json
 
         if output == "json":
-            print(json.dumps(response.json))
+            print(json.dumps(json_data))
         elif output == "json-pp":
-            print(json.dumps(response.json, indent=4, sort_keys=True,))
+            print(json.dumps(json_data, indent=4, sort_keys=True,))
         else:
+
             print(
                 yaml.dump(
-                    yaml.load(
-                        json.dumps(response.json), Loader=yaml.FullLoader,
-                    )
+                    yaml.load(json.dumps(json_data), Loader=yaml.FullLoader,)
                 )
             )
 
@@ -679,7 +679,7 @@ def create_with_ssh_key(
         ) and wait_for_operation_secs == 0:
             print(
                 (
-                    "if setting disks 'wait-for-operation-secs' parameter"
+                    "If setting disks, 'wait-for-operation-secs' parameter"
                     " must be greater than zero (recommended 600 seconds)"
                 ),
                 file=sys.stderr,
@@ -693,10 +693,22 @@ def create_with_ssh_key(
         if wait_for_operation_secs > 0:
             self.wait_for_status(
                 id=worker_id,
-                status=["storage_pending"],
+                status=["storage_pending", "error"],
                 timeout_secs=wait_for_operation_secs,
             )
 
+        if get_client().k8s_worker.get(id=worker_id).status == "error":
+            print(
+                (
+                    "Create request has errored. "
+                    "Check status message with `hpecp k8sworker get {}".format(
+                        id
+                    )
+                ),
+                file=sys.stderr,
+            )
+            sys.exit(1)
+
         if ephemeral_disks is not None or persistent_disks is not None:
             self.set_storage(
                 id=worker_id,

hpecp/k8s_worker.py

@@ -145,17 +145,18 @@ def create_with_ssh_key(self, ip, ssh_key_data, tags=[]):
             url="/api/v2/worker/k8shost/",
             http_method="post",
             data=data,
-            description="worker/create_with_ssh_key",
+            description="K8sWorkerController/create_with_ssh_key",
         )
         return CaseInsensitiveDict(response.headers)["location"]
 
-    def get(self, id, setup_log=False):
+    def get(self, id, params=None, setup_log=False):
 
-        if setup_log is True:
-            params = {"setup_log": "true"}
-        else:
+        if params is None:
             params = {}
 
+        if setup_log is True:
+            params["setup_log"] = "true"
+
         return super(K8sWorkerController, self).get(id, params)
 
     def set_storage(self, worker_id, ephemeral_disks=[], persistent_disks=[]):

tests/library/k8s_worker_test.py

@@ -1,13 +1,21 @@
 from unittest import TestCase
 import requests
-from mock import patch
+from mock import patch, MagicMock
+import sys
+import os
+import json
 
 from hpecp import ContainerPlatformClient
-from hpecp.k8s_worker import K8sWorkerController, WorkerK8sStatus
+from hpecp.k8s_worker import K8sWorkerController, WorkerK8sStatus, WorkerK8s
 from hpecp.exceptions import APIItemConflictException, APIItemNotFoundException
 from .base_test import session_mock_response, BaseTestCase
 import tempfile
 
+try:
+    from imp import reload
+except Exception:
+    from importlib import reload
+
 
 class MockResponse:
     def __init__(
@@ -389,26 +397,57 @@ def test_with_only_ssh_key_content_provided(
         is passed to the library method 'create_with_ssh_key()'.
         """
 
-        with patch.object(
-            K8sWorkerController,
-            "create_with_ssh_key",
-            return_value="/api/v2/worker/k8shost/1",
-        ) as mock_create_with_ssh_key:
-            try:
-                hpecp_cli = self.cli.CLI()
-                hpecp_cli.k8sworker.create_with_ssh_key(
-                    ip="127.0.0.1", ssh_key="test_ssh_key",
-                )
-            except Exception:
-                self.fail("Unexpected exception.")
+        def mock_k8s_worker_get(*args, **kwargs):
+            worker = WorkerK8s(
+                {
+                    "status": "bundle",
+                    "approved_worker_pubkey": [],
+                    "tags": [],
+                    "hostname": "",
+                    "ipaddr": "10.1.0.186",
+                    "setup_log": (
+                        "/var/log/bluedata/install/"
+                        "k8shost_setup_10.1.0.186-"
+                        "2020-4-26-18-49-10"
+                    ),
+                    "_links": {"self": {"href": "/api/v2/worker/k8shost/5"}},
+                }
+            )
+            return worker
+
+        def mock_create_with_ssh_key(*args, **kwargs):
+            return "/api/v2/worker/k8shost/5"
+
+        def mock_get_client():
+            client = ContainerPlatformClient(
+                username="",
+                password="",
+                api_host="",
+                api_port=9090,
+                use_ssl=True,
+                verify_ssl=True,
+                warn_ssl=True,
+            )
+            client.session_id = "ABC"
+            client.k8s_worker.get = mock_k8s_worker_get
+            client.k8s_worker.create_with_ssh_key = mock_create_with_ssh_key
+            return client
 
-        mock_create_with_ssh_key.assert_called_once_with(
-            ip="127.0.0.1", ssh_key_data="test_ssh_key", tags=[],
-        )
+        # support debugging if this test fails
+        with patch.dict("os.environ", {"LOG_LEVEL": "DEBUG"}):
+            hpecp_cli = self.cli.CLI()
+
+            # manually patch methods due to json serialization error
+            # when using Mock or MagicMock
+            self.cli.get_client = mock_get_client
+
+            hpecp_cli.k8sworker.create_with_ssh_key(
+                ip="127.0.0.1", ssh_key="test_ssh_key",
+            )
 
         stdout = self.out.getvalue().strip()
 
-        self.assertEqual(stdout, "/api/v2/worker/k8shost/1")
+        self.assertEqual(stdout, "/api/v2/worker/k8shost/5")
 
     @patch("requests.post", side_effect=mocked_requests_post)
     @patch("hpecp.k8s_worker")
@@ -506,34 +545,64 @@ def test_with_only_ssh_key_content_provided_raises_general_exception(
             "Expected: `{}`, Actual: `{}`".format(expected_err, stderr),
         )
 
-    @patch("requests.post", side_effect=mocked_requests_post)
-    @patch("hpecp.k8s_worker")
-    def test_with_only_ssh_key_file_provided(self, mock_post, mock_k8sworker):
+    @patch("requests.post", side_effect=mocked_requests_post)  # Login response
+    def test_with_only_ssh_key_file_provided(self, mock_login_response):
 
         ssh_key_file = tempfile.NamedTemporaryFile(delete=True, mode="w")
         ssh_key_file.write("test_ssh_key_file_data")
         ssh_key_file.flush()
 
-        with patch.object(
-            K8sWorkerController,
-            "create_with_ssh_key",
-            return_value="/api/v2/worker/k8shost/1",
-        ) as mock_create_with_ssh_key:
-            try:
-                hpecp_cli = self.cli.CLI()
-                hpecp_cli.k8sworker.create_with_ssh_key(
-                    ip="127.0.0.1", ssh_key_file=ssh_key_file.name,
-                )
-            except Exception as e:
-                self.fail("Unexpected exception. {}".format(e))
+        def mock_k8s_worker_get(*args, **kwargs):
+            worker = WorkerK8s(
+                {
+                    "status": "bundle",
+                    "approved_worker_pubkey": [],
+                    "tags": [],
+                    "hostname": "",
+                    "ipaddr": "10.1.0.186",
+                    "setup_log": (
+                        "/var/log/bluedata/install/"
+                        "k8shost_setup_10.1.0.186-"
+                        "2020-4-26-18-49-10"
+                    ),
+                    "_links": {"self": {"href": "/api/v2/worker/k8shost/5"}},
+                }
+            )
+            return worker
+
+        def mock_create_with_ssh_key(*args, **kwargs):
+            return "/api/v2/worker/k8shost/5"
+
+        def mock_get_client():
+            client = ContainerPlatformClient(
+                username="",
+                password="",
+                api_host="",
+                api_port=9090,
+                use_ssl=True,
+                verify_ssl=True,
+                warn_ssl=True,
+            )
+            client.session_id = "ABC"
+            client.k8s_worker.get = mock_k8s_worker_get
+            client.k8s_worker.create_with_ssh_key = mock_create_with_ssh_key
+            return client
 
-        mock_create_with_ssh_key.assert_called_once_with(
-            ip="127.0.0.1", ssh_key_data="test_ssh_key_file_data", tags=[],
-        )
+        # support debugging if this test fails
+        with patch.dict("os.environ", {"LOG_LEVEL": "DEBUG"}):
+            hpecp_cli = self.cli.CLI()
+
+            # manually patch methods due to json serialization error
+            # when using Mock or MagicMock
+            self.cli.get_client = mock_get_client
+
+            hpecp_cli.k8sworker.create_with_ssh_key(
+                ip="127.0.0.1", ssh_key_file=ssh_key_file.name
+            )
 
         stdout = self.out.getvalue().strip()
 
-        self.assertEqual(stdout, "/api/v2/worker/k8shost/1")
+        self.assertEqual(stdout, "/api/v2/worker/k8shost/5")
 
         ssh_key_file.close()