Improve reporters and models (#30)

* for reporter_web:
- allow port definition
- improve logging and status

- add ReportManager into TestDetails
- new TestStep class

* move models to models folder

Author: pjn2work

README.md

@@ -66,13 +66,13 @@
       * **log:** shows test execution on .log file, with the same name as the project_name, errors are shown in stderr
       * **portalio:** ReportPortalIO Web REST DB and reporter:
       * **slack:** tests results are sent to Slack channel
-      * **web:** tests results can be seen in realtime on a browser
+      * **web:** tests results can be seen in realtime on a browser. use **-r-web-port PORT** to specify other than 9204
       * **xml:** test results will be saved on report.xml file
 
 
 # 2.3. Run:
   - ### options:
-    * **-rid**        RunID (ex: -rid 17, if not passed than current hour and minute will be used ex: 2359)
+    * **-rid**        RunID (ex: -rid 17, if not passed then current hour and minute will be used ex: 2359)
     * **-pn**         ProjectName (ex: -pn jules)
     * **-env**        EnvironmentName to test (ex: -env dev)
     * **-rf**         ResultsFolder (ex: -rf "/qa/test_results/"), where the tests results will be stored

testipy/__init__.py

@@ -1,9 +1,7 @@
-#!/usr/bin/env python3
-
 import logging
 
 
-__version__ = "0.10.1"
+__version__ = "0.10.2"
 __app__ = "TestiPy"
 __app_full__ = "Python Test Tool"
 __author__ = "Pedro Nunes"

testipy/configs/default_config.py

@@ -1,6 +1,6 @@
 import os
 
-from testipy.configs import enums_data
+from testipy.configs.enums_data import STATE_PASSED, STATE_FAILED
 
 # run.py
 default_project_name = "local"
@@ -24,8 +24,8 @@
 separator_and_join_tags = "&"
 
 # execute_tests.py
-if_no_test_started_mark_as = enums_data.STATE_PASSED
-count_as_failed_states = [enums_data.STATE_FAILED]
+if_no_test_started_mark_as = STATE_PASSED
+count_as_failed_states = [STATE_FAILED]
 suite_threads = 1
 
 # report_base.py

testipy/engine/execute_tests.py

@@ -1,21 +1,24 @@
+from __future__ import annotations
 import os
 import traceback
 import concurrent.futures
 
-from typing import List
+from typing import List, TYPE_CHECKING
 
 from testipy import get_exec_logger
 from testipy.configs import enums_data, default_config
-from testipy.engine.models import PackageAttr, SuiteAttr, TestMethodAttr
 from testipy.lib_modules import common_methods as cm
 from testipy.lib_modules.common_methods import synchronized
 from testipy.lib_modules.state_counter import StateCounter
 from testipy.lib_modules.textdecor import color_state
 from testipy.lib_modules.start_arguments import StartArguments
 from testipy.helpers.prettify import format_duration
 from testipy.helpers.handle_assertions import ExpectedError
-from testipy.reporter.report_manager import ReportManager
-from testipy.reporter import SuiteDetails, TestDetails
+
+if TYPE_CHECKING:
+    from testipy.models import PackageAttr, SuiteAttr, TestMethodAttr, SuiteDetails, TestDetails
+    from testipy.reporter.report_manager import ReportManager
+
 
 _exec_logger = get_exec_logger()
 

testipy/engine/read_tests.py

@@ -9,8 +9,10 @@
 from testipy.lib_modules import py_inspector, common_methods as cm
 from testipy.lib_modules.args_parser import ArgsParser
 from testipy.helpers import load_config
-from testipy.engine.models import (
-    PackageAttr, SuiteAttr, TestMethodAttr,
+from testipy.models.attr import (
+    PackageAttr,
+    SuiteAttr,
+    TestMethodAttr,
     get_package_by_name,
     mark_packages_suites_methods_ids,
     show_test_structure,

testipy/helpers/data_driven_testing.py

@@ -1,16 +1,17 @@
 from __future__ import annotations
-
 from abc import abstractmethod, ABC
 from collections import OrderedDict
 from enum import Enum
-from typing import Union, Dict, List, Tuple
+from typing import Union, Dict, List, Tuple, TYPE_CHECKING
 
 from testipy.configs import enums_data
-from testipy.reporter.package_manager import SuiteDetails, TestDetails
-from testipy.reporter.report_manager import ReportManager
 from testipy.helpers import get_traceback_tabulate, load_config, left_update_dict, prettify
 from testipy.helpers.handle_assertions import ExpectedError, SkipTestError
 
+if TYPE_CHECKING:
+    from testipy.models import SuiteDetails, TestDetails
+    from testipy.reporter import ReportManager
+
 
 class RunMode(Enum):
     SCENARIOS_AS_TESTS__USECASES_AS_TESTSTEPS = 1

testipy/helpers/errors.py

@@ -42,12 +42,15 @@ def get_traceback_list(exc_value: BaseException) -> List[Dict]:
     tbe = traceback.TracebackException.from_exception(exc_value)
 
     # get stacktrace (cascade methods calls)
-    error_lines = [{
+    error_lines = [
+        {
             "filename": frame_summary.filename,
             "method"  : frame_summary.name,
             "lineno"  : frame_summary.lineno,
             "code"    : frame_summary.line
-        } for frame_summary in tbe.stack]
+        }
+        for frame_summary in tbe.stack
+    ]
 
     # append error, by order of execution
     result.append({

testipy/helpers/handle_assertions.py

@@ -87,8 +87,8 @@ def assert_equal_complex_object(
 
 
 def assert_equal_dicts(
-    expected: Any,
-    received: Any,
+    expected: Dict,
+    received: Dict,
     expected_name: str = "expected",
     received_name: str = "received",
 ) -> None:
@@ -103,8 +103,8 @@ def assert_equal_dicts(
 
 
 def assert_equal_lists(
-    expected: Any,
-    received: Any,
+    expected: List,
+    received: List,
     expected_name: str = "expected",
     received_name: str = "received",
     same_len: bool = True,

testipy/lib_modules/args_parser.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 from __future__ import annotations
 
 import sys

testipy/lib_modules/browser_manager/playwright.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 import base64
 
 from time import sleep