16 Commits

Author SHA1 Message Date
Richard Kubíček
4c0d03fa79 Revert "test_superfaktura_api: add type ignore for pytest"
This reverts commit d0147a0451.
2025-03-21 19:22:00 +01:00
Richard Kubíček
ff079440ac requirements_dev: specify package versions 2025-03-21 15:46:12 +01:00
Richard Kubíček
284edd3a45 ga: add mypy to requirements_dev 2025-03-21 15:41:24 +01:00
Richard Kubíček
e84426e49c ga: add mypy workflow 2025-03-13 13:42:10 +01:00
Richard Kubíček
d0147a0451 test_superfaktura_api: add type ignore for pytest 2025-03-13 13:40:12 +01:00
Richard Kubíček
11e14a8924 docs_conf: ignore by type 2025-03-13 13:40:12 +01:00
Richard Kubíček
3d4400db2d Merge pull request #11 from Eledio/feature/tests
Unit tests for API
2025-03-13 11:34:02 +01:00
Richard Kubíček
b41bf28a34 test_superfaktura_api: fix unnecessary mock file open 2025-03-11 21:23:56 +01:00
Richard Kubíček
8d3b2589b0 test_superfaktura_api: add test download with not writable file descriptor 2025-03-11 21:18:14 +01:00
Richard Kubíček
d2cbbd0596 test_superfaktura_api: add test invalid json as repsonse from the server 2025-03-11 21:18:14 +01:00
Richard Kubíček
45259f8f27 Update pytest.yml 2025-03-05 22:24:27 +01:00
Richard Kubíček
5b50f2c3eb ga: fix workflow for pylint 2025-03-05 13:15:43 +01:00
Richard Kubíček
16cb1b39ba ga: add workflow for pytest 2025-03-05 13:07:12 +01:00
Richard Kubíček
e2f89cf754 requirements_dev: add pytest-cov 2025-03-05 13:00:04 +01:00
Richard Kubíček
886004a20a test: introduce basic tests 2025-03-05 12:07:46 +01:00
Richard Kubíček
e668f76b4c requirements: add setuptools 2025-03-05 12:07:27 +01:00
8 changed files with 152 additions and 2 deletions

24
.github/workflows/mypy.yml vendored Normal file
View File

@@ -0,0 +1,24 @@
name: MyPy Type Checking
on: [push]
jobs:
type-check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements_dev.txt
- name: Run MyPy
run: mypy .

View File

@@ -20,7 +20,7 @@ jobs:
pip install pylint pip install pylint
- name: pylint - name: pylint
run: | run: |
pylint $(git ls-files '*.py') --fail-under=9.0 --output-format=json > pylint-report.json pylint $(git ls-files '*.py' | grep -v '^test/') --fail-under=9.0 --output-format=json > pylint-report.json
- name: Generate Pylint Score - name: Generate Pylint Score
id: pylint_score id: pylint_score

29
.github/workflows/pytest.yml vendored Normal file
View File

@@ -0,0 +1,29 @@
name: PyTest
on: [push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements_dev.txt
- name: Test with pytest
run: |
mkdir -p junit
pytest test/ --doctest-modules --junitxml=junit/test-results.xml --cov=superfaktura --cov-report=xml --cov-report=html
- name: Upload pytest test results
uses: actions/upload-artifact@v4
with:
name: pytest-results
path: junit/test-results.xml
# Use always() to always run this step to publish test results when there are test failures
if: ${{ always() }}

View File

@@ -1,3 +1,4 @@
# type: ignore
# Configuration file for the Sphinx documentation builder. # Configuration file for the Sphinx documentation builder.
# #
# For the full list of built-in configuration values, see the documentation: # For the full list of built-in configuration values, see the documentation:

View File

@@ -1,2 +1,3 @@
requests~=2.32.3 requests~=2.32.3
python-dotenv~=1.0.1 python-dotenv~=1.0.1
setuptools~=75.8.0

7
requirements_dev.txt Normal file
View File

@@ -0,0 +1,7 @@
requests~=2.32.3
python-dotenv~=1.0.1
pytest~=8.3.5
pytest-cov~=6.0.0
mypy~=1.9.0
types-requests~=2.31
types-setuptools~=68.2

0
test/__init__.py Normal file
View File

View File

@@ -0,0 +1,88 @@
import os
import pytest
from unittest.mock import patch, mock_open, MagicMock
import requests
from superfaktura.superfaktura_api import (
SuperFakturaAPI,
SuperFakturaAPIException,
SuperFakturaAPIMissingCredentialsException,
)
@pytest.fixture
def api():
with patch.dict(os.environ, {
"SUPERFAKTURA_API_KEY": "test_key",
"SUPERFAKTURA_API_URL": "https://api.superfaktura.cz",
"SUPERFAKTURA_API_EMAIL": "test_email",
"SUPERFAKTURA_API_COMPANY_ID": "test_company_id"
}):
return SuperFakturaAPI()
def test_missing_credentials():
with patch.dict(os.environ, {}, clear=True):
with pytest.raises(SuperFakturaAPIMissingCredentialsException):
SuperFakturaAPI()
def test_get(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 200
mock_get.return_value.json.return_value = {"data": "test"}
response = api.get("test_endpoint")
assert response == {"data": "test"}
def test_get_failure(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 404
with pytest.raises(SuperFakturaAPIException):
api.get("test_endpoint")
def test_download(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 200
mock_get.return_value.content = b"test_content"
with patch("builtins.open", mock_open()) as mock_file:
with open("test_file", "wb") as f:
api.download("test_endpoint", f)
mock_file().write.assert_called_once_with(b"test_content")
def test_download_failure(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 404
with patch("builtins.open", mock_open()):
with open("test_file", "wb") as f:
with pytest.raises(SuperFakturaAPIException):
api.download("test_endpoint", f)
def test_post(api):
with patch("requests.post") as mock_post:
mock_post.return_value.status_code = 200
mock_post.return_value.json.return_value = {"data": "test"}
response = api.post("test_endpoint", '{"name": "Example"}')
assert response == {"data": "test"}
def test_post_failure(api):
with patch("requests.post") as mock_post:
mock_post.return_value.status_code = 404
mock_post.return_value.json.return_value = {"error": "not found"}
with pytest.raises(SuperFakturaAPIException):
api.post("test_endpoint", '{"name": "Example"}')
def test_get_invalid_json(api):
with patch("requests.get") as mock_get:
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.side_effect = requests.exceptions.JSONDecodeError("msg", "doc", 0)
mock_get.return_value = mock_response
with pytest.raises(SuperFakturaAPIException, match="Unable to decode response as JSON"):
api.get("test_endpoint")
def test_download_not_writable_descriptor(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 200
mock_get.return_value.content = b"test_content"
mock_descriptor = MagicMock()
mock_descriptor.writable.return_value = False
with pytest.raises(SuperFakturaAPIException, match=" is not writable"):
api.download("test_endpoint", mock_descriptor)