Merge pull request #48 from AbsaOSS/feature/add-integration-test-for-local-run

Feature/add integration test for local run

Author: miroslavpojer

.DS_Store

@@ -21,6 +21,10 @@ on:
       - '**'
     types: [ opened, synchronize, reopened ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   static-code-analysis:
     runs-on: ubuntu-latest
@@ -34,7 +38,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
         with:
-          python-version: '3.11'
+          python-version: '3.13'
           cache: 'pip'
 
       - name: Install dependencies
@@ -68,7 +72,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
         with:
-          python-version: '3.11'
+          python-version: '3.13'
           cache: 'pip'
 
       - name: Install dependencies
@@ -96,18 +100,41 @@ jobs:
 
       - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
         with:
-          python-version: '3.11'
+          python-version: '3.13'
           cache: 'pip'
 
       - name: Install Python dependencies
         run: |
           pip install -r requirements.txt
 
-      - name: Set PYTHONPATH environment variable
-        run: echo "PYTHONPATH=${GITHUB_WORKSPACE}/version_tag_check/version_tag_check" >> $GITHUB_ENV
-
       - name: Check code coverage with Pytest
-        run: pytest --cov=. -v tests/ --cov-fail-under=80
+        run: pytest --cov=. -v -m "not integration" tests/ --cov-fail-under=80
+
+  integration-test:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        with:
+          python-version: '3.13'
+          cache: 'pip'
+
+      - name: Install Python dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Run integration tests
+        run: pytest -v -m integration tests/integration/
 
   mypy-check:
     runs-on: ubuntu-latest
@@ -121,7 +148,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
         with:
-          python-version: '3.11'
+          python-version: '3.13'
           cache: 'pip'
 
       - name: Install dependencies

.github/workflows/test.yml

@@ -46,7 +46,7 @@ fail-under=10
 #from-stdin=
 
 # Files or directories to be skipped. They should be base names, not paths.
-ignore=CVS
+ignore=CVS,tests
 
 # Add files or directories matching the regular expressions patterns to the
 # ignore-list. The regex matches against paths and can be in Posix or Windows

.pylintrc

@@ -6,6 +6,7 @@
 - [Run Black Tool Locally](#run-black-tool-locally)
 - [Run mypy Tool Locally](#run-mypy-tool-locally)
 - [Run Unit Tests with Pytest](#run-unit-tests-with-pytest)
+- [Run Integration Tests with Pytest](#run-integration-tests-with-pytest)
 - [Code Coverage with pytest-cov](#code-coverage-with-pytest-cov)
 - [Releasing](#releasing)
 - [Development Flow with GitHub Copilot](#development-flow-with-github-copilot)
@@ -189,16 +190,42 @@ Success: no issues found in 1 source file
 
 ---
 
-
 ## Run Unit Tests with Pytest
 
-Unit tests are written using the Pytest framework. To run all the tests, use the following command:
+Unit tests are written using the Pytest framework and are located under `tests/unit/`.
+
+To run only unit tests (excluding integration tests), use the following command:
 ```shell
-pytest tests/
+pytest -v tests/unit/
 ```
 
 You can modify the directory to control the level of detail or granularity as per your needs.
 
+---
+
+## Run Integration Tests with Pytest
+
+Integration tests are located under `tests/integration/` and are marked with `@pytest.mark.integration`.
+
+These tests run the action entrypoint (`main.py`) in a subprocess and patch `GitHubRepository` in the child process to avoid real network calls.
+Inputs are provided via the same environment variables used by the action (`INPUT_GITHUB_TOKEN`, `INPUT_GITHUB_REPOSITORY`, `INPUT_VERSION_TAG`, `INPUT_SHOULD_EXIST`).
+
+Prerequisites:
+
+- Perform the [setup of python venv](#set-up-python-environment).
+
+Run only integration tests:
+
+```shell
+pytest -v -m integration tests/integration/
+```
+
+Run everything except integration tests:
+
+```shell
+pytest -v -m "not integration" tests/
+```
+
 ---
 ## Code Coverage with pytest-cov
 
@@ -207,7 +234,7 @@ The objective of the project is to achieve a minimum score of 80 %. We do exclud
 
 To generate the coverage report, run the following command:
 ```shell
-pytest --ignore=tests/integration --cov=. tests/ --cov-fail-under=80 --cov-report=html
+pytest --ignore=tests --cov=. tests/ --cov-fail-under=80 --cov-report=html
 ```
 
 See the coverage report on the path:

DEVELOPER.md

@@ -9,3 +9,23 @@ omit = ["tests/*", "main.py", "version_tag_check/github_repository.py"]
 [tool.mypy]
 check_untyped_defs = true
 exclude = "tests"
+
+[tool.pytest.ini_options]
+markers = [
+	"integration: integration-style tests that run main.py as a subprocess",
+]
+
+testpaths = [
+	"tests",
+]
+
+norecursedirs = [
+	".git",
+	".mypy_cache",
+	".pytest_cache",
+	".venv",
+	"__pycache__",
+	"build",
+	"dist",
+	"htmlcov",
+]

pyproject.toml

@@ -0,0 +1,43 @@
+"""Shared fixtures and helpers for integration tests."""
+
+import os
+from pathlib import Path
+
+import pytest
+
+
+PROJECT_ROOT = Path(__file__).resolve().parents[2]
+
+
+@pytest.fixture
+def subprocess_env_with_mocked_github(tmp_path):
+    """Create a subprocess environment with mocked GitHubRepository.
+
+    This fixture prepares:
+    - A copy of os.environ with PYTHONPATH pointing to the project root
+    - A temporary sitecustomize.py module that patches GitHubRepository
+      with DummyGitHubRepository before main.py runs
+
+    The sitecustomize.py is auto-imported by Python at startup, ensuring
+    the mock is applied before any production code executes.
+
+    Returns:
+        dict: Environment variables ready for subprocess.run(env=...)
+    """
+    # Base environment with PYTHONPATH including project root
+    env = os.environ.copy()
+    env["PYTHONPATH"] = f"{PROJECT_ROOT}{os.pathsep}{env.get('PYTHONPATH', '')}"
+
+    # Create sitecustomize.py to patch GitHubRepository in the child process
+    sitecustomize_path = tmp_path / "sitecustomize.py"
+    sitecustomize_path.write_text(
+        "from version_tag_check import github_repository as ghr\n"
+        "from tests.integration.dummy_github_repository import DummyGitHubRepository\n"
+        "ghr.GitHubRepository = DummyGitHubRepository\n",
+        encoding="utf-8",
+    )
+
+    # Prepend temp directory so Python auto-imports our sitecustomize module
+    env["PYTHONPATH"] = f"{tmp_path}{os.pathsep}{env['PYTHONPATH']}"
+
+    return env

tests/utils/__init__.py tests/integration/__init__.pytests/utils/__init__.py renamed to tests/integration/__init__.py

@@ -0,0 +1,19 @@
+"""Test-only dummy GitHubRepository used by integration tests."""
+
+from __future__ import annotations
+
+from version_tag_check.version import Version
+
+
+class DummyGitHubRepository:
+    """Simple stand-in for GitHubRepository used in integration tests."""
+
+    def __init__(self, owner: str, repo: str, token: str) -> None:
+        self.owner = owner
+        self.repo = repo
+        self.token = token
+
+    def get_all_tags(self) -> list[Version]:
+        """Return a deterministic list of tags for integration tests."""
+
+        return [Version("v0.0.1"), Version("v0.0.2"), Version("v0.1.0")]

tests/integration/conftest.py

@@ -0,0 +1,76 @@
+"""Integration-style tests that run the action via main.py for local execution.
+
+These tests execute the action entrypoint (main.py) in a subprocess to cover the
+real wiring (logging setup + VersionTagCheckAction).
+
+To avoid real network calls, GitHubRepository is patched in the child process
+via a temporary ``sitecustomize.py`` module.
+"""
+
+import subprocess
+import sys
+from pathlib import Path
+
+import pytest
+
+from version_tag_check.utils.constants import ERROR_TAG_ALREADY_EXISTS
+
+PROJECT_ROOT = Path(__file__).resolve().parents[2]
+
+
+@pytest.mark.integration
+def test_local_run_successful_new_version(subprocess_env_with_mocked_github):
+    """Run main.py as a subprocess and expect success for a valid new version.
+
+    Scenario: New tag v0.1.1 is a valid patch increment on top of existing
+    v0.1.0.
+    """
+
+    # Use the fixture to get the environment with mocked GitHubRepository
+    env = subprocess_env_with_mocked_github
+
+    # Provide action inputs via the same environment variables used in the action.yml
+    env["INPUT_GITHUB_TOKEN"] = "fake-token"
+    env["INPUT_GITHUB_REPOSITORY"] = "owner/repo"
+    env["INPUT_VERSION_TAG"] = "v0.1.1"
+    env["INPUT_SHOULD_EXIST"] = "false"
+
+    # Enable debug logging so we can see integration-level logs if needed
+    env["RUNNER_DEBUG"] = "1"
+
+    result = subprocess.run(
+        [sys.executable, str(PROJECT_ROOT / "main.py")],
+        cwd=PROJECT_ROOT,
+        env=env,
+        capture_output=True,
+        text=True,
+    )
+
+    assert result.returncode == 0, f"stdout: {result.stdout}\nstderr: {result.stderr}"
+
+
+@pytest.mark.integration
+def test_local_run_fails_on_existing_tag(subprocess_env_with_mocked_github):
+    """Run main.py as a subprocess and expect failure when tag already exists.
+
+    Scenario: New tag v0.1.0 already exists in the list returned by
+    DummyGitHubRepository, so the action should fail.
+    """
+
+    env = subprocess_env_with_mocked_github
+
+    env["INPUT_GITHUB_TOKEN"] = "fake-token"
+    env["INPUT_GITHUB_REPOSITORY"] = "owner/repo"
+    env["INPUT_VERSION_TAG"] = "v0.1.0"  # already present in DummyGitHubRepository
+    env["INPUT_SHOULD_EXIST"] = "false"
+
+    result = subprocess.run(
+        [sys.executable, str(PROJECT_ROOT / "main.py")],
+        cwd=PROJECT_ROOT,
+        env=env,
+        capture_output=True,
+        text=True,
+    )
+
+    assert result.returncode != 0
+    assert ERROR_TAG_ALREADY_EXISTS in (result.stdout + result.stderr)