diff --git a/pyproject.toml b/pyproject.toml index b9aff5a74b..5bc40b1495 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,7 +24,7 @@ classifiers = [ dependencies = [ "jmespath==0.10.0", "six==1.16.0", - "tencentcloud-sdk-python>=3.0.1372", + "tencentcloud-sdk-python-common>=3.0.1372", ] [project.urls] diff --git a/setup.py b/setup.py index ee6d1b01f5..1faaa36ceb 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ def main(): - dep_sdk = "tencentcloud-sdk-python >= %s" % __version__.rsplit(".", 1)[0] + dep_sdk = "tencentcloud-sdk-python-common >= %s" % __version__.rsplit(".", 1)[0] setup( name='tccli', install_requires=[dep_sdk, "jmespath==0.10.0", "six==1.16.0"], diff --git a/tccli/action_caller.py b/tccli/action_caller.py new file mode 100644 index 0000000000..cfca7e70a4 --- /dev/null +++ b/tccli/action_caller.py @@ -0,0 +1,203 @@ +# -*- coding:utf-8 -*- +import os +import os.path as path +import time + +import six +from jmespath import search +from tencentcloud.common import credential +from tencentcloud.common.common_client import CommonClient +from tencentcloud.common.profile.client_profile import ClientProfile +from tencentcloud.common.profile.http_profile import HttpProfile + +import tccli.format_output as format_output +import tccli.options_define as options_define +from tccli import __version__ +from tccli.exceptions import ConfigurationError, ClientError +from tccli.utils import Utils + + +class GenericActionCaller(object): + def __init__(self, module, action): + self._module = module + self._action = action + self._avail_vers = [] + + def __call__(self, args, parsed_globals): + self._call_json(args, parsed_globals) + + def available_versions(self): + if not self._avail_vers: + svc_path = os.path.join(path.dirname(path.abspath(__file__)), 'services', self._module) + dirs = os.listdir(svc_path) + self._avail_vers = [d for d in dirs if d[0] == "v" and os.path.isdir(path.join(svc_path, d))] + + return self._avail_vers + + @staticmethod + def convert_version_str(ver): + return ver[1:5] + "-" + ver[5:7] + "-" + ver[7:9] + + def _call_json(self, args, parsed_globals): + g_param = self.parse_global_arg(parsed_globals) + + if g_param[options_define.UseCVMRole.replace('-', '_')]: + cred = credential.CVMRoleCredential() + elif g_param[options_define.RoleArn.replace('-', '_')] and g_param[ + options_define.RoleSessionName.replace('-', '_')]: + cred = credential.STSAssumeRoleCredential( + g_param[options_define.SecretId], g_param[options_define.SecretKey], + g_param[options_define.RoleArn.replace('-', '_')], + g_param[options_define.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"] + ) + elif os.getenv(options_define.ENV_TKE_REGION) and os.getenv(options_define.ENV_TKE_PROVIDER_ID) and os.getenv( + options_define.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(options_define.ENV_TKE_ROLE_ARN): + cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials() + else: + cred = credential.Credential( + g_param[options_define.SecretId], g_param[options_define.SecretKey], g_param[options_define.Token] + ) + http_profile = HttpProfile( + reqTimeout=60 if g_param[options_define.Timeout] is None else int(g_param[options_define.Timeout]), + reqMethod="POST", + endpoint=g_param[options_define.Endpoint], + proxy=g_param[options_define.HttpsProxy.replace('-', '_')] + ) + cpf = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256") + if g_param[options_define.Language]: + cpf.language = g_param[options_define.Language] + version = self.convert_version_str(g_param[options_define.Version]) + region = g_param[options_define.Region] + client = CommonClient(self._module, version, cred, region, cpf) + client._sdkVersion += ("_CLI_" + __version__) + + start_time = time.time() + while True: + json_obj = client.call_json(self._action, args) + + if not g_param[options_define.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == \ + g_param['OptionsDefine.WaiterInfo']['to']: + break + + cur_time = time.time() + if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']: + raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' % + (g_param['OptionsDefine.WaiterInfo']['expr'], + g_param['OptionsDefine.WaiterInfo']['to'], + search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))) + else: + print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)) + time.sleep(g_param['OptionsDefine.WaiterInfo']['interval']) + + format_output.output("action", json_obj, g_param[options_define.Output], g_param[options_define.Filter]) + + def parse_global_arg(self, parsed_globals): + g_param = parsed_globals + cvm_role_flag = True + for param in parsed_globals.keys(): + if param in [options_define.SecretKey, options_define.SecretId, options_define.RoleArn, + options_define.RoleSessionName]: + if parsed_globals[param] is not None: + cvm_role_flag = False + break + is_exist_profile = True + if not parsed_globals["profile"]: + is_exist_profile = False + g_param["profile"] = os.environ.get("TCCLI_PROFILE", "default") + + configure_path = os.path.join(os.path.expanduser("~"), ".tccli") + is_conf_exist, conf_path = Utils.file_existed(configure_path, g_param["profile"] + ".configure") + is_cred_exist, cred_path = Utils.file_existed(configure_path, g_param["profile"] + ".credential") + + conf = {} + cred = {} + + if is_conf_exist: + conf = Utils.load_json_msg(conf_path) + if is_cred_exist: + cred = Utils.load_json_msg(cred_path) + + if not (isinstance(conf, dict) and isinstance(cred, dict)): + raise ConfigurationError( + "file: %s or %s is not json format" + % (g_param["profile"] + ".configure", g_param["profile"] + ".credential")) + + if options_define.Token not in cred: + cred[options_define.Token] = None + + if not is_exist_profile: + if os.environ.get(options_define.ENV_SECRET_ID) and os.environ.get(options_define.ENV_SECRET_KEY): + cred[options_define.SecretId] = os.environ.get(options_define.ENV_SECRET_ID) + cred[options_define.SecretKey] = os.environ.get(options_define.ENV_SECRET_KEY) + cred[options_define.Token] = os.environ.get(options_define.ENV_TOKEN) + cvm_role_flag = False + + if os.environ.get(options_define.ENV_REGION): + conf[options_define.SysParam][options_define.Region] = os.environ.get(options_define.ENV_REGION) + + if os.environ.get(options_define.ENV_ROLE_ARN) and os.environ.get(options_define.ENV_ROLE_SESSION_NAME): + cred[options_define.RoleArn] = os.environ.get(options_define.ENV_ROLE_ARN) + cred[options_define.RoleSessionName] = os.environ.get(options_define.ENV_ROLE_SESSION_NAME) + cvm_role_flag = False + + if cvm_role_flag: + if "type" in cred and cred["type"] == "cvm-role": + g_param[options_define.UseCVMRole.replace('-', '_')] = True + + for param in g_param.keys(): + if g_param[param] is None: + if param in [options_define.SecretKey, options_define.SecretId, options_define.Token]: + if param in cred: + g_param[param] = cred[param] + elif not (g_param[options_define.UseCVMRole.replace('-', '_')] + or os.getenv(options_define.ENV_TKE_ROLE_ARN)): + raise ConfigurationError("%s is invalid" % param) + elif param in [options_define.Region, options_define.Output, options_define.Language]: + if param in conf[options_define.SysParam]: + g_param[param] = conf[options_define.SysParam][param] + elif param != options_define.Language: + raise ConfigurationError("%s is invalid" % param) + elif param.replace('_', '-') in [options_define.RoleArn, options_define.RoleSessionName]: + if param.replace('_', '-') in cred: + g_param[param] = cred[param.replace('_', '-')] + + try: + if g_param[options_define.ServiceVersion]: + g_param[options_define.Version] = "v" + g_param[options_define.ServiceVersion].replace('-', '') + else: + version = conf[self._module][options_define.Version] + g_param[options_define.Version] = "v" + version.replace('-', '') + + if g_param[options_define.Endpoint] is None: + g_param[options_define.Endpoint] = conf[self._module][options_define.Endpoint] + g_param["sts_cred_endpoint"] = conf.get("sts", {}).get("endpoint") + except Exception as err: + raise ConfigurationError("config file:%s error, %s" % (conf_path, str(err))) + + if g_param[options_define.Version] not in self.available_versions(): + raise Exception("available versions: %s" % " ".join(self.available_versions())) + + if g_param[options_define.Waiter]: + param = eval(g_param[options_define.Waiter]) + if 'expr' not in param: + raise Exception('`expr` in `--waiter` must be defined') + if 'to' not in param: + raise Exception('`to` in `--waiter` must be defined') + if 'timeout' not in param: + if 'waiter' in conf and 'timeout' in conf['waiter']: + param['timeout'] = conf['waiter']['timeout'] + else: + param['timeout'] = 180 + if 'interval' not in param: + if 'waiter' in conf and 'interval' in conf['waiter']: + param['interval'] = conf['waiter']['interval'] + else: + param['interval'] = 5 + param['interval'] = min(param['interval'], param['timeout']) + g_param['OptionsDefine.WaiterInfo'] = param + + if six.PY2: + for key, value in g_param.items(): + if isinstance(value, six.text_type): + g_param[key] = value.encode('utf-8') + return g_param diff --git a/tccli/command.py b/tccli/command.py index fe94f6d113..89422d9321 100644 --- a/tccli/command.py +++ b/tccli/command.py @@ -8,6 +8,7 @@ from collections import OrderedDict from tccli import credentials +from tccli.action_caller import GenericActionCaller from tccli.utils import Utils from tccli.argument import CLIArgument, CustomArgument, ListArgument, BooleanArgument from tccli.exceptions import UnknownArgumentError @@ -180,7 +181,7 @@ def _build_command_map(self): action_model = service_model["actions"][action] action_caller = action_model.get("action_caller", None) if not action_caller: - action_caller = Services.action_caller(self._service_name)()[action] + action_caller = GenericActionCaller(self._service_name, action) command_map[action] = ActionCommand( service_name=self._service_name, version=self._version, diff --git a/tccli/plugins/test/add.py b/tccli/plugins/test/add.py index d3475a6345..8516df5cb9 100644 --- a/tccli/plugins/test/add.py +++ b/tccli/plugins/test/add.py @@ -4,7 +4,7 @@ from tencentcloud.common import credential from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException -from tencentcloud.cvm.v20170312 import cvm_client, models +from tencentcloud.common.common_client import CommonClient def add_command(args, parsed_globals): @@ -21,11 +21,10 @@ def add_command(args, parsed_globals): # do api call with secret key cred = credential.Credential(secret_id, secret_key, token) - cli = cvm_client.CvmClient(cred, region) + cli = CommonClient("cvm", "2017-03-12", cred, region) - req = models.DescribeInstancesRequest() try: - resp = cli.DescribeInstances(req) - print(resp.to_json_string(indent=2)) + resp = cli.call("DescribeInstances", {"Limit": 10}) + print(json.dumps(resp)) except TencentCloudSDKException as e: logging.exception(e) diff --git a/tests/test_auth.py b/tests/test_auth.py new file mode 100644 index 0000000000..e180b63120 --- /dev/null +++ b/tests/test_auth.py @@ -0,0 +1,10 @@ +# -*- coding:utf8 -*- + +from utils import shell, recover_profile + + +@recover_profile() +def test_auth(): + assert "在浏览器中转到以下链接, 并根据提示完成登录" in shell("tccli auth login --browser no") + + assert "登出成功, 密钥凭证已被删除:" in shell("tccli auth logout") diff --git a/tests/test_configure.py b/tests/test_configure.py new file mode 100644 index 0000000000..90103d2620 --- /dev/null +++ b/tests/test_configure.py @@ -0,0 +1,83 @@ +# -*- coding:utf8 -*- +import json +import pytest + +from utils import shell, recover_profile + + +def test_configure_list(): + cmd = 'tccli configure list' + output = shell(cmd) + assert "credential:" in output + assert "configure:" in output + assert "cvm.version =" in output + assert "cvm.endpoint =" in output + + +@recover_profile() +def test_configure_get_set(): + shell("tccli configure set region ap-guangzhou") + + assert "region = ap-guangzhou" in shell("tccli configure get region") + + +@recover_profile() +def test_configure_output_json(): + shell("tccli configure set output json") + + assert "output = json" in shell("tccli configure get output") + + assert json.loads(shell("tccli cvm DescribeInstances")) + + +@recover_profile() +def test_configure_output_text(): + shell("tccli configure set output text") + + assert "output = text" in shell("tccli configure get output") + + try: + json.loads(shell("tccli cvm DescribeInstances")) + pytest.fail("should be decode error in text output") + except Exception: + pass + + +@recover_profile() +def test_configure_output_table(): + shell("tccli configure set output table") + + assert "output = table" in shell("tccli configure get output") + + try: + json.loads(shell("tccli cvm DescribeInstances")) + pytest.fail("should be decode error in table output") + except Exception: + pass + + +@recover_profile() +def test_configure_credential(): + sec_id = "xxx" + sec_key = "yyy" + + shell("tccli configure set secretId %s" % sec_id) + shell("tccli configure set secretKey %s" % sec_key) + + output = shell("tccli configure get secretId").strip() + sec_id2 = output[len("secretId = "):] + + output = shell("tccli configure get secretKey").strip() + sec_key2 = output[len("secretKey = "):] + + assert sec_id == sec_id2 + assert sec_key == sec_key2 + + +@recover_profile("user2") +def test_configure_profile(): + shell("tccli configure --profile user2 set region ap-shanghai") + + assert "region = ap-shanghai\n" == shell("tccli configure --profile user2 get region") + + assert "region = ap-shanghai\n" == shell("TCCLI_PROFILE=user2 tccli configure get region") diff --git a/tests/test_cvm.py b/tests/test_cvm.py index 3d089823f6..a2334f513a 100644 --- a/tests/test_cvm.py +++ b/tests/test_cvm.py @@ -1,31 +1,20 @@ -from utils import TestCli +from utils import shell + def test_describe_regions(): - cmd = 'tccli cvm DescribeRegions' - expect = "\"Region\": \"ap-guangzhou\"" - test_cli = TestCli() - test_cli.equal(cmd, expect) + assert "\"Region\": \"ap-guangzhou\"" in shell("tccli cvm DescribeRegions") def test_describe_instances(): - cmd = 'tccli cvm DescribeInstances' - expect = "\"TotalCount\":" - test_cli = TestCli() - test_cli.equal(cmd, expect) + assert "\"TotalCount\":" in shell("tccli cvm DescribeInstances") def test_describe_disaster_disaster_recover_group_quota(): - cmd = 'tccli cvm DescribeDisasterRecoverGroupQuota' - expect = "\"CvmInHostGroupQuota\":" - test_cli = TestCli() - test_cli.equal(cmd, expect) + assert "\"CvmInHostGroupQuota\":" in shell("tccli cvm DescribeDisasterRecoverGroupQuota") def test_describe_disaster_recover_groups(): - cmd = 'tccli cvm DescribeDisasterRecoverGroups' - expect = "DisasterRecoverGroupSet" - test_cli = TestCli() - test_cli.equal(cmd, expect) + assert "DisasterRecoverGroupSet" in shell("tccli cvm DescribeDisasterRecoverGroups") def test_describe_hosts(): @@ -33,6 +22,5 @@ def test_describe_hosts(): cmd += ' --Filters.0.Name zone' cmd += ' --Filters.0.Values ap-guangzhou-2' cmd += ' --Offset 0 --Limit 20' - expect = "\"HostSet\": []" - test_cli = TestCli() - test_cli.equal(cmd, expect) + + assert "\"HostSet\": []" in shell(cmd) diff --git a/tests/test_helper.py b/tests/test_helper.py index eda2567f46..0455e297b3 100644 --- a/tests/test_helper.py +++ b/tests/test_helper.py @@ -1,30 +1,30 @@ # -*- coding:utf8 -*- -from utils import TestCli +from utils import shell def test_help(): cmd = 'tccli help' expect = 'tccli [options] [options] [options] [options and parameters]' - test_cli = TestCli() - test_cli.equal(cmd, expect) + + assert expect in shell(cmd) def test_help_detail(): cmd = 'tccli help --detail' expect = 'cvm\n 介绍如何使用API对云服务器进行操作，包括使用并管理实例、镜像、密钥等资源。' - test_cli = TestCli() - test_cli.equal(cmd, expect) + + assert expect in shell(cmd) def test_cvm_help(): cmd = 'tccli cvm help' expect = '' - test_cli = TestCli() - test_cli.equal(cmd, expect) + + assert expect in shell(cmd) def test_cvm_help_detail(): cmd = 'tccli cvm help --detail' expect = 'AVAILABLE ACTIONS\n AllocateHosts' - test_cli = TestCli() - test_cli.equal(cmd, expect) + + assert expect in shell(cmd) diff --git a/tests/test_sso.py b/tests/test_sso.py new file mode 100644 index 0000000000..4b459dba5c --- /dev/null +++ b/tests/test_sso.py @@ -0,0 +1,12 @@ +# -*- coding:utf8 -*- + +from utils import shell, recover_profile + + +@recover_profile() +def test_sso_configure_and_logout(): + url = "https://tencentcloudsso.com/test/login" + assert ("url 已配置为 '%s', 接下来可以使用 `tccli sso login` 进行登陆\n" % url == + shell("tccli sso configure --url %s" % url)) + + assert "登出成功, 密钥凭证已被删除:" in shell("tccli sso logout") diff --git a/tests/utils.py b/tests/utils.py index 383882ead4..84e8e303aa 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -1,14 +1,69 @@ +import contextlib +import functools import os +import subprocess +import sys -class TestCli(object): +def shell(cmd): + p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) + p.wait() - def run_cmd(self, cmd): - result = os.popen(cmd) - return result + if sys.version_info.major >= 3: + return p.stdout.read(409600).decode("utf-8") - def equal(self, cmd, expect): - run = self.run_cmd(cmd) - result = run.read() - # self.assertEqual(result, expect, "Unexpected Result") - assert result.find(expect) >= 0 + return p.stdout.read(409600) + + +def recover_profile(prof="default"): + def decorator(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + with recover_profile_ctx(prof): + return func(*args, **kwargs) + + return wrapper + + return decorator + + +@contextlib.contextmanager +def recover_profile_ctx(prof="default"): + cred_path = os.path.expanduser("~/.tccli/%s.credential" % prof) + conf_path = os.path.expanduser("~/.tccli/%s.configure" % prof) + + cred_backup = None + conf_backup = None + + if os.path.exists(cred_path): + with open(cred_path, "r") as cred_f: + cred_backup = cred_f.readlines() + + if os.path.exists(conf_path): + with open(conf_path, "r") as conf_f: + conf_backup = conf_f.readlines() + + yield + + if sys.version_info.major == 2: + FileNotFound = OSError + else: + FileNotFound = FileNotFoundError + + if cred_backup: + with open(cred_path, "w") as cred_f: + cred_f.writelines(cred_backup) + else: + try: + os.remove(cred_path) + except FileNotFound: + pass + + if conf_backup: + with open(conf_path, "w") as conf_f: + conf_f.writelines(conf_backup) + else: + try: + os.remove(conf_path) + except FileNotFound: + pass