From de529339028fa9ebdd0db7c10fe0d684e63f19d6 Mon Sep 17 00:00:00 2001
From: Dorian Turba <froggit.commit.z3jqj@simplelogin.com>
Date: Mon, 10 Jul 2023 13:24:40 +0200
Subject: [PATCH] add pytest template

---
 pytest.r2.yml                    | 13 ++++++
 python/testing/pytest/README.md  | 74 ++++++++++++++++++++++++++++++++
 python/testing/pytest/pytest.yml | 14 ++++++
 3 files changed, 101 insertions(+)
 create mode 100644 pytest.r2.yml
 create mode 100644 python/testing/pytest/README.md
 create mode 100644 python/testing/pytest/pytest.yml

diff --git a/pytest.r2.yml b/pytest.r2.yml
new file mode 100644
index 0000000..878662f
--- /dev/null
+++ b/pytest.r2.yml
@@ -0,0 +1,13 @@
+files:
+    template: ./python/testing/pytest/pytest.yml
+    documentation: ./python/testing/pytest/README.md
+data:
+    description: "Run pytest on your repository"
+    icon: 💎
+    public: true
+    labels:
+        - Test
+        - Utilities
+        - Python>=3.7
+    license: MIT
+    deprecated: false
diff --git a/python/testing/pytest/README.md b/python/testing/pytest/README.md
new file mode 100644
index 0000000..b012f84
--- /dev/null
+++ b/python/testing/pytest/README.md
@@ -0,0 +1,74 @@
+## Objective
+
+Run [pytest](https://docs.pytest.org/en/latest/) on your Python code to ensure all unit tests pass.
+Pytest is a popular framework for writing and executing tests in Python, and it supports test
+automation, modular fixtures, parameterized testing, and many other features.
+
+### Global Configuration of pytest
+
+To add configuration to `pytest` that is shared with any other usage of pytest (such as manual runs,
+pre-commit, etc.), you can use the `pytest.ini` or `pyproject.toml` configuration files. Learn more
+about [pytest configuration](https://docs.pytest.org/en/stable/customize.html) files.
+
+Here's an example of a `pytest.ini` file:
+
+```ini
+[pytest]
+minversion = 6.0
+addopts = -ra -q
+testpaths =
+    tests
+```
+
+This configuration file sets the minimum pytest version to 6.0, sets additional command line
+options, and specifies the test directory.
+
+And here's an example of pytest configuration in `pyproject.toml` (New in version 6.0.):
+
+```python
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = [
+    "tests",
+]
+```
+
+## How to use it
+
+1. Configure the `pytest.ini` or `pyproject.toml` file in your repository's root directory with your
+   desired rules.
+2. Include the pytest template in your CI/CD configuration (see quick use above).
+3. If you need to customize the job, check
+   the [jobs customization](https://docs.r2devops.io/get-started/use-templates/#job-templates-customization).
+
+## Change the Python version
+
+By default, the template uses the latest Python version available in the image. If you need to
+change the Python version, you can override the docker image used in the template. For example:
+
+```yaml
+stages:
+  - test  
+
+include:
+  - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba/r2devops_catalog/pytest@latest.yaml'
+
+pytest:
+    image: python:3.11
+```
+
+This example uses Python 3.11 instead of the latest Python version available.
+
+## Add a <a href="https://docs.pytest.org/en/latest/"><img alt="Tested with pytest" src="https://img.shields.io/badge/Tested%20with-pytest-green"></a> Badge to your project README.md
+
+To display the use of pytest in your project, you can add the following badge to your README.md:
+
+```markdown
+<a href="https://docs.pytest.org/en/latest/">
+    <img alt="Tested with pytest" src="https://img.shields.io/badge/Tested%20with-pytest-green">
+</a>
+```
+
+Please note that the `src` URL in the pytest badge will need to be updated to reflect the actual
+testing status of your project in your continuous integration pipeline.
diff --git a/python/testing/pytest/pytest.yml b/python/testing/pytest/pytest.yml
new file mode 100644
index 0000000..1dcc298
--- /dev/null
+++ b/python/testing/pytest/pytest.yml
@@ -0,0 +1,14 @@
+pytest:
+    image: python:latest
+    stage: code_quality
+    script:
+        - python --version  # Debug
+        - python -m venv venv --upgrade-deps || python -m venv venv  # upgrade-deps is not supported before 3.9
+        - source venv/bin/activate
+        - pip install pytest
+        - pytest
+    only:
+        changes:
+            - ./**/*.py
+            - .gitlab-ci.yml
+            - pyproject.toml
-- 
GitLab