Add RP item objects

siarheiparkhomik · web-flow · commit fa091f7352a8 · 2020-10-02T15:01:01.000+03:00
diff --git a/reportportal_client/items/__init__.py b/reportportal_client/items/__init__.py
@@ -0,0 +1,16 @@
+"""This package provides common static objects and variables.
+
+Copyright (c) 2018 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
diff --git a/reportportal_client/items/helpers.py b/reportportal_client/items/helpers.py
@@ -0,0 +1,23 @@
+"""
+This module contains common classes-helpers for the items.
+
+Copyright (c) 2018 http://reportportal.io .
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from enum import IntEnum
+
+
+class ItemWeight(IntEnum):
+    """Enum with weights for different item types."""
+
+    ROOT_ITEM_WEIGHT = 1
+    LOG_ITEM_WEIGHT = 10
diff --git a/reportportal_client/items/rp_base_item.py b/reportportal_client/items/rp_base_item.py
@@ -0,0 +1,99 @@
+"""
+This module contains functional for Base RP items management.
+
+Copyright (c) 2018 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from reportportal_client.core.rp_requests import HttpRequest
+from reportportal_client.core.rp_responses import RPResponse
+from reportportal_client.static.defines import NOT_FOUND
+
+
+class BaseRPItem(object):
+    """This model stores attributes related to RP item."""
+
+    def __init__(self, rp_url, session, api_version, project_name,
+                 launch_uuid, generated_id):
+        """Initialize instance attributes.
+
+        :param rp_url:         report portal url
+        :param session:        Session object
+        :param api_version:    RP API version
+        :param project_name:   RP project name
+        :param launch_uuid:    Parent launch UUID
+        :param generated_id:   Id generated to speed up client
+        """
+        self.uuid = None
+        self.weight = None
+        self.generated_id = generated_id
+        self.http_requests = []
+        self.responses = []
+        self.rp_url = rp_url
+        self.session = session
+        self.api_version = api_version
+        self.project_name = project_name
+        self.launch_uuid = launch_uuid
+
+    @property
+    def http_request(self):
+        """Get last http request.
+
+        :return: request object
+        """
+        return self.http_requests[-1] if self.http_requests else None
+
+    @property
+    def response(self):
+        """Get last http response.
+
+        :return: Response data object
+        """
+        return self.responses[-1] if self.responses else None
+
+    @response.setter
+    def response(self, data):
+        """Set the response object for the test item.
+
+        :param data: Response data object
+        """
+        response = RPResponse(data)
+        self.responses.append(response)
+        self.uuid = response.id if (response.id is
+                                    not NOT_FOUND) else self.uuid
+
+    @property
+    def unhandled_requests(self):
+        """Get list of requests that were not handled.
+
+        :return: list of HttpRequest objects
+        """
+        return [request for request in self.http_requests
+                if not request.response]
+
+    def add_request(self, endpoint, method, request_class, *args, **kwargs):
+        """Add new request object.
+
+        :param endpoint:       request endpoint
+        :param method:         Session object method. Allowable values: get,
+                               post, put, delete
+        :param request_class:  request class object
+        :param args:           request object attributes
+        :param kwargs:         request object named attributes
+        :return: None
+        """
+        rp_request = request_class(*args, **kwargs)
+        rp_request.http_request = HttpRequest(method, endpoint)
+        rp_request.priority = self.weight
+        self.http_requests.append(rp_request)
diff --git a/reportportal_client/items/rp_log_items/__init__.py b/reportportal_client/items/rp_log_items/__init__.py
@@ -0,0 +1,16 @@
+"""This package provides common static objects and variables.
+
+Copyright (c) 2018 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
diff --git a/reportportal_client/items/rp_log_items/rp_log_item.py b/reportportal_client/items/rp_log_items/rp_log_item.py
@@ -0,0 +1,70 @@
+"""
+This module contains functional for RP log items management.
+
+Copyright (c) 2018 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from reportportal_client.items.rp_base_item import BaseRPItem
+from reportportal_client.core.rp_requests import RPRequestLog
+from reportportal_client.static.defines import RP_LOG_LEVELS
+from reportportal_client.items.helpers import ItemWeight
+
+
+class RPLogItem(BaseRPItem):
+    """This model stores attributes for RP log items."""
+
+    def __init__(self, rp_url, session, api_version, project_name,
+                 launch_uuid, generated_id):
+        """Initialize instance attributes.
+
+        :param rp_url:          report portal URL
+        :param session:         Session object
+        :param api_version:     RP API version
+        :param project_name:    RP project name
+        :param launch_uuid:     Parent launch UUID
+        :param generated_id:    Id generated to speed up client
+        """
+        super(RPLogItem, self).__init__(rp_url, session, api_version,
+                                        project_name, launch_uuid,
+                                        generated_id)
+        self.weight = ItemWeight.LOG_ITEM_WEIGHT
+
+    @property
+    def response(self):
+        """Get the response object for RP log item."""
+        return self._responses[0]
+
+    @response.setter
+    def response(self, value):
+        """Set the response object for RP log item."""
+        raise NotImplementedError
+
+    def create(self, time, file_obj=None, item_uuid=None,
+               level=RP_LOG_LEVELS[40000], message=None):
+        """Add request for log item creation.
+
+        :param time:        Log item time
+        :param file_obj:    Object of the RPFile
+        :param item_uuid:   Parent test item UUID
+        :param level:       Log level. Allowable values: error(40000),
+                            warn(30000), info(20000), debug(10000),
+                            trace(5000), fatal(50000), unknown(60000)
+        :param message:     Log message
+        """
+        endpoint = "/api/{version}/{projectName}/log".format(
+            version=self.api_version, projectName=self.project_name)
+        self.add_request(endpoint, self.session.post, RPRequestLog,
+                         self.launch_uuid, time, file=file_obj,
+                         item_uuid=item_uuid, level=level, message=message)
diff --git a/reportportal_client/items/rp_test_items/__init__.py b/reportportal_client/items/rp_test_items/__init__.py
@@ -0,0 +1,16 @@
+"""This package provides common static objects and variables.
+
+Copyright (c) 2018 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
diff --git a/reportportal_client/items/rp_test_items/rp_base_test_item.py b/reportportal_client/items/rp_test_items/rp_base_test_item.py
@@ -0,0 +1,86 @@
+"""
+This module contains functional for Base RP test items management.
+
+Copyright (c) 2018 http://reportportal.io .
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from reportportal_client.items.rp_base_item import BaseRPItem
+from reportportal_client.core.rp_requests import ItemFinishRequest
+
+
+class RPBaseTestItem(BaseRPItem):
+    """This model stores common attributes for RP test items."""
+
+    def __init__(self, rp_url, session, api_version, project_name, item_name,
+                 item_type, launch_uuid, generated_id, has_stats, **kwargs):
+        """Initialize instance attributes.
+
+        :param rp_url:        report portal url
+        :param session:       Session object
+        :param api_version:   RP API version
+        :param project_name:  RP project name
+        :param item_name:     RP item name
+        :param item_type:     Type of the test item. Allowable values: "suite",
+                              "story", "test", "scenario", "step",
+                              "before_class", "before_groups", "before_method",
+                              "before_suite", "before_test", "after_class",
+                              "after_groups", "after_method", "after_suite",
+                              "after_test"
+        :param launch_uuid:   Parent launch UUID
+        :param generated_id:  Id generated to speed up client
+        :param has_stats:     If item has stats
+        :param kwargs:        Dict of additional named parameters
+        """
+        super(RPBaseTestItem, self).__init__(rp_url, session, api_version,
+                                             project_name, launch_uuid,
+                                             generated_id)
+        self.item_name = item_name
+        self.item_type = item_type
+        self.description = kwargs.get("description")
+        self.attributes = kwargs.get("attributes")
+        self.uuid = kwargs.get("uuid")
+        self.code_ref = kwargs.get("code_ref")
+        self.parameters = kwargs.get("parameters")
+        self.unique_id = kwargs.get("unique_id")
+        self.retry = kwargs.get("retry", False)
+        self.has_stats = has_stats
+        self.child_items = []
+
+    def add_child_item(self, item):
+        """Add new child item to the list.
+
+        :param item:        test item object
+        :return:            None
+        """
+        self.child_items.append(item)
+
+    def finish(self, end_time, status=None, description=None, issue=None):
+        """Form finish request for RP test item.
+
+        :param end_time:    Test item end time
+        :param status:      Test status. Allowable values: "passed",
+                            "failed", "stopped", "skipped", "interrupted",
+                            "cancelled"
+        :param description: Test item description.
+        :param issue:       Issue of the current test item
+        """
+        endpoint = "{url}/api/{version}/{projectName}/item/{itemUuid}". \
+            format(url=self.rp_url, version=self.api_version,
+                   projectName=self.project_name, itemUuid=self.uuid)
+
+        self.add_request(endpoint, self.session.post, ItemFinishRequest,
+                         end_time, self.launch_uuid, status,
+                         attributes=self.attributes, description=description,
+                         issue=issue, retry=self.retry)
diff --git a/reportportal_client/items/rp_test_items/rp_child_test_item.py b/reportportal_client/items/rp_test_items/rp_child_test_item.py
diff --git a/reportportal_client/items/rp_test_items/rp_root_test_item.py b/reportportal_client/items/rp_test_items/rp_root_test_item.py
