qase-robotframework 2.0.1__py3-none-any.whl

qase_robotframework-2.0.1.dist-info/AUTHORS.rst

@@ -0,0 +1,6 @@
+============
+Contributors
+============
+
+* Parviz Khavari <csctclan@gmail.com>
+* Nikita Fedorov <nik333r@gmail.com>

qase_robotframework-2.0.1.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Qase TMS
+
+   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.

qase_robotframework-2.0.1.dist-info/METADATA

@@ -0,0 +1,332 @@
+Metadata-Version: 2.1
+Name: qase-robotframework
+Version: 2.0.1
+Summary: Qase Robot Framework Plugin
+Author-email: Qase Team <support@qase.io>
+License: Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2019 Qase TMS
+        
+           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.
+        
+Project-URL: Homepage, https://github.com/qase-tms/qase-python/tree/master/qase-robotframework
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Robot Framework
+Classifier: Programming Language :: Python
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: qase-python-commons <2.0.0,>=1.0.4
+Provides-Extra: testing
+Requires-Dist: pytest ; extra == 'testing'
+Requires-Dist: pytest-cov ; extra == 'testing'
+
+> # Qase Robot Framework Listener
+>
+> Publish results simple and easy.
+
+## How to integrate
+
+```
+pip install qase-robotframework
+```
+
+## Usage
+
+If you want to create a persistent link to Test Cases in Qase, you should add Qase test case IDs to robot framework tests.
+They should be added as a tags in form like `Q-<case id without project code>`. You can use upper and lower case to indicate the test case IDs. Example:
+
+```robotframework
+*** Test Cases ***
+Push button
+    [Tags]  q-2
+    Push button    1
+    Result should be    1
+
+Push multiple buttons
+    [Tags]  Q-3
+    Push button    1
+    Push button    2
+    Result should be    12
+```
+
+```robotframework
+*** Test Cases ***    Expression    Expected
+Addition              12 + 2 + 2    16
+                      2 + -3        -1
+    [Tags]   Q-7
+
+Subtraction           12 - 2 - 2    8
+                      2 - -3        5
+    [Tags]   Q-8
+```
+
+### Working with steps
+
+Listener supports reporting steps results:
+
+Example:
+```robotframework
+Quick Get A JSON Body Test                                                  ## Test case: "Quick Get A JSON Body Test"
+    [Tags]  Q-3
+    ${response}=    GET  https://jsonplaceholder.typicode.com/posts/1       ## 1-st step - "GET"
+    Should Be Equal As Strings    1  ${response.json()}[id]                 ## 2-nd step - "Should Be Equal As Strings"
+
+Initializing the test case                                                  ## Test case: "Initializing the test case"
+    [Tags]  q-4
+    Set To Dictionary    ${info}   field1=A sample string                   ## 1-st step - "Set To Dictionary"
+```
+
+## Configuration
+
+Listener supports loading configuration both from environment variables and from `tox.ini` file.
+
+ENV variables:
+- `QASE_MODE` - Define mode: `testops` to enable report
+- `QASE_ENVIRONMENT` - Environment ID for the run
+- `QASE_DEBUG` - If passed something - will enable debug logging for listener. Default: `False`
+- `QASE_TESTOPS_MODE` - You can switch between `sync` and `async` modes. Default is `async`
+- `QASE_TESTOPS_API_TOKEN` - API token to access Qase TestOps
+- `QASE_TESTOPS_PROJECT` - Project code from Qase TestOps
+- `QASE_TESTOPS_PLAN_ID` - Plan ID if you want to add results to existing run from Test Plan
+- `QASE_TESTOPS_RUN_ID` - Run ID if you want to add results to existing run
+- `QASE_TESTOPS_RUN_TITLE` - Set custom run name when no run ID is provided
+- `QASE_TESTOPS_COMPLETE_RUN` - Will complete run after all tests are finished. Default: `False`
+- `QASE_TESTOPS_HOST` - Define a host for Qase TestOps. Default: `qase.io`
+### Usage:
+```
+QASE_API_TOKEN=<API TOKEN> QASE_PROJECT=PRJCODE robot --listener qaseio.robotframework.Listener keyword_driven.robot data_driven.robot
+```
+Moving variables to `tox.ini`, example configuration:
+```ini
+[qase]
+qase_testops_api_token=api_key
+qase_testops_project=project_code
+qase_testops_run_id=run_id
+qase_testops_run_title=New Robot Framework Run
+qase_debug=True
+qase_testops_complete_run=True
+```
+Execution:
+```
+robot --listener qaseio.robotframework.Listener someTest.robot
+```
+## Contribution
+
+Install project locally:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e .[testing]
+```
+
+Install dev requirements:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+Test project:
+
+```bash
+tox
+```

qase_robotframework-2.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+qaseio/robotframework/__init__.py,sha256=c-2wRxqBi0y-9MiG0QGWkJ-rIeNko051xifyWRZmqu4,55
+qaseio/robotframework/listener.py,sha256=C2EXjp16prGj3V0JgCi4BdaFYIbX16yZvbzm8Z6Zq_s,5768
+qaseio/robotframework/models.py,sha256=GH9gS9A8YL4YJrmMJoTaFq6TH6W_alLgPbwgGCfmFzQ,1430
+qaseio/robotframework/types.py,sha256=v2hJ_d5_HkoGVKc3XKpbbkzhW6zSeB2LJZ9SJ_pX1T8,665
+qase_robotframework-2.0.1.dist-info/AUTHORS.rst,sha256=ovfDvPiIQMIDiAlkvF0ccfGNCD_MVUKIu1VYPlBU54Q,115
+qase_robotframework-2.0.1.dist-info/LICENSE,sha256=VzCH_PocWanN68XZU3ugW81fBEP7jdU_mCSDpaIv-oY,11338
+qase_robotframework-2.0.1.dist-info/METADATA,sha256=hsMFyRT5UzXAKQO_QZ_xs1Dt6shbkAVH6FfGwkUZgNA,16877
+qase_robotframework-2.0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qase_robotframework-2.0.1.dist-info/top_level.txt,sha256=keRvf1O-Wqp_5utcMOmxaX_kLGqHnuamAY58LtJywl8,7
+qase_robotframework-2.0.1.dist-info/RECORD,,

qase_robotframework-2.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

qase_robotframework-2.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+qaseio

qaseio/robotframework/__init__.py

@@ -0,0 +1,3 @@
+from .listener import Listener
+
+__all__ = ["Listener"]

qaseio/robotframework/listener.py

@@ -0,0 +1,165 @@
+import configparser
+import logging
+import os
+import re
+import uuid
+import time
+from datetime import datetime
+
+from qaseio.commons import QaseTestOps
+from qaseio.commons import QaseUtils
+from qaseio.commons import QaseReport
+from .types import Envs, STATUSES
+from .models import *
+
+logger = logging.getLogger("qase-robotframework")
+
+
+class Listener:
+    ROBOT_LISTENER_API_VERSION = 2
+
+    def __init__(self):
+        self.config = configparser.ConfigParser()
+        self.config.read("tox.ini")
+
+        if self._get_param(Envs.MODE) and self._get_param(Envs.MODE).lower() == 'testops':
+            token = self._get_param(Envs.TESTOPS_API_TOKEN)
+            project_code = self._get_param(Envs.TESTOPS_PROJECT)
+
+            if not token or not project_code:
+                raise ValueError("Token and Project code should be provided")
+
+            run_title = "Automated Run {}".format(str(datetime.now()))
+            if self._get_param(Envs.TESTOPS_RUN_TITLE, None):
+                run_title = self._get_param(Envs.TESTOPS_RUN_TITLE, None)
+
+            self.reporter = QaseTestOps(
+                api_token=token,
+                project_code=project_code,
+                run_id=self._get_param(Envs.TESTOPS_RUN_ID, None),
+                plan_id=self._get_param(Envs.TESTOPS_PLAN_ID, None),
+                complete_run=self._get_param(Envs.TESTOPS_COMPLETE_RUN).lower() in ['true', '1'],
+                mode=self._get_param(Envs.TESTOPS_MODE, 'async'),
+                run_title=run_title,
+                host=self._get_param(Envs.TESTOPS_HOST, 'qase.io'),
+                environment=self._get_param(Envs.ENVIRONMENT, None)
+            )
+        else:
+            self.reporter = QaseReport(
+                report_path=self._get_param(Envs.REPORT_PATH, 'build/qase-report'),
+            )
+
+        self.result = {}
+        self.steps = {}
+        self.step_uuid = None
+        self.suite = {}
+
+        self.debug = self._get_param(Envs.DEBUG) and self._get_param(Envs.DEBUG).lower() in ['true', '1']
+        if self.debug:
+            logger.setLevel(logging.DEBUG)
+            ch = logging.StreamHandler()
+            formatter = logging.Formatter(
+                "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+            )
+            ch.setFormatter(formatter)
+            logger.addHandler(ch)
+
+        self.reporter.start_run()
+
+    def _get_param(self, param: Envs, default=None):
+        param: str = param.value
+        return os.environ.get(
+            param, self.config.get("qase", param.lower(), fallback=default)
+        )
+
+    def start_suite(self, name, attributes):
+        self.suite = {
+            "title": name,
+            "description": attributes["doc"]
+        }
+        logger.debug("Starting suite '%s'", name)
+
+    def start_test(self, name, attributes: StartTestModel):
+        logger.debug("Starting test '%s'", name)
+
+        self.result = {
+            'is_api_result': True,
+            'case': {},
+            'steps': {},
+            'param': {},
+        }
+        self.result['uuid'] = str(uuid.uuid4())
+        self.result["started_at"] = time.time()
+
+        case_id = self._extract_ids(attributes.get("tags"))
+        if case_id:
+            self.result["case_id"] = int(case_id)
+
+    def end_test(self, name, attributes: EndTestModel):
+        logger.debug("Finishing test '%s'", name)
+
+        completed_at = time.time()
+        self.result['time_ms'] = int((completed_at - self.result.get("started_at")) * 1000)
+        self.result['completed_at'] = completed_at
+        self.result['status'] = STATUSES[attributes.get("status")]
+        self.result['stacktrace'] = attributes.get("message")
+        self.result['case'] = {}
+        self.result['case']['title'] = name
+        self.result['case']['description'] = attributes.get("doc")
+        if self.suite:
+            self.result['case']['suite_title'] = self.suite.get('title', None)
+            # self.result['case']['suite_description'] = self.suite.get('description', None) // Not support in Qase API yet
+
+        self.reporter.add_result(self.result, QaseUtils().build_tree(self.steps))
+
+        self.result = {}
+        self.steps = {}
+        self.step_uuid = None
+
+        logger.info(
+            "Finished case result: %s, error: %s",
+            attributes.get("status"),
+            attributes.get("message"),
+        )
+
+    def start_keyword(self, name, attributes):
+        id = str(uuid.uuid4())
+
+        self.steps[id] = {
+            "uuid": id,
+            "started_at": time.time(),
+            "attachments": [],
+            "steps": {},
+            "parent_id": self.step_uuid
+        }
+
+        self.step_uuid = id
+
+    def end_keyword(self, name, attributes):
+        now = time.time()
+
+        self.steps[self.step_uuid]['status'] = STATUSES[attributes["status"]]
+        self.steps[self.step_uuid]['action'] = attributes["kwname"]
+        self.steps[self.step_uuid]['duration'] = int((now - self.steps[self.step_uuid]['started_at']) * 1000)
+        self.steps[self.step_uuid]['completed_at'] = now
+        self.steps[self.step_uuid]['comment'] = f"Step `{name}` with args: {attributes['args']}"
+
+        self.step_uuid = self.steps[self.step_uuid]['parent_id']
+
+    def end_suite(self, name, attributes: EndSuiteModel):
+        self.suite = {}
+        logger.debug("Finishing suite '%s'", name)
+
+    def close(self):
+        logger.info("complete run executing")
+        self.reporter.complete_run(True)
+
+    def log_message(self, message):
+        logger.debug("Log:", message)
+
+    def _extract_ids(self, list_of_tags: List[str]):
+        id = re.compile(r"Q-(\d+)", re.IGNORECASE)
+        for tag in list_of_tags:
+            if id.fullmatch(tag):
+                return int(id.match(tag).groups()[0])
+        return None

qaseio/robotframework/models.py

@@ -0,0 +1,86 @@
+import sys
+from typing import List
+
+if sys.version_info >= (3, 8):
+    from typing import TypedDict
+else:
+    from typing import Dict as TypedDict
+
+
+class StartSuiteModel(TypedDict):
+    id: str
+    longname: str
+    doc: str
+    metadata: dict
+    source: str
+    suites: List[str]
+    tests: List[str]
+    totaltests: int
+    starttime: str
+
+
+class EndSuiteModel(TypedDict):
+    id: str
+    longname: str
+    doc: str
+    metadata: dict
+    source: str
+    starttime: str
+    endtime: str
+    elapsedtime: int
+    status: str
+    statistics: str
+    message: str
+
+
+class StartTestModel(TypedDict):
+    id: str
+    longname: str
+    originalname: str
+    doc: dict
+    tags: List[str]
+    critical: str
+    template: str
+    lineno: int
+    starttime: str
+
+
+class EndTestModel(TypedDict):
+    id: str
+    longname: str
+    originalname: str
+    doc: dict
+    tags: List[str]
+    critical: str
+    template: str
+    lineno: int
+    starttime: str
+    endtime: str
+    elapsedtime: int
+    status: str
+    message: str
+
+
+class StartKeywordModel(TypedDict):
+    type: str
+    kwname: str
+    libname: str
+    doc: dict
+    args: List[str]
+    assign: List[str]
+    tags: List[str]
+    starttime: str
+
+
+class EndKeywordModel(TypedDict):
+    type: str
+    kwname: str
+    libname: str
+    doc: dict
+    args: List[str]
+    assign: List[str]
+    tags: List[str]
+    starttime: str
+    endtime: str
+    elapsedtime: int
+    status: str

qaseio/robotframework/types.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+
+class Envs(Enum):
+    DEBUG = "QASE_DEBUG"
+    MODE = "QASE_MODE"
+    ENVIRONMENT = "QASE_ENVIRONMENT"
+
+    TESTOPS_MODE = "QASE_TESTOPS_MODE"
+    TESTOPS_HOST = "QASE_TESTOPS_HOST"
+    TESTOPS_API_TOKEN = "QASE_TESTOPS_API_TOKEN"
+    TESTOPS_PROJECT = "QASE_TESTOPS_PROJECT"
+    TESTOPS_RUN_ID = "QASE_TESTOPS_RUN_ID"
+    TESTOPS_PLAN_ID = "QASE_TESTOPS_PLAN_ID"
+    TESTOPS_RUN_TITLE = "QASE_TESTOPS_RUN_TITLE"
+    TESTOPS_COMPLETE_RUN = "QASE_TESTOPS_COMPLETE_RUN"
+
+    REPORT_PATH = "QASE_REPORT_PATH"
+
+
+STATUSES = {
+    "PASS": "passed",
+    "FAIL": "failed",
+    "SKIP": "skipped",
+    "NOT RUN": "skipped",
+    "NOT_SET": "skipped"
+}