Merge pull request httprunner#975 from httprunner/dev

## 3.1.4 (2020-07-30)

**Changed**

- change: override variables strategy, step variables > extracted variables from previous steps

**Fixed**

- fix: parameters feature with custom functions
- fix: request json field with variable reference
- fix: pickle BufferedReader TypeError in upload feature

docs/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+## 3.1.4 (2020-07-30)
+
+**Changed**
+
+- change: override variables strategy, step variables > extracted variables from previous steps
+
+**Fixed**
+
+- fix: parameters feature with custom functions
+- fix: request json field with variable reference
+- fix: pickle BufferedReader TypeError in upload feature
+
 ## 3.1.3 (2020-07-06)
 
 **Added**

examples/httpbin/basic_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: basic.yml
 
 

examples/httpbin/hooks_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: hooks.yml
 
 

examples/httpbin/load_image_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: load_image.yml
 
 

examples/httpbin/upload_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: upload.yml
 
 

examples/httpbin/validate_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: validate.yml
 
 

examples/postman_echo/conftest.py

@@ -0,0 +1,64 @@
+# NOTICE: Generated By HttpRunner.
+import json
+import os
+import time
+
+import pytest
+from loguru import logger
+
+from httprunner.utils import get_platform, ExtendJSONEncoder
+
+
+@pytest.fixture(scope="session", autouse=True)
+def session_fixture(request):
+    """setup and teardown each task"""
+    logger.info(f"start running testcases ...")
+
+    start_at = time.time()
+
+    yield
+
+    logger.info(f"task finished, generate task summary for --save-tests")
+
+    summary = {
+        "success": True,
+        "stat": {
+            "testcases": {"total": 0, "success": 0, "fail": 0},
+            "teststeps": {"total": 0, "failures": 0, "successes": 0},
+        },
+        "time": {"start_at": start_at, "duration": time.time() - start_at},
+        "platform": get_platform(),
+        "details": [],
+    }
+
+    for item in request.node.items:
+        testcase_summary = item.instance.get_summary()
+        summary["success"] &= testcase_summary.success
+
+        summary["stat"]["testcases"]["total"] += 1
+        summary["stat"]["teststeps"]["total"] += len(testcase_summary.step_datas)
+        if testcase_summary.success:
+            summary["stat"]["testcases"]["success"] += 1
+            summary["stat"]["teststeps"]["successes"] += len(
+                testcase_summary.step_datas
+            )
+        else:
+            summary["stat"]["testcases"]["fail"] += 1
+            summary["stat"]["teststeps"]["successes"] += (
+                len(testcase_summary.step_datas) - 1
+            )
+            summary["stat"]["teststeps"]["failures"] += 1
+
+        testcase_summary_json = testcase_summary.dict()
+        testcase_summary_json["records"] = testcase_summary_json.pop("step_datas")
+        summary["details"].append(testcase_summary_json)
+
+    summary_path = "/Users/debugtalk/MyProjects/HttpRunner-dev/HttpRunner/examples/postman_echo/logs/request_methods/hardcode.summary.json"
+    summary_dir = os.path.dirname(summary_path)
+    os.makedirs(summary_dir, exist_ok=True)
+
+    with open(summary_path, "w", encoding="utf-8") as f:
+        json.dump(summary, f, indent=4, ensure_ascii=False, cls=ExtendJSONEncoder)
+
+    logger.info(f"generated task summary: {summary_path}")
+

examples/postman_echo/request_methods/demo_testsuite_yml/request_with_functions_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/request_with_functions.yml
 
 
@@ -57,7 +57,7 @@ class TestCaseRequestWithFunctions(HttpRunner):
             .assert_equal("status_code", 200)
             .assert_equal(
                 "body.data",
-                "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar21.",
+                "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar32.",
             )
             .assert_type_match("body.json", "None")
             .assert_type_match("body.json", "NoneType")

examples/postman_echo/request_methods/demo_testsuite_yml/request_with_testcase_reference_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/request_with_testcase_reference.yml
 
 

examples/postman_echo/request_methods/hardcode_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/hardcode.yml
 
 

examples/postman_echo/request_methods/request_with_functions.yml

@@ -47,7 +47,7 @@ teststeps:
         data: "This is expected to be sent back as part of response body: $foo1-$foo2-$foo3."
     validate:
         - eq: ["status_code", 200]
