mirror of
https://github.com/httprunner/httprunner.git
synced 2026-05-12 11:29:48 +08:00
542 lines
18 KiB
Python
542 lines
18 KiB
Python
import os
|
|
import subprocess
|
|
import sys
|
|
from shutil import copyfile
|
|
from typing import Text, List, Tuple, Dict, Set, NoReturn
|
|
|
|
import jinja2
|
|
from loguru import logger
|
|
from sentry_sdk import capture_exception
|
|
|
|
from httprunner import exceptions, __version__
|
|
from httprunner.compat import (
|
|
ensure_testcase_v3_api,
|
|
ensure_testcase_v3,
|
|
convert_variables,
|
|
ensure_path_sep,
|
|
)
|
|
from httprunner.loader import (
|
|
load_folder_files,
|
|
load_test_file,
|
|
load_testcase,
|
|
load_testsuite,
|
|
load_project_meta,
|
|
)
|
|
from httprunner.response import uniform_validator
|
|
from httprunner.utils import ensure_file_path_valid, override_config_variables
|
|
|
|
""" cache converted pytest files, avoid duplicate making
|
|
"""
|
|
pytest_files_made_cache_mapping: Dict[Text, Text] = {}
|
|
|
|
""" save generated pytest files to run, except referenced testcase
|
|
"""
|
|
pytest_files_run_set: Set = set()
|
|
|
|
__TEMPLATE__ = jinja2.Template(
|
|
"""# NOTE: Generated By HttpRunner v{{ version }}
|
|
# FROM: {{ testcase_path }}
|
|
{% if imports_list %}
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.getcwd())
|
|
{% endif %}
|
|
from httprunner import HttpRunner, Config, Step, RunRequest, RunTestCase
|
|
{% for import_str in imports_list %}
|
|
{{ import_str }}
|
|
{% endfor %}
|
|
|
|
class {{ class_name }}(HttpRunner):
|
|
config = {{ config_chain_style }}
|
|
|
|
teststeps = [
|
|
{% for step_chain_style in teststeps_chain_style %}
|
|
{{ step_chain_style }},
|
|
{% endfor %}
|
|
]
|
|
|
|
if __name__ == "__main__":
|
|
{{ class_name }}().test_start()
|
|
|
|
"""
|
|
)
|
|
|
|
|
|
def __ensure_absolute(path: Text) -> Text:
|
|
path = ensure_path_sep(path)
|
|
project_meta = load_project_meta(path)
|
|
|
|
if os.path.isabs(path):
|
|
absolute_path = path
|
|
else:
|
|
absolute_path = os.path.join(project_meta.RootDir, path)
|
|
|
|
if not os.path.isfile(absolute_path):
|
|
raise exceptions.ParamsError(f"Invalid testcase file path: {absolute_path}")
|
|
|
|
return absolute_path
|
|
|
|
|
|
def __ensure_cwd_relative(path: Text) -> Text:
|
|
""" convert absolute path to relative path, based on os.getcwd()
|
|
|
|
Args:
|
|
path: absolute path
|
|
|
|
Returns: relative path based on os.getcwd()
|
|
|
|
"""
|
|
if os.path.isabs(path):
|
|
return path[len(os.getcwd()) + 1 :]
|
|
else:
|
|
return path
|
|
|
|
|
|
def __ensure_testcase_module(path: Text) -> NoReturn:
|
|
""" ensure pytest files are in python module, generate __init__.py on demand
|
|
"""
|
|
init_file = os.path.join(os.path.dirname(path), "__init__.py")
|
|
if os.path.isfile(init_file):
|
|
return
|
|
|
|
with open(init_file, "w", encoding="utf-8") as f:
|
|
f.write("# NOTICE: Generated By HttpRunner. DO NOT EDIT!\n")
|
|
|
|
|
|
def __ensure_project_meta_files(tests_path: Text) -> NoReturn:
|
|
""" ensure project meta files exist in generated pytest folder files
|
|
include debugtalk.py and .env
|
|
"""
|
|
project_meta = load_project_meta(tests_path)
|
|
|
|
# handle cases when generated pytest directory are different from original yaml/json testcases
|
|
debugtalk_path = project_meta.debugtalk_path
|
|
if debugtalk_path:
|
|
debugtalk_new_path = ensure_file_path_valid(debugtalk_path)
|
|
if debugtalk_new_path != debugtalk_path:
|
|
logger.info(f"copy debugtalk.py to {debugtalk_new_path}")
|
|
copyfile(debugtalk_path, debugtalk_new_path)
|
|
|
|
global pytest_files_made_cache_mapping
|
|
pytest_files_made_cache_mapping[debugtalk_new_path] = ""
|
|
|
|
dot_csv_path = project_meta.dot_env_path
|
|
if dot_csv_path:
|
|
dot_csv_new_path = ensure_file_path_valid(dot_csv_path)
|
|
if dot_csv_new_path != dot_csv_path:
|
|
logger.info(f"copy .env to {dot_csv_new_path}")
|
|
copyfile(dot_csv_path, dot_csv_new_path)
|
|
|
|
|
|
def convert_testcase_path(testcase_path: Text) -> Tuple[Text, Text]:
|
|
"""convert single YAML/JSON testcase path to python file"""
|
|
testcase_new_path = ensure_file_path_valid(testcase_path)
|
|
|
|
dir_path = os.path.dirname(testcase_new_path)
|
|
file_name, _ = os.path.splitext(os.path.basename(testcase_new_path))
|
|
testcase_python_path = os.path.join(dir_path, f"{file_name}_test.py")
|
|
|
|
# convert title case, e.g. request_with_variables => RequestWithVariables
|
|
name_in_title_case = file_name.title().replace("_", "")
|
|
|
|
return testcase_python_path, name_in_title_case
|
|
|
|
|
|
def format_pytest_with_black(*python_paths: Text) -> NoReturn:
|
|
logger.info("format pytest cases with black ...")
|
|
try:
|
|
subprocess.run(["black", *python_paths])
|
|
except subprocess.CalledProcessError as ex:
|
|
capture_exception(ex)
|
|
logger.error(ex)
|
|
sys.exit(1)
|
|
except FileNotFoundError:
|
|
err_msg = """
|
|
missing dependency tool: black
|
|
install black manually and try again:
|
|
$ pip install black
|
|
"""
|
|
logger.error(err_msg)
|
|
sys.exit(1)
|
|
|
|
|
|
def make_config_chain_style(config: Dict) -> Text:
|
|
config_chain_style = f'Config("{config["name"]}")'
|
|
|
|
if config["variables"]:
|
|
variables = config["variables"]
|
|
config_chain_style += f".variables(**{variables})"
|
|
|
|
if "base_url" in config:
|
|
config_chain_style += f'.base_url("{config["base_url"]}")'
|
|
|
|
if "verify" in config:
|
|
config_chain_style += f'.verify({config["verify"]})'
|
|
|
|
if "export" in config:
|
|
config_chain_style += f'.export(*{config["export"]})'
|
|
|
|
return config_chain_style
|
|
|
|
|
|
def make_request_chain_style(request: Dict) -> Text:
|
|
method = request["method"].lower()
|
|
url = request["url"]
|
|
request_chain_style = f'.{method}("{url}")'
|
|
|
|
if "params" in request:
|
|
params = request["params"]
|
|
request_chain_style += f".with_params(**{params})"
|
|
|
|
if "headers" in request:
|
|
headers = request["headers"]
|
|
request_chain_style += f".with_headers(**{headers})"
|
|
|
|
if "cookies" in request:
|
|
cookies = request["cookies"]
|
|
request_chain_style += f".with_cookies(**{cookies})"
|
|
|
|
if "data" in request:
|
|
data = request["data"]
|
|
if isinstance(data, Text):
|
|
data = f'"{data}"'
|
|
request_chain_style += f".with_data({data})"
|
|
|
|
if "json" in request:
|
|
req_json = request["json"]
|
|
request_chain_style += f".with_json({req_json})"
|
|
|
|
if "timeout" in request:
|
|
timeout = request["timeout"]
|
|
request_chain_style += f".set_timeout({timeout})"
|
|
|
|
if "verify" in request:
|
|
verify = request["verify"]
|
|
request_chain_style += f".set_verify({verify})"
|
|
|
|
if "allow_redirects" in request:
|
|
allow_redirects = request["allow_redirects"]
|
|
request_chain_style += f".set_allow_redirects({allow_redirects})"
|
|
|
|
if "upload" in request:
|
|
upload = request["upload"]
|
|
request_chain_style += f".upload(**{upload})"
|
|
|
|
return request_chain_style
|
|
|
|
|
|
def make_teststep_chain_style(teststep: Dict) -> Text:
|
|
if teststep.get("request"):
|
|
step_info = f'RunRequest("{teststep["name"]}")'
|
|
elif teststep.get("testcase"):
|
|
step_info = f'RunTestCase("{teststep["name"]}")'
|
|
else:
|
|
raise exceptions.TestCaseFormatError(f"Invalid teststep: {teststep}")
|
|
|
|
if "variables" in teststep:
|
|
variables = teststep["variables"]
|
|
step_info += f".with_variables(**{variables})"
|
|
|
|
if "setup_hooks" in teststep:
|
|
setup_hooks = teststep["setup_hooks"]
|
|
for hook in setup_hooks:
|
|
if isinstance(hook, Text):
|
|
step_info += f'.setup_hook("{hook}")'
|
|
elif isinstance(hook, Dict) and len(hook) == 1:
|
|
assign_var_name, hook_content = list(hook.items())[0]
|
|
step_info += f'.setup_hook("{hook}", "{assign_var_name}")'
|
|
else:
|
|
raise exceptions.TestCaseFormatError(f"Invalid setup hook: {hook}")
|
|
|
|
if teststep.get("request"):
|
|
step_info += make_request_chain_style(teststep["request"])
|
|
elif teststep.get("testcase"):
|
|
testcase = teststep["testcase"]
|
|
call_ref_testcase = f".call({testcase})"
|
|
step_info += call_ref_testcase
|
|
|
|
if "teardown_hooks" in teststep:
|
|
teardown_hooks = teststep["teardown_hooks"]
|
|
for hook in teardown_hooks:
|
|
if isinstance(hook, Text):
|
|
step_info += f'.teardown_hook("{hook}")'
|
|
elif isinstance(hook, Dict) and len(hook) == 1:
|
|
assign_var_name, hook_content = list(hook.items())[0]
|
|
step_info += f'.teardown_hook("{hook}", "{assign_var_name}")'
|
|
else:
|
|
raise exceptions.TestCaseFormatError(f"Invalid teardown hook: {hook}")
|
|
|
|
if "extract" in teststep:
|
|
# request step
|
|
step_info += ".extract()"
|
|
for extract_name, extract_path in teststep["extract"].items():
|
|
step_info += f'.with_jmespath("{extract_path}", "{extract_name}")'
|
|
|
|
if "export" in teststep:
|
|
# reference testcase step
|
|
export: List[Text] = teststep["export"]
|
|
step_info += f".export(*{export})"
|
|
|
|
if "validate" in teststep:
|
|
step_info += ".validate()"
|
|
|
|
for v in teststep["validate"]:
|
|
validator = uniform_validator(v)
|
|
assert_method = validator["assert"]
|
|
check = validator["check"]
|
|
if '"' in check:
|
|
# e.g. body."user-agent" => 'body."user-agent"'
|
|
check = f"'{check}'"
|
|
else:
|
|
check = f'"{check}"'
|
|
expect = validator["expect"]
|
|
if isinstance(expect, Text):
|
|
expect = f'"{expect}"'
|
|
step_info += f".assert_{assert_method}({check}, {expect})"
|
|
|
|
return f"Step({step_info})"
|
|
|
|
|
|
def make_testcase(testcase: Dict, dir_path: Text = None) -> Text:
|
|
"""convert valid testcase dict to pytest file path"""
|
|
# ensure compatibility with testcase format v2
|
|
testcase = ensure_testcase_v3(testcase)
|
|
|
|
# validate testcase format
|
|
load_testcase(testcase)
|
|
|
|
testcase_abs_path = __ensure_absolute(testcase["config"]["path"])
|
|
logger.info(f"start to make testcase: {testcase_abs_path}")
|
|
|
|
testcase_python_path, testcase_cls_name = convert_testcase_path(testcase_abs_path)
|
|
if dir_path:
|
|
testcase_python_path = os.path.join(
|
|
dir_path, os.path.basename(testcase_python_path)
|
|
)
|
|
|
|
global pytest_files_made_cache_mapping
|
|
if testcase_python_path in pytest_files_made_cache_mapping:
|
|
return testcase_python_path
|
|
|
|
config = testcase["config"]
|
|
config["path"] = __ensure_cwd_relative(testcase_python_path)
|
|
config["variables"] = convert_variables(
|
|
config.get("variables", {}), testcase_abs_path
|
|
)
|
|
|
|
# prepare reference testcase
|
|
imports_list = []
|
|
teststeps = testcase["teststeps"]
|
|
for teststep in teststeps:
|
|
if not teststep.get("testcase"):
|
|
continue
|
|
|
|
# make ref testcase pytest file
|
|
ref_testcase_path = __ensure_absolute(teststep["testcase"])
|
|
test_content = load_test_file(ref_testcase_path)
|
|
|
|
# api in v2 format, convert to v3 testcase
|
|
if "request" in test_content and "name" in test_content:
|
|
test_content = ensure_testcase_v3_api(test_content)
|
|
|
|
test_content.setdefault("config", {})["path"] = ref_testcase_path
|
|
ref_testcase_python_path = make_testcase(test_content)
|
|
|
|
# prepare ref testcase class name
|
|
ref_testcase_cls_name = pytest_files_made_cache_mapping[
|
|
ref_testcase_python_path
|
|
]
|
|
teststep["testcase"] = ref_testcase_cls_name
|
|
|
|
# prepare import ref testcase
|
|
ref_testcase_python_path = ref_testcase_python_path[len(os.getcwd()) + 1 :]
|
|
ref_module_name, _ = os.path.splitext(ref_testcase_python_path)
|
|
ref_module_name = ref_module_name.replace(os.sep, ".")
|
|
imports_list.append(
|
|
f"from {ref_module_name} import TestCase{ref_testcase_cls_name} as {ref_testcase_cls_name}"
|
|
)
|
|
|
|
data = {
|
|
"version": __version__,
|
|
"testcase_path": __ensure_cwd_relative(testcase_abs_path),
|
|
"class_name": f"TestCase{testcase_cls_name}",
|
|
"imports_list": imports_list,
|
|
"config_chain_style": make_config_chain_style(config),
|
|
"teststeps_chain_style": [
|
|
make_teststep_chain_style(step) for step in teststeps
|
|
],
|
|
}
|
|
content = __TEMPLATE__.render(data)
|
|
|
|
# ensure new file's directory exists
|
|
dir_path = os.path.dirname(testcase_python_path)
|
|
if not os.path.exists(dir_path):
|
|
os.makedirs(dir_path)
|
|
|
|
with open(testcase_python_path, "w", encoding="utf-8") as f:
|
|
f.write(content)
|
|
|
|
pytest_files_made_cache_mapping[testcase_python_path] = testcase_cls_name
|
|
__ensure_testcase_module(testcase_python_path)
|
|
|
|
logger.info(f"generated testcase: {testcase_python_path}")
|
|
|
|
return testcase_python_path
|
|
|
|
|
|
def make_testsuite(testsuite: Dict) -> NoReturn:
|
|
"""convert valid testsuite dict to pytest folder with testcases"""
|
|
# validate testsuite format
|
|
load_testsuite(testsuite)
|
|
|
|
testsuite_config = testsuite["config"]
|
|
testsuite_path = testsuite_config["path"]
|
|
testsuite_variables = convert_variables(
|
|
testsuite_config.get("variables", {}), testsuite_path
|
|
)
|
|
|
|
logger.info(f"start to make testsuite: {testsuite_path}")
|
|
|
|
# create directory with testsuite file name, put its testcases under this directory
|
|
testsuite_path = ensure_file_path_valid(testsuite_path)
|
|
testsuite_dir, file_suffix = os.path.splitext(testsuite_path)
|
|
# demo_testsuite.yml => demo_testsuite_yml
|
|
testsuite_dir = f"{testsuite_dir}_{file_suffix.lstrip('.')}"
|
|
|
|
for testcase in testsuite["testcases"]:
|
|
# get referenced testcase content
|
|
testcase_file = testcase["testcase"]
|
|
testcase_path = __ensure_absolute(testcase_file)
|
|
testcase_dict = load_test_file(testcase_path)
|
|
testcase_dict.setdefault("config", {})
|
|
testcase_dict["config"]["path"] = testcase_path
|
|
|
|
# override testcase name
|
|
testcase_dict["config"]["name"] = testcase["name"]
|
|
# override base_url
|
|
base_url = testsuite_config.get("base_url") or testcase.get("base_url")
|
|
if base_url:
|
|
testcase_dict["config"]["base_url"] = base_url
|
|
# override verify
|
|
if "verify" in testsuite_config:
|
|
testcase_dict["config"]["verify"] = testsuite_config["verify"]
|
|
# override variables
|
|
# testsuite testcase variables > testsuite config variables
|
|
testcase_variables = convert_variables(
|
|
testcase.get("variables", {}), testcase_path
|
|
)
|
|
testcase_variables = override_config_variables(
|
|
testcase_variables, testsuite_variables
|
|
)
|
|
# testsuite testcase variables > testcase config variables
|
|
testcase_dict["config"]["variables"] = convert_variables(
|
|
testcase_dict["config"].get("variables", {}), testcase_path
|
|
)
|
|
testcase_dict["config"]["variables"].update(testcase_variables)
|
|
|
|
# make testcase
|
|
testcase_pytest_path = make_testcase(testcase_dict, testsuite_dir)
|
|
pytest_files_run_set.add(testcase_pytest_path)
|
|
|
|
|
|
def __make(tests_path: Text) -> NoReturn:
|
|
""" make testcase(s) with testcase/testsuite/folder absolute path
|
|
generated pytest file path will be cached in pytest_files_made_cache_mapping
|
|
|
|
Args:
|
|
tests_path: should be in absolute path
|
|
|
|
"""
|
|
test_files = []
|
|
if os.path.isdir(tests_path):
|
|
files_list = load_folder_files(tests_path)
|
|
test_files.extend(files_list)
|
|
elif os.path.isfile(tests_path):
|
|
test_files.append(tests_path)
|
|
else:
|
|
raise exceptions.TestcaseNotFound(f"Invalid tests path: {tests_path}")
|
|
|
|
for test_file in test_files:
|
|
if test_file.lower().endswith("_test.py"):
|
|
pytest_files_run_set.add(test_file)
|
|
continue
|
|
|
|
try:
|
|
test_content = load_test_file(test_file)
|
|
except (exceptions.FileNotFound, exceptions.FileFormatError) as ex:
|
|
logger.warning(ex)
|
|
continue
|
|
|
|
if not isinstance(test_content, Dict):
|
|
logger.warning(f"test content not in dict format. \npath: {test_file}")
|
|
continue
|
|
|
|
# api in v2 format, convert to v3 testcase
|
|
if "request" in test_content and "name" in test_content:
|
|
test_content = ensure_testcase_v3_api(test_content)
|
|
|
|
if "config" not in test_content:
|
|
logger.warning(
|
|
f"Invalid testcase/testsuite: missing config part in testcase/testsuite.\npath: {test_file}"
|
|
)
|
|
continue
|
|
|
|
test_content.setdefault("config", {})["path"] = test_file
|
|
|
|
# testcase
|
|
if "teststeps" in test_content:
|
|
try:
|
|
testcase_pytest_path = make_testcase(test_content)
|
|
pytest_files_run_set.add(testcase_pytest_path)
|
|
except exceptions.TestCaseFormatError:
|
|
continue
|
|
|
|
# testsuite
|
|
elif "testcases" in test_content:
|
|
try:
|
|
make_testsuite(test_content)
|
|
except exceptions.TestSuiteFormatError:
|
|
continue
|
|
|
|
# invalid format
|
|
else:
|
|
logger.warning(f"skip invalid testcase/testsuite file: {test_file}")
|
|
|
|
|
|
def main_make(tests_paths: List[Text]) -> List[Text]:
|
|
if not tests_paths:
|
|
return []
|
|
|
|
for tests_path in tests_paths:
|
|
tests_path = ensure_path_sep(tests_path)
|
|
if not os.path.isabs(tests_path):
|
|
tests_path = os.path.join(os.getcwd(), tests_path)
|
|
|
|
try:
|
|
__make(tests_path)
|
|
except exceptions.MyBaseError as ex:
|
|
logger.error(ex)
|
|
sys.exit(1)
|
|
|
|
__ensure_project_meta_files(tests_path)
|
|
|
|
# format pytest files
|
|
pytest_files_format_list = pytest_files_made_cache_mapping.keys()
|
|
format_pytest_with_black(*pytest_files_format_list)
|
|
|
|
return list(pytest_files_run_set)
|
|
|
|
|
|
def init_make_parser(subparsers):
|
|
""" make testcases: parse command line options and run commands.
|
|
"""
|
|
parser = subparsers.add_parser(
|
|
"make", help="Convert YAML/JSON testcases to pytest cases.",
|
|
)
|
|
parser.add_argument(
|
|
"testcase_path", nargs="*", help="Specify YAML/JSON testcase file/folder path"
|
|
)
|
|
|
|
return parser
|