Merge pull request #561 from HttpRunner/fix_match_func_var

2.1.2
This commit is contained in:
debugtalk
2019-04-19 12:12:09 +08:00
committed by GitHub
9 changed files with 395 additions and 89 deletions

View File

@@ -5,7 +5,11 @@ python:
- 3.4
- 3.5
- 3.6
- 3.7-dev
matrix:
include:
- python: 3.7
dist: xenial
sudo: true
install:
- pip install pipenv --upgrade-strategy=only-if-needed
- pipenv install --dev --skip-lock

View File

@@ -1,5 +1,20 @@
# Release History
## 2.1.2 (2019-04-17)
**Features**
- support new variable notation ${var}
- use \$\$ to escape \$ notation
- add Python 3.7 for travis CI
**Bugfixes**
- match duplicate variable/function in single raw string
- escape '{' and '}' notation in raw string
- print_info: TypeError when value is None
- display api name when running api as testcase
## 2.1.1 (2019-04-11)
**Features**

View File

@@ -1,7 +1,7 @@
__title__ = 'HttpRunner'
__description__ = 'One-stop solution for HTTP(S) testing.'
__url__ = 'https://github.com/HttpRunner/HttpRunner'
__version__ = '2.1.1'
__version__ = '2.1.2'
__author__ = 'debugtalk'
__author_email__ = 'mail@debugtalk.com'
__license__ = 'Apache-2.0'

View File