-        - eq: ["body.data", "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar21."]
+        - eq: ["body.data", "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar32."]
         - type_match: ["body.json", None]
         - type_match: ["body.json", NoneType]
         - type_match: ["body.json", null]

examples/postman_echo/request_methods/request_with_functions_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/request_with_functions.yml
 
 
@@ -57,7 +57,7 @@ class TestCaseRequestWithFunctions(HttpRunner):
             .assert_equal("status_code", 200)
             .assert_equal(
                 "body.data",
-                "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar21.",
+                "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar32.",
             )
             .assert_type_match("body.json", "None")
             .assert_type_match("body.json", "NoneType")

examples/postman_echo/request_methods/request_with_parameters_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/request_with_parameters.yml
 
 

examples/postman_echo/request_methods/request_with_testcase_reference_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/request_with_testcase_reference.yml
 
 

examples/postman_echo/request_methods/request_with_variables.yml

@@ -38,7 +38,7 @@ teststeps:
         data: "This is expected to be sent back as part of response body: $foo1-$foo2-$foo3."
     validate:
         - eq: ["status_code", 200]
-        - eq: ["body.data", "This is expected to be sent back as part of response body: bar12-testcase_config_bar2-bar21."]
+        - eq: ["body.data", "This is expected to be sent back as part of response body: bar12-testcase_config_bar2-bar32."]
 -
     name: post form data
     variables:

examples/postman_echo/request_methods/request_with_variables_test.py

@@ -1,5 +1,5 @@
-# NOTE: Generated By HttpRunner v3.1.3
-# FROM: request_methods\request_with_variables.yml
+# NOTE: Generated By HttpRunner v3.1.4
+# FROM: request_methods/request_with_variables.yml
 
 
 from httprunner import HttpRunner, Config, Step, RunRequest, RunTestCase
@@ -42,7 +42,7 @@ class TestCaseRequestWithVariables(HttpRunner):
             .assert_equal("status_code", 200)
             .assert_equal(
                 "body.data",
-                "This is expected to be sent back as part of response body: bar12-testcase_config_bar2-bar21.",
+                "This is expected to be sent back as part of response body: bar12-testcase_config_bar2-bar32.",
             )
         ),
         Step(

examples/postman_echo/request_methods/validate_with_functions_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/validate_with_functions.yml
 
 

examples/postman_echo/request_methods/validate_with_variables_test.py

@@ -1,4 +1,4 @@
-# NOTE: Generated By HttpRunner v3.1.3
+# NOTE: Generated By HttpRunner v3.1.4
 # FROM: request_methods/validate_with_variables.yml
 
 

httprunner/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.1.3"
+__version__ = "3.1.4"
 __description__ = "One-stop solution for HTTP(S) testing."
 
 # import firstly for monkey patch if needed

httprunner/make.py

@@ -24,7 +24,7 @@
     convert_relative_project_root_dir,
 )
 from httprunner.response import uniform_validator
-from httprunner.utils import override_config_variables, is_support_multiprocessing
+from httprunner.utils import merge_variables, is_support_multiprocessing
 
 """ cache converted pytest files, avoid duplicate making
 """
@@ -485,9 +485,7 @@ def make_testsuite(testsuite: Dict) -> NoReturn:
         testcase_variables = convert_variables(
             testcase.get("variables", {}), testcase_path
         )
