PyTestLog2DB 0.3.4__tar.gz → 0.4.0__tar.gz

pytestlog2db-0.4.0/MANIFEST.in

@@ -0,0 +1 @@
+include build_backend.py

pytestlog2db-0.4.0/PKG-INFO

@@ -0,0 +1,346 @@
+Metadata-Version: 2.4
+Name: PyTestLog2DB
+Version: 0.4.0
+Summary: Imports pytest result(s) to TestResultWebApp database
+Author-email: Tran Duy Ngoan <Ngoan.TranDuy@vn.bosch.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://pypi.org/project/PyTestLog2DB/
+Project-URL: Documentation, https://github.com/test-fullautomation/python-pytestlog2db/blob/develop/PyTestLog2DB/PyTestLog2DB.pdf
+Project-URL: Readme, https://github.com/test-fullautomation/python-pytestlog2db/blob/develop/README.rst
+Project-URL: Repository, https://github.com/test-fullautomation/python-pytestlog2db
+Project-URL: Issues, https://github.com/test-fullautomation/python-pytestlog2db/issues
+Keywords: pytest,testresults,database
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: docutils>=0.22.4
+Requires-Dist: colorama
+Requires-Dist: TestResultDBAccess
+Requires-Dist: lxml
+Requires-Dist: PythonExtensionsCollection
+Requires-Dist: GenPackageDoc
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: docutils>=0.22.4; extra == "docs"
+Dynamic: license-file
+
+PyTestLog2DB
+============
+
+Table of Contents
+-----------------
+
+-  `Getting Started <#getting-started>`__
+
+   -  `How to install <#how-to-install>`__
+-  `Usage <#usage>`__
+-  `Example <#example>`__
+-  `Contribution <#contribution>`__
+-  `Sourcecode Documentation <#sourcecode-documentation>`__
+-  `Feedback <#feedback>`__
+-  `About <#about>`__
+
+   -  `Maintainers <#maintainers>`__
+   -  `Contributors <#contributors>`__
+   -  `License <#license>`__
+
+Getting Started
+---------------
+
+**PyTestLog2DB** is a command-line tool that enables you to import pytest_ XML
+result files into TestResultWebApp_'s database for presenting an overview about
+the whole test execution and detail of each test result.
+
+**PyTestLog2DB** tool is operating system independent and only works with
+Python 3.
+
+How to install
+~~~~~~~~~~~~~~
+
+**PyTestLog2DB** can be installed in two different ways.
+
+The **PyTestLog2DB** can be installed in two different ways.
+
+1. Installation via PyPi (recommended for users)
+
+   .. code::
+
+      pip install PyTestLog2DB
+
+   `PyTestLog2DB in PyPi <https://pypi.org/project/PyTestLog2DB/>`_
+
+2. Installation via GitHub (recommended for developers)
+
+   * Clone the **python-pytestlog2db** repository to your machine.
+
+     .. code::
+
+        git clone https://github.com/test-fullautomation/python-pytestlog2db.git
+
+     `PyTestLog2DB in GitHub <https://github.com/test-fullautomation/python-PyTestLog2DB>`_
+
+   * Use the following command to install **PyTestLog2DB** (executed in repository main folder):
+
+     .. code::
+
+        python -m pip install .
+
+     Or:
+
+     .. code::
+
+        python -m pip install --proxy <proxy> .
+
+     This command will also download and install all dependencies that are required to work with the source files in the current repository.
+     After the initial installation of **PyTestLog2DB** is done, you have the following two possibilities:
+
+     1. *Clean the previous installation*:
+
+        .. code::
+
+           python "./cleanup_installation.py"
+
+        ``cleanup_installation.py`` explicitly deletes all files and folders within the component installation folder under
+        ``site-packages`` and also deletes local build artefacts.
+
+     2. *Render the component documentation*:
+
+        .. code::
+
+           python "./genpackagedoc.py"
+
+        This would e.g. be required in case of changes in the interface of **PyTestLog2DB**.
+
+        The documentation is rendered by a separate application called **GenPackageDoc**, that is part
+        of the build dependencies and runtime dependencies of **PyTestLog2DB**.
+
+        **GenPackageDoc** needs to be configured. Details about how to do this, can be found in the
+        `README.rst <https://github.com/test-fullautomation/python-genpackagedoc/blob/develop/README.rst>`_
+        (sections *Install dependencies* and *Configure dependencies*).
+
+   * Use the following command to build **PyTestLog2DB** (executed in repository main folder):
+
+     .. code::
+
+        python -m build .
+
+     Or:
+
+     .. code::
+
+        python -m pip config set global.proxy <proxy>
+        python -m build .
+
+After succesful installation, the executable file **PyTestLog2DB** will be
+available (under *Scripts* folder of Python on Windows and *~/.local/bin/*
+folder on Linux).
+
+In case above location is added to **PATH** environment variable then you can
+run it directly as operation system's command.
+
+Usage
+-----
+
+**PyTestLog2DB** requires the pytest_ result file(s) which contains the test
+result in *JUnit XML* format and TestResultWebApp_'s database information for
+importing.
+
+Use below command to get tools's usage
+
+::
+
+   PyTestLog2DB -h
+
+
+The usage should be showed as below:
+
+::
+
+   usage: PyTestLog2DB (PyTestXMLReport to TestResultWebApp importer) [-h] [-v] [--recursive] [--dryrun] [--append] [--UUID UUID] [--variant VARIANT] [--versions VERSIONS] [--config CONFIG]
+                                                                      resultxmlfile server user password database
+
+   PyTestLog2DB imports pytest JUnit XML report file(s)generated by pytest into a WebApp database.
+
+   positional arguments:
+   resultxmlfile        absolute or relative path to the pytest JUnit XML report file or directory of report files to be imported.
+   server               server which hosts the database (IP or URL).
+   user                 user for database login.
+   password             password for database login.
+   database             database schema for database login.
+
+   optional arguments:
+   -h, --help           show this help message and exit
+   -v, --version        version of the PyTestLog2DB importer.
+   --recursive          if set, then the path is searched recursively for output files to be imported.
+   --dryrun             if set, then verify all input arguments (includes DB connection) and show what would be done.
+   --append             is used in combination with --UUID <UUID>. If set, allow to append new result(s) to existing execution result UUID in --UUID argument.
+   --UUID UUID          UUID used to identify the import and version ID on webapp. If not provided PyTestLog2DB will generate an UUID for the whole import.
+   --variant VARIANT    variant name to be set for this import.
+   --versions VERSIONS  metadata: Versions (Software;Hardware;Test) to be set for this import (semicolon separated).
+   --config CONFIG      configuration json file for component mapping information.
+   --interface {db,rest}
+                        database access interface.
+   --testrunurl TESTRUNURL
+                        link to test execution job: Jenkins job, Gitlab CI/CD pipeline, ...
+
+The below command is simple usage with all required arguments to import
+pytest_ results into TestResultWebApp's database:
+
+::
+
+   PyTestLog2DB <resultxmlfile> <server> <user> <password> <database>
+
+Besides the executable file, you can also run tool as a Python module
+
+::
+
+   python -m PyTestLog2DB <resultxmlfile> <server> <user> <password> <database>
+
+Example
+-------
+
+In order the import the robot result(s) to TestResultWebApp's database,
+we need the pytest_ result file in *JUnit XML* format.
+
+So, firstly execute the pytest_ testcase(s) to get the result file(s). But the
+***.xml** result file is not generated by default.
+
+We need to specify the argument *--junit-xml=<path>* when executing pytest_
+to get the generated *JUnit XML* report file at given path.
+
+E.g:
+::
+
+   pytest --junit-xml=path/to/result.xml pytest/folder
+
+After that, the ***.xml** result file will be available at **path/to/result.xml**
+and can be used for importing to TestResultWebApp_ with command:
+
+::
+
+   PyTestLog2DB path/to/result.xml localhost test_user test_pw test_db
+
+Then, open TestResultWebApp with your favourite browser and you will see how
+wonderful the execution result is displayed as below figures:
+
+Dashboard view:
+
+.. image:: https://github.com/test-fullautomation/python-pytestlog2db/blob/develop/packagedoc/additional_docs/pictures/Dashboard.png?raw=true
+   :alt: Dashboard view
+
+Datatable view:
+
+.. image:: https://github.com/test-fullautomation/python-pytestlog2db/blob/develop/packagedoc/additional_docs/pictures/Datatable.png?raw=true
+   :alt: Datatable view
+
+Notes:
+~~~~~~
+
+   The ***.xml** report file generated by pytest contains only the testcase
+   result(s) and less metadata information about the test execution such as
+   *project/variant*, *software version*, *tester* , *component*, ...
+   which are required by TestResultWebApp_.
+
+   So that, **PyTestLog2DB** will handle those information with the default values.
+
+   But you can use the optional argument *--config CONFIG* to specify those
+   information when importing to TestResultWebApp_'s database.
+
+   Sample configuration file:
+
+   ::
+
+      {
+         "variant"   : "MyProject",
+         "version_sw": "0.1.1",
+         "components": {
+            "Testsuite1"       : "test-data.test_tsclass.TestSuite1",
+            "Testsuite2"       : "test-data.test_tsclass.TestSuite2",
+            "Others"          : [
+               "test-data.test_ts1",
+               "test-data.test_ts2"
+            ]
+         },
+         "tester"    : "Tran Duy Ngoan"
+      }
+
+   Please refer `PyTestLog2DB tool’s Documentation`_ for more detail about default
+   values and the configuration json file.
+
+Contribution
+------------
+We are always searching support and you are cordially invited to help to improve
+**PyTestLog2DB** tool.
+
+Sourcecode Documentation
+------------------------
+To understand more detail about the tool's features, parameters and how pytest
+result(s) will be displayed on TestResultWebApp, please refer to
+`PyTestLog2DB tool’s Documentation`_.
+
+Feedback
+--------
+Please feel free to give any feedback to us via
+
+Email to: `Thomas Pollerspöck`_
+
+Issue tracking: `PyTestLog2DB Issues`_
+
+About
+-----
+
+Maintainers
+~~~~~~~~~~~
+`Thomas Pollerspöck`_
+
+`Holger Queckenstedt`_
+
+`Tran Duy Ngoan`_
+
+Contributors
+~~~~~~~~~~~~
+
+`Nguyen Huynh Tri Cuong`_
+
+`Mai Dinh Nam Son`_
+
+`Tran Hoang Nguyen`_
+
+License
+~~~~~~~
+
+Copyright 2020-2023 Robert Bosch GmbH
+
+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
+
+    |License: Apache v2|
+
+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.
+
+
+.. |License: Apache v2| image:: https://img.shields.io/pypi/l/robotframework.svg
+   :target: http://www.apache.org/licenses/LICENSE-2.0.html
+.. _pytest: https://docs.pytest.org
+.. _JUnit XML: https://llg.cubic.org/docs/junit
+.. _PyTestLog2DB: https://github.com/test-fullautomation/python-pytestlog2db
+.. _TestResultWebApp: https://github.com/test-fullautomation/TestResultWebApp
+.. _PyPI: https://pypi.org/
+.. _Thomas Pollerspöck: mailto:Thomas.Pollerspoeck@de.bosch.com
+.. _Tran Duy Ngoan: mailto:Ngoan.TranDuy@vn.bosch.com
+.. _Nguyen Huynh Tri Cuong: mailto:Cuong.NguyenHuynhTri@vn.bosch.com
+.. _Mai Dinh Nam Son: mailto:Son.MaiDinhNam@vn.bosch.com
+.. _Tran Hoang Nguyen: mailto:Nguyen.TranHoang@vn.bosch.com
+.. _Holger Queckenstedt: mailto:Holger.Queckenstedt@de.bosch.com
+.. _PyTestLog2DB tool’s Documentation: https://github.com/test-fullautomation/python-pytestlog2db/blob/develop/PyTestLog2DB/PyTestLog2DB.pdf
+.. _PyTestLog2DB Issues: https://github.com/test-fullautomation/python-pytestlog2db/issues

{PyTestLog2DB-0.3.4 → pytestlog2db-0.4.0}/PyTestLog2DB/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2023 Robert Bosch GmbH
+#  Copyright 2020-2026 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

{PyTestLog2DB-0.3.4 → pytestlog2db-0.4.0}/PyTestLog2DB/__main__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2023 Robert Bosch GmbH
+#  Copyright 2020-2026 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

{PyTestLog2DB-0.3.4 → pytestlog2db-0.4.0}/PyTestLog2DB/pytestlog2db.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2023 Robert Bosch GmbH
+#  Copyright 2020-2026 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

{PyTestLog2DB-0.3.4 → pytestlog2db-0.4.0}/PyTestLog2DB/version.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2023 Robert Bosch GmbH
+#  Copyright 2020-2026 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,5 +18,5 @@
 #
 # Version and date of PyTestLog2DB
 #
-VERSION      = "0.3.4"
-VERSION_DATE = "02.08.2024"
+VERSION      = "0.4.0"
+VERSION_DATE = "23.03.2026"