@@ -7,10 +7,11 @@ import re
from httprunner import exceptions, utils, validator
from httprunner.compat import basestring, builtin_str, numeric_types, str
# TODO: change variable notation from $var to {{var}}
# $var_1
variable_regex_compile = re.compile(r"\$(\w+)")
# ${func1($var_1, $var_3)}
# use $$ to escape $ notation
dolloar_regex_compile = re.compile(r"\$\$")
# variable notation, e.g. ${var} or $var
variable_regex_compile = re.compile(r"\$\{(\w+)\}|\$(\w+)")
# function notation, e.g. ${func1($var_1, $var_3)}
function_regex_compile = re.compile(r"\$\{(\w+)\(([\$\w\.\-/\s=,]*)\)\}")
@@ -30,18 +31,32 @@ def parse_string_value(str_value):
return str_value
def is_variable_exist(content):
def is_var_or_func_exist(content):
""" check if variable or function exist
"""
if not isinstance(content, basestring):
return False
return True if variable_regex_compile.search(content) else False
def is_function_exist(content):
if not isinstance(content, basestring):
try:
match_start_position = content.index("$", 0)
except ValueError:
return False
return True if function_regex_compile.search(content) else False
while match_start_position < len(content):
dollar_match = dolloar_regex_compile.match(content, match_start_position)
if dollar_match:
match_start_position = dollar_match.end()
continue
func_match = function_regex_compile.match(content, match_start_position)
if func_match:
return True
var_match = variable_regex_compile.match(content, match_start_position)
if var_match:
return True
return False
def regex_findall_variables(content):
@@ -68,7 +83,12 @@ def regex_findall_variables(content):
"""
try:
return variable_regex_compile.findall(content)
vars_list = []
for var_tuple in variable_regex_compile.findall(content):
vars_list.append(
var_tuple[0] or var_tuple[1]
)
return vars_list
except TypeError:
return []
@@ -436,46 +456,73 @@ class LazyString(object):
args: ["${func2($a, $b)}", "$c"]
"""
self._string = raw_string
args_mapping = {}
self._args = []
# Notice: functions must be handled before variables
# search function like ${func($a, $b)}
func_match_list = regex_findall_functions(self._string)
match_start_position = 0
for func_match in func_match_list:
func_str = "${%s(%s)}" % (func_match[0], func_match[1])
match_start_position = raw_string.index(func_str, match_start_position)
self._string = self._string.replace(func_str, "{}", 1)
function_meta = parse_function_params(func_match[1])
function_meta = {
"func_name": func_match[0]
}
function_meta.update(parse_function_params(func_match[1]))
lazy_func = LazyFunction(
function_meta,
self.functions_mapping,
self.check_variables_set
)
args_mapping[match_start_position] = lazy_func
def escape_braces(origin_string):
return origin_string.replace("{", "{{").replace("}", "}}")
# search variable like $var
var_match_list = regex_findall_variables(self._string)
match_start_position = 0
for var_name in var_match_list:
# check if any variable undefined in check_variables_set
if var_name not in self.check_variables_set:
raise exceptions.VariableNotFound(var_name)
try:
match_start_position = raw_string.index("$", 0)
begin_string = raw_string[0:match_start_position]
self._string = escape_braces(begin_string)
except ValueError:
self._string = escape_braces(raw_string)
return
var = "${}".format(var_name)
match_start_position = raw_string.index(var, match_start_position)
# TODO: escape '{' and '}'
# self._string = self._string.replace("{", "{{")
# self._string = self._string.replace("}", "}}")
self._string = self._string.replace(var, "{}", 1)
args_mapping[match_start_position] = var_name
while match_start_position < len(raw_string):
self._args = [args_mapping[key] for key in sorted(args_mapping.keys())]
# Notice: notation priority
# $$ > ${func($a, $b)} > $var
# search $$
dollar_match = dolloar_regex_compile.match(raw_string, match_start_position)
if dollar_match:
match_start_position = dollar_match.end()
self._string += "$"
continue
# search function like ${func($a, $b)}
func_match = function_regex_compile.match(raw_string, match_start_position)
if func_match:
function_meta = parse_function_params(func_match.group(1))
function_meta = {
"func_name": func_match.group(1)
}
function_meta.update(parse_function_params(func_match.group(2)))
lazy_func = LazyFunction(
function_meta,
self.functions_mapping,
self.check_variables_set
)
self._args.append(lazy_func)
match_start_position = func_match.end()
self._string += "{}"
continue
# search variable like ${var} or $var
var_match = variable_regex_compile.match(raw_string, match_start_position)
if var_match:
var_name = var_match.group(1) or var_match.group(2)
# check if any variable undefined in check_variables_set
if var_name not in self.check_variables_set:
raise exceptions.VariableNotFound(var_name)
self._args.append(var_name)
match_start_position = var_match.end()
self._string += "{}"
continue
curr_position = match_start_position
try:
# find next $ location
match_start_position = raw_string.index("$", curr_position+1)
remain_string = raw_string[curr_position:match_start_position]
except ValueError:
remain_string = raw_string[curr_position:]
# break while loop
match_start_position = len(raw_string)
self._string += escape_braces(remain_string)
def __repr__(self):
return "LazyString({})".format(self.raw_string)
@@ -549,9 +596,11 @@ def prepare_lazy_data(content, functions_mapping=None, check_variables_set=None,
elif isinstance(content, basestring):
# content is in string format here
if not (is_variable_exist(content) or is_function_exist(content)):
if not is_var_or_func_exist(content):
# content is neither variable nor function
return content
# replace $$ notation with $ and consider it as normal char.
# e.g. abc => abc, abc$$def => abc$def, abc$$$$def$$h => abc$$def$h
return content.replace("$$", "$")
functions_mapping = functions_mapping or {}
check_variables_set = check_variables_set or set()
@@ -1205,6 +1254,9 @@ def parse_tests(tests_mapping):
# encapsulate api as a testcase
for api_content in tests_mapping["apis"]:
testcase = {
"config": {
"name": api_content.get("name")
},
"teststeps": [api_content]
}
parsed_testcase = _parse_testcase(testcase, project_mapping)

View File

@@ -385,6 +385,8 @@ def print_info(info_mapping):
continue
elif isinstance(value, (dict, list)):
value = json.dumps(value)
elif value is None:
value = "None"
if is_py2:
if isinstance(key, unicode):

View File

@@ -1,9 +1,11 @@
name: headers
name: get headers
base_url: http://httpbin.org
variables:
expected_status_code: 200
request:
url: /headers
method: GET
validate:
- eq: ["status_code", 200]
- eq: ["status_code", $expected_status_code]
- eq: [content.headers.Host, "httpbin.org"]

View File

@@ -37,6 +37,10 @@ class TestParserBasic(unittest.TestCase):
parser.regex_findall_variables("a$var"),
["var"]
)
self.assertEqual(
parser.regex_findall_variables("a$var${var2}$var3${var4}"),
["var", "var2", "var3", "var4"]
)
self.assertEqual(
parser.regex_findall_variables("$v ar"),
["v"]
@@ -281,7 +285,7 @@ class TestParserBasic(unittest.TestCase):
{"abc": "def"}
)
def test_lazy_string(self):
def test_parse_func_var_abnormal(self):
variables_mapping = {
"var_1": "abc",
"var_2": "def",
@@ -295,6 +299,160 @@ class TestParserBasic(unittest.TestCase):
"func1": lambda x,y: str(x) + str(y)
}
# {
var = parser.LazyString("ABC$var_1{", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{{")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc{")
var = parser.LazyString("{ABC$var_1{}a}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "{{ABC{}{{}}a}}")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "{ABCabc{}a}")
var = parser.LazyString("AB{C$var_1{}a}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "AB{{C{}{{}}a}}")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "AB{Cabc{}a}")
# }
var = parser.LazyString("ABC$var_1}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}}}")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc}")
# $$
var = parser.LazyString("ABC$$var_1{", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC$var_1{{")
self.assertEqual(var._args, [])
self.assertEqual(var.to_value(variables_mapping), "ABC$var_1{")
# $$$
var = parser.LazyString("ABC$$$var_1{", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC${}{{")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABC$abc{")
# $$$$
var = parser.LazyString("ABC$$$$var_1{", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC$$var_1{{")
self.assertEqual(var._args, [])
self.assertEqual(var.to_value(variables_mapping), "ABC$$var_1{")
# ${
var = parser.LazyString("ABC$var_1${", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}${{")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc${")
var = parser.LazyString("ABC$var_1${a", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}${{a")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc${a")
# $}
var = parser.LazyString("ABC$var_1$}a", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}$}}a")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc$}a")
# }{
var = parser.LazyString("ABC$var_1}{a", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}}}{{a")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc}{a")
# {}
var = parser.LazyString("ABC$var_1{}a", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{{}}a")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc{}a")
def test_parse_func_var_duplicate(self):
variables_mapping = {
"var_1": "abc",
"var_2": "def",
"var_3": 123,
"var_4": {"a": 1},
"var_5": True,
"var_6": None
}
check_variables_set = variables_mapping.keys()
functions_mapping = {
"func1": lambda x,y: str(x) + str(y)
}
var = parser.LazyString(
"ABC${func1($var_1, $var_3)}--${func1($var_1, $var_3)}",
functions_mapping,
check_variables_set
)
self.assertEqual(var._string, "ABC{}--{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123--abc123")
var = parser.LazyString("ABC${func1($var_1, $var_3)}$var_1", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123abc")
var = parser.LazyString(
"ABC${func1($var_1, $var_3)}$var_1--${func1($var_1, $var_3)}$var_1",
functions_mapping,
check_variables_set
)
self.assertEqual(var._string, "ABC{}{}--{}{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123abc--abc123abc")
def test_parse_function(self):
variables_mapping = {
"var_1": "abc",
"var_2": "def",
"var_3": 123,
"var_4": {"a": 1},
"var_5": True,
"var_6": None
}
check_variables_set = variables_mapping.keys()
functions_mapping = {
"func1": lambda x,y: str(x) + str(y)
}
var = parser.LazyString("${func1($var_1, $var_3)}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "{}")
self.assertIsInstance(var._args[0], parser.LazyFunction)
self.assertEqual(var.to_value(variables_mapping), "abc123")
var = parser.LazyString("ABC${func1($var_1, $var_3)}DE", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}DE")
self.assertIsInstance(var._args[0], parser.LazyFunction)
self.assertEqual(var.to_value(variables_mapping), "ABCabc123DE")
var = parser.LazyString("ABC${func1($var_1, $var_3)}$var_5", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123True")
var = parser.LazyString("ABC${func1($var_1, $var_3)}DE$var_4", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}DE{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123DE{'a': 1}")
var = parser.LazyString("ABC$var_5${func1($var_1, $var_3)}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{}")
self.assertEqual(var.to_value(variables_mapping), "ABCTrueabc123")
def test_parse_variable(self):
""" variable format ${var} and $var
"""
variables_mapping = {
"var_1": "abc",
"var_2": "def",
"var_3": 123,
"var_4": {"a": 1},
"var_5": True,
"var_6": None
}
check_variables_set = variables_mapping.keys()
functions_mapping = {}
# format: $var
var = parser.LazyString("ABC$var_1", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}")
self.assertEqual(var._args, ["var_1"])
@@ -320,22 +478,10 @@ class TestParserBasic(unittest.TestCase):
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc$")
var = parser.LazyString("ABC$var_1{", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{")
self.assertEqual(var._args, ["var_1"])
# self.assertEqual(var.to_value(variables_mapping), "ABCabc{")
var = parser.LazyString("ABC$$var_1{", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC${}{")
self.assertEqual(var._args, ["var_1"])
var = parser.LazyString("ABC$var_1${", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}${")
self.assertEqual(var._args, ["var_1"])
var = parser.LazyString("ABC$var_1${a", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}${a")
self.assertEqual(var._args, ["var_1"])
var = parser.LazyString("ABC$var_1/123$var_1/456", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}/123{}/456")
self.assertEqual(var._args, ["var_1", "var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc/123abc/456")
var = parser.LazyString("ABC$var_1/$var_2/$var_1", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}/{}/{}")
@@ -347,27 +493,46 @@ class TestParserBasic(unittest.TestCase):
self.assertEqual(var._args, ["var_1", "var_3"])
self.assertEqual(var.to_value(variables_mapping), "func1(abc, 123)")
var = parser.LazyString("${func1($var_1, $var_3)}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "{}")
self.assertIsInstance(var._args[0], parser.LazyFunction)
self.assertEqual(var.to_value(variables_mapping), "abc123")
# format: ${var}
var = parser.LazyString("ABC${var_1}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc")
var = parser.LazyString("ABC${func1($var_1, $var_3)}DE", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}DE")
self.assertIsInstance(var._args[0], parser.LazyFunction)
self.assertEqual(var.to_value(variables_mapping), "ABCabc123DE")
var = parser.LazyString("ABC${func1($var_1, $var_3)}$var_5", functions_mapping, check_variables_set)
var = parser.LazyString("ABC${var_1}${var_3}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123True")
self.assertEqual(var._args, ["var_1", "var_3"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc123")
var = parser.LazyString("ABC${func1($var_1, $var_3)}DE$var_4", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}DE{}")
self.assertEqual(var.to_value(variables_mapping), "ABCabc123DE{'a': 1}")
var = parser.LazyString("ABC${var_1}/${var_3}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}/{}")
self.assertEqual(var._args, ["var_1", "var_3"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc/123")
var = parser.LazyString("ABC$var_5${func1($var_1, $var_3)}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}{}")
self.assertEqual(var.to_value(variables_mapping), "ABCTrueabc123")
var = parser.LazyString("ABC${var_1}/", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}/")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc/")
var = parser.LazyString("ABC${var_1}123", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}123")
self.assertEqual(var._args, ["var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc123")
var = parser.LazyString("ABC${var_1}/123${var_1}/456", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}/123{}/456")
self.assertEqual(var._args, ["var_1", "var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc/123abc/456")
var = parser.LazyString("ABC${var_1}/${var_2}/${var_1}", functions_mapping, check_variables_set)
self.assertEqual(var._string, "ABC{}/{}/{}")
self.assertEqual(var._args, ["var_1", "var_2", "var_1"])
self.assertEqual(var.to_value(variables_mapping), "ABCabc/def/abc")
var = parser.LazyString("func1(${var_1}, ${var_3})", functions_mapping, check_variables_set)
self.assertEqual(var._string, "func1({}, {})")
self.assertEqual(var._args, ["var_1", "var_3"])
self.assertEqual(var.to_value(variables_mapping), "func1(abc, 123)")
def test_parse_data_multiple_identical_variables(self):
variables_mapping = {
@@ -548,6 +713,37 @@ class TestParserBasic(unittest.TestCase):
self.assertEqual(parsed_testcase["num2"], 6)
self.assertEqual(parsed_testcase["num1"], 3)
def test_is_var_or_func_exist(self):
self.assertTrue(parser.is_var_or_func_exist("$var"))
self.assertTrue(parser.is_var_or_func_exist("${var}"))
self.assertTrue(parser.is_var_or_func_exist("$var${var}"))
self.assertFalse(parser.is_var_or_func_exist("${var"))
self.assertFalse(parser.is_var_or_func_exist("$$var"))
self.assertFalse(parser.is_var_or_func_exist("var$$0"))
self.assertTrue(parser.is_var_or_func_exist("var$$$0"))
self.assertFalse(parser.is_var_or_func_exist("var$$$$0"))
self.assertTrue(parser.is_var_or_func_exist("${func()}"))
self.assertTrue(parser.is_var_or_func_exist("${func($a)}"))
self.assertTrue(parser.is_var_or_func_exist("${func($a)}$b"))
def test_parse_variables_mapping_dollar_notation(self):
variables = {
"varA": "123$varB",
"varB": "456$$0",
"varC": "${sum_two($a, $b)}",
"a": 1,
"b": 2,
"c": "abc"
}
functions = {
"sum_two": sum_two
}
prepared_variables = parser.prepare_lazy_data(variables, functions, variables.keys())
parsed_testcase = parser.parse_variables_mapping(prepared_variables)
self.assertEqual(parsed_testcase["varA"], "123456$0")
self.assertEqual(parsed_testcase["varB"], "456$0")
self.assertEqual(parsed_testcase["varC"], 3)
def test_prepare_lazy_data(self):
variables = {
"host": "https://httprunner.org",
@@ -584,6 +780,29 @@ class TestParserBasic(unittest.TestCase):
variables.keys()
)
def test_prepare_lazy_data_dual_dollar(self):
variables = {
"num0": 123,
"var1": "abc$$num0",
"var2": "abc$$$num0",
"var3": "abc$$$$num0",
}
functions = {
"sum_two": sum_two
}
prepared_variables = parser.prepare_lazy_data(
variables,
functions,
variables.keys()
)
self.assertEqual(prepared_variables["var1"], "abc$num0")
self.assertIsInstance(prepared_variables["var2"], parser.LazyString)
self.assertEqual(prepared_variables["var3"], "abc$$num0")
parsed_variables = parser.parse_variables_mapping(prepared_variables)
self.assertEqual(parsed_variables["var1"], "abc$num0")
self.assertEqual(parsed_variables["var2"], "abc$123")
self.assertEqual(parsed_variables["var3"], "abc$$num0")
class TestParser(unittest.TestCase):

View File

@@ -263,3 +263,15 @@ class TestUtils(ApiServerUnittest):
parameters_content_list = []
product_list = utils.gen_cartesian_product(*parameters_content_list)
self.assertEqual(product_list, [])
def test_print_info(self):
info_mapping = {
"a": 1,
"t": (1, 2),
"b": {
"b1": 123
},
"c": None,
"d": [4, 5]
}
utils.print_info(info_mapping)

View File

@@ -1,5 +1,5 @@
config:
name: create users with uid
name: create users with parameters
variables:
device_sn: ${gen_random_string(15)}
base_url: "http://127.0.0.1:5000"