-        testcase_variables = override_config_variables(
-            testcase_variables, testsuite_variables
-        )
+        testcase_variables = merge_variables(testcase_variables, testsuite_variables)
         # testsuite testcase variables > testcase config variables
         testcase_dict["config"]["variables"] = convert_variables(
             testcase_dict["config"].get("variables", {}), testcase_path

httprunner/runner.py

@@ -21,7 +21,7 @@
 from httprunner.parser import build_url, parse_data, parse_variables_mapping
 from httprunner.response import ResponseObject
 from httprunner.testcase import Config, Step
-from httprunner.utils import override_config_variables
+from httprunner.utils import merge_variables
 from httprunner.models import (
     TConfig,
     TStep,
@@ -335,17 +335,16 @@ def run_testcase(self, testcase: TestCase) -> "HttpRunner":
         self.__start_at = time.time()
         self.__step_datas: List[StepData] = []
         self.__session = self.__session or HttpSession()
-        self.__session_variables = {}
+        # save extracted variables of teststeps
+        extracted_variables: VariablesMapping = {}
 
         # run teststeps
         for step in self.__teststeps:
             # override variables
-            # session variables (extracted from pre step) > step variables
-            step.variables.update(self.__session_variables)
+            # step variables > extracted variables from previous steps
+            step.variables = merge_variables(step.variables, extracted_variables)
             # step variables > testcase config variables
-            step.variables = override_config_variables(
-                step.variables, self.__config.variables
-            )
+            step.variables = merge_variables(step.variables, self.__config.variables)
 
             # parse variables
             step.variables = parse_variables_mapping(
@@ -360,8 +359,9 @@ def run_testcase(self, testcase: TestCase) -> "HttpRunner":
                 extract_mapping = self.__run_step(step)
 
             # save extracted variables to session variables
-            self.__session_variables.update(extract_mapping)
+            extracted_variables.update(extract_mapping)
 
+        self.__session_variables.update(extracted_variables)
         self.__duration = time.time() - self.__start_at
         return self
 

httprunner/scaffold.py

@@ -103,7 +103,7 @@ def create_file(path, file_content=""):
         data: "This is expected to be sent back as part of response body: $foo1-$foo2-$foo3."
     validate:
         - eq: ["status_code", 200]
-        - eq: ["body.data", "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar21."]
+        - eq: ["body.data", "This is expected to be sent back as part of response body: bar12-$expect_foo2-bar32."]
 -
     name: post form data
     variables:

httprunner/utils.py

@@ -193,25 +193,23 @@ def default(self, obj):
             return repr(obj)
 
 
-def override_config_variables(
-    step_variables: VariablesMapping, config_variables: VariablesMapping
+def merge_variables(
+    variables: VariablesMapping, variables_to_be_overridden: VariablesMapping
 ) -> VariablesMapping:
-    """ override variables:
-            testcase step variables > testcase config variables
-            testsuite testcase variables > testsuite config variables
+    """ merge two variables mapping, the first variables have higher priority
     """
     step_new_variables = {}
-    for key, value in step_variables.items():
+    for key, value in variables.items():
         if f"${key}" == value or "${" + key + "}" == value:
             # e.g. {"base_url": "$base_url"}
             # or {"base_url": "${base_url}"}
             continue
 
         step_new_variables[key] = value
 
-    variables = copy.deepcopy(config_variables)
-    variables.update(step_new_variables)
-    return variables
+    merged_variables = copy.copy(variables_to_be_overridden)
+    merged_variables.update(step_new_variables)
+    return merged_variables
 
 
 def is_support_multiprocessing() -> bool:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "httprunner"
-version = "3.1.3"
+version = "3.1.4"
 description = "One-stop solution for HTTP(S) testing."
 license = "Apache-2.0"
 readme = "README.md"

tests/make_test.py

@@ -218,7 +218,12 @@ def test_make_teststep_chain_style(self):
     def test_make_requests_with_json_chain_style(self):
         step = {
             "name": "get with params",
-            "variables": {"foo1": "bar1", "foo2": 123, "sum_v": "${sum_two(1, 2)}","myjson":{"name": "user", "password": "123456"}},
+            "variables": {
+                "foo1": "bar1",
+                "foo2": 123,
+                "sum_v": "${sum_two(1, 2)}",
+                "myjson": {"name": "user", "password": "123456"},
+            },
             "request": {
                 "method": "GET",
                 "url": "/get",

tests/utils_test.py

@@ -6,7 +6,7 @@
 from httprunner import loader, utils
 from httprunner.utils import (
     ExtendJSONEncoder,
-    override_config_variables,
+    merge_variables,
 )
 
 
@@ -122,7 +122,7 @@ def test_override_config_variables(self):
         step_variables = {"base_url": "$base_url", "foo1": "bar1"}
         config_variables = {"base_url": "https://httpbin.org", "foo1": "bar111"}
         self.assertEqual(
-            override_config_variables(step_variables, config_variables),
+            merge_variables(step_variables, config_variables),
             {"base_url": "https://httpbin.org", "foo1": "bar1"},
         )