[scm] OPSAPS-35700 Add external accounts to python API.

    Identical modeling to the final API model in OPSAPS-34817.

    Testing:
     - test scripts to test each of the APIs separately against a recent server
     - new unit tests

    Sample python script:
    ----
    from cm_api.api_client import ApiResource, ApiException, API_CURRENT_VERSION
    api = ApiResource(server_host="test-1.cloudera.com", username="admin", password="admin", version=14)
    cats = api.get_supported_external_account_categories()
    print "cat: %s" %(cats)
    for cat in cats:
      types = api.get_supported_external_account_types(cat.name)
      for type_ in types:
        print "type: %s, allowed: %s" %(type_.name, type_.allowedAccountConfigs)

    name = "test7"
    acct = api.create_external_account(name=name, display_name=name,
      type_name="AWS_ACCESS_KEY_AUTH")
    print "Created: %s" % acct

    acct.accountConfigs['aws_access_key'] = "test1"
    acct.accountConfigs['aws_secret_key'] = "test2"

    acct_updated = api.update_external_account(acct)
    print "Updated: %s with configs: %s" % (acct_updated, acct_updated.accountConfigs)

    acct_deleted = api.delete_external_account(acct.name)
    print "Deleted: %s" % acct_deleted
    ---

Author: Jayesh Seshadri

python/src/cm_api/api_client.py

@@ -21,7 +21,7 @@
   import simplejson as json
 
 from cm_api.http_client import HttpClient, RestException
-from cm_api.endpoints import batch, cms, clusters, events, hosts, tools
+from cm_api.endpoints import batch, cms, clusters, events, hosts, external_accounts, tools
 from cm_api.endpoints import types, users, timeseries
 from cm_api.resource import Resource
 
