testit-python-commons 4.2.8__py3-none-any.whl

testit_python_commons/decorators.py

@@ -0,0 +1,221 @@
+import asyncio
+import inspect
+import logging
+import types
+from functools import wraps
+
+from testit_python_commons.services.logger import adapter_logger
+from testit_python_commons.services.utils import Utils
+
+
+def inner(function):
+    def set_properties(kwargs):
+        if not hasattr(function, 'test_properties') and kwargs:
+            function.test_properties = {}
+
+            for key, value in kwargs.items():
+                if hasattr(function,
+                           'callspec') and key not in function.callspec.params:
+                    function.test_properties[key] = str(value)
+
+    @wraps(function)
+    def sync_wrapper(*args, **kwargs):
+        set_properties(kwargs)
+        function(*args, **kwargs)
+
+    @wraps(function)
+    async def async_wrapper(*args, **kwargs):
+        set_properties(kwargs)
+        await function(*args, **kwargs)
+
+    if isinstance(function, types.FunctionType):
+        if inspect.iscoroutinefunction(function):
+            return async_wrapper
+
+        return sync_wrapper
+
+    return function
+
+
+@Utils.deprecated('Use "workItemIds" instead.')
+@adapter_logger
+def workItemID(*test_workitems_id: int or str):  # noqa: N802
+    def outer(function):
+        function.test_workitems_id = []
+        for test_workitem_id in test_workitems_id:
+            function.test_workitems_id.append(str(test_workitem_id))
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def workItemIds(*test_workitems_id: int or str):  # noqa: N802
+    """
+    specifies a method that links autotests with manual tests. Receives the array of manual tests' IDs
+    """
+    def outer(function):  # noqa: N802
+        function.test_workitems_id = []
+        for test_workitem_id in test_workitems_id:
+            function.test_workitems_id.append(str(test_workitem_id))
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def displayName(test_displayname: str):  # noqa: N802
+    """
+    specifies internal autotest name (used in Test IT)
+    """
+    def outer(function):
+        function.test_displayname = test_displayname
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def nameSpace(test_namespace: str):  # noqa: N802
+    """
+    specifies directory in the TMS system (default - file's name of test)
+    """
+    def outer(function):
+        function.test_namespace = test_namespace
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def className(test_classname: str):  # noqa: N802
+    """
+    specifies subdirectory in the TMS system (default - class's name of test)
+    """
+    def outer(function):
+        function.test_classname = test_classname
+        return inner(function)
+
+    return outer
+
+
+@Utils.deprecated('Use "externalId" instead.')
+@adapter_logger
+def externalID(test_external_id: str):  # noqa: N802
+    def outer(function):
+        function.test_external_id = test_external_id
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def externalId(test_external_id: str):  # noqa: N802
+    """
+    specifies unique internal autotest ID (used in Test IT)
+    """
+    def outer(function):
+        function.test_external_id = test_external_id
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def title(test_title: str):
+    """
+    specifies autotest name specified in the autotest card.
+    If not specified, the name from the displayName method is used
+    """
+    def outer(function):
+        function.test_title = test_title
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def description(test_description: str):
+    """
+    specifies autotest description specified in the autotest card
+    """
+    def outer(function):
+        function.test_description = test_description
+        return inner(function)
+
+    return outer
+
+
+@Utils.deprecated('Use "tags" instead.')
+@adapter_logger
+def labels(*test_labels: str):
+    """
+    specifies labels listed in the autotest card
+    """
+    def outer(function):
+        function.test_labels = test_labels
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def tags(*test_tags: str):
+    """
+    specifies tags listed in the autotest card
+    """
+    def outer(function):
+        function.test_tags = test_tags
+        return inner(function)
+
+    return outer
+
+
+@Utils.deprecated('Use "links" instead.')
+@adapter_logger
+def link(url: str, title: str = None, type: str = None, description: str = None):  # noqa: A002,VNE003
+    def outer(function):
+        if not hasattr(function, 'test_links'):
+            function.test_links = []
+
+        function.test_links.append(
+            Utils.convert_link_dict_to_link_model({
+                "url": url,
+                "title": title,
+                "type": type,
+                "description": description}))
+
+        return inner(function)
+
+    return outer
+
+
+@adapter_logger
+def links(url: str = None, title: str = None, type: str = None,  # noqa: A002,VNE003
+          description: str = None, links: list or tuple = None):
+    """
+    specifies links listed in the autotest card
+    """
+    def outer(function):
+        if not hasattr(function, 'test_links'):
+            function.test_links = []
+
+        if url:
+            function.test_links.append(
+                Utils.convert_link_dict_to_link_model({
+                    "url": url,
+                    "title": title,
+                    "type": type,
+                    "description": description}))
+        elif links and (isinstance(links, list) or isinstance(links, tuple)):
+            for link in links:
+                if isinstance(link, dict) and 'url' in link:
+                    function.test_links.append(
+                        Utils.convert_link_dict_to_link_model(link))
+                else:
+                    logging.warning(f'Link ({link}) can\'t be processed!')
+        else:
+            logging.warning(f'Links for {function.__name__} can\'t be processed!\nPlease, set "url" or "links"!')
+        return inner(function)
+
+    return outer

