tests: add examples with scaffold

examples/demo-with-py-plugin/.gitignore

@@ -0,0 +1,15 @@
+.env
+reports/
+*.so
+.vscode/
+.idea/
+.DS_Store
+output/
+__pycache__/
+*.pyc
+.python-version
+logs/
+
+# plugin
+debugtalk.bin
+debugtalk.so

examples/demo-with-py-plugin/debugtalk.py

@@ -0,0 +1,73 @@
+import logging
+import time
+from typing import List
+
+import funppy
+
+
+def get_httprunner_version():
+    return "v4.0.0-alpha"
+
+
+def sleep(n_secs):
+    time.sleep(n_secs)
+
+
+def sum(*args):
+    result = 0
+    for arg in args:
+        result += arg
+    return result
+
+
+def sum_ints(*args: List[int]) -> int:
+    result = 0
+    for arg in args:
+        result += arg
+    return result
+
+
+def sum_two_int(a: int, b: int) -> int:
+    return a + b
+
+
+def sum_two_string(a: str, b: str) -> str:
+    return a + b
+
+
+def sum_strings(*args: List[str]) -> str:
+    result = ""
+    for arg in args:
+        result += arg
+    return result
+
+
+def concatenate(*args: List[str]) -> str:
+    result = ""
+    for arg in args:
+        result += str(arg)
+    return result
+
+
+def setup_hook_example(name):
+    logging.warning("setup_hook_example")
+    return f"setup_hook_example: {name}"
+
+
+def teardown_hook_example(name):
+    logging.warning("teardown_hook_example")
+    return f"teardown_hook_example: {name}"
+
+
+if __name__ == '__main__':
+    funppy.register("get_httprunner_version", get_httprunner_version)
+    funppy.register("sum", sum)
+    funppy.register("sum_ints", sum_ints)
+    funppy.register("concatenate", concatenate)
+    funppy.register("sum_two_int", sum_two_int)
+    funppy.register("sum_two", sum_two_int)
+    funppy.register("sum_two_string", sum_two_string)
+    funppy.register("sum_strings", sum_strings)
+    funppy.register("setup_hook_example", setup_hook_example)
+    funppy.register("teardown_hook_example", teardown_hook_example)
+    funppy.serve()

examples/demo-with-py-plugin/testcases/demo_ref_testcase.yml

@@ -0,0 +1,33 @@
+config:
+    name: "request methods testcase: reference testcase"
+    variables:
+        foo1: testsuite_config_bar1
+        expect_foo1: testsuite_config_bar1
+        expect_foo2: config_bar2
+    base_url: "https://postman-echo.com"
+    verify: False
+
+teststeps:
+-
+    name: request with functions
+    variables:
+        foo1: testcase_ref_bar1
+        expect_foo1: testcase_ref_bar1
+    testcase: testcases/demo_requests.yml
+    export:
+        - foo3
+-
+    name: post form data
+    variables:
+        foo1: bar1
+    request:
+        method: POST
+        url: /post
+        headers:
+            User-Agent: HttpRunner/${get_httprunner_version()}
+            Content-Type: "application/x-www-form-urlencoded"
+        data: "foo1=$foo1&foo2=$foo3"
+    validate:
+        - eq: ["status_code", 200]
+        - eq: ["body.form.foo1", "bar1"]
+        - eq: ["body.form.foo2", "bar21"]

examples/demo-with-py-plugin/testcases/demo_requests.yml

@@ -0,0 +1,65 @@
+config:
+    name: "request methods testcase with functions"
+    variables:
+        foo1: config_bar1
+        foo2: config_bar2
+        expect_foo1: config_bar1
+        expect_foo2: config_bar2
+    base_url: "https://postman-echo.com"
+    verify: False
+    export: ["foo3"]
+
+teststeps:
+-
+    name: get with params
+    variables:
+        foo1: bar11
+        foo2: bar21
+        sum_v: "${sum_two(1, 2)}"
+    request:
+        method: GET
+        url: /get
+        params:
+            foo1: $foo1
+            foo2: $foo2
+            sum_v: $sum_v
+        headers:
+            User-Agent: HttpRunner/${get_httprunner_version()}
+    extract:
+        foo3: "body.args.foo2"
+    validate:
+        - eq: ["status_code", 200]
+        - eq: ["body.args.foo1", "bar11"]
+        - eq: ["body.args.sum_v", "3"]
+        - eq: ["body.args.foo2", "bar21"]
+-
+    name: post raw text
+    variables:
+        foo1: "bar12"
+        foo3: "bar32"
+    request:
+        method: POST
+        url: /post
+        headers:
+            User-Agent: HttpRunner/${get_httprunner_version()}
+            Content-Type: "text/plain"
+        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-bar32."]
+-
+    name: post form data
+    variables:
+        foo2: bar23
+    request:
+        method: POST
+        url: /post
+        headers:
+            User-Agent: HttpRunner/${get_httprunner_version()}
+            Content-Type: "application/x-www-form-urlencoded"
+        data: "foo1=$foo1&foo2=$foo2&foo3=$foo3"
+    validate:
+        - eq: ["status_code", 200]
+        - eq: ["body.form.foo1", "$expect_foo1"]
+        - eq: ["body.form.foo2", "bar23"]
+        - eq: ["body.form.foo3", "bar21"]