@@ -309,6 +309,83 @@ def do_batch(self, elements):
     """
     return batch.do_batch(self, elements)
 
+  def get_supported_external_account_categories(self):
+    """
+    Lookup all supported categories.
+    @return: An ApiExternalAcccountCategory list
+    """
+    return external_accounts.get_supported_categories(self)
+
+  def get_supported_external_account_types(self, category_name):
+    """
+    Lookup all supported types in a category.
+    @param category_name: The category name
+    @return: An ApiExternalAcccountType list
+    """
+    return external_accounts.get_supported_types(self, category_name)
+
+  def create_external_account(self, name, display_name, type_name,
+                              account_configs=None):
+    """
+    Create an external account
+    @param name: Immutable external account name
+    @param display_name: Display name
+    @param type_name: Account type
+    @param account_configs: Optional account configuration
+    @return: An ApiExternalAccount object
+    """
+    return external_accounts.create_external_account(
+      self, name, display_name, type_name, account_configs)
+
+
+  def get_external_account(self, name, view=None):
+    """
+    Lookup an external account by name
+    @param name: Account name
+    @param view: View
+    @return: An ApiExternalAccount object
+    """
+    return external_accounts.get_external_account(
+      self, name, view)
+
+
+  def get_external_account_by_display_name(
+    self, display_name, view=None):
+    """
+    Lookup an external account by display name
+    @param display_name: Account display name
+    @param view: View
+    @return: An ApiExternalAccount object
+    """
+    return external_accounts.get_external_account_by_display_name(
+      self, display_name, view)
+
+  def get_all_external_accounts(self, type_name, view=None):
+    """
+    Lookup all external accounts of a particular type, by type name.
+    @param type_name: Type name
+    @param view: View
+    @return: A list of ApiExternalAccount objects.
+    """
+    return external_accounts.get_all_external_accounts(
+      self, type_name, view)
+
+  def update_external_account(self, account):
+    """
+    Update an external account
+    @param account: Account to update, account name must be specified.
+    @return: An ApiExternalAccount object
+    """
+    return external_accounts.update_external_account(self, account)
+
+  def delete_external_account(self, name):
+    """
+    Delete an external account by name
+    @param name: Account name
+    @return: An ApiExternalAccount object
+    """
+    return external_accounts.delete_external_account(self, name)
+
 def get_root_resource(server_host, server_port=None,
                       username="admin", password="admin",
                       use_tls=False, version=API_CURRENT_VERSION):

python/src/cm_api/endpoints/external_accounts.py

@@ -0,0 +1,171 @@
+# Licensed to Cloudera, Inc. under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  Cloudera, Inc. licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+try:
+  import json
+except ImportError:
+  import simplejson as json
+
+from cm_api.endpoints.types import *
+
+__docformat__ = "epytext"
+
+EXTERNAL_ACCOUNT_PATH = "/externalAccounts/%s"
+EXTERNAL_ACCOUNT_FETCH_PATH = "/externalAccounts/%s/%s"
+
+def get_supported_categories(resource_root):
+  """
+  Lookup all supported categories.
+  @param resource_root: The root Resource object.
+  @return: An ApiExternalAcccountCategory list
+  """
+  return call(resource_root.get, EXTERNAL_ACCOUNT_PATH % ("supportedCategories",) ,
+      ApiExternalAccountCategory, True)
+
+def get_supported_types(resource_root, category_name):
+  """
+  Lookup all supported types in a category.
+  @param resource_root: The root Resource object.
+  @param category_name: The category name
+  @return: An ApiExternalAcccountType list
+  """
+  return call(resource_root.get,
+      EXTERNAL_ACCOUNT_FETCH_PATH % ("supportedTypes", category_name,),
+      ApiExternalAccountType, True)
+
+def create_external_account(resource_root, name, display_name, type_name,
+                            account_configs=None):
+  """
+  Create an external account
+  @param resource_root: The root Resource object.
+  @param name: Immutable external account name
+  @param display_name: Display name
+  @param type_name: Account type
+  @param account_configs: Optional account configuration (ApiList of ApiConfig objects)
+  @return: An ApiExternalAccount object matching the newly created account
+  """
+  account = ApiExternalAccount(resource_root,
+                               name=name,
+                               displayName=display_name,
+                               typeName=type_name,
+                               accountConfigs=account_configs)
+  return call(resource_root.post,
+      EXTERNAL_ACCOUNT_PATH % ("create",),
+      ApiExternalAccount, False, data=account)
+
+def get_external_account(resource_root, name, view=None):
+  """
+  Lookup an external account by name
+  @param resource_root: The root Resource object.
+  @param name: Account name
+  @param view: View
+  @return: An ApiExternalAccount object
+  """
+  return call(resource_root.get,
+      EXTERNAL_ACCOUNT_FETCH_PATH % ("account", name,),
+      ApiExternalAccount, False, params=view and dict(view=view) or None)
+
+def get_external_account_by_display_name(resource_root,
+                                         display_name, view=None):
+  """
+  Lookup an external account by display name
+  @param resource_root: The root Resource object.
+  @param display_name: Account display name
+  @param view: View
+  @return: An ApiExternalAccount object
+  """
+  return call(resource_root.get,
+      EXTERNAL_ACCOUNT_FETCH_PATH % ("accountByDisplayName", display_name,),
+      ApiExternalAccount, False, params=view and dict(view=view) or None)
+
+def get_all_external_accounts(resource_root, type_name, view=None):
+  """
+  Lookup all external accounts of a particular type, by type name.
+  @param resource_root: The root Resource object.
+  @param type_name: Type name
+  @param view: View
+  @return: An ApiList of ApiExternalAccount objects matching the specified type
+  """
+  return call(resource_root.get,
+      EXTERNAL_ACCOUNT_FETCH_PATH % ("type", type_name,),
+      ApiExternalAccount, True, params=view and dict(view=view) or None)
+
+def update_external_account(resource_root, account):
+  """
+  Update an external account
+  @param resource_root: The root Resource object.
+  @param account: Account to update, account name must be specified.
+  @return: An ApiExternalAccount object, representing the updated external account
+  """
+  return call(resource_root.put,
+      EXTERNAL_ACCOUNT_PATH % ("update",),
+      ApiExternalAccount, False, data=account)
+
+def delete_external_account(resource_root, name):
+  """
+  Delete an external account by name
+  @param resource_root: The root Resource object.
+  @param name: Account name
+  @return: The deleted ApiExternalAccount object
+  """
+  return call(resource_root.delete,
+      EXTERNAL_ACCOUNT_FETCH_PATH % ("delete", name,),
+      ApiExternalAccount, False)
+
+
+class ApiExternalAccountCategory(BaseApiObject):
+  _ATTRIBUTES = {
+    'name'        : None,
+    'displayName' : None,
+    'description' : None
+  }
+
+  def __str__(self):
+    return "<ApiExternalAccountCategory>: %s" % (
+        self.name)
+
+class ApiExternalAccountType(BaseApiObject):
+  _ATTRIBUTES = {
+    'name'         : None,
+    'displayName'  : None,
+    'type'         : None,
+    'categoryName' : None,
+    'description'  : None,
+    'allowedAccountConfigs' : Attr(ApiConfig)
+  }
+
+  def __str__(self):
+    return "<ApiExternalAccountType>: %s (categoryName: %s)" % (
+        self.name, self.typeName)
+
+class ApiExternalAccount(BaseApiObject):
+  _ATTRIBUTES = {
+    'name'             : None,
+    'displayName'      : None,
+    'typeName'         : None,
+    'createdTime'      : ROAttr(),
+    'lastModifiedTime' : ROAttr(),
+    'accountConfigs'   : Attr(ApiConfig)
+  }
+
+  def __init__(self, resource_root, name=None, displayName=None,
+               typeName=None, accountConfigs=None):
+    BaseApiObject.init(self, resource_root, locals())
+
+  def __str__(self):
+    return "<ApiExternalAccount>: %s (typeName: %s)" % (
+        self.name, self.typeName)
+