testit_python_commons/dynamic_methods.py

@@ -0,0 +1,237 @@
+import logging
+
+from testit_python_commons.services import TmsPluginManager
+from testit_python_commons.services.logger import adapter_logger
+from testit_python_commons.services.utils import Utils
+
+
+@Utils.deprecated('Use "addLinks" instead.')
+@adapter_logger
+def addLink(url: str, title: str = None, type: str = None, description: str = None):  # noqa: A002,VNE003,N802
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_link'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_link(
+            link=Utils.convert_link_dict_to_link_model({
+                "url": url,
+                "title": title,
+                "type": type,
+                "description": description}))
+
+
+@adapter_logger
+def addLinks(url: str = None, title: str = None, type: str = None, description: str = None,  # noqa: A002,VNE003,N802
+             links: list or tuple = None):
+    """
+    links in the autotest result
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_link'):
+        if url:
+            TmsPluginManager.get_plugin_manager().hook \
+                .add_link(
+                link=Utils.convert_link_dict_to_link_model({
+                    "url": url,
+                    "title": title,
+                    "type": type,
+                    "description": description}))
+        elif links and (isinstance(links, list) or isinstance(links, tuple)):
+            for link in links:
+                if isinstance(link, dict) and 'url' in link:
+                    TmsPluginManager.get_plugin_manager().hook \
+                        .add_link(link=Utils.convert_link_dict_to_link_model(link))
+                else:
+                    logging.warning(f'Link ({link}) can\'t be processed!')
+        else:
+            logging.warning("Links can't be processed!\nPlease, set 'url' or 'links'!")
+
+
+@Utils.deprecated('Use "addMessage" instead.')
+@adapter_logger
+def message(test_message: str):
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_message'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_message(test_message=test_message)
+
+
+@adapter_logger
+def addMessage(test_message: str):   # noqa: N802
+    """
+    information about autotest in the autotest result
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_message'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_message(test_message=test_message)
+
+
+@Utils.deprecated('Use "addAttachments" instead.')
+@adapter_logger
+def attachments(*attachments_paths):
+    active_step = TmsPluginManager.get_step_manager().get_active_step()
+
+    if active_step:
+        adapter_manager = TmsPluginManager.get_adapter_manager()
+        if not adapter_manager:
+            return
+        attachment_ids = adapter_manager.load_attachments(attachments_paths)
+
+        active_step.set_attachments(active_step.get_attachments() + attachment_ids)
+    else:
+        if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_attachments'):
+            TmsPluginManager.get_plugin_manager().hook \
+                .add_attachments(attach_paths=attachments_paths)
+
+
+@adapter_logger
+def addAttachments(data, is_text: bool = False, name: str = None):   # noqa: N802
+    """
+    uploading files in the autotest result
+    """
+    active_step = TmsPluginManager.get_step_manager().get_active_step()
+
+    if active_step:
+        __add_attachments_to_step(active_step, data, is_text, name)
+    else:
+        __add_attachments_to_test(data, is_text, name)
+
+
+@adapter_logger
+def __add_attachments_to_step(step, data, is_text: bool = False, name: str = None):
+    adapter_manager = TmsPluginManager.get_adapter_manager()
+    if not adapter_manager:
+        return
+    if is_text:
+        attachment_ids = adapter_manager.create_attachment(data, name)
+    else:
+        if isinstance(data, str):
+            attachment_ids = adapter_manager.load_attachments([data])
+        elif isinstance(data, tuple) or isinstance(data, list):
+            attachment_ids = adapter_manager.load_attachments(data)
+        else:
+            logging.warning(f'File ({data}) not found!')
+            return
+
+    step.set_attachments(step.get_attachments() + attachment_ids)
+
+
+@adapter_logger
+def __add_attachments_to_test(data, is_text: bool = False, name: str = None):
+    if is_text and hasattr(TmsPluginManager.get_plugin_manager().hook, 'create_attachment'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .create_attachment(
+            body=data,
+            name=name)
+    elif hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_attachments'):
+        if isinstance(data, str):
+            TmsPluginManager.get_plugin_manager().hook \
+                .add_attachments(attach_paths=[data])
+        elif isinstance(data, tuple) or isinstance(data, list):
+            TmsPluginManager.get_plugin_manager().hook \
+                .add_attachments(attach_paths=data)
+        else:
+            logging.warning(f'({data}) is not path!')
+
+
+@adapter_logger
+def addWorkItemIds(*test_work_item_ids: int or str):  # noqa: N802
+    """
+    a dynamic method that links autotests with manual tests. Receives the array of manual tests' IDs
+    """
+    if not hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_work_item_id'):
+        return
+
+    for test_work_item_id in test_work_item_ids:
+        TmsPluginManager.get_plugin_manager().hook.add_work_item_id(test_work_item_id=str(test_work_item_id))
+
+
+@adapter_logger
+def addDisplayName(test_display_name: str):  # noqa: N802
+    """
+    a dynamic method for adding internal autotest name (used in Test IT)
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_display_name'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_display_name(test_display_name=str(test_display_name))
+
+
+@adapter_logger
+def addNameSpace(test_namespace: str):  # noqa: N802
+    """
+    a dynamic method for adding directory in the TMS system (default - file's name of test)
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_namespace'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_namespace(test_namespace=str(test_namespace))
+
+
+@adapter_logger
+def addClassName(test_classname: str):  # noqa: N802
+    """
+    a dynamic method for adding subdirectory in the TMS system (default - class's name of test)
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_classname'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_classname(test_classname=str(test_classname))
+
+
+@adapter_logger
+def addExternalId(test_external_id: str):  # noqa: N802
+    """
+    a dynamic method for adding unique internal autotest ID (used in Test IT)
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_external_id'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_external_id(test_external_id=str(test_external_id))
+
+
+@adapter_logger
+def addTitle(test_title: str): # noqa: N802
+    """
+    a dynamic method for adding autotest name specified in the autotest card. If not specified, the name from the displayName method is used
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_title'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_title(test_title=str(test_title))
+
+
+@adapter_logger
+def addDescription(test_description: str): # noqa: N802
+    """
+    a dynamic method for adding autotest description specified in the autotest card
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_description'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_description(test_description=str(test_description))
+
+
+@Utils.deprecated('Use "addTags" instead.')
+@adapter_logger
+def addLabels(*test_labels: str): # noqa: N802
+    """
+    a dynamic method for adding labels listed in the autotest card
+    """
+    if not hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_label'):
+        return
+
+    for test_label in test_labels:
+        TmsPluginManager.get_plugin_manager().hook.add_label(test_label=str(test_label))
+
+
+@adapter_logger
+def addTags(*test_tags: str): # noqa: N802
+    """
+    a dynamic method for adding tags listed in the autotest card
+    """
+    if not hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_tag'):
+        return
+
+    for test_tag in test_tags:
+        TmsPluginManager.get_plugin_manager().hook.add_tag(test_tag=str(test_tag))
+
+
+@adapter_logger
+def addParameter(name: str, value: str): # noqa: N802
+    """
+    a dynamic method for adding parameter in the autotest result
+    """
+    if hasattr(TmsPluginManager.get_plugin_manager().hook, 'add_parameter'):
+        TmsPluginManager.get_plugin_manager().hook \
+            .add_parameter(name=str(name), value=str(value))

testit_python_commons/models/__init__.py

@@ -0,0 +1,5 @@
+from testit_python_commons.models.link_type import LinkType
+
+__all__ = [
+    'LinkType'
+]

testit_python_commons/models/adapter_mode.py

@@ -0,0 +1,4 @@
+class AdapterMode:
+    USE_FILTER = '0'
+    RUN_ALL_TESTS = '1'
+    NEW_TEST_RUN = '2'

testit_python_commons/models/fixture.py

@@ -0,0 +1,24 @@
+from attr import attrs, attrib
+from attr import Factory
+
+
+@attrs
+class FixtureResult:
+    title = attrib(default=None)
+    outcome = attrib(default=None)
+    description = attrib(default=None)
+    message = attrib(default=None)
+    stacktrace = attrib(default=None)
+    steps = attrib(default=None)
+    attachments = attrib(default=Factory(list))
+    parameters = attrib(default=Factory(list))
+    start = attrib(default=None)
+    stop = attrib(default=None)
+
+
+@attrs
+class FixturesContainer:
+    uuid = attrib(default=None)
+    external_ids = attrib(default=Factory(list))
+    befores = attrib(default=Factory(list))
+    afters = attrib(default=Factory(list))

testit_python_commons/models/link.py

@@ -0,0 +1,53 @@
+from testit_python_commons.models.link_type import LinkType
+from testit_python_commons.services.logger import adapter_logger
+from testit_python_commons.utils import HtmlEscapeUtils
+
+
+class Link:
+    __url: str = None
+    __title: str = None
+    __link_type: LinkType = None
+    __description: str = None
+
+    @adapter_logger
+    def set_url(self, url: str):
+        self.__url = url
+
+        return self
+
+    @adapter_logger
+    def get_url(self) -> str:
+        return self.__url
+
+    @adapter_logger
+    def set_title(self, title: str):
+        self.__title = HtmlEscapeUtils.escape_html_tags(title)
+
+        return self
+
+    @adapter_logger
+    def get_title(self) -> str:
+        return self.__title
+
+    @adapter_logger
+    def set_link_type(self, link_type: LinkType):
+        if link_type is None:
+            link_type = LinkType.RELATED
+
+        self.__link_type = link_type
+
+        return self
+
+    @adapter_logger
+    def get_link_type(self) -> LinkType:
+        return self.__link_type
+
+    @adapter_logger
+    def set_description(self, description: str):
+        self.__description = HtmlEscapeUtils.escape_html_tags(description)
+
+        return self
+
+    @adapter_logger
+    def get_description(self) -> str:
+        return self.__description

testit_python_commons/models/link_type.py

@@ -0,0 +1,10 @@
+class LinkType:
+    """
+    Test IT link type
+    """
+    RELATED = 'Related'
+    BLOCKED_BY = 'BlockedBy'
+    DEFECT = 'Defect'
+    ISSUE = 'Issue'
+    REQUIREMENT = 'Requirement'
+    REPOSITORY = 'Repository'

testit_python_commons/models/outcome_type.py

@@ -0,0 +1,5 @@
+class OutcomeType:
+    PASSED = 'Passed'
+    FAILED = 'Failed'
+    SKIPPED = 'Skipped'
+    BLOCKED = 'Blocked'

testit_python_commons/models/status_type.py

@@ -0,0 +1,6 @@
+class StatusType:
+    SUCCEEDED = 'Succeeded'
+    FAILED = 'Failed'
+    INCOMPLETE = 'Incomplete'
+    INPROGRESS = 'InProgress'
+    PENDING = 'Pending'

testit_python_commons/models/step_result.py

@@ -0,0 +1,90 @@
+from testit_python_commons.utils.html_escape_utils import HtmlEscapeUtils
+
+
+class StepResult:
+    __title: str = None
+    __outcome: str = None
+    __description: str = None
+    __duration: int = None
+    __started_on: str = None
+    __completed_on: str = None
+    __step_results: list = None
+    __attachments: list = None
+    __parameters: dict = None
+
+    def __init__(self):
+        self.__step_results = []
+        self.__attachments = []
+        self.__parameters = {}
+
+    def set_title(self, title: str):
+        self.__title = HtmlEscapeUtils.escape_html_tags(title)
+
+        return self
+
+    def get_title(self) -> str:
+        return self.__title
+
+    def set_outcome(self, outcome: str):
+        self.__outcome = HtmlEscapeUtils.escape_html_tags(outcome)
+
+        return self
+
+    def get_outcome(self) -> str:
+        return self.__outcome
+
+    def set_description(self, description: str):
+        self.__description = HtmlEscapeUtils.escape_html_tags(description)
+
+        return self
+
+    def get_description(self) -> str:
+        return self.__description
+
+    def set_duration(self, duration: int):
+        self.__duration = duration
+
+        return self
+
+    def get_duration(self) -> int:
+        return self.__duration
+
+    def set_started_on(self, started_on: str):
+        self.__started_on = started_on
+
+        return self
+
+    def get_started_on(self) -> str:
+        return self.__started_on
+
+    def set_completed_on(self, completed_on: str):
+        self.__completed_on = completed_on
+
+        return self
+
+    def get_completed_on(self) -> str:
+        return self.__completed_on
+
+    def set_step_results(self, step_results: list):
+        self.__step_results = step_results
+
+        return self
+
+    def get_step_results(self) -> list:
+        return self.__step_results
+
+    def set_attachments(self, attachments: list):
+        self.__attachments = attachments
+
+        return self
+
+    def get_attachments(self) -> list:
+        return self.__attachments
+
+    def set_parameters(self, parameters: dict):
+        self.__parameters = HtmlEscapeUtils.escape_html_in_object(parameters)
+
+        return self
+
+    def get_parameters(self) -> dict:
+        return self.__parameters