Merge pull request #251 from hpe-container-platform-community/snowch/implement-datatap-module-250

add datatap functionality

Author: snowch

bin/cli.py

@@ -39,6 +39,7 @@
 import hpecp
 from hpecp import ContainerPlatformClient
 from hpecp.cli.catalog import CatalogProxy
+from hpecp.cli.datatap import DatatapProxy
 from hpecp.cli.gateway import GatewayProxy
 from hpecp.cli.httpclient import HttpClientProxy
 from hpecp.cli.k8scluster import K8sClusterProxy
@@ -415,6 +416,7 @@ def __init__(self,):
         self.user = UserProxy()
         self.role = RoleProxy()
         self.version = version
+        self.datatap = DatatapProxy()
 
 
 if __name__ == "__main__":

hpecp/cli/datatap.py

@@ -0,0 +1,55 @@
+# (C) Copyright [2020] 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.
+
+"""HPE Container Platform CLI."""
+
+from __future__ import print_function
+
+from textwrap import dedent
+from hpecp.datatap import Datatap
+from hpecp.cli import base
+
+
+class DatatapProxy(base.BaseProxy):
+    """Proxy object to :py:attr:`<hpecp.client.datatap>`."""
+
+    def __init__(self):
+        """Create instance of proxy class with the client module name."""
+        super(DatatapProxy, self).new_instance("datatap", Datatap)
+
+    def __dir__(self):
+        """Return the CLI method names."""
+        return [
+            "get",
+            "list",
+            "delete",
+            # "examples",
+            "wait_for_state",
+        ]
+
+    def examples(self):
+        """Show examples for working with roles."""
+        print(
+            dedent(
+                """\
+                    Coming soon ...
+                """  # noqa:  E501
+            )
+        )

hpecp/client.py

@@ -43,6 +43,7 @@
 
 from .catalog import CatalogController
 from .config import ConfigController
+from .datatap import DatatapController
 from .exceptions import (
     APIException,
     APIItemConflictException,
@@ -453,6 +454,7 @@ def __init__(
         self._user = UserController(self)
         self._catalog = CatalogController(self)
         self._role = RoleController(self)
+        self._datatap = DatatapController(self)
 
     def create_session(self):
         """Create a session with the HPE CP controller.
@@ -960,3 +962,22 @@ def role(self):
         >>> client.role.get()
         """
         return self._role
+
+    @property
+    def datatap(self):
+        """Retrieve a reference to a `.datatap.DatatapController` object.
+
+        See the class :py:class:`.role.DatatapController` for the methods
+        available.
+
+        Example
+        -------
+        This example calls the method :py:meth:`get()
+        <.datatap.DatatapController.get>`
+        in :py:class:`.datatap.DatatapController`.
+
+        >>> client = ContainerPlatformClient(...)
+        >>> client.create_session()
+        >>> client.datatap.get()
+        """
+        return self._datatap

hpecp/datatap.py

@@ -0,0 +1,111 @@
+# (C) Copyright [2020] 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.
+
+"""Module for working with datatap."""
+
+from .base_resource import AbstractResource, AbstractResourceController
+
+
+class Datatap(AbstractResource):
+    """Datatap Image item."""
+
+    # All of the fields of Catalog objects as returned by the HPE Container
+    # Platform API.
+    # TODO: Verify this with the specification
+    all_fields = (
+        "label_name",
+        "label_description",
+        "self_href",
+        # "state",
+        # "state_info",
+    )
+
+    default_display_fields = [
+        "label_name",
+        "label_description",
+        "self_href",
+    ]
+
+    # These fields are displayed by default, e.g. in tabulate()
+    # TODO: Verify this with the specification
+    # TODO: Pick a smaller subset, again based on the API response
+    default_display_fields = all_fields
+
+    @property
+    def label_name(self):
+        """@Field: from json['label']['name']."""
+        try:
+            return self.json["label"]["name"]
+        except KeyError:
+            return ""
+
+    @property
+    def label_description(self):
+        """@Field: from json['label']['description']."""
+        try:
+            return self.json["label"]["description"]
+        except KeyError:
+            return ""
+
+    @property
+    def self_href(self):
+        """@Field: from json['_links']['self']['href']."""
+        try:
+            return self.json["_links"]["self"]["href"]
+        except KeyError:
+            return ""
+
+    # @property
+    # def state(self):
+    #     """@Field: from json['state']"""
+    #     try:
+    #         return self.json["state"]
+    #     except KeyError:
+    #         return ""
+
+    # @property
+    # def state_info(self):
+    #     """@Field: from json['state_info']"""
+    #     try:
+    #         return self.json["state_info"]
+    #     except KeyError:
+    #         return ""
+
+
+class DatatapController(AbstractResourceController):
+    """Class that users will interact with to work with datataps.
+
+    An instance of this class is available in the
+    `client.ContainerPlatformClient` with the attribute name
+    :py:attr:`datatap <.client.ContainerPlatformClient.catalog>`. The methods
+    of this class can be invoked using `client.datatap.method()`. See the
+    example below:
+
+    Examples
+    --------
+    >>> client = ContainerPlatformClient(...).create_session()
+    >>> client.datatap.list()
+    """
+
+    base_resource_path = "/api/v1/dataconn"
+
+    resource_list_path = "data_connectors"
+
+    resource_class = Datatap