921179d5f6
This patchset disabled Groups controller and removed related API/CLI unit test cases. Change-Id: I6bbd3615c85cc9db98e57fd6fa9ccfeb80c572c9
432 lines
21 KiB
Python
432 lines
21 KiB
Python
import argparse
|
|
import orm.base_config as base_config
|
|
import os
|
|
import requests
|
|
|
|
from . import cli_common
|
|
from . import config
|
|
|
|
|
|
class ResponseError(Exception):
|
|
pass
|
|
|
|
|
|
class ConnectionError(Exception):
|
|
pass
|
|
|
|
|
|
def add_to_parser(service_sub):
|
|
parser = \
|
|
service_sub.add_parser('cms',
|
|
help='Customer Management Service',
|
|
formatter_class=lambda prog:
|
|
argparse.HelpFormatter(prog,
|
|
max_help_position=30,
|
|
width=120))
|
|
parser.add_argument('--version', action='version', version='%(prog)s 1.0')
|
|
parser.add_argument('--auth-region', type=str,
|
|
help='Region used for authentication',
|
|
default=get_environment_variable('auth-region'))
|
|
parser.add_argument('--keystone-auth-url', type=str,
|
|
help='keystone-auth-url used for authentication',
|
|
default=get_environment_variable('keystone-auth-url'))
|
|
parser.add_argument('--tenant-name', type=str,
|
|
help='Keystone user tenant name',
|
|
default=get_environment_variable('tenant-name'))
|
|
parser.add_argument('--username', type=str, help='Keystone user name',
|
|
default=get_environment_variable('username'))
|
|
parser.add_argument('--user-domain', type=str, help='Keystone user domain',
|
|
default=get_environment_variable('user-domain'))
|
|
parser.add_argument('--password', type=str, help='Keystone user password',
|
|
default=get_environment_variable('password'))
|
|
parser.add_argument('--project-domain', type=str,
|
|
help='Keystone project domain',
|
|
default=get_environment_variable('project-domain'))
|
|
parser.add_argument('--rms-base-url', type=str, help='RMS base URL',
|
|
default=get_environment_variable('rms-base-url'))
|
|
parser.add_argument('--cms-base-url', type=str, help='CMS base URL',
|
|
default=get_environment_variable('cms-base-url'))
|
|
parser.add_argument('--tracking_id', type=str,
|
|
help='"X-RANGER-Tracking-Id" header')
|
|
parser.add_argument('--port', type=int, help='port number of CMS server')
|
|
parser.add_argument('--timeout', type=int,
|
|
help='request timeout in seconds (default: 10)')
|
|
parser.add_argument('-v', '--verbose', help='show details',
|
|
action="store_true")
|
|
parser.add_argument('-f', '--faceless',
|
|
help=argparse.SUPPRESS,
|
|
default=False,
|
|
action="store_true")
|
|
subparsers = parser.add_subparsers(dest='subcmd',
|
|
metavar='<subcommand> [-h] <args>')
|
|
|
|
# customer
|
|
parser_create_customer = subparsers.add_parser('create_customer',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <data file '
|
|
'with new customer '
|
|
'JSON>')
|
|
parser_create_customer.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_create_customer.add_argument('datafile',
|
|
type=argparse.FileType('r'),
|
|
help='<data file with new customer '
|
|
'JSON>')
|
|
|
|
parser_delete_customer = subparsers.add_parser('delete_customer',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <customer '
|
|
'id>')
|
|
parser_delete_customer.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_delete_customer.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
|
|
parser_update_customer = subparsers.add_parser('update_customer',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <customer '
|
|
'id> <data file with '
|
|
'updated customer '
|
|
'JSON>')
|
|
parser_update_customer.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_update_customer.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_update_customer.add_argument('datafile',
|
|
type=argparse.FileType('r'),
|
|
help='<data file with updated '
|
|
'customer JSON>')
|
|
|
|
# region
|
|
parser_add_region = subparsers.add_parser('add_region',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <customer id> '
|
|
'<data file with region('
|
|
's) JSON>')
|
|
parser_add_region.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_add_region.add_argument('custid', type=str, help='<customer id>')
|
|
parser_add_region.add_argument('datafile', type=argparse.FileType('r'),
|
|
help='<data file with region(s) JSON>')
|
|
|
|
parser_replace_region = subparsers.add_parser('replace_region',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <customer '
|
|
'id> <data file with '
|
|
'region(s) JSON>')
|
|
parser_replace_region.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_replace_region.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_replace_region.add_argument('datafile', type=argparse.FileType('r'),
|
|
help='<data file with region(s) JSON>')
|
|
|
|
parser_delete_region = subparsers.add_parser('delete_region',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] '
|
|
'[--force_delete] '
|
|
'<customer id> '
|
|
'<region id>')
|
|
parser_delete_region.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_delete_region.add_argument('custid', type=str, help='<customer id>')
|
|
parser_delete_region.add_argument('regionid', type=str, help='<region id>')
|
|
parser_delete_region.add_argument('--force_delete',
|
|
help='force delete region',
|
|
action="store_true")
|
|
|
|
# add user
|
|
parser_add_user = subparsers.add_parser('add_user',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <customer id> '
|
|
'<region id> <data file '
|
|
'with user(s) JSON>')
|
|
parser_add_user.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_add_user.add_argument('custid', type=str, help='<customer id>')
|
|
parser_add_user.add_argument('regionid', type=str, help='<region id>')
|
|
parser_add_user.add_argument('datafile', type=argparse.FileType('r'),
|
|
help='<data file with user(s) JSON>')
|
|
|
|
# replace user
|
|
parser_replace_user = subparsers.add_parser('replace_user',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] <customer id> '
|
|
'<region id> <data file '
|
|
'with user(s) JSON>')
|
|
parser_replace_user.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_replace_user.add_argument('custid', type=str, help='<customer id>')
|
|
parser_replace_user.add_argument('regionid', type=str, help='<region id>')
|
|
parser_replace_user.add_argument('datafile', type=argparse.FileType('r'),
|
|
help='<data file with user(s) JSON>')
|
|
|
|
# delete user
|
|
parser_delete_user = subparsers.add_parser(
|
|
'delete_user',
|
|
help='[<"X-RANGER-Client" header>] '
|
|
'<customer id> <region id> <user id>')
|
|
parser_delete_user.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_delete_user.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_delete_user.add_argument('regionid', type=str,
|
|
help='<region id>')
|
|
parser_delete_user.add_argument('userid', type=str,
|
|
help='<user id>')
|
|
|
|
# add default user
|
|
parser_add_default_user = \
|
|
subparsers.add_parser('add_default_user',
|
|
help='[<"X-RANGER-Client" header>] '
|
|
'<customer id> '
|
|
'<data file with '
|
|
'region(s) JSON>')
|
|
parser_add_default_user.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_add_default_user.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_add_default_user.add_argument('datafile',
|
|
type=argparse.FileType('r'),
|
|
help='<data file with user(s) JSON>')
|
|
|
|
# replace default user
|
|
parser_replace_default_user = \
|
|
subparsers.add_parser('replace_default_user',
|
|
help='[<"X-RANGER-Client" header>] '
|
|
'<customer id> '
|
|
'<data file '
|
|
'with region(s) '
|
|
'JSON>')
|
|
parser_replace_default_user.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_replace_default_user.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_replace_default_user.add_argument('datafile',
|
|
type=argparse.FileType('r'),
|
|
help='<data file with user(s) '
|
|
'JSON>')
|
|
|
|
# change enable
|
|
parser_enable_customer = subparsers.add_parser('enabled',
|
|
help='[<"X-RANGER-Client" '
|
|
'header>] '
|
|
'<customer id> '
|
|
'<data file with '
|
|
'true/false JSON>')
|
|
parser_enable_customer.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_enable_customer.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_enable_customer.add_argument('datafile',
|
|
type=argparse.FileType('r'),
|
|
help='<data file with true/false '
|
|
'JSON>')
|
|
|
|
# delete default user
|
|
parser_delete_default_user = \
|
|
subparsers.add_parser('delete_default_user',
|
|
help='[<"X-RANGER-Client" header>] <customer '
|
|
'id> <user id>')
|
|
parser_delete_default_user.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_delete_default_user.add_argument('custid', type=str,
|
|
help='<customer id>')
|
|
parser_delete_default_user.add_argument('userid', type=str,
|
|
help='<user id>')
|
|
|
|
# add metadata
|
|
h1, h2, h3 = ('[<"X-RANGER-Client" header>]', '<customer id>',
|
|
'<data file with metadata(s) JSON>')
|
|
parser_add_metadata = subparsers.add_parser('add_metadata',
|
|
help='%s %s %s' % (h1, h2, h3))
|
|
parser_add_metadata.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_add_metadata.add_argument('custid', type=str,
|
|
help=h2)
|
|
parser_add_metadata.add_argument('datafile', type=argparse.FileType('r'),
|
|
help=h3)
|
|
|
|
# replace metadata
|
|
h1, h2, h3 = ('[<"X-RANGER-Client" header>]', '<customer id>',
|
|
'<data file with metadata(s) JSON>')
|
|
parser_replace_metadata = subparsers.add_parser('replace_metadata',
|
|
help='%s %s %s' % (
|
|
h1, h2, h3))
|
|
parser_replace_metadata.add_argument('client',
|
|
**cli_common.ORM_CLIENT_KWARGS)
|
|
parser_replace_metadata.add_argument('custid', type=str,
|
|
help=h2)
|
|
parser_replace_metadata.add_argument('datafile',
|
|
type=argparse.FileType('r'),
|
|
help=h3)
|
|
|
|
# get customer
|
|
h1, h2 = '[<"X-RANGER-Client" header>]', '<customer id or customer name>'
|
|
parser_get_customer = subparsers.add_parser('get_customer',
|
|
help='%s %s' % (h1, h2))
|
|
parser_get_customer.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_get_customer.add_argument('custid', type=str, help=h2)
|
|
|
|
# list customers
|
|
h1 = '[<"X-RANGER-Client" header>]'
|
|
h2 = '[--region <name>] [--user <name>] [--metadata <key:value>]' \
|
|
' [--starts_with <name>] [--contains <name>]'
|
|
parser_list_customer = subparsers.add_parser('list_customers',
|
|
help='%s %s' % (h1, h2))
|
|
parser_list_customer.add_argument('client', **cli_common.ORM_CLIENT_KWARGS)
|
|
parser_list_customer.add_argument('--region', type=str, help='region name')
|
|
parser_list_customer.add_argument('--user', type=str, help='user name')
|
|
parser_list_customer.add_argument('--starts_with', type=str,
|
|
help='customer name')
|
|
parser_list_customer.add_argument('--contains', type=str,
|
|
help='* contains in customer name')
|
|
parser_list_customer.add_argument('--metadata', action='append', nargs="+",
|
|
type=str, help='<key:value>')
|
|
|
|
return parser
|
|
|
|
|
|
def preparm(p):
|
|
return ('' if len(p) else '?') + ('&' if len(p) else '')
|
|
|
|
|
|
def cmd_details(args):
|
|
if args.subcmd == 'create_customer':
|
|
return requests.post, 'customers/'
|
|
elif args.subcmd == 'delete_customer':
|
|
return requests.delete, 'customers/%s' % args.custid
|
|
elif args.subcmd == 'update_customer':
|
|
return requests.put, 'customers/%s' % args.custid
|
|
elif args.subcmd == 'add_region':
|
|
return requests.post, 'customers/%s/regions' % args.custid
|
|
elif args.subcmd == 'replace_region':
|
|
return requests.put, 'customers/%s/regions' % args.custid
|
|
elif args.subcmd == 'delete_region':
|
|
return requests.delete, 'customers/%s/regions/%s/%s' % (
|
|
args.custid,
|
|
args.regionid,
|
|
args.force_delete)
|
|
elif args.subcmd == 'add_user':
|
|
return requests.post, 'customers/%s/regions/%s/users' % (
|
|
args.custid, args.regionid)
|
|
elif args.subcmd == 'replace_user':
|
|
return requests.put, 'customers/%s/regions/%s/users' % (
|
|
args.custid, args.regionid)
|
|
elif args.subcmd == 'delete_user':
|
|
return requests.delete, 'customers/%s/regions/%s/users/%s' % (
|
|
args.custid,
|
|
args.regionid,
|
|
args.userid)
|
|
elif args.subcmd == 'add_default_user':
|
|
return requests.post, 'customers/%s/users' % args.custid
|
|
elif args.subcmd == 'replace_default_user':
|
|
return requests.put, 'customers/%s/users' % args.custid
|
|
elif args.subcmd == 'delete_default_user':
|
|
return requests.delete, 'customers/%s/users/%s' % (
|
|
args.custid,
|
|
args.userid)
|
|
elif args.subcmd == 'add_metadata':
|
|
return requests.post, 'customers/%s/metadata' % args.custid
|
|
elif args.subcmd == 'replace_metadata':
|
|
return requests.put, 'customers/%s/metadata' % args.custid
|
|
elif args.subcmd == 'get_customer':
|
|
return requests.get, 'customers/%s' % args.custid
|
|
elif args.subcmd == 'enabled':
|
|
return requests.put, 'customers/%s/enabled' % args.custid
|
|
elif args.subcmd == 'list_customers':
|
|
param = ''
|
|
if args.region:
|
|
param += '%sregion=%s' % (preparm(param), args.region)
|
|
if args.user:
|
|
param += '%suser=%s' % (preparm(param), args.user)
|
|
if args.starts_with:
|
|
param += '%sstarts_with=%s' % (preparm(param), args.starts_with)
|
|
if args.contains:
|
|
param += '%scontains=%s' % (preparm(param), args.contains)
|
|
if args.metadata:
|
|
for meta in args.metadata:
|
|
param += '%smetadata=%s' % (preparm(param), meta[0])
|
|
return requests.get, 'customers/%s' % param
|
|
|
|
|
|
def validate_args(args):
|
|
for argument in ('tenant_name', 'username', 'password',
|
|
'auth_region', 'keystone_auth_url'):
|
|
argument_value = getattr(args, argument, None)
|
|
if argument_value is not None:
|
|
globals()[argument] = argument_value
|
|
else:
|
|
configuration_value = getattr(config, argument)
|
|
if configuration_value:
|
|
globals()[argument] = configuration_value
|
|
else:
|
|
message = ('ERROR: {} for token generation was not supplied. '
|
|
'Please use its command-line argument or '
|
|
'environment variable.'.format(argument))
|
|
print(message)
|
|
raise cli_common.MissingArgumentError(message)
|
|
|
|
|
|
def get_environment_variable(argument):
|
|
# The rules are: all caps, underscores instead of dashes and prefixed
|
|
|
|
environment_variable = 'RANGER_{}'.format(
|
|
argument.replace('-', '_').upper())
|
|
|
|
return os.environ.get(environment_variable)
|
|
|
|
|
|
def run(args):
|
|
host = args.cms_base_url if args.cms_base_url else \
|
|
base_config.cms['base_url']
|
|
port = args.port if args.port else base_config.cms['port']
|
|
data = args.datafile.read() if 'datafile' in args else '{}'
|
|
timeout = args.timeout if args.timeout else 10
|
|
|
|
rest_cmd, cmd_url = cmd_details(args)
|
|
url = '%s/v1/orm/' % (host) + cmd_url
|
|
if args.faceless:
|
|
auth_key = auth_region = requester = client = ''
|
|
else:
|
|
try:
|
|
validate_args(args)
|
|
auth_key = cli_common.get_token(timeout, args)
|
|
except Exception:
|
|
exit(1)
|
|
auth_region = globals()['auth_region']
|
|
requester = globals()['username']
|
|
client = requester
|
|
|
|
tracking_id = args.tracking_id if args.tracking_id else None
|
|
headers = {
|
|
'content-type': 'application/json',
|
|
'X-Auth-Token': auth_key,
|
|
'X-Auth-Region': auth_region,
|
|
'X-RANGER-Requester': requester,
|
|
'X-RANGER-Client': client,
|
|
'X-RANGER-Tracking-Id': tracking_id
|
|
}
|
|
|
|
if args.verbose:
|
|
print((
|
|
"Sending API:\ntimeout: %d\ndata: %s\nheaders: %s\ncmd: %s\nurl: "
|
|
"%s\n" % (
|
|
timeout, data, headers, rest_cmd.__name__, url)))
|
|
|
|
try:
|
|
resp = rest_cmd(url, timeout=timeout, data=data, headers=headers,
|
|
verify=config.verify)
|
|
except Exception as e:
|
|
print(e)
|
|
exit(1)
|
|
|
|
if not 200 <= resp.status_code < 300:
|
|
content = resp.content
|
|
print('API error: %s %s (Reason: %d)\n%s' % (
|
|
rest_cmd.__name__.upper(), url, resp.status_code, content))
|
|
exit(1)
|
|
|
|
if resp.status_code == 204: # no content
|
|
exit(0)
|
|
|
|
rj = resp.json()
|
|
if rj == 'Not found':
|
|
print('No output was found')
|
|
else:
|
|
cli_common.pretty_print_json(rj)
|