refactor: rename schema to models

httprunner/models.py

@@ -0,0 +1,190 @@
+import os
+from enum import Enum
+from typing import Any
+from typing import Dict, Text, Union, Callable
+from typing import List
+
+from pydantic import BaseModel, Field
+from pydantic import HttpUrl
+
+Name = Text
+Url = Text
+BaseUrl = Union[HttpUrl, Text]
+VariablesMapping = Dict[Text, Any]
+FunctionsMapping = Dict[Text, Callable]
+Headers = Dict[Text, Text]
+Cookies = Dict[Text, Text]
+Verify = bool
+Hook = List[Text]
+Export = List[Text]
+Validators = List[Dict]
+Env = Dict[Text, Any]
+
+
+class MethodEnum(Text, Enum):
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    DELETE = "DELETE"
+    HEAD = "HEAD"
+    OPTIONS = "OPTIONS"
+    PATCH = "PATCH"
+
+
+class TConfig(BaseModel):
+    name: Name
+    verify: Verify = False
+    base_url: BaseUrl = ""
+    # Text: prepare variables in debugtalk.py, ${gen_variables()}
+    variables: Union[VariablesMapping, Text] = {}
+    setup_hooks: Hook = []
+    teardown_hooks: Hook = []
+    export: Export = []
+    path: Text = None
+
+
+class TRequest(BaseModel):
+    """requests.Request model"""
+
+    method: MethodEnum
+    url: Url
+    params: Dict[Text, Text] = {}
+    headers: Headers = {}
+    req_json: Union[Dict, List] = Field({}, alias="json")
+    data: Union[Text, Dict[Text, Any]] = ""
+    cookies: Cookies = {}
+    timeout: float = 120
+    allow_redirects: bool = True
+    verify: Verify = False
+    upload: Dict = {}  # used for upload files
+
+
+class TStep(BaseModel):
+    name: Name
+    request: Union[TRequest, None] = None
+    testcase: Union[Text, Callable, None] = None
+    variables: VariablesMapping = {}
+    setup_hooks: Hook = []
+    teardown_hooks: Hook = []
+    extract: Union[Dict[Text, Text], List[Text]] = {}
+    validators: Validators = Field([], alias="validate")
+    validate_script: List[Text] = []
+
+
+class TestCase(BaseModel):
+    config: TConfig
+    teststeps: List[TStep]
+
+
+class ProjectMeta(BaseModel):
+    debugtalk_py: Text = ""  # debugtalk.py file content
+    functions: FunctionsMapping = {}
+    env: Env = {}
+    PWD: Text = os.getcwd()
+    test_path: Text = None  # run with specified test path
+
+
+class TestsMapping(BaseModel):
+    project_meta: ProjectMeta
+    testcases: List[TestCase]
+
+
+class TestCaseTime(BaseModel):
+    start_at: float = 0
+    start_at_iso_format: Text = ""
+    duration: float = 0
+
+
+class TestCaseInOut(BaseModel):
+    vars: VariablesMapping = {}
+    export: Dict = {}
+
+
+class RequestStat(BaseModel):
+    content_size: float = 0
+    response_time_ms: float = 0
+    elapsed_ms: float = 0
+
+
+class RequestData(BaseModel):
+    method: MethodEnum = MethodEnum.GET
+    url: Url
+    headers: Headers = {}
+    cookies: Cookies = {}
+    body: Union[Text, bytes, Dict, None] = {}
+
+
+class ResponseData(BaseModel):
+    status_code: int
+    headers: Dict
+    cookies: Cookies
+    encoding: Union[Text, None] = None
+    content_type: Text
+    body: Union[Text, bytes, Dict]
+
+
+class ReqRespData(BaseModel):
+    request: RequestData
+    response: ResponseData
+
+
+class SessionData(BaseModel):
+    """request session data, including request, response, validators and stat data"""
+
+    success: bool = False
+    # in most cases, req_resps only contains one request & response
+    # while when 30X redirect occurs, req_resps will contain multiple request & response
+    req_resps: List[ReqRespData] = []
+    stat: RequestStat = RequestStat()
+    validators: Dict = {}
+
+
+class StepData(BaseModel):
+    """teststep data, each step maybe corresponding to one request or one testcase"""
+
+    success: bool = False
+    name: Text = ""  # teststep name
+    data: Union[SessionData, List[SessionData]] = None
+    export: Dict = {}
+
+
+class TestCaseSummary(BaseModel):
+    name: Text
+    success: bool
+    case_id: Text
+    time: TestCaseTime
+    in_out: TestCaseInOut = {}
+    log: Text = ""
+    step_datas: List[StepData] = []
+
+
+class PlatformInfo(BaseModel):
+    httprunner_version: Text
+    python_version: Text
+    platform: Text
+
+
+class TestCaseRef(BaseModel):
+    name: Text
+    base_url: Text = ""
+    testcase: Text
+    variables: VariablesMapping = {}
+
+
+class TestSuite(BaseModel):
+    config: TConfig
+    testcases: List[TestCaseRef]
+
+
+class Stat(BaseModel):
+    total: int = 0
+    success: int = 0
+    fail: int = 0
+
+
+class TestSuiteSummary(BaseModel):
+    success: bool = False
+    stat: Stat = Stat()
+    time: TestCaseTime = TestCaseTime()
+    platform: PlatformInfo
+    testcases: List[TestCaseSummary]