firebird-qa 0.19.0__tar.gz

firebird_qa-0.19.0/.gitignore

@@ -0,0 +1,136 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# WingIDE
+*.wpr
+*.wpu
+
+# Sphinx build
+docs/_build

firebird_qa-0.19.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 FirebirdSQL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

firebird_qa-0.19.0/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.1
+Name: firebird-qa
+Version: 0.19.0
+Summary: pytest plugin for Firebird QA
+Project-URL: Home, https://github.com/FirebirdSQL/firebird-qa
+Project-URL: Documentation, https://firebird-qa.rtfd.io
+Project-URL: Issues, https://github.com/FirebirdSQL/firebird-qa/issues
+Project-URL: Funding, https://github.com/sponsors/pcisar
+Project-URL: Source, https://github.com/FirebirdSQL/firebird-qa
+Author-email: Pavel Cisar <pcisar@users.sourceforge.net>
+License: MIT License
+        
+        Copyright (c) 2020 FirebirdSQL
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: Collections,Configuration,Firebird,Hooks,Logging,Protobuf,Signals,Trace
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: <4,>=3.8
+Requires-Dist: firebird-base>=1.7.1
+Requires-Dist: firebird-driver>=1.10.1
+Requires-Dist: psutil>=5.9.8
+Requires-Dist: pytest>=8.0.0
+Description-Content-Type: text/markdown
+
+# pytest plugin for Firebird QA
+
+## Installation
+
+If you plan to use this plugin for personal purposes (not related to Firebird project QA),
+we recommend to use `pipx` to install `pytest` together with `firebird-qa` plugin:
+
+```
+pipx install pytest
+pipx inject pytest firebird-qa
+```
+
+## Configuration
+
+### Firebird-driver configuration
+
+The QA plugin uses firebird-driver to access the Firebird servers, and uses driver configuration
+object to set up various driver and server/database connection parameters. The configuration object
+is initialized from `firebird-driver.conf` file, and plugin specifically utilizes server sections
+in this file. When pytest is invoked, you must specify tested server with `–server <name>` option,
+where `<name>` is name of server configuration section in `firebird-driver.conf` file.
+
+This file is stored in firebird-qa repository, and defines default configuration suitable to most QA setups.
+
+Note:
+
+The `firebird-driver.conf` file should be located in QA root directory. In default setup, the QA plugin
+is used to test local Firebird installation with default user name and password (SYSDBA/masterkey)
+via local server (configuration section).
+
+Important:
+
+The firebird-driver currently does not support specification of client library in server sections.
+However, the QA plugin works around that limitation. If server section for tested server contains
+`fb_client_library` option specification, it’s copied to global setting.
+
+See configuration chapter in [driver documentation](https://firebird-driver.readthedocs.io) for details.
+
+### Pytest configuration
+
+While it’s not required, it’s recommended to create pytest configuration file in QA root directory.
+You may use this file to simplify your use of pytest with addopts option, or adjust pytest behaviour.
+
+Suggested options for `pytest.ini`:
+```
+console_output_style = count
+testpaths = tests
+addopts = --server local --install-terminal
+```
+
+## Running test for Firebird
+
+To run all tests in suite against local Firebird server, invoke:
+```
+pytest --server local ./tests
+```
+
+Tip: If you created `pytest.ini` with recommended values, you can just invoke pytest without additional parameters.
+
+### pytest report header
+
+When pytest is invoked, a report header is printed on terminal before individual tests are executed.
+The QA plugin extend this header with next information:
+
+- Python encodings
+
+  - system
+  - locale
+  - filesystem
+
+- Information about tested Firebird server
+
+  - conf. section name
+  - version
+  - mode
+  - architecture
+  - home directory
+  - tools directory
+  - used client library
+
+### pytest switches installed by QA plugin
+
+The QA plugin installs several pytest command-line switches. When you run pytest ``--help``,
+they are listed in Firebird QA section:
+```
+Firebird QA:
+   --server=SERVER       Server configuration name
+   --bin-dir=PATH        Path to directory with Firebird utilities
+   --protocol={xnet,inet,inet4,wnet}
+                         Network protocol used for database attachments
+   --runslow             Run slow tests
+   --save-output         Save test std[out|err] output to files
+   --skip-deselected={platform,version,any}
+                         SKIP tests instead deselection
+   --extend-xml          Extend XML JUnit report with additional information
+   --install-terminal    Use our own terminal reporter
+```
+
+**server:**
+
+REQUIRED option. Section name in firebird-driver.conf with connection parameters for tested server.
+
+**bin-dir:**
+
+Normally, the QA plugin detects and properly sets the directory where Firebird tools are installed.
+However, you can set this directory explicitly using the --bin-dir switch.
+
+**protocol:**
+
+Override for network protocol specified in firebird-driver.conf file (or default).
+
+**runslow:**
+
+Tests that run for longer than 10 minutes on equipment used for regular Firebird QA should be
+marked as slow. They are not executed, unless this switch is specified.
+
+**save-output:**
+
+_Experimental switch_
+
+When this switch is specified, stdout/stderr output of external Firebird tool executed by
+test is stored in `/out` subdirectory. Intended for test debugging.
+
+**skip-deselected:**
+
+Tests that are not applicable to tested server (because they are for specific platform or
+Firebird versions) are deselected during pytest collection phase. It means that they are not
+shown in test session report. This switch changes the routine, so tests are marked to skip
+(with message explaining why) instead deselection, so they show up is session report.
+
+**extend-xml:**
+
+When this switch is used together with `--junitxml` switch, the produced JUnitXML file will
+contain additional metadata for testsuite and testcase elements recorded as property sub-elements.
+
+  **Important:**
+
+  Please note that using this feature will break schema verifications for the latest JUnitXML schema.
+  This might be a problem when used with some CI servers.
+
+**install-terminal:**
+
+This option changes default pytest terminal reporter that displays pytest NODE IDs, to custom
+reporter that displays Firebord QA test IDs.
+
+pytest node IDs are of the form `module.py::class::method` or `module.py::function`.
+
+Firebord QA test IDs are defined in our test metadata.
+
+  **Important:**
+
+  Right now, the custom terminal is opt-in feature. This will be changed in some future release
+  to opt-out using new switch.
+
+
+### Test for use with this plugin
+
+Please read the [plugin documentation](https://firebird-qa.rtfd.io) for instructions how
+to create tests that use special support provided by this plugin.

firebird_qa-0.19.0/PLUGIN-README.md

@@ -0,0 +1,159 @@
+# pytest plugin for Firebird QA
+
+## Installation
+
+If you plan to use this plugin for personal purposes (not related to Firebird project QA),
+we recommend to use `pipx` to install `pytest` together with `firebird-qa` plugin:
+
+```
+pipx install pytest
+pipx inject pytest firebird-qa
+```
+
+## Configuration
+
+### Firebird-driver configuration
+
+The QA plugin uses firebird-driver to access the Firebird servers, and uses driver configuration
+object to set up various driver and server/database connection parameters. The configuration object
+is initialized from `firebird-driver.conf` file, and plugin specifically utilizes server sections
+in this file. When pytest is invoked, you must specify tested server with `–server <name>` option,
+where `<name>` is name of server configuration section in `firebird-driver.conf` file.
+
+This file is stored in firebird-qa repository, and defines default configuration suitable to most QA setups.
+
+Note:
+
+The `firebird-driver.conf` file should be located in QA root directory. In default setup, the QA plugin
+is used to test local Firebird installation with default user name and password (SYSDBA/masterkey)
+via local server (configuration section).
+
+Important:
+
+The firebird-driver currently does not support specification of client library in server sections.
+However, the QA plugin works around that limitation. If server section for tested server contains
+`fb_client_library` option specification, it’s copied to global setting.
+
+See configuration chapter in [driver documentation](https://firebird-driver.readthedocs.io) for details.
+
+### Pytest configuration
+
+While it’s not required, it’s recommended to create pytest configuration file in QA root directory.
+You may use this file to simplify your use of pytest with addopts option, or adjust pytest behaviour.
+
+Suggested options for `pytest.ini`:
+```
+console_output_style = count
+testpaths = tests
+addopts = --server local --install-terminal
+```
+
+## Running test for Firebird
+
+To run all tests in suite against local Firebird server, invoke:
+```
+pytest --server local ./tests
+```
+
+Tip: If you created `pytest.ini` with recommended values, you can just invoke pytest without additional parameters.
+
+### pytest report header
+
+When pytest is invoked, a report header is printed on terminal before individual tests are executed.
+The QA plugin extend this header with next information:
+
+- Python encodings
+
+  - system
+  - locale
+  - filesystem
+
+- Information about tested Firebird server
+
+  - conf. section name
+  - version
+  - mode
+  - architecture
+  - home directory
+  - tools directory
+  - used client library
+
+### pytest switches installed by QA plugin
+
+The QA plugin installs several pytest command-line switches. When you run pytest ``--help``,
+they are listed in Firebird QA section:
+```
+Firebird QA:
+   --server=SERVER       Server configuration name
+   --bin-dir=PATH        Path to directory with Firebird utilities
+   --protocol={xnet,inet,inet4,wnet}
+                         Network protocol used for database attachments
+   --runslow             Run slow tests
+   --save-output         Save test std[out|err] output to files
+   --skip-deselected={platform,version,any}
+                         SKIP tests instead deselection
+   --extend-xml          Extend XML JUnit report with additional information
+   --install-terminal    Use our own terminal reporter
+```
+
+**server:**
+
+REQUIRED option. Section name in firebird-driver.conf with connection parameters for tested server.
+
+**bin-dir:**
+
+Normally, the QA plugin detects and properly sets the directory where Firebird tools are installed.
+However, you can set this directory explicitly using the --bin-dir switch.
+
+**protocol:**
+
+Override for network protocol specified in firebird-driver.conf file (or default).
+
+**runslow:**
+
+Tests that run for longer than 10 minutes on equipment used for regular Firebird QA should be
+marked as slow. They are not executed, unless this switch is specified.
+
+**save-output:**
+
+_Experimental switch_
+
+When this switch is specified, stdout/stderr output of external Firebird tool executed by
+test is stored in `/out` subdirectory. Intended for test debugging.
+
+**skip-deselected:**
+
+Tests that are not applicable to tested server (because they are for specific platform or
+Firebird versions) are deselected during pytest collection phase. It means that they are not
+shown in test session report. This switch changes the routine, so tests are marked to skip
+(with message explaining why) instead deselection, so they show up is session report.
+
+**extend-xml:**
+
+When this switch is used together with `--junitxml` switch, the produced JUnitXML file will
+contain additional metadata for testsuite and testcase elements recorded as property sub-elements.
+
+  **Important:**
+
+  Please note that using this feature will break schema verifications for the latest JUnitXML schema.
+  This might be a problem when used with some CI servers.
+
+**install-terminal:**
+
+This option changes default pytest terminal reporter that displays pytest NODE IDs, to custom
+reporter that displays Firebord QA test IDs.
+
+pytest node IDs are of the form `module.py::class::method` or `module.py::function`.
+
+Firebord QA test IDs are defined in our test metadata.
+
+  **Important:**
+
+  Right now, the custom terminal is opt-in feature. This will be changed in some future release
+  to opt-out using new switch.
+
+
+### Test for use with this plugin
+
+Please read the [plugin documentation](https://firebird-qa.rtfd.io) for instructions how
+to create tests that use special support provided by this plugin.