[cm_api] OPSAPS-22366 Python API changes for cluster template import

Author: Vivek Chaudhary

python/setup.py

@@ -38,7 +38,7 @@
 
 setup(
   name = 'cm_api',
-  version = '11.0.0',    # Compatible with API v11 (CM 5.5)
+  version = '12.0.0',    # Compatible with API v12 (CM 5.7)
   packages = find_packages('src', exclude=['cm_api_tests']),
   package_dir = {'cm_api': 'src/cm_api',
                  'cm_shell': 'src/cm_shell'},

python/src/cm_api/api_client.py

@@ -30,7 +30,7 @@
 LOG = logging.getLogger(__name__)
 
 API_AUTH_REALM = "Cloudera Manager"
-API_CURRENT_VERSION = 11
+API_CURRENT_VERSION = 12
 
 class ApiException(RestException):
   """

python/src/cm_api/endpoints/clusters.py

@@ -16,6 +16,7 @@
 
 from cm_api.endpoints.types import *
 from cm_api.endpoints import services, parcels, host_templates
+from sys import api_version
 
 __docformat__ = "epytext"
 
@@ -605,3 +606,17 @@ def configure_for_kerberos(self, datanode_transceiver_port=None,
     if datanode_web_port:
         args['datanodeWebPort'] = datanode_web_port
     return self._cmd('configureForKerberos', data=args, api_version=11)
+
+  def export(self, export_auto_config=False):
+    """
+    Export the cluster template for the given cluster. ccluster must have host
+    templates defined. It cluster does not have host templates defined it will
+    export host templates based on roles assignment.
+
+    @param export_auto_config: Also export auto configured configs
+    @return: Return cluster template
+    @since: API v12
+    """
+
+    return self._get("export", ApiClusterTemplate, False,
+                     params=dict(exportAutoConfig=export_auto_config), api_version=12)

python/src/cm_api/endpoints/cms.py

@@ -482,3 +482,13 @@ def end_trial(self):
     @since: API v6
     """
     self._post("trial/end", None, api_version=6)
+
+  def import_cluster_template(self, api_cluster_template):
+    """
+    Create a cluster according to the provided template
+
+    @param api_cluster_template: cluster template to import
+    @return: Command handing cluster import
+    @since: API v12
+    """
+    return self._post("importClusterTemplate", ApiCommand, False, api_cluster_template, api_version=12)

python/src/cm_api/endpoints/types.py

@@ -1140,6 +1140,93 @@ class ApiTimeSeriesRequest(BaseApiObject):
   def __str__(self):
     return "<ApiTimeSeriesRequest>: %s" % (self.query)
 
+class ApiProductVersion(BaseApiObject):
+  _ATTRIBUTES = {
+    'version'       : None,
+    'product'       : None,
+  }
+
+class ApiClusterTemplateConfig(BaseApiObject):
+  _ATTRIBUTES = {
+    'name'        : None,
+    'value'       : None,
+    'ref'         : None,
+    'variable'    : None,
+    'autoConfig'  : None,
+  }
+
+class ApiClusterTemplateRoleConfigGroup(BaseApiObject):
+  _ATTRIBUTES = {
+    'refName'        : None,
+    'roleType'       : None,
+    'base'           : None,
+    'displayName'    : None,
+    'configs'        : Attr(ApiClusterTemplateConfig),
+  }
+
+class ApiClusterTemplateRole(BaseApiObject):
+  _ATTRIBUTES = {
+    'refName'           : None,
+    'roleType'          : None,
+  }
+
+class ApiClusterTemplateHostTemplate(BaseApiObject):
+  _ATTRIBUTES = {
+    'refName'                   : None,
+    'roleConfigGroupsRefNames'  : None,
+  }
+
+class ApiClusterTemplateHostInfo(BaseApiObject):
+  _ATTRIBUTES = {
+    'hostName'                  : None,
+    'hostNameRange'             : None,
+    'rackId'                    : None,
+    'hostTemplateRefName'       : None,
+    'roleRefNames'              : None,
+  }
+
+class ApiClusterTemplateVariable(BaseApiObject):
+  _ATTRIBUTES = {
+    'name'         : None,
+    'value'        : None,
+  }
+
+class ApiClusterTemplateRoleConfigGroupInfo(BaseApiObject):
+  _ATTRIBUTES = {
+    'rcgRefName'  : None,
+    'name'        : None,
+  }
+
+class ApiClusterTemplateInstantiator(BaseApiObject):
+  _ATTRIBUTES = {
+    'clusterName'      : None,
+    'hosts'            : Attr(ApiClusterTemplateHostInfo),
+    'variables'        : Attr(ApiClusterTemplateVariable),
+    'roleConfigGroups' : Attr(ApiClusterTemplateRoleConfigGroupInfo),
+  }
+
+class ApiClusterTemplateService(BaseApiObject):
+  _ATTRIBUTES = {
+    'refName'           : None,
+    'serviceType'       : None,
+    'serviceConfigs'    : Attr(ApiClusterTemplateConfig),
+    'roleConfigGroups'  : Attr(ApiClusterTemplateRoleConfigGroup),
+    'displayName'       : None,
+    'roles'             : Attr(ApiClusterTemplateRole),
+  }
+
+class ApiClusterTemplate(BaseApiObject):
+  _ATTRIBUTES = {
+    'cdhVersion'    : None,
+    'displayName'   : None,
+    'cmVersion'     : None,
+    "repositories"  : None,
+    'products'      : Attr(ApiProductVersion),
+    'services'      : Attr(ApiClusterTemplateService),
+    'hostTemplates' : Attr(ApiClusterTemplateHostTemplate),
+    'instantiator'  : Attr(ApiClusterTemplateInstantiator),
+  }
+
 def config_to_api_list(dic):
   """
   Converts a python dictionary into a list containing the proper

python/src/cm_api_tests/test_clusters.py

@@ -42,7 +42,7 @@ def test_update_cdh_version(self):
         data=data,
         retdata={ 'name' : 'foo'})
     cluster.update_cdh_version('4.2.1')
- 
+
   def test_upgrade_cdh(self):
     resource = utils.MockResource(self)
     cluster = ApiCluster(resource, name="foo")
@@ -104,3 +104,13 @@ def test_configure_for_kerberos(self):
         data=data,
         retdata={ 'name' : 'foo'})
     cluster.configure_for_kerberos(23456, 12345)
+
+  def test_export_cluster_template(self):
+    resource = utils.MockResource(self)
+    cluster = ApiCluster(resource, name="foo")
+    resource.expect(
+      method="GET",
+      reqpath="/clusters/foo/export",
+      params=dict(exportAutoConfig=True),
+      retdata=ApiClusterTemplate(resource).to_json_dict())
+    cluster.export(export_auto_config=True)

python/src/cm_api_tests/test_cms.py

@@ -16,7 +16,8 @@
 
 import unittest
 from cm_api.endpoints.cms import ClouderaManager
-from cm_api.endpoints.types import config_to_json, ApiConfig, ApiCmPeer
+from cm_api.endpoints.types import config_to_json, ApiConfig, ApiCmPeer,\
+  ApiCommand, ApiClusterTemplate
 from cm_api_tests import utils
 
 try:
@@ -278,3 +279,15 @@ def test_peer_v11(self):
         params=params_status_aggregation,
         retdata=json.loads(SAMPLE_COMMAND_JSON))
     cms.test_peer_connectivity("peer2", peer_type="STATUS_AGGREGATION")
+
+  def test_import_cluster_v12(self):
+    resource = utils.MockResource(self, version=12)
+    cms = ClouderaManager(resource)
+    data = ApiClusterTemplate(resource).to_json_dict()
+    resource.expect(
+      method="POST",
+      reqpath="/cm/importClusterTemplate",
+      data = data,
+      retdata=ApiCommand(resource).to_json_dict())
+    cms.import_cluster_template(data)
+