examples/demo-with-py-plugin/testcases/demo_with_funplugin.json

@@ -0,0 +1,176 @@
+{
+    "config": {
+        "name": "demo with complex mechanisms",
+        "base_url": "https://postman-echo.com",
+        "variables": {
+            "a": "${sum(10, 2.3)}",
+            "b": 3.45,
+            "n": "${sum_ints(1, 2, 2)}",
+            "varFoo1": "${gen_random_string($n)}",
+            "varFoo2": "${max($a, $b)}"
+        }
+    },
+    "teststeps": [
+        {
+            "name": "transaction 1 start",
+            "transaction": {
+                "name": "tran1",
+                "type": "start"
+            }
+        },
+        {
+            "name": "get with params",
+            "request": {
+                "method": "GET",
+                "url": "/get",
+                "params": {
+                    "foo1": "$varFoo1",
+                    "foo2": "$varFoo2"
+                },
+                "headers": {
+                    "User-Agent": "HttpRunnerPlus"
+                }
+            },
+            "variables": {
+                "b": 34.5,
+                "n": 3,
+                "name": "get with params",
+                "varFoo2": "${max($a, $b)}"
+            },
+            "setup_hooks": [
+                "${setup_hook_example($name)}"
+            ],
+            "teardown_hooks": [
+                "${teardown_hook_example($name)}"
+            ],
+            "extract": {
+                "varFoo1": "body.args.foo1"
+            },
+            "validate": [
+                {
+                    "check": "status_code",
+                    "assert": "equals",
+                    "expect": 200,
+                    "msg": "check response status code"
+                },
+                {
+                    "check": "headers.\"Content-Type\"",
+                    "assert": "startswith",
+                    "expect": "application/json"
+                },
+                {
+                    "check": "body.args.foo1",
+                    "assert": "length_equals",
+                    "expect": 5,
+                    "msg": "check args foo1"
+                },
+                {
+                    "check": "$varFoo1",
+                    "assert": "length_equals",
+                    "expect": 5,
+                    "msg": "check args foo1"
+                },
+                {
+                    "check": "body.args.foo2",
+                    "assert": "equals",
+                    "expect": "34.5",
+                    "msg": "check args foo2"
+                }
+            ]
+        },
+        {
+            "name": "transaction 1 end",
+            "transaction": {
+                "name": "tran1",
+                "type": "end"
+            }
+        },
+        {
+            "name": "post json data",
+            "request": {
+                "method": "POST",
+                "url": "/post",
+                "body": {
+                    "foo1": "$varFoo1",
+                    "foo2": "${max($a, $b)}"
+                }
+            },
+            "validate": [
+                {
+                    "check": "status_code",
+                    "assert": "equals",
+                    "expect": 200,
+                    "msg": "check status code"
+                },
+                {
+                    "check": "body.json.foo1",
+                    "assert": "length_equals",
+                    "expect": 5,
+                    "msg": "check args foo1"
+                },
+                {
+                    "check": "body.json.foo2",
+                    "assert": "equals",
+                    "expect": 12.3,
+                    "msg": "check args foo2"
+                }
+            ]
+        },
+        {
+            "name": "post form data",
+            "request": {
+                "method": "POST",
+                "url": "/post",
+                "headers": {
+                    "Content-Type": "application/x-www-form-urlencoded; charset=UTF-8"
+                },
+                "body": {
+                    "foo1": "$varFoo1",
+                    "foo2": "${max($a, $b)}",
+                    "time": "${get_timestamp()}"
+                }
+            },
+            "extract": {
+                "varTime": "body.form.time"
+            },
+            "validate": [
+                {
+                    "check": "status_code",
+                    "assert": "equals",
+                    "expect": 200,
+                    "msg": "check status code"
+                },
+                {
+                    "check": "body.form.foo1",
+                    "assert": "length_equals",
+                    "expect": 5,
+                    "msg": "check args foo1"
+                },
+                {
+                    "check": "body.form.foo2",
+                    "assert": "equals",
+                    "expect": "12.3",
+                    "msg": "check args foo2"
+                }
+            ]
+        },
+        {
+            "name": "get with timestamp",
+            "request": {
+                "method": "GET",
+                "url": "/get",
+                "params": {
+                    "time": "$varTime"
+                }
+            },
+            "validate": [
+                {
+                    "check": "body.args.time",
+                    "assert": "length_equals",
+                    "expect": 13,
+                    "msg": "check extracted var timestamp"
+                }
+            ]
+        }
+    ]
+}