Metadata-Version: 2.4
Name: pytest-gitlab-code-quality
Version: 0.3.0
Summary: Collects warnings while testing and generates a GitLab Code Quality Report.
Project-URL: Homepage, https://github.com/NiclasvanEyk/pytest-gitlab-code-quality
Project-URL: Documentation, https://github.com/NiclasvanEyk/pytest-gitlab-code-quality
Project-URL: Repository, https://github.com/NiclasvanEyk/pytest-gitlab-code-quality
Project-URL: Issues, https://github.com/NiclasvanEyk/pytest-gitlab-code-quality/issues
Project-URL: Changelog, https://github.com/NiclasvanEyk/pytest-gitlab-code-quality/blob/main/CHANGELOG.md
Project-URL: Funding, https://github.com/sponsors/NiclasvanEyk
Author-email: Niclas van Eyk <niclas.eyk@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Niclas van Eyk
        
        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.md
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.9
Requires-Dist: pytest>=8.1.1
Description-Content-Type: text/markdown

# GitLab Code Quality for Pytest

![current package version](https://img.shields.io/pypi/v/pytest-gitlab-code-quality)
![supported Python versions](https://img.shields.io/pypi/pyversions/pytest-gitlab-code-quality)
![github sponsors](https://img.shields.io/github/sponsors/NiclasvanEyk)
![license](https://img.shields.io/github/license/NiclasvanEyk/pytest-gitlab-code-quality)

Enables GitLab to collect and show warnings emitted during your test runs through their [code quality report].

| Terminal | GitLab |
|----------|--------|
| ![Pytest warnings in the terminal](https://github.com/NiclasvanEyk/pytest-gitlab-code-quality/blob/main/.github/images/terminal.png?raw=true) | ![Pytest warnings in the GitLab merge request widget](https://github.com/NiclasvanEyk/pytest-gitlab-code-quality/blob/main/.github/images/gitlab.png?raw=true) |

If you run GitLab Premium or Ultimate, you should even see the warnings [right next to the code](https://docs.gitlab.com/ee/ci/testing/code_quality.html#merge-request-changes-view) in the diff view of merge requests.
The [official documentation](https://docs.gitlab.com/ee/ci/testing/code_quality.html) contains more information and screenshots.

## Getting Started

Install the plugin using a package manager of your choice

```shell
pip install pytest-gitlab-code-quality
```

then specify the output location for the report using the `--gitlab-code-quality-report` option

```shell
pytest --gitlab-code-quality-report=pytest-warnings.json
```

In GitLab CI, this will look similar to this:

```yaml
# .gitlab-ci.yml
pytest:
  stage: test
  image: python
  script:
    - pip install -r requirements.txt # Or however you install your dependencies
    - python -m pytest --gitlab-code-quality-report=pytest-warnings.json

  # The three lines below are required in order for the warnings to show up!
  artifacts:
    reports:
      codequality: pytest-warnings.json
```

## Motivation

Some warnings are only surfaced during runtime, so static analyzers do not always catch them.
The screenshots at the top of this document contain the example of a questionably configured SQLAlchemy model.
Tests are a cheap way to surface such issues.

While you may run the tests locally and see these warnings there, you also might overlook them or don't know whether they were introduced by your changes or were already present before.
Either way, I think it makes sense to explicitly surface and track them during code review instead of burying them in the CI logs that nobody looks at when the tests pass.
And that is exactly why this plugin was created.
