mirror of
https://github.com/httprunner/httprunner.git
synced 2026-05-12 02:21:29 +08:00
457 lines
13 KiB
Python
457 lines
13 KiB
Python
# encoding: utf-8
|
|
|
|
import ast
|
|
import os
|
|
import re
|
|
|
|
from httprunner import exceptions
|
|
from httprunner.compat import basestring, builtin_str, numeric_types, str
|
|
|
|
variable_regexp = r"\$([\w_]+)"
|
|
function_regexp = r"\$\{([\w_]+\([\$\w\.\-_ =,]*\))\}"
|
|
function_regexp_compile = re.compile(r"^([\w_]+)\(([\$\w\.\-_ =,]*)\)$")
|
|
|
|
|
|
def parse_string_value(str_value):
|
|
""" parse string to number if possible
|
|
e.g. "123" => 123
|
|
"12.2" => 12.3
|
|
"abc" => "abc"
|
|
"$var" => "$var"
|
|
"""
|
|
try:
|
|
return ast.literal_eval(str_value)
|
|
except ValueError:
|
|
return str_value
|
|
except SyntaxError:
|
|
# e.g. $var, ${func}
|
|
return str_value
|
|
|
|
|
|
def extract_variables(content):
|
|
""" extract all variable names from content, which is in format $variable
|
|
|
|
Args:
|
|
content (str): string content
|
|
|
|
Returns:
|
|
list: variables list extracted from string content
|
|
|
|
Examples:
|
|
>>> extract_variables("$variable")
|
|
["variable"]
|
|
|
|
>>> extract_variables("/blog/$postid")
|
|
["postid"]
|
|
|
|
>>> extract_variables("/$var1/$var2")
|
|
["var1", "var2"]
|
|
|
|
>>> extract_variables("abc")
|
|
[]
|
|
|
|
"""
|
|
# TODO: change variable notation from $var to {{var}}
|
|
try:
|
|
return re.findall(variable_regexp, content)
|
|
except TypeError:
|
|
return []
|
|
|
|
|
|
def extract_functions(content):
|
|
""" extract all functions from string content, which are in format ${fun()}
|
|
|
|
Args:
|
|
content (str): string content
|
|
|
|
Returns:
|
|
list: functions list extracted from string content
|
|
|
|
Examples:
|
|
>>> extract_functions("${func(5)}")
|
|
["func(5)"]
|
|
|
|
>>> extract_functions("${func(a=1, b=2)}")
|
|
["func(a=1, b=2)"]
|
|
|
|
>>> extract_functions("/api/1000?_t=${get_timestamp()}")
|
|
["get_timestamp()"]
|
|
|
|
>>> extract_functions("/api/${add(1, 2)}")
|
|
["add(1, 2)"]
|
|
|
|
>>> extract_functions("/api/${add(1, 2)}?_t=${get_timestamp()}")
|
|
["add(1, 2)", "get_timestamp()"]
|
|
|
|
"""
|
|
try:
|
|
return re.findall(function_regexp, content)
|
|
except TypeError:
|
|
return []
|
|
|
|
|
|
def parse_function(content):
|
|
""" parse function name and args from string content.
|
|
|
|
Args:
|
|
content (str): string content
|
|
|
|
Returns:
|
|
dict: function meta dict
|
|
|
|
{
|
|
"func_name": "xxx",
|
|
"args": [],
|
|
"kwargs": {}
|
|
}
|
|
|
|
Examples:
|
|
>>> parse_function("func()")
|
|
{'func_name': 'func', 'args': [], 'kwargs': {}}
|
|
|
|
>>> parse_function("func(5)")
|
|
{'func_name': 'func', 'args': [5], 'kwargs': {}}
|
|
|
|
>>> parse_function("func(1, 2)")
|
|
{'func_name': 'func', 'args': [1, 2], 'kwargs': {}}
|
|
|
|
>>> parse_function("func(a=1, b=2)")
|
|
{'func_name': 'func', 'args': [], 'kwargs': {'a': 1, 'b': 2}}
|
|
|
|
>>> parse_function("func(1, 2, a=3, b=4)")
|
|
{'func_name': 'func', 'args': [1, 2], 'kwargs': {'a':3, 'b':4}}
|
|
|
|
"""
|
|
matched = function_regexp_compile.match(content)
|
|
if not matched:
|
|
raise exceptions.FunctionNotFound("{} not found!".format(content))
|
|
|
|
function_meta = {
|
|
"func_name": matched.group(1),
|
|
"args": [],
|
|
"kwargs": {}
|
|
}
|
|
|
|
args_str = matched.group(2).strip()
|
|
if args_str == "":
|
|
return function_meta
|
|
|
|
args_list = args_str.split(',')
|
|
for arg in args_list:
|
|
arg = arg.strip()
|
|
if '=' in arg:
|
|
key, value = arg.split('=')
|
|
function_meta["kwargs"][key.strip()] = parse_string_value(value.strip())
|
|
else:
|
|
function_meta["args"].append(parse_string_value(arg))
|
|
|
|
return function_meta
|
|
|
|
|
|
def parse_validator(validator):
|
|
""" parse validator, validator maybe in two format
|
|
@param (dict) validator
|
|
format1: this is kept for compatiblity with the previous versions.
|
|
{"check": "status_code", "comparator": "eq", "expect": 201}
|
|
{"check": "$resp_body_success", "comparator": "eq", "expect": True}
|
|
format2: recommended new version
|
|
{'eq': ['status_code', 201]}
|
|
{'eq': ['$resp_body_success', True]}
|
|
@return (dict) validator info
|
|
{
|
|
"check": "status_code",
|
|
"expect": 201,
|
|
"comparator": "eq"
|
|
}
|
|
"""
|
|
if not isinstance(validator, dict):
|
|
raise exceptions.ParamsError("invalid validator: {}".format(validator))
|
|
|
|
if "check" in validator and len(validator) > 1:
|
|
# format1
|
|
check_item = validator.get("check")
|
|
|
|
if "expect" in validator:
|
|
expect_value = validator.get("expect")
|
|
elif "expected" in validator:
|
|
expect_value = validator.get("expected")
|
|
else:
|
|
raise exceptions.ParamsError("invalid validator: {}".format(validator))
|
|
|
|
comparator = validator.get("comparator", "eq")
|
|
|
|
elif len(validator) == 1:
|
|
# format2
|
|
comparator = list(validator.keys())[0]
|
|
compare_values = validator[comparator]
|
|
|
|
if not isinstance(compare_values, list) or len(compare_values) != 2:
|
|
raise exceptions.ParamsError("invalid validator: {}".format(validator))
|
|
|
|
check_item, expect_value = compare_values
|
|
|
|
else:
|
|
raise exceptions.ParamsError("invalid validator: {}".format(validator))
|
|
|
|
return {
|
|
"check": check_item,
|
|
"expect": expect_value,
|
|
"comparator": comparator
|
|
}
|
|
|
|
|
|
def substitute_variables(content, variables_mapping):
|
|
""" substitute variables in content with variables_mapping
|
|
|
|
Args:
|
|
content (str/dict/list/numeric/bool/type): content to be substituted.
|
|
variables_mapping (dict): variables mapping.
|
|
|
|
Returns:
|
|
substituted content.
|
|
|
|
Examples:
|
|
>>> content = {
|
|
'request': {
|
|
'url': '/api/users/$uid',
|
|
'headers': {'token': '$token'}
|
|
}
|
|
}
|
|
>>> variables_mapping = {"$uid": 1000}
|
|
>>> substitute_variables(content, variables_mapping)
|
|
{
|
|
'request': {
|
|
'url': '/api/users/1000',
|
|
'headers': {'token': '$token'}
|
|
}
|
|
}
|
|
|
|
"""
|
|
if isinstance(content, (list, set, tuple)):
|
|
return [
|
|
substitute_variables(item, variables_mapping)
|
|
for item in content
|
|
]
|
|
|
|
if isinstance(content, dict):
|
|
substituted_data = {}
|
|
for key, value in content.items():
|
|
eval_key = substitute_variables(key, variables_mapping)
|
|
eval_value = substitute_variables(value, variables_mapping)
|
|
substituted_data[eval_key] = eval_value
|
|
|
|
return substituted_data
|
|
|
|
if isinstance(content, basestring):
|
|
# content is in string format here
|
|
for var, value in variables_mapping.items():
|
|
if content == var:
|
|
# content is a variable
|
|
content = value
|
|
else:
|
|
if not isinstance(value, str):
|
|
value = builtin_str(value)
|
|
content = content.replace(var, value)
|
|
|
|
return content
|
|
|
|
|
|
###############################################################################
|
|
## parse content with variables and functions mapping
|
|
###############################################################################
|
|
|
|
def get_mapping_variable(variable_name, variables_mapping):
|
|
""" get variable from variables_mapping.
|
|
|
|
Args:
|
|
variable_name (str): variable name
|
|
variables_mapping (dict): variables mapping
|
|
|
|
Returns:
|
|
mapping variable value.
|
|
|
|
Raises:
|
|
exceptions.VariableNotFound: variable is not found.
|
|
|
|
"""
|
|
try:
|
|
return variables_mapping[variable_name]
|
|
except KeyError:
|
|
raise exceptions.VariableNotFound("{} is not found.".format(variable_name))
|
|
|
|
|
|
def get_mapping_function(function_name, functions_mapping):
|
|
""" get function from functions_mapping,
|
|
if not found, then try to check if builtin function.
|
|
|
|
Args:
|
|
variable_name (str): variable name
|
|
variables_mapping (dict): variables mapping
|
|
|
|
Returns:
|
|
mapping function object.
|
|
|
|
Raises:
|
|
exceptions.FunctionNotFound: function is neither defined in debugtalk.py nor builtin.
|
|
|
|
"""
|
|
if function_name in functions_mapping:
|
|
return functions_mapping[function_name]
|
|
|
|
try:
|
|
# check if builtin functions
|
|
item_func = eval(function_name)
|
|
if callable(item_func):
|
|
# is builtin function
|
|
return item_func
|
|
except (NameError, TypeError):
|
|
# is not builtin function
|
|
raise exceptions.FunctionNotFound("{} is not found.".format(function_name))
|
|
|
|
|
|
def parse_string_functions(content, variables_mapping, functions_mapping):
|
|
""" parse string content with functions mapping.
|
|
|
|
Args:
|
|
content (str): string content to be parsed.
|
|
variables_mapping (dict): variables mapping.
|
|
functions_mapping (dict): functions mapping.
|
|
|
|
Returns:
|
|
str: parsed string content.
|
|
|
|
Examples:
|
|
>>> content = "abc${add_one(3)}def"
|
|
>>> functions_mapping = {"add_one": lambda x: x + 1}
|
|
>>> parse_string_functions(content, functions_mapping)
|
|
"abc4def"
|
|
|
|
"""
|
|
functions_list = extract_functions(content)
|
|
for func_content in functions_list:
|
|
function_meta = parse_function(func_content)
|
|
func_name = function_meta["func_name"]
|
|
|
|
args = function_meta.get("args", [])
|
|
kwargs = function_meta.get("kwargs", {})
|
|
args = parse_data(args, variables_mapping, functions_mapping)
|
|
kwargs = parse_data(kwargs, variables_mapping, functions_mapping)
|
|
|
|
func = get_mapping_function(func_name, functions_mapping)
|
|
eval_value = func(*args, **kwargs)
|
|
|
|
func_content = "${" + func_content + "}"
|
|
if func_content == content:
|
|
# content is a function, e.g. "${add_one(3)}"
|
|
content = eval_value
|
|
else:
|
|
# content contains one or many functions, e.g. "abc${add_one(3)}def"
|
|
content = content.replace(
|
|
func_content,
|
|
str(eval_value), 1
|
|
)
|
|
|
|
return content
|
|
|
|
|
|
def parse_string_variables(content, variables_mapping):
|
|
""" parse string content with variables mapping.
|
|
|
|
Args:
|
|
content (str): string content to be parsed.
|
|
variables_mapping (dict): variables mapping.
|
|
|
|
Returns:
|
|
str: parsed string content.
|
|
|
|
Examples:
|
|
>>> content = "/api/users/$uid"
|
|
>>> variables_mapping = {"$uid": 1000}
|
|
>>> parse_string_variables(content, variables_mapping)
|
|
"/api/users/1000"
|
|
|
|
"""
|
|
variables_list = extract_variables(content)
|
|
for variable_name in variables_list:
|
|
variable_value = get_mapping_variable(variable_name, variables_mapping)
|
|
|
|
# TODO: replace variable label from $var to {{var}}
|
|
if "${}".format(variable_name) == content:
|
|
# content is a variable
|
|
content = variable_value
|
|
else:
|
|
# content contains one or several variables
|
|
if not isinstance(variable_value, str):
|
|
variable_value = builtin_str(variable_value)
|
|
|
|
content = content.replace(
|
|
"${}".format(variable_name),
|
|
variable_value, 1
|
|
)
|
|
|
|
return content
|
|
|
|
|
|
def parse_data(content, variables_mapping=None, functions_mapping=None):
|
|
""" parse content with variables mapping
|
|
|
|
Args:
|
|
content (str/dict/list/numeric/bool/type): content to be parsed
|
|
variables_mapping (dict): variables mapping.
|
|
functions_mapping (dict): functions mapping.
|
|
|
|
Returns:
|
|
parsed content.
|
|
|
|
Examples:
|
|
>>> content = {
|
|
'request': {
|
|
'url': '/api/users/$uid',
|
|
'headers': {'token': '$token'}
|
|
}
|
|
}
|
|
>>> variables_mapping = {"uid": 1000, "token": "abcdef"}
|
|
>>> parse_data(content, variables_mapping)
|
|
{
|
|
'request': {
|
|
'url': '/api/users/1000',
|
|
'headers': {'token': 'abcdef'}
|
|
}
|
|
}
|
|
|
|
"""
|
|
# TODO: refactor type check
|
|
# TODO: combine this with TestcaseParser
|
|
if content is None or isinstance(content, (numeric_types, bool, type)):
|
|
return content
|
|
|
|
if isinstance(content, (list, set, tuple)):
|
|
return [
|
|
parse_data(item, variables_mapping, functions_mapping)
|
|
for item in content
|
|
]
|
|
|
|
if isinstance(content, dict):
|
|
parsed_content = {}
|
|
for key, value in content.items():
|
|
parsed_key = parse_data(key, variables_mapping, functions_mapping)
|
|
parsed_value = parse_data(value, variables_mapping, functions_mapping)
|
|
parsed_content[parsed_key] = parsed_value
|
|
|
|
return parsed_content
|
|
|
|
if isinstance(content, basestring):
|
|
# content is in string format here
|
|
variables_mapping = variables_mapping or {}
|
|
functions_mapping = functions_mapping or {}
|
|
content = content.strip()
|
|
|
|
# replace functions with evaluated value
|
|
# Notice: _eval_content_functions must be called before _eval_content_variables
|
|
content = parse_string_functions(content, variables_mapping, functions_mapping)
|
|
|
|
# replace variables with binding value
|
|
content = parse_string_variables(content, variables_mapping)
|
|
|
|
return content
|