Compare commits

..
74 Commits
Author SHA1 Message Date
CI Bot 9a9b7b2985 chore: release v1.1.0 [skip ci] 2026-07-08 19:15:45 +00:00
brian 5b9573d499 Merge pull request '[minor] Add Redis scan_keys iterator API' (#34) from cursor/redis-scan-keys into main
Test Python Package / integration-tests (push) Successful in 52s
Test Python Package / unit-tests (push) Failing after 13s
Code Quality Pipeline / code-quality (push) Successful in 24s
Test Python Package / coverage-report (push) Has been skipped
Release on merge to main / release (push) Successful in 1m18s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/34
2026-07-08 21:14:24 +02:00
Brian Bjarke JensenandCursor 50444af982 Add Redis scan_keys iterator API.
Test Python Package / unit-tests (pull_request) Successful in 14s
Code Quality Pipeline / code-quality (pull_request) Successful in 32s
Test Python Package / coverage-report (pull_request) Successful in 16s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / integration-tests (pull_request) Successful in 1m3s
Provide a SCAN-based key iterator for Redis adapters so callers can enumerate large keyspaces without relying on blocking KEYS lookups.

Co-authored-by: Cursor <[email protected]>
2026-07-08 21:06:13 +02:00
CI Bot 2f19fcc972 chore: release v1.0.0 [skip ci] 2026-07-08 18:25:00 +00:00
brian 3bd65895ec Merge pull request '[breaking] Clarify MinIO get() error semantics to match Redis behavior' (#33) from cursor/minio-error-semantics into main
Code Quality Pipeline / code-quality (push) Successful in 47s
Test Python Package / unit-tests (push) Successful in 1m17s
Test Python Package / coverage-report (push) Successful in 16s
Release on merge to main / release (push) Successful in 16s
Test Python Package / integration-tests (push) Successful in 1m6s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/33
2026-07-08 20:24:41 +02:00
Brian Bjarke JensenandCursor 5311d49fa6 Clarify MinIO get() error semantics to match Redis behavior.
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / integration-tests (pull_request) Successful in 1m17s
Test Python Package / unit-tests (pull_request) Successful in 1m28s
Code Quality Pipeline / code-quality (pull_request) Successful in 1m36s
Test Python Package / coverage-report (pull_request) Successful in 16s
Return None only for missing objects and re-raise other S3 and network failures so callers can distinguish not-found from real errors.

Co-authored-by: Cursor <[email protected]>
2026-07-08 20:02:03 +02:00
CI Bot 703bb9521f chore: release v0.5.1 [skip ci] 2026-07-07 19:37:22 +00:00
brian 8e47ebf4c6 Merge pull request '[patch] Fix MinIO get_object response leak in MinioAdapter.get()' (#32) from fix/minio-get-object-response-cleanup into main
Release on merge to main / release (push) Successful in 14s
Test Python Package / unit-tests (push) Successful in 15s
Code Quality Pipeline / code-quality (push) Successful in 47s
Test Python Package / integration-tests (push) Successful in 54s
Test Python Package / coverage-report (push) Successful in 15s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/32
2026-07-07 21:37:04 +02:00
Brian Bjarke JensenandCursor 9a800bf553 Fetch live PR title in pr-title-check CI workflow.
Code Quality Pipeline / code-quality (pull_request) Successful in 24s
Test Python Package / integration-tests (pull_request) Successful in 1m18s
Test Python Package / unit-tests (pull_request) Successful in 1m24s
Test Python Package / coverage-report (pull_request) Successful in 12s
PR Title Check / check-title (pull_request) Successful in 6s
Rerunning the job now reads the current title from the Gitea API instead of the stale pull_request event payload.

Co-authored-by: Cursor <[email protected]>
2026-07-07 21:34:18 +02:00
Brian Bjarke JensenandCursor 8c34534187 Fix MinIO get_object response leak in MinioAdapter.get().
Test Python Package / integration-tests (pull_request) Successful in 27s
Code Quality Pipeline / code-quality (pull_request) Successful in 31s
Test Python Package / unit-tests (pull_request) Successful in 36s
Test Python Package / coverage-report (pull_request) Successful in 53s
PR Title Check / check-title (pull_request) Failing after 5s
Close and release the HTTP response in a finally block per SDK guidance, and add unit tests for success and read-failure cleanup.

Co-authored-by: Cursor <[email protected]>
2026-07-07 21:21:42 +02:00
brian b1210bddf2 Merge pull request 'Reach 100% combined coverage with targeted unit tests' (#31) from cursor/balanced-100-coverage into main
Test Python Package / coverage-report (push) Successful in 45s
Test Python Package / unit-tests (push) Successful in 14s
Code Quality Pipeline / code-quality (push) Successful in 33s
Release on merge to main / release (push) Successful in 36s
Test Python Package / integration-tests (push) Successful in 23s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/31
2026-07-07 21:05:51 +02:00
Brian Bjarke JensenandCursor 39b104383c Fix mypy unreachable-code warning in minio reconnect test.
PR Title Check / check-title (pull_request) Successful in 7s
Test Python Package / coverage-report (pull_request) Successful in 12s
Code Quality Pipeline / code-quality (pull_request) Successful in 48s
Test Python Package / unit-tests (pull_request) Successful in 19s
Test Python Package / integration-tests (pull_request) Successful in 28s
Drop bucket_name assertions that mypy treated as always false after manually clearing _bucket_name.

Co-authored-by: Cursor <[email protected]>
2026-07-07 21:04:39 +02:00
Brian Bjarke JensenandCursor beb2b5128e Reach 100% combined coverage with targeted unit tests.
Code Quality Pipeline / code-quality (pull_request) Failing after 29s
Test Python Package / integration-tests (pull_request) Successful in 35s
Test Python Package / unit-tests (pull_request) Successful in 42s
PR Title Check / check-title (pull_request) Successful in 52s
Test Python Package / coverage-report (pull_request) Successful in 12s
Add fast unit tests for lazy-import helpers and injected-client connect paths that integration tests miss, and raise the coverage floor to 100%.

Co-authored-by: Cursor <[email protected]>
2026-07-07 21:01:03 +02:00
brian ce062be411 Merge pull request 'Enforce 90% combined coverage floor in CI' (#29) from cursor/enforce-coverage-floor into main
Release on merge to main / release (push) Successful in 5s
Test Python Package / unit-tests (push) Successful in 19s
Test Python Package / integration-tests (push) Successful in 25s
Code Quality Pipeline / code-quality (push) Successful in 48s
Test Python Package / coverage-report (push) Successful in 12s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/29
2026-07-07 20:41:44 +02:00
Brian Bjarke JensenandCursor a381d45650 Lower combined coverage floor from 95% to 90%.
PR Title Check / check-title (pull_request) Successful in 4s
Code Quality Pipeline / code-quality (pull_request) Successful in 24s
Test Python Package / unit-tests (pull_request) Successful in 36s
Test Python Package / integration-tests (pull_request) Successful in 48s
Test Python Package / coverage-report (pull_request) Successful in 12s
Update fail_under in pyproject.toml and the README to match.

Co-authored-by: Cursor <[email protected]>
2026-07-07 20:39:08 +02:00
Brian Bjarke JensenandCursor 5c8cd841b6 Document where combined coverage floor is enforced in CI.
Test Python Package / unit-tests (pull_request) Successful in 13s
Code Quality Pipeline / code-quality (pull_request) Successful in 26s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / integration-tests (pull_request) Successful in 1m7s
Test Python Package / coverage-report (pull_request) Failing after 15s
Clarify that unit and integration jobs skip the floor check because they only produce partial coverage.

Co-authored-by: Cursor <[email protected]>
2026-07-07 20:34:54 +02:00
Brian Bjarke JensenandCursor 34632980ba Skip coverage floor check in partial CI test jobs.
Code Quality Pipeline / code-quality (pull_request) Successful in 48s
Test Python Package / integration-tests (pull_request) Successful in 47s
Test Python Package / coverage-report (pull_request) Failing after 15s
PR Title Check / check-title (pull_request) Successful in 5s
Test Python Package / unit-tests (pull_request) Successful in 21s
Unit and integration jobs each produce partial coverage; pytest-cov reads fail_under from pyproject.toml unless overridden with --cov-fail-under=0.

Co-authored-by: Cursor <[email protected]>
2026-07-07 20:33:21 +02:00
Brian Bjarke JensenandCursor 5393efc6cd Enforce a 95% combined coverage floor in CI and local runs.
Test Python Package / unit-tests (pull_request) Failing after 56s
Code Quality Pipeline / code-quality (pull_request) Successful in 1m36s
Test Python Package / integration-tests (pull_request) Failing after 1m14s
Test Python Package / coverage-report (pull_request) Has been skipped
PR Title Check / check-title (pull_request) Successful in 35s
Configure fail_under in pyproject.toml and read it in the coverage-report workflow so the threshold stays in one place.

Co-authored-by: Cursor <[email protected]>
2026-07-07 20:27:39 +02:00
brian e39fc96ac1 Merge pull request 'Split CI into parallel unit, integration, and coverage report jobs' (#28) from cursor/split-ci-test-jobs into main
Code Quality Pipeline / code-quality (push) Successful in 23s
Test Python Package / coverage-report (push) Successful in 10s
Release on merge to main / release (push) Successful in 6s
Test Python Package / unit-tests (push) Successful in 13s
Test Python Package / integration-tests (push) Successful in 22s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/28
2026-07-07 19:37:27 +02:00
Brian Bjarke JensenandCursor c1f4826d78 Use christopherhx v4 artifact actions for parallel coverage merge.
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / unit-tests (pull_request) Successful in 18s
Code Quality Pipeline / code-quality (pull_request) Successful in 24s
Test Python Package / integration-tests (pull_request) Successful in 46s
Test Python Package / coverage-report (pull_request) Successful in 16s
Restore per-job coverage uploads while keeping unit and integration jobs parallel on Gitea 1.26.

Co-authored-by: Cursor <[email protected]>
2026-07-07 19:35:19 +02:00
Brian Bjarke JensenandCursor 0315a33a3b Avoid cross-job artifacts; combine coverage with --cov-append.
PR Title Check / check-title (pull_request) Successful in 4s
Test Python Package / unit-tests (pull_request) Successful in 10s
Code Quality Pipeline / code-quality (pull_request) Successful in 24s
Test Python Package / integration-tests (pull_request) Successful in 20s
Test Python Package / coverage-report (pull_request) Successful in 24s
Gitea artifact download is unreliable with v3 actions, so the report job re-runs both suites on one runner after parallel test gates pass.

Co-authored-by: Cursor <[email protected]>
2026-07-07 19:27:26 +02:00
Brian Bjarke JensenandCursor 5d33ec6091 Use artifact action v3 for Gitea Actions compatibility.
PR Title Check / check-title (pull_request) Successful in 5s
Code Quality Pipeline / code-quality (pull_request) Successful in 24s
Test Python Package / unit-tests (pull_request) Successful in 22s
Test Python Package / integration-tests (pull_request) Successful in 32s
Test Python Package / coverage-report (pull_request) Failing after 3m18s
Gitea does not support upload-artifact/download-artifact v4 yet.

Co-authored-by: Cursor <[email protected]>
2026-07-07 19:17:57 +02:00
Brian Bjarke JensenandCursor 9538e4d26d Split CI into parallel unit, integration, and coverage report jobs.
Code Quality Pipeline / code-quality (pull_request) Successful in 32s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / unit-tests (pull_request) Successful in 1m28s
Test Python Package / integration-tests (pull_request) Successful in 56s
Test Python Package / coverage-report (pull_request) Failing after 11s
Run test jobs in parallel and merge coverage artifacts for an accurate full-suite PR report.

Co-authored-by: Cursor <[email protected]>
2026-07-06 22:02:35 +02:00
brian 14b8d2798c Merge pull request 'Replace hardcoded version examples in release docs' (#27) from cursor/fix-version-doc-drift into main
Test Python Package / test (push) Successful in 52s
Code Quality Pipeline / code-quality (push) Successful in 46s
Release on merge to main / release (push) Successful in 7s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/27
2026-07-06 21:37:34 +02:00
Brian Bjarke JensenandCursor d3cbb65bbc Use version-agnostic examples in release docs.
Code Quality Pipeline / code-quality (pull_request) Successful in 46s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 1m21s
Replace hardcoded semver examples with stable placeholders and point readers to pyproject.toml for the current version.

Co-authored-by: Cursor <[email protected]>
2026-07-06 21:25:50 +02:00
CI Bot 7dbb1fc8ab chore: release v0.5.0 [skip ci] 2026-07-06 18:51:47 +00:00
brian 918e5e6ba4 Merge pull request '[minor] Add config and client injection with test reorganization' (#25) from cursor/config-client-injection into main
Code Quality Pipeline / code-quality (push) Successful in 31s
Release on merge to main / release (push) Successful in 14s
Test Python Package / test (push) Successful in 57s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/25
2026-07-06 20:51:01 +02:00
Brian Bjarke JensenandCursor 3aa91280ec Load MINIO_SECURE from env and replace adapter asserts with explicit errors.
Code Quality Pipeline / code-quality (pull_request) Successful in 32s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 57s
Default TLS to enabled for production MinIO setups while keeping local and integration tests on plain HTTP via explicit secure=false configuration.

Co-authored-by: Cursor <[email protected]>
2026-07-06 20:45:37 +02:00
Brian Bjarke JensenandCursor 7991dabdbc Add config and client injection with test reorganization.
Introduce typed config objects, optional adapter injection, and .env loading to simplify testing while preserving env-based defaults for production usage.

Co-authored-by: Cursor <[email protected]>
2026-07-06 20:44:08 +02:00
brian 366831ac52 Merge pull request 'chore(deps): update dependencies' (#26) from renovate/auto-deps-update into main
Code Quality Pipeline / code-quality (push) Successful in 34s
Release on merge to main / release (push) Successful in 6s
Test Python Package / test (push) Successful in 47s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/26
2026-07-06 20:42:20 +02:00
CI Bot a98905daa7 chore(deps): update dependencies [automated]
Code Quality Pipeline / code-quality (pull_request) Successful in 46s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 52s
2026-07-06 03:00:36 +00:00
brian 7ed1b34233 Merge pull request 'Sync uv.lock on release to prevent CI failures' (#24) from cursor/sync-uv-lock-on-release into main
Code Quality Pipeline / code-quality (push) Successful in 46s
Release on merge to main / release (push) Successful in 6s
Test Python Package / test (push) Successful in 1m18s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/24
2026-07-05 20:27:29 +02:00
Brian Bjarke Jensen 3236f27610 manually updated package version
PR Title Check / check-title (pull_request) Successful in 5s
Test Python Package / test (pull_request) Successful in 1m12s
Code Quality Pipeline / code-quality (pull_request) Successful in 47s
2026-07-05 20:19:33 +02:00
Brian Bjarke JensenandCursor ac487d91f8 Sync uv.lock on release to keep CI clean.
Code Quality Pipeline / code-quality (pull_request) Failing after 49s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 1m9s
Run uv lock during version bumps and commit the lockfile in the release workflow.

Co-authored-by: Cursor <[email protected]>
2026-07-05 20:06:35 +02:00
CI Bot a049ce327c chore: release v0.4.1 [skip ci] 2026-07-05 14:16:33 +00:00
brian 7b4cf8421b Merge pull request '[patch] Extract shared connection lifecycle into ConnectionAwareAdapter' (#23) from cursor/extract-connection-aware-adapter into main
Code Quality Pipeline / code-quality (push) Successful in 47s
Release on merge to main / release (push) Successful in 9s
Test Python Package / test (push) Successful in 1m7s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/23
2026-07-05 16:15:34 +02:00
Brian Bjarke JensenandCursor b5a92e6222 Sync uv.lock with pyproject.toml version 0.4.0.
Code Quality Pipeline / code-quality (pull_request) Successful in 31s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 48s
Co-authored-by: Cursor <[email protected]>
2026-07-05 16:11:23 +02:00
Brian Bjarke JensenandCursor 7b950e0d93 Extract shared connection lifecycle into ConnectionAwareAdapter.
Move duplicated context-manager, health-check cache, and connection guards from Redis and Minio adapters into an internal base class.

Co-authored-by: Cursor <[email protected]>
2026-07-05 16:09:25 +02:00
CI Bot fe0c477dff chore: release v0.4.0 [skip ci] 2026-07-05 13:41:59 +00:00
brian e7e0fc8c1d Merge pull request '[minor] Strengthen is_connected with cached health probes' (#22) from cursor/strengthen-is-connected-health-checks into main
Code Quality Pipeline / code-quality (push) Successful in 50s
Release on merge to main / release (push) Successful in 8s
Test Python Package / test (push) Successful in 1m12s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/22
2026-07-05 15:41:00 +02:00
Brian Bjarke JensenandCursor 34fc046868 Sync uv.lock with pyproject.toml version 0.3.2.
Code Quality Pipeline / code-quality (pull_request) Successful in 31s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 58s
Co-authored-by: Cursor <[email protected]>
2026-07-05 15:38:49 +02:00
Brian Bjarke JensenandCursor 5149299c1b Strengthen is_connected with cached health probes.
Code Quality Pipeline / code-quality (pull_request) Failing after 35s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 1m9s
Convert is_connected to a method that verifies backend liveness via TTL-cached ping (Redis) or bucket_exists (MinIO), with cache invalidation on connect/disconnect.

Co-authored-by: Cursor <[email protected]>
2026-07-05 15:28:25 +02:00
CI Bot fef9552cbf chore: release v0.3.2 [skip ci] 2026-06-30 14:12:18 +00:00
brian e9b21895f4 Merge pull request '[patch] Fix optional dependency handling for Redis and MinIO adapters' (#19) from cursor/fix-optional-dependencies into main
Code Quality Pipeline / code-quality (push) Successful in 31s
Release on merge to main / release (push) Successful in 8s
Test Python Package / test (push) Successful in 37s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/19
2026-06-30 16:08:01 +02:00
Brian Bjarke JensenandCursor f5953906c1 Fix optional-deps import test for full-suite execution.
Code Quality Pipeline / code-quality (pull_request) Successful in 31s
PR Title Check / check-title (pull_request) Successful in 5s
Test Python Package / test (pull_request) Successful in 41s
Run the base-import assertion in a subprocess so integration tests do not pollute sys.modules.

Co-authored-by: Cursor <[email protected]>
2026-06-30 16:05:41 +02:00
Brian Bjarke JensenandCursor 1f02195c27 Delegate top-level adapter imports to adapters package.
Code Quality Pipeline / code-quality (pull_request) Successful in 47s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Failing after 1m1s
Keep lazy loading in adapters/__init__.py as the single place to register new adapters.

Co-authored-by: Cursor <[email protected]>
2026-06-30 15:57:52 +02:00
Brian Bjarke JensenandCursor f092ca2022 Fix trailing whitespace in LICENSE and .gitignore.
Code Quality Pipeline / code-quality (pull_request) Successful in 37s
PR Title Check / check-title (pull_request) Successful in 5s
Test Python Package / test (pull_request) Failing after 47s
Co-authored-by: Cursor <[email protected]>
2026-06-30 15:48:01 +02:00
Brian Bjarke JensenandCursor c6eed43d70 Fix optional dependency handling for Redis and MinIO adapters.
Lazy-load adapters at package boundaries and fail fast with install hints when extras are missing.

Co-authored-by: Cursor <[email protected]>
2026-06-30 15:47:04 +02:00
brian 9e4b1e2c5e Merge pull request 'Avoid testcontainers Redis deprecation warning in integration tests.' (#18) from fix/redis-testcontainer-deprecation into main
Code Quality Pipeline / code-quality (push) Successful in 31s
Release on merge to main / release (push) Successful in 6s
Test Python Package / test (push) Successful in 43s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/18
2026-06-29 15:04:39 +02:00
Brian Bjarke JensenandCursor 0096df78a5 Avoid testcontainers Redis deprecation warning in integration tests.
Code Quality Pipeline / code-quality (pull_request) Successful in 47s
PR Title Check / check-title (pull_request) Successful in 5s
Test Python Package / test (pull_request) Successful in 52s
Use a local RedisTestContainer with wait strategies instead of the deprecated RedisContainer, and keep conftest focused on fixtures.

Co-authored-by: Cursor <[email protected]>
2026-06-29 15:00:45 +02:00
brian 3073bfbf50 Merge pull request 'Fix PR coverage comment posting in CI.' (#17) from fix/coverage-pr-comment into main
Code Quality Pipeline / code-quality (push) Successful in 36s
Release on merge to main / release (push) Successful in 5s
Test Python Package / test (push) Successful in 47s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/17
2026-06-29 11:37:34 +02:00
Brian Bjarke JensenandCursor 30a1de32e8 Fix PR coverage comment posting in CI.
Test Python Package / test (pull_request) Successful in 48s
Code Quality Pipeline / code-quality (pull_request) Successful in 31s
PR Title Check / check-title (pull_request) Successful in 5s
Build the Gitea API payload with json.dumps so multiline coverage output is valid JSON, and fail the step when the API rejects the request.

Co-authored-by: Cursor <[email protected]>
2026-06-28 23:46:49 +02:00
brian 8465957976 Merge pull request '[patch] update dependencies' (#16) from renovate/auto-deps-update into main
Test Python Package / test (push) Successful in 47s
Code Quality Pipeline / code-quality (push) Successful in 30s
Release on merge to main / release (push) Failing after 7s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/16
2026-06-28 23:46:13 +02:00
Brian Bjarke Jensen 3ecb9c3136 chore: retrigger CI
Code Quality Pipeline / code-quality (pull_request) Successful in 46s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 47s
2026-06-28 23:41:02 +02:00
Brian Bjarke JensenandCursor 0f31170209 Fix mypy errors from minio 7.2.20 type stubs.
Code Quality Pipeline / code-quality (pull_request) Successful in 36s
PR Title Check / check-title (pull_request) Failing after 6s
Test Python Package / test (pull_request) Successful in 43s
Guard bucket_name before Minio API calls, update S3Error test mocks for the new constructor signature, and add types-redis to the pre-commit mypy hook.

Co-authored-by: Cursor <[email protected]>
2026-06-28 23:32:31 +02:00
CI Bot e3cab5e0b6 chore(deps): update dependencies [automated]
Code Quality Pipeline / code-quality (pull_request) Failing after 22s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 1m3s
2026-06-28 21:22:26 +00:00
brian f428a974f6 Merge pull request 'Fix dependency bot PR creation for Gitea.' (#15) from cursor/fix-dependency-bot-gitea-pr into main
Code Quality Pipeline / code-quality (push) Successful in 31s
Release on merge to main / release (push) Successful in 6s
Test Python Package / test (push) Successful in 57s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/15
2026-06-28 22:56:14 +02:00
Brian Bjarke JensenandCursor a3b9912107 Fix dependency bot PR creation for Gitea.
Code Quality Pipeline / code-quality (pull_request) Successful in 27s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 1m3s
Replace peter-evans/create-pull-request with a Gitea API script that commits, pushes, and opens the deps update PR.

Co-authored-by: Cursor <[email protected]>
2026-06-28 22:41:59 +02:00
brian abaa078471 Merge pull request 'Fix dependency update bot to use uv lock --upgrade.' (#14) from cursor/fix-dependency-update-bot-uv-lock into main
Code Quality Pipeline / code-quality (push) Successful in 47s
Release on merge to main / release (push) Successful in 6s
Test Python Package / test (push) Successful in 1m2s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/14
2026-06-28 22:34:48 +02:00
Brian Bjarke JensenandCursor 9864f0cc9d Fix dependency update bot to use uv lock --upgrade.
Code Quality Pipeline / code-quality (pull_request) Successful in 45s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 53s
Replace invalid uv pip update/compile commands with the native lockfile upgrade workflow.

Co-authored-by: Cursor <[email protected]>
2026-06-28 22:30:28 +02:00
brian e39b467b6b Merge pull request 'Automate releases from PR titles and clean up CI workflows.' (#13) from cursor/pr-title-release-automation into main
Code Quality Pipeline / code-quality (push) Successful in 30s
Release on merge to main / release (push) Successful in 6s
Test Python Package / test (push) Successful in 1m4s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/13
2026-06-28 22:25:01 +02:00
Brian Bjarke Jensen 85c1a64e14 Sync uv.lock with pyproject.toml version 0.3.1.
Code Quality Pipeline / code-quality (pull_request) Successful in 30s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Successful in 1m7s
2026-06-28 22:21:59 +02:00
Brian Bjarke JensenandCursor a8491c005c Automate releases from PR titles and clean up CI workflows.
Code Quality Pipeline / code-quality (pull_request) Failing after 39s
PR Title Check / check-title (pull_request) Successful in 5s
Test Python Package / test (pull_request) Successful in 1m3s
Add release and PR title checks, shared CI scripts, Gitea PR template, and align pyproject.toml to v0.3.1.

Co-authored-by: Cursor <[email protected]>
2026-06-28 22:18:40 +02:00
brian 2bb361e3a3 Merge pull request 'Add public repository interfaces and subclassable adapter CRUD API.' (#11) from cursor/public-repository-api into main
Code Quality Pipeline / code-quality (push) Successful in 30s
Test Python Package / test (push) Successful in 52s
Publish Python Package / build-and-publish (push) Successful in 22s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/11
2026-06-28 20:05:14 +02:00
Brian Bjarke JensenandCursor c5169df10d Use pre-commit for Prettier in CI and document local hook setup.
Test Python Package / test (pull_request) Successful in 50s
Code Quality Pipeline / code-quality (pull_request) Successful in 31s
Run prettier via pre-commit in code-quality workflow and add README instructions for installing and running hooks during development.

Co-authored-by: Cursor <[email protected]>
2026-06-28 19:56:25 +02:00
Brian Bjarke JensenandCursor 497533f0e3 Fix mypy context manager typing for adapter subclasses.
Code Quality Pipeline / code-quality (pull_request) Failing after 26s
Test Python Package / test (pull_request) Successful in 1m7s
Return Self from __enter__ so with-blocks preserve subclass types, and align mypy python_version with the 3.12 runtime target.

Co-authored-by: Cursor <[email protected]>
2026-06-28 19:42:15 +02:00
Brian Bjarke JensenandCursor e98fd3b90d Add public repository interfaces and subclassable adapter CRUD API.
Code Quality Pipeline / code-quality (pull_request) Failing after 19s
Test Python Package / test (pull_request) Successful in 50s
Define split JSON and object repository ABCs, promote adapter methods to public CRUD, add example domain repositories, modernize interface stubs, and make the package installable for tests.

Co-authored-by: Cursor <[email protected]>
2026-06-28 10:58:33 +02:00
brian f4280f15c1 Merge pull request 'Remove non-existent Mongo adapter from README.' (#10) from cleanup/remove-mongo-adapter-mentions into main
Test Python Package / test (push) Successful in 1m12s
Code Quality Pipeline / code-quality (push) Successful in 24s
Reviewed-on: https://gitea.lille-vemmelund.dk/brian/python-repositories/pulls/10
2026-06-21 23:05:47 +02:00
Brian Bjarke Jensen d9b9fa49a2 updated package settings
Code Quality Pipeline / code-quality (pull_request) Successful in 41s
Test Python Package / test (pull_request) Successful in 1m18s
2026-06-21 22:45:29 +02:00
Brian Bjarke Jensen 9d25f7c722 updated package settings
Code Quality Pipeline / code-quality (pull_request) Failing after 39s
Test Python Package / test (pull_request) Successful in 1m23s
2026-06-21 22:43:14 +02:00
Brian Bjarke Jensen 163581526d updated package settings
Code Quality Pipeline / code-quality (pull_request) Failing after 21s
Test Python Package / test (pull_request) Failing after 12s
2026-06-21 22:39:50 +02:00
Brian Bjarke Jensen 933c4ee7c5 updated package settings
Test Python Package / test (pull_request) Successful in 1m27s
Code Quality Pipeline / code-quality (pull_request) Successful in 41s
2026-06-21 22:34:50 +02:00
Brian Bjarke Jensen 2b0d98f84c updated package settings
Code Quality Pipeline / code-quality (pull_request) Failing after 51s
Test Python Package / test (pull_request) Failing after 2m1s
2026-06-21 22:26:41 +02:00
Brian Bjarke JensenandCursor 729fa48505 Remove non-existent Mongo adapter from README.
Code Quality Pipeline / code-quality (pull_request) Failing after 2m9s
Test Python Package / test (pull_request) Failing after 2m10s
The package only ships Redis and MinIO adapters, so the docs should not reference a mongo extra.

Co-authored-by: Cursor <[email protected]>
2026-06-21 22:17:44 +02:00
61 changed files with 3942 additions and 1589 deletions
+9
View File
@@ -0,0 +1,9 @@
# Redis (requires redis extra)
REDIS_URI=redis://localhost:6379
# MinIO (requires minio extra)
MINIO_ENDPOINT=localhost:9000
MINIO_ACCESS_KEY=minioadmin
MINIO_SECRET_KEY=minioadmin
MINIO_BUCKET=my-bucket
MINIO_SECURE=false
+21
View File
@@ -0,0 +1,21 @@
## Version bump
If this PR changes files under `python_repositories/`, the **title must** start with one of:
- `[patch]` or `[fix]` — bug fix (`1.2.3``1.2.4`)
- `[minor]` or `[feat]` — new feature (`1.2.3``1.3.0`)
- `[major]` or `[breaking]` — breaking change (`1.2.3``2.0.0`)
Current version: see [`pyproject.toml`](pyproject.toml) on `main`.
Docs-, CI-, or test-only PRs do not need a prefix.
**Example title:** `[minor] Add streaming support to RedisAdapter`
## Summary
<!-- What changed and why -->
## Test plan
- [ ] Integration tests pass locally
+3 -5
View File
@@ -16,7 +16,7 @@ jobs:
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: ${{ inputs.python-version }} python-version-file: .python-version
- name: Install uv - name: Install uv
run: pip install uv run: pip install uv
@@ -36,9 +36,7 @@ jobs:
run: uv run ruff format --check . run: uv run ruff format --check .
- name: Pyupgrade check - name: Pyupgrade check
run: uv run pyupgrade --py313-plus $(git ls-files '*.py') && git diff --exit-code run: uv run pyupgrade --py312-plus $(git ls-files '*.py') && git diff --exit-code
- name: Prettier format - name: Prettier format
run: | run: uv run pre-commit run prettier --all-files
npm install --save-dev --save-exact prettier
npx prettier --check .
+13 -15
View File
@@ -11,26 +11,24 @@ jobs:
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with:
token: ${{ secrets.CI_RUNNER_TOKEN }}
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: ${{ inputs.python-version }} python-version-file: .python-version
- name: Install uv and pip-review - name: Install uv
run: | run: pip install uv
pip install uv pip-review
- name: Update dependencies in pyproject.toml - name: Upgrade dependencies
run: | run: uv lock --upgrade
uv pip update --all --group dev
uv pip compile --all
- name: Commit and push changes - name: Commit and push changes
uses: peter-evans/create-pull-request@v6 env:
with: API_URL: ${{ vars.API_URL }}
commit-message: "chore(deps): update dependencies [automated]" REPO_OWNER: ${{ github.repository_owner }}
branch: "renovate/auto-deps-update" REPO_NAME: ${{ github.event.repository.name }}
title: "chore(deps): update dependencies" CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
body: "This PR was created automatically to update dependencies." run: scripts/ci/create-deps-update-pr.sh
token: ${{ secrets.CI_RUNNER_TOKEN }}
+29
View File
@@ -0,0 +1,29 @@
name: PR Title Check
on:
pull_request:
branches:
- main
jobs:
check-title:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Check PR title when source files change
env:
API_URL: ${{ vars.API_URL }}
REPO_OWNER: ${{ github.repository_owner }}
REPO_NAME: ${{ github.event.repository.name }}
PR_NUMBER: ${{ github.event.pull_request.number }}
CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
run: |
git fetch origin "${{ github.base_ref }}"
PR_TITLE=$(scripts/ci/fetch-pr-title.sh)
echo "Live PR title: ${PR_TITLE}"
git diff --name-only "origin/${{ github.base_ref }}...HEAD" \
| scripts/ci/check-pr-title.sh "$PR_TITLE"
+2 -6
View File
@@ -17,17 +17,13 @@ jobs:
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: ${{ inputs.python-version }} python-version-file: .python-version
- name: Install uv - name: Install uv
run: pip install uv run: pip install uv
- name: Update version in pyproject.toml to match tag - name: Update version in pyproject.toml to match tag
run: | run: scripts/ci/bump-version.sh --from-tag "${GITHUB_REF##*/}"
TAG_VERSION="${GITHUB_REF##*/}"
VERSION="${TAG_VERSION#v}"
sed -i.bak -E "s/^version = \".*\"/version = \"${VERSION}\"/" pyproject.toml
rm pyproject.toml.bak
- name: Build package - name: Build package
run: | run: |
+83
View File
@@ -0,0 +1,83 @@
name: Release on merge to main
on:
push:
branches:
- main
jobs:
release:
if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.CI_RUNNER_TOKEN }}
- name: Parse merge commit
id: meta
env:
COMMIT_MSG: ${{ github.event.head_commit.message }}
run: scripts/ci/parse-merge-commit.sh "$COMMIT_MSG"
- name: Set up Python
if: steps.meta.outputs.bump != 'skip'
uses: actions/setup-python@v5
with:
python-version-file: .python-version
- name: Install uv
if: steps.meta.outputs.bump != 'skip'
run: pip install uv
- name: Bump version
if: steps.meta.outputs.bump != 'skip'
id: bump
run: scripts/ci/bump-version.sh "${{ steps.meta.outputs.bump }}"
- name: Generate release notes
if: steps.meta.outputs.bump != 'skip'
id: notes
env:
PR_TITLE: ${{ steps.meta.outputs.pr_title }}
run: |
PREV_TAG=$(git describe --tags --abbrev=0)
NEW_TAG="v${{ steps.bump.outputs.version }}"
scripts/ci/generate-release-notes.sh "$NEW_TAG" "$PR_TITLE" "$PREV_TAG"
- name: Commit, tag, and push
if: steps.meta.outputs.bump != 'skip'
env:
VERSION: ${{ steps.bump.outputs.version }}
CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
run: |
git config user.name "CI Bot"
git config user.email "[email protected]"
git add pyproject.toml uv.lock
git commit -m "chore: release v${VERSION} [skip ci]"
git tag "v${VERSION}"
git remote set-url origin "https://x-access-token:${CI_RUNNER_TOKEN}@${GITHUB_SERVER_URL#https://}/${GITHUB_REPOSITORY}.git"
git push origin main
git push origin "v${VERSION}"
- name: Create Gitea release
if: steps.meta.outputs.bump != 'skip'
env:
API_URL: ${{ vars.API_URL }}
REPO_OWNER: ${{ github.repository_owner }}
REPO_NAME: ${{ github.event.repository.name }}
CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
VERSION: ${{ steps.bump.outputs.version }}
PR_TITLE: ${{ steps.meta.outputs.pr_title }}
RELEASE_BODY: ${{ steps.notes.outputs.body }}
run: |
SUMMARY=$(echo "$PR_TITLE" | sed -E 's/^\[(patch|fix|minor|feat|major|breaking)\][[:space:]]*//i')
export RELEASE_NAME="v${VERSION} — ${SUMMARY}"
PAYLOAD=$(python3 -c 'import json, os; print(json.dumps({"tag_name": "v" + os.environ["VERSION"], "name": os.environ["RELEASE_NAME"], "body": os.environ["RELEASE_BODY"]}))')
curl -s -X POST \
"${API_URL}/repos/${REPO_OWNER}/${REPO_NAME}/releases" \
-H "Authorization: token ${CI_RUNNER_TOKEN}" \
-H "Content-Type: application/json" \
-d "$PAYLOAD"
-29
View File
@@ -1,29 +0,0 @@
name: Security Audit
on:
schedule:
- cron: "0 0 * * 0" # Weekly
workflow_dispatch:
jobs:
safety:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ inputs.python-version }}
- name: Install uv
run: pip install uv
- name: Install dependencies
env:
UV_LINK_MODE: copy
run: uv sync
- name: Run safety check
run: uv run safety check
+1 -1
View File
@@ -15,7 +15,7 @@ jobs:
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: ${{ inputs.python-version }} python-version-file: .python-version
- name: Install uv - name: Install uv
run: pip install uv run: pip install uv
@@ -1,38 +0,0 @@
name: Sync pyproject.toml Version
on:
workflow_run:
workflows: ["Publish Python Package"]
types:
- completed
jobs:
commit-version-update:
if: ${{ github.event.workflow_run.conclusion == 'success' }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ inputs.python-version }}
- name: Configure git
run: |
git config user.name "CI Bot"
git config user.email "[email protected]"
- name: Update version in pyproject.toml to match tag
run: |
TAG_VERSION="${{ github.event.workflow_run.head_branch }}"
VERSION="${TAG_VERSION#v}"
sed -i.bak -E "s/^version = \".*\"/version = \"${VERSION}\"/" pyproject.toml
rm pyproject.toml.bak
- name: Commit and push changes
run: |
git add pyproject.toml
git commit -m "chore: update version in pyproject.toml to ${VERSION} [skip ci]" || echo "No changes to commit"
git push
+125 -9
View File
@@ -7,7 +7,7 @@ on:
pull_request: pull_request:
jobs: jobs:
test: unit-tests:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
@@ -16,7 +16,7 @@ jobs:
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: ${{ inputs.python-version }} python-version-file: .python-version
- name: Install uv - name: Install uv
run: pip install uv run: pip install uv
@@ -26,12 +26,117 @@ jobs:
UV_LINK_MODE: copy UV_LINK_MODE: copy
run: uv sync --all-extras run: uv sync --all-extras
- name: Run pytest - name: Run unit tests
run: |
# --cov-fail-under=0: partial coverage only; floor is checked in coverage-report.
uv run pytest tests/unit/ -m "not integration" \
--cov=python_repositories \
--cov-report= \
--cov-fail-under=0
- name: Upload unit coverage
uses: https://github.com/christopherHX/gitea-upload-artifact@v4
with:
name: coverage-unit
path: .coverage
retention-days: 1
compression-level: 0
integration-tests:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version-file: .python-version
- name: Install uv
run: pip install uv
- name: Install dependencies
env: env:
PYTHONPATH: . UV_LINK_MODE: copy
run: uv run pytest --cov=python_repositories --cov-report=term-missing > coverage.txt run: uv sync --all-extras
- name: Verify Docker
run: docker info
- name: Run integration tests
run: |
# --cov-fail-under=0: partial coverage only; floor is checked in coverage-report.
uv run pytest -m integration \
--cov=python_repositories \
--cov-report= \
--cov-fail-under=0
- name: Upload integration coverage
uses: https://github.com/christopherHX/gitea-upload-artifact@v4
with:
name: coverage-integration
path: .coverage
retention-days: 1
compression-level: 0
coverage-report:
# Merges unit + integration coverage and enforces fail_under from pyproject.toml.
needs: [unit-tests, integration-tests]
runs-on: ubuntu-latest
if: github.event_name == 'pull_request' || github.event_name == 'push'
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version-file: .python-version
- name: Install uv
run: pip install uv
- name: Install dependencies
env:
UV_LINK_MODE: copy
run: uv sync --all-extras
- name: Download unit coverage
uses: https://github.com/christopherHX/gitea-download-artifact@v4
with:
name: coverage-unit
path: coverage-unit
- name: Download integration coverage
uses: https://github.com/christopherHX/gitea-download-artifact@v4
with:
name: coverage-integration
path: coverage-integration
- name: Combine coverage report
run: |
# --fail-under=0 so the full report is always written before the floor check.
uv run coverage combine coverage-unit/.coverage coverage-integration/.coverage
uv run coverage report -m --include='python_repositories/*' --fail-under=0 > coverage.txt
- name: Show coverage report
run: cat coverage.txt
- name: Enforce coverage floor
run: |
# Reads fail_under from pyproject.toml; only combined coverage is evaluated here.
FAIL_UNDER=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['tool']['coverage']['report']['fail_under'])")
echo "Checking combined coverage against ${FAIL_UNDER}% floor..."
if uv run coverage report --fail-under="$FAIL_UNDER" --include='python_repositories/*'; then
echo "Coverage floor met."
else
echo "::error::Combined coverage is below the ${FAIL_UNDER}% floor"
exit 1
fi
- name: Post coverage summary to PR - name: Post coverage summary to PR
if: github.event_name == 'pull_request'
env: env:
API_URL: ${{ vars.API_URL }} API_URL: ${{ vars.API_URL }}
REPO_OWNER: ${{ github.repository_owner }} REPO_OWNER: ${{ github.repository_owner }}
@@ -39,9 +144,20 @@ jobs:
PR_NUMBER: ${{ github.event.pull_request.number }} PR_NUMBER: ${{ github.event.pull_request.number }}
CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }} CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
run: | run: |
COVERAGE=$(cat coverage.txt) PAYLOAD=$(python3 -c '
COMMENT_BODY="**Test Coverage Report:**\n\`\`\`\n$COVERAGE\n\`\`\`" import json
curl -s -X POST "$API_URL/repos/$REPO_OWNER/$REPO_NAME/issues/$PR_NUMBER/comments" \ import pathlib
coverage = pathlib.Path("coverage.txt").read_text()
print(
json.dumps(
{
"body": f"**Test Coverage Report:**\n```\n{coverage}\n```",
}
)
)
')
curl -sf -X POST "$API_URL/repos/$REPO_OWNER/$REPO_NAME/issues/$PR_NUMBER/comments" \
-H "Authorization: token $CI_RUNNER_TOKEN" \ -H "Authorization: token $CI_RUNNER_TOKEN" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d "{\"body\": \"$COMMENT_BODY\"}" -d "$PAYLOAD"
-1
View File
@@ -173,4 +173,3 @@ cython_debug/
# PyPI configuration file # PyPI configuration file
.pypirc .pypirc
+3 -1
View File
@@ -24,13 +24,15 @@ repos:
rev: v1.8.0 rev: v1.8.0
hooks: hooks:
- id: mypy - id: mypy
additional_dependencies:
- types-redis
# Python syntax modernization with pyupgrade # Python syntax modernization with pyupgrade
- repo: https://github.com/asottile/pyupgrade - repo: https://github.com/asottile/pyupgrade
rev: v3.20.0 rev: v3.20.0
hooks: hooks:
- id: pyupgrade - id: pyupgrade
args: ["--py311-plus"] args: ["--py312-plus"]
# Formatting for Markdown, JSON, and YAML with Prettier # Formatting for Markdown, JSON, and YAML with Prettier
- repo: https://github.com/pre-commit/mirrors-prettier - repo: https://github.com/pre-commit/mirrors-prettier
+9 -9
View File
@@ -2,17 +2,17 @@ MIT License
Copyright (c) 2025 brian Copyright (c) 2025 brian
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 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 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 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 copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
following conditions: following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software. portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 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 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 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 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. USE OR OTHER DEALINGS IN THE SOFTWARE.
+204 -8
View File
@@ -1,17 +1,213 @@
# python-repositories # python-repositories
Various python repository interfaces exposed as a python package. Unified repository interfaces and technology-specific adapters for Python projects.
Subclass an adapter in your own repository to add domain-specific methods while reusing connection management and CRUD operations.
## Architecture
| Layer | Responsibility |
| ---------------- | ----------------------------------------------------------------- |
| **Interfaces** | Abstract contracts for connection, context, and CRUD |
| **Adapters** | Technology-specific base classes (`RedisAdapter`, `MinioAdapter`) |
| **Your project** | Subclass an adapter and add domain methods |
Connection adapters expose `connect()`, `disconnect()`, and `is_connected()`. The latter verifies backend reachability with a cached health probe (default TTL: 1 second). Subclasses may override `health_check_ttl_seconds`.
## Optional dependencies ## Optional dependencies
This package supports interacting with multiple different backends: Repository **interfaces** import with the base package. **Adapters** require the matching extra; importing an adapter without its extra raises `ImportError` with install instructions.
- Redis Install with the extras you need:
- Mongo
- MinIO
To add support for a specific backend install this package with one or more of these optional packages:
```bash ```bash
uv add python-repositories[redis, mongo, minio] uv add python-repositories[redis]
uv add python-repositories[minio]
uv add python-repositories[redis,minio]
``` ```
### Redis (`JsonRepositoryInterface`)
Requires Redis with the RedisJSON module (e.g. redis-stack).
| Environment variable | Description |
| -------------------- | ---------------------------------------------------- |
| `REDIS_URI` | Redis connection URL (e.g. `redis://localhost:6379`) |
For key discovery:
- `list_keys(pattern)` is simple and returns a `list[str]`, but it uses Redis `KEYS` and may block on large datasets.
- `scan_keys(pattern, *, count=None)` is preferred for production use and yields keys incrementally via Redis `SCAN`.
Example:
```python
for key in repo.scan_keys("user:*"):
print(key)
```
### MinIO (`ObjectRepositoryInterface`)
| Environment variable | Description |
| -------------------- | ------------------------------------------- |
| `MINIO_ENDPOINT` | MinIO server endpoint |
| `MINIO_ACCESS_KEY` | Access key |
| `MINIO_SECRET_KEY` | Secret key |
| `MINIO_BUCKET` | Bucket name (created on connect if missing) |
| `MINIO_SECURE` | Use HTTPS (`true`/`false`; default: `true`) |
Copy [`.env.example`](.env.example) to `.env` for local development. `RedisConfig.from_env()` and `MinioConfig.from_env()` load `.env` automatically when resolving configuration from the environment.
## Configuration injection
Adapters accept optional `config` and `client` keyword arguments for explicit setup and testing:
```python
from python_repositories import RedisAdapter, RedisConfig, MinioAdapter, MinioConfig
redis = RedisAdapter(config=RedisConfig(uri="redis://localhost:6379"))
minio = MinioAdapter(
config=MinioConfig(
endpoint="localhost:9000",
access_key="minioadmin",
secret_key="minioadmin",
bucket="my-bucket",
secure=False,
)
)
```
When both `config` and `client` are provided, `connect()` skips client creation (the caller owns the client lifecycle). `config` is required whenever `client` is injected.
Load a `.env` file explicitly:
```python
from python_repositories import load_dotenv
load_dotenv() # optional — from_env() also loads .env by default
```
Calling `RedisAdapter()` or `MinioAdapter()` with no arguments still loads configuration from environment variables (and `.env` if present).
## Quick start
### JSON documents with Redis
```python
from python_repositories.examples.user_json_repository import UserJsonRepository
with UserJsonRepository() as repo:
repo.save_user("alice", {"name": "Alice", "email": "[email protected]"})
user = repo.get_user("alice")
repo.delete_user("alice")
```
### Binary objects with MinIO
```python
from io import BytesIO
from python_repositories.examples.artifact_object_repository import (
ArtifactObjectRepository,
)
with ArtifactObjectRepository() as repo:
repo.store_artifact("report-1", BytesIO(b"pdf bytes here"))
data = repo.get_artifact("report-1")
```
### Subclassing in your own project
```python
from python_repositories import RedisAdapter
class UserRepository(RedisAdapter):
def _key(self, user_id: str) -> str:
return f"user:{user_id}"
def get_user(self, user_id: str) -> dict | None:
return self.get(self._key(user_id))
def save_user(self, user_id: str, user: dict) -> None:
self.set(self._key(user_id), user)
```
## Public API
```python
from python_repositories import (
ConnectionAwareInterface,
ContextAwareInterface,
JsonRepositoryInterface,
MinioAdapter,
MinioConfig,
ObjectRepositoryInterface,
RedisAdapter,
RedisConfig,
load_dotenv,
)
```
## Development
```bash
uv sync --all-extras
uv run pre-commit install # once per clone — runs hooks on git commit
uv run pytest tests/unit/ -v # fast, no Docker
uv run pytest -m "not integration" -v # all non-Docker tests
uv run pytest -v # full suite (requires Docker)
```
Integration tests are marked with `@pytest.mark.integration` and require Docker (testcontainers). Run unit tests alone for quick local feedback.
CI runs unit and integration tests in parallel with coverage, then merges `.coverage` artifacts in a follow-up job (via [christopherhx/gitea-\*-artifact@v4](https://github.com/christopherHX/gitea-upload-artifact) for Gitea 1.26 compatibility). Combined coverage must be at least **90%**; the floor is set by [`fail_under` in `pyproject.toml`](pyproject.toml#L45-L48) and enforced after merging unit and integration coverage, not on unit-only runs.
To check coverage locally (requires Docker for the full suite):
```bash
uv run pytest --cov=python_repositories --cov-report=
uv run coverage report
```
`pre-commit` is included in the dev dependency group. `uv sync` installs the CLI, but git does not run hooks until you install them with `pre-commit install` (one time per clone). After that, commits run the checks defined in [`.pre-commit-config.yaml`](.pre-commit-config.yaml) (ruff, mypy, pyupgrade, prettier, and general file hygiene).
To run all hooks manually without committing:
```bash
uv run pre-commit run --all-files
```
## Releases
Releases are automated when a pull request is merged to `main`. CI reads the **merged PR title** to decide whether and how to bump the version.
### How it works
1. Open a PR targeting `main` (see [`.gitea/PULL_REQUEST_TEMPLATE.md`](.gitea/PULL_REQUEST_TEMPLATE.md)).
2. If the PR changes files under `python_repositories/`, the title **must** start with a version bump prefix (enforced by CI).
3. On merge, [`release.yml`](.gitea/workflows/release.yml) bumps [`pyproject.toml`](pyproject.toml) and syncs [`uv.lock`](uv.lock), commits, tags `vX.Y.Z`, creates a Gitea release with auto-generated notes, and pushes the tag.
4. [`publish.yml`](.gitea/workflows/publish.yml) builds and publishes the package to the Gitea Package Registry.
Docs-, CI-, and test-only PRs do not need a prefix and will not trigger a release.
### PR title prefixes
| Prefix | Bump | Example |
| ------------------------- | ---------- | --------------------- |
| `[patch]` or `[fix]` | patch | `1.2.3``1.2.4` |
| `[minor]` or `[feat]` | minor | `1.2.3``1.3.0` |
| `[major]` or `[breaking]` | major | `1.2.3``2.0.0` |
| _(none)_ | no release | docs / CI / deps only |
Example titles:
- `[minor] Add public repository interfaces and subclassable adapter CRUD API`
- `[patch] Fix mypy context manager typing for adapter subclasses`
### Release notes
Release notes are generated from commits since the previous tag (see [`scripts/ci/generate-release-notes.sh`](scripts/ci/generate-release-notes.sh)).
### Manual release
You can still push a `v*.*.*` tag manually; `publish.yml` will build and publish. The current released version is in [`pyproject.toml`](pyproject.toml) (and on the latest `v*.*.*` tag).
+25 -4
View File
@@ -1,6 +1,6 @@
[project] [project]
name = "python-repositories" name = "python-repositories"
version = "0.1.0" version = "1.1.0"
description = "Various python repository interfaces exposed as a python package." description = "Various python repository interfaces exposed as a python package."
authors = [ authors = [
{ name = "Brian Bjarke Jensen", email = "[email protected]" } { name = "Brian Bjarke Jensen", email = "[email protected]" }
@@ -14,6 +14,7 @@ classifiers = [
"Operating System :: OS Independent", "Operating System :: OS Independent",
] ]
dependencies = [ dependencies = [
"python-dotenv>=1.0.0",
"python-utils>=0.1.0", "python-utils>=0.1.0",
"structlog>=25.4.0", "structlog>=25.4.0",
] ]
@@ -26,21 +27,41 @@ minio = [
"minio>=7.2.16", "minio>=7.2.16",
] ]
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = ["."]
addopts = "--import-mode=importlib"
markers = [
"integration: tests requiring Docker containers (deselect with '-m \"not integration\"')",
]
[tool.coverage.run]
source = ["python_repositories"]
[tool.coverage.report]
fail_under = 100
show_missing = true
precision = 2
[tool.uv.sources] [tool.uv.sources]
python-utils = { index = "gitea" } python-utils = { index = "gitea" }
[[tool.uv.index]] [[tool.uv.index]]
name = "threadripper-proxpi-cache" name = "threadripper-proxpi-cache"
url = "http://10.0.0.2:5001/index/" url = "https://proxpi.lille-vemmelund.dk/index/"
default = true default = true
[[tool.uv.index]] [[tool.uv.index]]
name = "gitea" name = "gitea"
url = "https://gitea.gt-proj.com/api/packages/brian/pypi/simple/" url = "https://gitea.lille-vemmelund.dk/api/packages/brian/pypi/simple/"
explicit = true explicit = true
[tool.mypy] [tool.mypy]
python_version = "3.10" python_version = "3.12"
warn_return_any = true # nudge to use stricter types warn_return_any = true # nudge to use stricter types
warn_unused_configs = true # nudge to remove unused configs warn_unused_configs = true # nudge to remove unused configs
disallow_untyped_defs = true # disallow untyped function definitions disallow_untyped_defs = true # disallow untyped function definitions
+40 -3
View File
@@ -1,6 +1,43 @@
"""python_repositories: Unified repository interfaces and adapters.""" """python_repositories: Unified repository interfaces and adapters."""
from . import adapters from __future__ import annotations
from . import interfaces
__all__ = ["adapters", "interfaces"] from typing import TYPE_CHECKING
# Interfaces are always available; they have no optional backend dependencies.
from . import adapters
from .config import MinioConfig, RedisConfig, load_dotenv
from .interfaces import (
ConnectionAwareInterface,
ContextAwareInterface,
JsonRepositoryInterface,
ObjectRepositoryInterface,
)
# Adapters are imported only for static type checkers; runtime loading is delegated below.
if TYPE_CHECKING:
from .adapters.minio_adapter import MinioAdapter as MinioAdapter
from .adapters.redis_adapter import RedisAdapter as RedisAdapter
__all__ = [
"ConnectionAwareInterface",
"ContextAwareInterface",
"JsonRepositoryInterface",
"MinioConfig",
"ObjectRepositoryInterface",
"RedisConfig",
"load_dotenv",
*adapters.__all__,
]
def __getattr__(name: str) -> object:
"""Delegate adapter lookups to adapters; lazy loading is defined there."""
if name in adapters.__all__:
return getattr(adapters, name)
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
def __dir__() -> list[str]:
"""Expose lazy adapter names in tab completion and dir()."""
return sorted(__all__)
+31 -2
View File
@@ -4,10 +4,39 @@ Adapters for various backend repositories (e.g., Redis, Minio).
This module exposes concrete implementations for repository interfaces. This module exposes concrete implementations for repository interfaces.
""" """
from .redis_adapter import RedisAdapter from __future__ import annotations
from .minio_adapter import MinioAdapter
import importlib
from typing import TYPE_CHECKING
# Adapters are imported only for static type checkers; runtime loading is deferred below.
if TYPE_CHECKING:
from .minio_adapter import MinioAdapter
from .redis_adapter import RedisAdapter
# Map public adapter names to their defining module and class.
# Each adapter module fails fast with an install hint if its extra is missing.
# When adding a new adapter, update this dict and __all__ only.
_LAZY_EXPORTS = {
"RedisAdapter": (".redis_adapter", "RedisAdapter"),
"MinioAdapter": (".minio_adapter", "MinioAdapter"),
}
__all__ = [ __all__ = [
"RedisAdapter", "RedisAdapter",
"MinioAdapter", "MinioAdapter",
] ]
def __getattr__(name: str) -> object:
"""Load an adapter on first access so the base package installs without backend clients."""
if name in _LAZY_EXPORTS:
module_path, attr = _LAZY_EXPORTS[name]
module = importlib.import_module(module_path, __package__)
return getattr(module, attr)
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
def __dir__() -> list[str]:
"""Expose lazy adapter names in tab completion and dir()."""
return sorted(__all__)
@@ -0,0 +1,80 @@
"""Shared connection lifecycle behavior for repository adapters."""
from __future__ import annotations
import time
from abc import abstractmethod
from typing import Self
import structlog
from python_repositories.interfaces import (
ConnectionAwareInterface,
ContextAwareInterface,
)
class ConnectionAwareAdapter(ConnectionAwareInterface, ContextAwareInterface):
"""Base adapter with context-manager and TTL-cached connection health checks."""
health_check_ttl_seconds: float = 1.0
connection_name: str = ""
def __init__(self) -> None:
self.logger = structlog.get_logger(self.__class__.__name__)
self._health_check_at: float | None = None
self._health_check_ok: bool = False
def __enter__(self) -> Self:
"""Enter the context."""
self.connect()
return self
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None:
"""Exit the context."""
ctx_info = {"exc_type": exc_type, "exc_val": exc_val, "exc_tb": exc_tb}
if any(
(
exc_type is not None,
exc_val is not None,
exc_tb is not None,
),
):
self.logger.error("Error while exiting context", **ctx_info)
self.disconnect()
def _invalidate_health_cache(self) -> None:
self._health_check_at = None
self._health_check_ok = False
@abstractmethod
def _is_client_ready(self) -> bool:
"""Return True when internal state is sufficient for a probe."""
@abstractmethod
def _probe_connection(self) -> bool:
"""Backend-specific liveness check; called only when client is ready."""
def is_connected(self) -> bool:
"""Check if connected to the backend."""
if not self._is_client_ready():
return False
now = time.monotonic()
if self._health_check_at is not None:
seconds_since_last_health_check = now - self._health_check_at
cache_is_fresh = (
seconds_since_last_health_check < self.health_check_ttl_seconds
)
if cache_is_fresh:
return self._health_check_ok
result = self._probe_connection()
self._health_check_at = now
self._health_check_ok = result
self.logger.debug("Connection status", connected=result)
return result
def _require_connected(self) -> None:
if not self.is_connected():
raise ConnectionError(f"Not connected to {self.connection_name}")
+80 -83
View File
@@ -1,119 +1,114 @@
"""Definition of MinioAdapter class.""" """Definition of MinioAdapter class."""
from __future__ import annotations from __future__ import annotations
import os
from io import BytesIO from io import BytesIO
from importlib.util import find_spec
import structlog
from python_utils import check_env
from python_repositories.interfaces import ( from python_repositories.adapters.connection_aware_adapter import (
ContextAwareInterface, ConnectionAwareAdapter,
ConnectionAwareInterface,
) )
from python_repositories.config import MinioConfig
from python_repositories.interfaces import ObjectRepositoryInterface
# Handle optional dependencies try:
if find_spec("minio") is not None:
import minio import minio
except ImportError as exc:
raise ImportError(
"MinIO support requires the minio extra. "
"Install with: pip install python-repositories[minio]"
) from exc
class MinioAdapter( class MinioAdapter(ObjectRepositoryInterface, ConnectionAwareAdapter):
ContextAwareInterface,
ConnectionAwareInterface,
):
"""Minio adapter exposing basic CRUD functionality.""" """Minio adapter exposing basic CRUD functionality."""
endpoint_env_var_name: str = "MINIO_ENDPOINT" endpoint_env_var_name: str = "MINIO_ENDPOINT"
access_key_env_var_name: str = "MINIO_ACCESS_KEY" access_key_env_var_name: str = "MINIO_ACCESS_KEY"
secret_key_env_var_name: str = "MINIO_SECRET_KEY" secret_key_env_var_name: str = "MINIO_SECRET_KEY"
bucket_env_var_name: str = "MINIO_BUCKET" bucket_env_var_name: str = "MINIO_BUCKET"
secure_env_var_name: str = "MINIO_SECURE"
chunk_size: int = 5 * 2**20 # 5 MiB chunk_size: int = 5 * 2**20 # 5 MiB
connection_name: str = "Minio"
def __init__(self) -> None: def __init__(
# Setup logger self,
self.logger = structlog.get_logger( *,
self.__class__.__name__, config: MinioConfig | None = None,
) client: minio.Minio | None = None,
# Check environment variables ) -> None:
check_env( super().__init__()
{ if config is None:
if client is not None:
raise ValueError("config is required when client is provided")
config = MinioConfig.from_env(
self.endpoint_env_var_name, self.endpoint_env_var_name,
self.access_key_env_var_name, self.access_key_env_var_name,
self.secret_key_env_var_name, self.secret_key_env_var_name,
self.bucket_env_var_name, self.bucket_env_var_name,
}, self.secure_env_var_name,
) )
# Prepare internal variables self._config = config
self._client: minio.Minio | None = None self._client_injected = client is not None
self._bucket_name: str | None = None self._client: minio.Minio | None = client
self._bucket_name: str | None = config.bucket if client is not None else None
if self._client_injected:
self._invalidate_health_cache()
def __enter__(self) -> MinioAdapter: def _is_client_ready(self) -> bool:
"""Enter the context.""" return self._client is not None and self._bucket_name is not None
self.connect()
return self
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None:
"""Exit the context."""
ctx_info = {"exc_type": exc_type, "exc_val": exc_val, "exc_tb": exc_tb}
if any(
(
exc_type is not None,
exc_val is not None,
exc_tb is not None,
),
):
self.logger.error("Error while exiting context", **ctx_info)
self.disconnect()
def connect(self) -> None: def connect(self) -> None:
"""Connect to the Minio server.""" """Connect to the Minio server."""
# Stop if already connected if self._client_injected:
if self.is_connected: if self._client is not None:
try:
_ = self._client.list_buckets()
except Exception as exc: # pylint: disable=broad-except
raise ConnectionError(
f"Could not connect to Minio at {self._config.endpoint}"
) from exc
self._invalidate_health_cache()
return
if self._client is not None and self.is_connected():
self.logger.info("Already connected to Minio") self.logger.info("Already connected to Minio")
return return
# Prepare arguments if self._client is not None:
endpoint = str(os.getenv(self.endpoint_env_var_name)) self.disconnect()
access_key = str(os.getenv(self.access_key_env_var_name)) endpoint = self._config.endpoint
secret_key = str(os.getenv(self.secret_key_env_var_name)) access_key = self._config.access_key
bucket = str(os.getenv(self.bucket_env_var_name)) secret_key = self._config.secret_key
# Connect client bucket = self._config.bucket
client = minio.Minio( client = minio.Minio(
endpoint=endpoint, endpoint=endpoint,
access_key=access_key, access_key=access_key,
secret_key=secret_key, secret_key=secret_key,
secure=False, secure=self._config.secure,
) )
# Test the connection by listing buckets (will raise if connection fails)
try: try:
_ = client.list_buckets() _ = client.list_buckets()
except Exception as exc: # pylint: disable=broad-except except Exception as exc: # pylint: disable=broad-except
raise ConnectionError(f"Could not connect to Minio at {endpoint}") from exc raise ConnectionError(f"Could not connect to Minio at {endpoint}") from exc
# Ensure bucket exists
if not client.bucket_exists(bucket): if not client.bucket_exists(bucket):
self.logger.info(f"Creating bucket '{bucket}'") self.logger.info(f"Creating bucket '{bucket}'")
client.make_bucket(bucket) client.make_bucket(bucket)
# Persist information
self._client = client self._client = client
self._bucket_name = bucket self._bucket_name = bucket
self._invalidate_health_cache()
def disconnect(self) -> None: def disconnect(self) -> None:
"""Disconnect from the Minio server.""" """Disconnect from the Minio server."""
# Close connection # N.B. Minio client does not have a close method, but we include this for symmetry
# N.B. Minio client does not have a close method, but we include this for symmetry with other adapters
# Reset client
self._client = None self._client = None
self._bucket_name = None self._bucket_name = None
self._invalidate_health_cache()
@property def _probe_connection(self) -> bool:
def is_connected(self) -> bool: assert self._client is not None and self._bucket_name is not None
"""Check if connected to Minio server.""" try:
res = bool(isinstance(self._client, minio.Minio)) return bool(self._client.bucket_exists(self._bucket_name))
self.logger.debug(res) except Exception: # pylint: disable=broad-except
return res return False
def _put( def put(
self, self,
object_name: str, object_name: str,
data: BytesIO, data: BytesIO,
@@ -128,8 +123,8 @@ class MinioAdapter(
if not isinstance(content_type, str) or len(content_type) == 0: if not isinstance(content_type, str) or len(content_type) == 0:
raise ValueError("content_type must be a non-empty string") raise ValueError("content_type must be a non-empty string")
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Minio") assert self._client is not None and self._bucket_name is not None
# Prepare buffer for reading # Prepare buffer for reading
num_bytes = data.getbuffer().nbytes num_bytes = data.getbuffer().nbytes
data.seek(0) data.seek(0)
@@ -147,16 +142,17 @@ class MinioAdapter(
f"Put object '{object_name}' into bucket '{self._bucket_name}'" f"Put object '{object_name}' into bucket '{self._bucket_name}'"
) )
def _get(self, object_name: str) -> BytesIO | None: def get(self, object_name: str) -> BytesIO | None:
"""Get an object from the Minio bucket.""" """Get an object from the Minio bucket."""
# Check input # Check input
if not isinstance(object_name, str) or len(object_name) == 0: if not isinstance(object_name, str) or len(object_name) == 0:
raise ValueError("object_name must be a non-empty string") raise ValueError("object_name must be a non-empty string")
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Minio") assert self._client is not None and self._bucket_name is not None
# Get data from bucket # Get data from bucket
# N.B. bucket name is set when connecting # N.B. bucket name is set when connecting
response = None
try: try:
response = self._client.get_object( response = self._client.get_object(
bucket_name=self._bucket_name, bucket_name=self._bucket_name,
@@ -176,20 +172,21 @@ class MinioAdapter(
self.logger.warning( self.logger.warning(
f"Object '{object_name}' not found in bucket '{self._bucket_name}'" f"Object '{object_name}' not found in bucket '{self._bucket_name}'"
) )
else: return None
self.logger.error(repr(exc)) raise
except Exception as exc: # pylint: disable=broad-except finally:
self.logger.error(repr(exc)) if response is not None:
return None response.close()
response.release_conn()
def _delete(self, object_name: str) -> None: def delete(self, object_name: str) -> None:
"""Delete an object from the Minio bucket.""" """Delete an object from the Minio bucket."""
# Check input # Check input
if not isinstance(object_name, str) or len(object_name) == 0: if not isinstance(object_name, str) or len(object_name) == 0:
raise ValueError("object_name must be a non-empty string") raise ValueError("object_name must be a non-empty string")
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Minio") assert self._client is not None and self._bucket_name is not None
# Delete object from bucket # Delete object from bucket
# N.B. bucket name is set when connecting # N.B. bucket name is set when connecting
self._client.remove_object( self._client.remove_object(
@@ -200,15 +197,15 @@ class MinioAdapter(
f"Deleted object '{object_name}' from bucket '{self._bucket_name}'" f"Deleted object '{object_name}' from bucket '{self._bucket_name}'"
) )
def _list_objects(self, prefix: str = "") -> list[str]: def list_objects(self, prefix: str = "") -> list[str]:
"""List objects in the Minio bucket with an optional prefix.""" """List objects in the Minio bucket with an optional prefix."""
# Check input # Check input
if not isinstance(prefix, str): if not isinstance(prefix, str):
raise ValueError("prefix must be a string") raise ValueError("prefix must be a string")
# Check connection # Check connection
# N.B. bucket name is set when connecting # N.B. bucket name is set when connecting
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Minio") assert self._client is not None and self._bucket_name is not None
# List objects in bucket # List objects in bucket
objects = self._client.list_objects( objects = self._client.list_objects(
bucket_name=self._bucket_name, bucket_name=self._bucket_name,
+101 -70
View File
@@ -1,70 +1,74 @@
"""Definition of RedisAdapter class.""" """Definition of RedisAdapter class."""
from __future__ import annotations from __future__ import annotations
from collections.abc import Iterator
from typing import cast from typing import cast
from importlib.util import find_spec
import os
import structlog
from python_utils import check_env from python_repositories.adapters.connection_aware_adapter import (
ConnectionAwareAdapter,
from python_repositories.interfaces import (
ContextAwareInterface,
ConnectionAwareInterface,
) )
from python_repositories.config import RedisConfig
from python_repositories.interfaces import JsonRepositoryInterface
# Handle optional dependencies try:
if find_spec("redis") is not None:
import redis import redis
from redis.commands.json.path import Path as RedisPath from redis.commands.json.path import Path as RedisPath
except ImportError as exc:
raise ImportError(
"Redis support requires the redis extra. "
"Install with: pip install python-repositories[redis]"
) from exc
class RedisAdapter( class RedisAdapter(JsonRepositoryInterface, ConnectionAwareAdapter):
ContextAwareInterface,
ConnectionAwareInterface,
):
"""Redis adapter exposing basic CRUD functionality.""" """Redis adapter exposing basic CRUD functionality."""
uri_env_var_name: str = "REDIS_URI" uri_env_var_name: str = "REDIS_URI"
path: str = "." # JSON root path, updated in __init__ path: str = "." # JSON root path, updated in __init__
encoding: str = "UTF-8" encoding: str = "UTF-8"
connection_name: str = "Redis"
def __init__(self) -> None: def __init__(
# Setup logger self,
self.logger = structlog.get_logger( *,
self.__class__.__name__, config: RedisConfig | None = None,
) client: redis.Redis | None = None,
# Check environment variables
check_env(self.uri_env_var_name)
# Prepare internal variables
self._client: redis.Redis | None = None
self.path: str = RedisPath.root_path()
def __enter__(self) -> RedisAdapter:
"""Enter the context."""
self.connect()
return self
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None: ) -> None:
"""Exit the context.""" super().__init__()
ctx_info = {"exc_type": exc_type, "exc_val": exc_val, "exc_tb": exc_tb} if config is None:
if any( if client is not None:
( raise ValueError("config is required when client is provided")
exc_type is not None, config = RedisConfig.from_env(self.uri_env_var_name)
exc_val is not None, self._config = config
exc_tb is not None, self._client_injected = client is not None
), self._client: redis.Redis | None = client
): self.path: str = RedisPath.root_path()
self.logger.error("Error while exiting context", **ctx_info) if self._client_injected:
self.disconnect() self._invalidate_health_cache()
def _is_client_ready(self) -> bool:
return self._client is not None
def connect(self) -> None: def connect(self) -> None:
"""Connect to the Redis server.""" """Connect to the Redis server."""
# Prepare arguments if self._client_injected:
uri = str(os.getenv(self.uri_env_var_name)) if self._client is not None:
# Connect client try:
if not self._client.ping():
raise ConnectionError(
f"Could not connect to Redis at {self._config.uri}"
)
except (redis.ConnectionError, redis.TimeoutError) as exc:
raise ConnectionError(
f"Could not connect to Redis at {self._config.uri}"
) from exc
self._invalidate_health_cache()
return
if self._client is not None:
self._client.close()
self._client = None
self._invalidate_health_cache()
uri = self._config.uri
try: try:
client = redis.Redis.from_url( client = redis.Redis.from_url(
url=uri, url=uri,
@@ -74,25 +78,24 @@ class RedisAdapter(
raise ConnectionError(f"Could not connect to Redis at {uri}") raise ConnectionError(f"Could not connect to Redis at {uri}")
except (redis.ConnectionError, redis.TimeoutError) as exc: except (redis.ConnectionError, redis.TimeoutError) as exc:
raise ConnectionError(f"Could not connect to Redis at {uri}") from exc raise ConnectionError(f"Could not connect to Redis at {uri}") from exc
# Persist client
self._client = client self._client = client
self._invalidate_health_cache()
def disconnect(self) -> None: def disconnect(self) -> None:
"""Disconnect from the Redis server.""" """Disconnect from the Redis server."""
# Close connection if self._client is not None and not self._client_injected:
if self._client is not None:
self._client.close() self._client.close()
# Reset client
self._client = None self._client = None
self._invalidate_health_cache()
@property def _probe_connection(self) -> bool:
def is_connected(self) -> bool: assert self._client is not None
"""Check if connected to Redis server.""" try:
res = bool(isinstance(self._client, redis.Redis)) return bool(self._client.ping())
self.logger.debug(res) except (redis.ConnectionError, redis.TimeoutError):
return res return False
def _set(self, key: str, data: dict) -> None: def set(self, key: str, data: dict) -> None:
"""Set a JSON object in Redis.""" """Set a JSON object in Redis."""
# Check input # Check input
if not isinstance(key, str) or len(key) == 0: if not isinstance(key, str) or len(key) == 0:
@@ -100,20 +103,20 @@ class RedisAdapter(
if not isinstance(data, dict) or len(data) == 0: if not isinstance(data, dict) or len(data) == 0:
raise ValueError("Data must be a non-empty dictionary") raise ValueError("Data must be a non-empty dictionary")
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Redis") assert self._client is not None
# Set data # Set data
self._client.json().set(key, self.path, data) self._client.json().set(key, self.path, data)
self.logger.debug(f"Set {key} to {data}") self.logger.debug(f"Set {key} to {data}")
def _get(self, key: str) -> dict | None: def get(self, key: str) -> dict | None:
"""Get a JSON object from Redis.""" """Get a JSON object from Redis."""
# Check input # Check input
if not isinstance(key, str) or len(key) == 0: if not isinstance(key, str) or len(key) == 0:
raise ValueError("Key must be a non-empty string") raise ValueError("Key must be a non-empty string")
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Redis") assert self._client is not None
# Get data # Get data
data = cast( data = cast(
dict | None, dict | None,
@@ -122,26 +125,28 @@ class RedisAdapter(
self.logger.debug(f"Got {data} from {key}") self.logger.debug(f"Got {data} from {key}")
return data return data
def _delete(self, key: str) -> None: def delete(self, key: str) -> None:
"""Delete data from Redis.""" """Delete data from Redis."""
# Check input # Check input
if not isinstance(key, str) or len(key) == 0: if not isinstance(key, str) or len(key) == 0:
raise ValueError("Key must be a non-empty string") raise ValueError("Key must be a non-empty string")
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Redis") assert self._client is not None
# Delete data # Delete data
self._client.json().delete(key) self._client.json().delete(key)
self.logger.debug(f"Deleted {key}") self.logger.debug(f"Deleted {key}")
def _list_keys(self, pattern: str) -> list[str]: def _validate_pattern(self, pattern: str) -> None:
"""List keys in Redis matching a pattern."""
# Check input
if not isinstance(pattern, str) or len(pattern) == 0: if not isinstance(pattern, str) or len(pattern) == 0:
raise ValueError("Pattern must be a non-empty string") raise ValueError("Pattern must be a non-empty string")
def list_keys(self, pattern: str) -> list[str]:
"""List keys in Redis using KEYS; may block on large datasets."""
self._validate_pattern(pattern)
# Check connection # Check connection
if self._client is None or not self.is_connected: self._require_connected()
raise ConnectionError("Not connected to Redis") assert self._client is not None
# List keys # List keys
keys_raw = cast( keys_raw = cast(
list[bytes], list[bytes],
@@ -150,3 +155,29 @@ class RedisAdapter(
keys: list[str] = [key.decode(self.encoding) for key in keys_raw] keys: list[str] = [key.decode(self.encoding) for key in keys_raw]
self.logger.debug(f"Got {keys} matching {pattern}") self.logger.debug(f"Got {keys} matching {pattern}")
return keys return keys
def scan_keys(
self,
pattern: str,
*,
count: int | None = None,
) -> Iterator[str]:
"""Yield keys in Redis using SCAN to avoid blocking large datasets."""
self._validate_pattern(pattern)
self._require_connected()
assert self._client is not None
client = self._client
def _decode(key: bytes | str) -> str:
return key if isinstance(key, str) else key.decode(self.encoding)
def _iter() -> Iterator[str]:
scan_iter = (
client.scan_iter(match=pattern, count=count)
if count is not None
else client.scan_iter(match=pattern)
)
for key_raw in scan_iter:
yield _decode(key_raw)
return _iter()
+9
View File
@@ -0,0 +1,9 @@
from .dotenv_loader import load_dotenv as load_dotenv
from .minio_config import MinioConfig as MinioConfig
from .redis_config import RedisConfig as RedisConfig
__all__ = [
"MinioConfig",
"RedisConfig",
"load_dotenv",
]
@@ -0,0 +1,14 @@
"""Load environment variables from a .env file."""
from __future__ import annotations
from pathlib import Path
from dotenv import load_dotenv as _load_dotenv
def load_dotenv(path: str | Path | None = None) -> bool:
"""Load .env into os.environ. Idempotent; returns True if a file was loaded."""
if path is None:
return bool(_load_dotenv())
return bool(_load_dotenv(path))
@@ -0,0 +1,65 @@
"""MinIO connection configuration."""
from __future__ import annotations
import os
from dataclasses import dataclass
from python_utils import check_env
from python_repositories.config.dotenv_loader import load_dotenv
_TRUTHY = frozenset({"1", "true", "yes", "on"})
_FALSY = frozenset({"0", "false", "no", "off"})
def _env_bool(name: str, default: bool) -> bool:
raw = os.getenv(name)
if raw is None:
return default
normalized = raw.strip().lower()
if normalized in _TRUTHY:
return True
if normalized in _FALSY:
return False
raise ValueError(f"Invalid boolean value for {name}: {raw!r}")
@dataclass(frozen=True)
class MinioConfig:
"""Configuration for connecting to MinIO."""
endpoint: str
access_key: str
secret_key: str
bucket: str
secure: bool = True
@classmethod
def from_env(
cls,
endpoint_env_var_name: str = "MINIO_ENDPOINT",
access_key_env_var_name: str = "MINIO_ACCESS_KEY",
secret_key_env_var_name: str = "MINIO_SECRET_KEY",
bucket_env_var_name: str = "MINIO_BUCKET",
secure_env_var_name: str = "MINIO_SECURE",
*,
use_dotenv: bool = True,
) -> MinioConfig:
"""Load configuration from environment variables."""
if use_dotenv:
load_dotenv()
env_var_names = {
endpoint_env_var_name,
access_key_env_var_name,
secret_key_env_var_name,
bucket_env_var_name,
}
check_env(env_var_names)
return cls(
endpoint=str(os.getenv(endpoint_env_var_name)),
access_key=str(os.getenv(access_key_env_var_name)),
secret_key=str(os.getenv(secret_key_env_var_name)),
bucket=str(os.getenv(bucket_env_var_name)),
secure=_env_bool(secure_env_var_name, default=True),
)
@@ -0,0 +1,30 @@
"""Redis connection configuration."""
from __future__ import annotations
import os
from dataclasses import dataclass
from python_utils import check_env
from python_repositories.config.dotenv_loader import load_dotenv
@dataclass(frozen=True)
class RedisConfig:
"""Configuration for connecting to Redis."""
uri: str
@classmethod
def from_env(
cls,
uri_env_var_name: str = "REDIS_URI",
*,
use_dotenv: bool = True,
) -> RedisConfig:
"""Load configuration from environment variables."""
if use_dotenv:
load_dotenv()
check_env(uri_env_var_name)
return cls(uri=str(os.getenv(uri_env_var_name)))
+1
View File
@@ -0,0 +1 @@
"""Example domain repositories built on technology adapters."""
@@ -0,0 +1,23 @@
"""Example domain repository backed by MinIO objects."""
from io import BytesIO
from python_repositories.adapters.minio_adapter import MinioAdapter
class ArtifactObjectRepository(MinioAdapter):
"""Example: domain repository backed by MinIO objects."""
def _object_name(self, artifact_id: str) -> str:
return f"artifacts/{artifact_id}"
def get_artifact(self, artifact_id: str) -> BytesIO | None:
return self.get(self._object_name(artifact_id))
def store_artifact(
self,
artifact_id: str,
data: BytesIO,
content_type: str = "application/octet-stream",
) -> None:
self.put(self._object_name(artifact_id), data, content_type)
@@ -0,0 +1,19 @@
"""Example domain repository backed by Redis JSON."""
from python_repositories.adapters.redis_adapter import RedisAdapter
class UserJsonRepository(RedisAdapter):
"""Example: domain repository backed by Redis JSON."""
def _key(self, user_id: str) -> str:
return f"user:{user_id}"
def get_user(self, user_id: str) -> dict | None:
return self.get(self._key(user_id))
def save_user(self, user_id: str, user: dict) -> None:
self.set(self._key(user_id), user)
def delete_user(self, user_id: str) -> None:
self.delete(self._key(user_id))
@@ -2,8 +2,16 @@ from .connection_aware_interface import (
ConnectionAwareInterface as ConnectionAwareInterface, ConnectionAwareInterface as ConnectionAwareInterface,
) )
from .context_aware_interface import ContextAwareInterface as ContextAwareInterface from .context_aware_interface import ContextAwareInterface as ContextAwareInterface
from .json_repository_interface import (
JsonRepositoryInterface as JsonRepositoryInterface,
)
from .object_repository_interface import (
ObjectRepositoryInterface as ObjectRepositoryInterface,
)
__all__ = [ __all__ = [
"ConnectionAwareInterface", "ConnectionAwareInterface",
"ContextAwareInterface", "ContextAwareInterface",
"JsonRepositoryInterface",
"ObjectRepositoryInterface",
] ]
@@ -9,15 +9,17 @@ class ConnectionAwareInterface(ABC):
@abstractmethod @abstractmethod
def connect(self) -> None: def connect(self) -> None:
"""Connect to resource.""" """Connect to resource."""
raise NotImplementedError() ...
@abstractmethod @abstractmethod
def disconnect(self) -> None: def disconnect(self) -> None:
"""Disconnect from resource.""" """Disconnect from resource."""
raise NotImplementedError() ...
@property
@abstractmethod @abstractmethod
def is_connected(self) -> bool: def is_connected(self) -> bool:
"""Check if connected to resource.""" """Return whether the adapter has an active, reachable connection.
raise NotImplementedError()
Implementations may perform a cached network probe to verify liveness.
"""
...
@@ -1,21 +1,22 @@
"""Definition of ConnectionAwareInterface abstract base class.""" """Definition of ContextAwareInterface abstract base class."""
from __future__ import annotations from __future__ import annotations
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from typing import Self
class ContextAwareInterface(ABC): class ContextAwareInterface(ABC):
"""Interface that defined context-related methods.""" """Interface that defines context-related methods."""
@abstractmethod @abstractmethod
def __enter__(self) -> ContextAwareInterface: def __enter__(self) -> Self:
"""Enter the context.""" """Enter the context."""
raise NotImplementedError() ...
@abstractmethod @abstractmethod
def __exit__( def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None: ) -> None:
"""Exit the context.""" """Exit the context."""
raise NotImplementedError() ...
@@ -0,0 +1,38 @@
"""Definition of JsonRepositoryInterface abstract base class."""
from collections.abc import Iterator
from abc import ABC, abstractmethod
class JsonRepositoryInterface(ABC):
"""Interface that defines JSON document CRUD methods."""
@abstractmethod
def get(self, key: str) -> dict | None:
"""Get a JSON object by key."""
...
@abstractmethod
def set(self, key: str, data: dict) -> None:
"""Set a JSON object by key."""
...
@abstractmethod
def delete(self, key: str) -> None:
"""Delete a JSON object by key."""
...
@abstractmethod
def list_keys(self, pattern: str) -> list[str]:
"""List keys matching a glob pattern."""
...
def scan_keys(
self,
pattern: str,
*,
count: int | None = None,
) -> Iterator[str]:
"""Yield keys matching a glob pattern incrementally."""
del count
yield from self.list_keys(pattern)
@@ -0,0 +1,37 @@
"""Definition of ObjectRepositoryInterface abstract base class."""
from abc import ABC, abstractmethod
from io import BytesIO
class ObjectRepositoryInterface(ABC):
"""Interface that defines binary object CRUD methods."""
@abstractmethod
def get(self, object_name: str) -> BytesIO | None:
"""Get an object by name.
Returns None when the object does not exist. Raises ConnectionError when
not connected. Other backend errors propagate to the caller.
"""
...
@abstractmethod
def put(
self,
object_name: str,
data: BytesIO,
content_type: str = "application/octet-stream",
) -> None:
"""Put an object by name."""
...
@abstractmethod
def delete(self, object_name: str) -> None:
"""Delete an object by name."""
...
@abstractmethod
def list_objects(self, prefix: str = "") -> list[str]:
"""List object names with an optional prefix."""
...
+44
View File
@@ -0,0 +1,44 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=common.sh
source "${SCRIPT_DIR}/common.sh"
usage() {
echo "Usage: bump-version.sh <major|minor|patch>" >&2
echo " bump-version.sh --from-tag <vX.Y.Z>" >&2
exit 1
}
if [[ $# -lt 1 ]]; then
usage
fi
if [[ "$1" == "--from-tag" ]]; then
if [[ $# -ne 2 ]]; then
usage
fi
VERSION="${2#v}"
else
BUMP_TYPE="$1"
CURRENT=$(latest_tag_version)
VERSION=$(bump_semver "$CURRENT" "$BUMP_TYPE")
fi
set_pyproject_version "$VERSION"
if command -v uv >/dev/null 2>&1; then
uv lock
else
echo "uv not found; uv.lock was not updated" >&2
exit 1
fi
if [[ -n "${GITHUB_OUTPUT:-}" ]]; then
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
else
echo "version=${VERSION}"
fi
echo "Updated pyproject.toml and uv.lock to version ${VERSION}" >&2
+41
View File
@@ -0,0 +1,41 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=common.sh
source "${SCRIPT_DIR}/common.sh"
PR_TITLE="${1:-${PR_TITLE:-}}"
if [[ -z "$PR_TITLE" ]]; then
echo "Usage: check-pr-title.sh <pr-title> (changed files on stdin)" >&2
exit 1
fi
CHANGED_FILES=$(cat)
if ! has_source_changes "$CHANGED_FILES"; then
echo "No changes under ${SOURCE_DIR}/ — PR title prefix not required."
exit 0
fi
if title_has_bump_prefix "$PR_TITLE"; then
echo "PR title has a valid version bump prefix."
exit 0
fi
cat >&2 <<EOF
PR changes files under ${SOURCE_DIR}/ but the title lacks a version bump prefix.
Title: ${PR_TITLE}
When changing package source, start the PR title with one of:
[patch] or [fix] — bug fix
[minor] or [feat] — new feature
[major] or [breaking] — breaking change
Example: [patch] Fix connection retry in RedisAdapter
See .gitea/PULL_REQUEST_TEMPLATE.md for details.
EOF
exit 1
+89
View File
@@ -0,0 +1,89 @@
#!/usr/bin/env bash
# Shared helpers for release and PR title CI scripts.
SOURCE_DIR="python_repositories"
# Returns bump type (major|minor|patch) or empty if no valid prefix.
bump_type_from_title() {
local title="$1"
local lower
lower=$(echo "$title" | tr '[:upper:]' '[:lower:]')
if echo "$lower" | grep -qE '^\[(major|breaking)\]'; then
echo "major"
elif echo "$lower" | grep -qE '^\[(minor|feat)\]'; then
echo "minor"
elif echo "$lower" | grep -qE '^\[(patch|fix)\]'; then
echo "patch"
fi
}
title_has_bump_prefix() {
[[ -n "$(bump_type_from_title "$1")" ]]
}
strip_bump_prefix() {
local title="$1"
echo "$title" | sed -E 's/^\[(patch|fix|minor|feat|major|breaking)\][[:space:]]*//i'
}
extract_pr_title_from_merge_commit() {
local msg="$1"
echo "$msg" | sed -n "s/^Merge pull request '\(.*\)' (#.*/\1/p"
}
changed_source_files() {
grep -E "^${SOURCE_DIR}/" || true
}
has_source_changes() {
local files="$1"
echo "$files" | changed_source_files | grep -q .
}
read_pyproject_version() {
sed -n 's/^version = "\(.*\)"/\1/p' pyproject.toml | head -1
}
latest_tag_version() {
local tag
tag=$(git describe --tags --abbrev=0 2>/dev/null || true)
if [[ -n "$tag" ]]; then
echo "${tag#v}"
else
read_pyproject_version
fi
}
set_pyproject_version() {
local version="$1"
sed -i.bak -E "s/^version = \".*\"/version = \"${version}\"/" pyproject.toml
rm -f pyproject.toml.bak
}
bump_semver() {
local current="$1"
local bump_type="$2"
local major minor patch
IFS=. read -r major minor patch <<< "$current"
case "$bump_type" in
major)
major=$((major + 1))
minor=0
patch=0
;;
minor)
minor=$((minor + 1))
patch=0
;;
patch)
patch=$((patch + 1))
;;
*)
echo "Unknown bump type: $bump_type" >&2
return 1
;;
esac
echo "${major}.${minor}.${patch}"
}
+64
View File
@@ -0,0 +1,64 @@
#!/usr/bin/env bash
set -euo pipefail
: "${API_URL:?API_URL is required}"
: "${REPO_OWNER:?REPO_OWNER is required}"
: "${REPO_NAME:?REPO_NAME is required}"
: "${CI_RUNNER_TOKEN:?CI_RUNNER_TOKEN is required}"
: "${GITHUB_SERVER_URL:?GITHUB_SERVER_URL is required}"
: "${GITHUB_REPOSITORY:?GITHUB_REPOSITORY is required}"
BRANCH="${BRANCH:-renovate/auto-deps-update}"
BASE_BRANCH="${BASE_BRANCH:-main}"
LOCKFILE="${LOCKFILE:-uv.lock}"
if git diff --quiet "$LOCKFILE"; then
echo "No dependency updates available."
exit 0
fi
git config user.name "CI Bot"
git config user.email "[email protected]"
git add "$LOCKFILE"
git commit -m "chore(deps): update dependencies [automated]"
git remote set-url origin "https://x-access-token:${CI_RUNNER_TOKEN}@${GITHUB_SERVER_URL#https://}/${GITHUB_REPOSITORY}.git"
git push origin "HEAD:${BRANCH}"
if curl -s "${API_URL}/repos/${REPO_OWNER}/${REPO_NAME}/pulls?state=open" \
-H "Authorization: token ${CI_RUNNER_TOKEN}" \
| BRANCH="$BRANCH" python3 -c '
import json
import os
import sys
branch = os.environ["BRANCH"]
prs = json.load(sys.stdin)
sys.exit(0 if any(pr.get("head", {}).get("ref") == branch for pr in prs) else 1)
'; then
echo "Pull request already exists; branch push updates it."
exit 0
fi
PAYLOAD=$(BRANCH="$BRANCH" BASE_BRANCH="$BASE_BRANCH" python3 -c '
import json
import os
print(
json.dumps(
{
"title": "chore(deps): update dependencies",
"body": "This PR was created automatically to update dependencies.",
"head": os.environ["BRANCH"],
"base": os.environ["BASE_BRANCH"],
}
)
)
')
curl -sf -X POST "${API_URL}/repos/${REPO_OWNER}/${REPO_NAME}/pulls" \
-H "Authorization: token ${CI_RUNNER_TOKEN}" \
-H "Content-Type: application/json" \
-d "$PAYLOAD"
echo "Created pull request."
+16
View File
@@ -0,0 +1,16 @@
#!/usr/bin/env bash
set -euo pipefail
# Fetch the current PR title from the Gitea API.
# Requires: API_URL, REPO_OWNER, REPO_NAME, PR_NUMBER, CI_RUNNER_TOKEN
: "${API_URL:?API_URL is required}"
: "${REPO_OWNER:?REPO_OWNER is required}"
: "${REPO_NAME:?REPO_NAME is required}"
: "${PR_NUMBER:?PR_NUMBER is required}"
: "${CI_RUNNER_TOKEN:?CI_RUNNER_TOKEN is required}"
curl -sf \
"${API_URL}/repos/${REPO_OWNER}/${REPO_NAME}/pulls/${PR_NUMBER}" \
-H "Authorization: token ${CI_RUNNER_TOKEN}" \
| python3 -c 'import json, sys; print(json.load(sys.stdin)["title"])'
+54
View File
@@ -0,0 +1,54 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=common.sh
source "${SCRIPT_DIR}/common.sh"
NEW_TAG="${1:-}"
SUMMARY="${2:-}"
PREV_TAG="${3:-}"
if [[ -z "$NEW_TAG" ]]; then
echo "Usage: generate-release-notes.sh <new-tag> [summary] [prev-tag]" >&2
exit 1
fi
if [[ -z "$PREV_TAG" ]]; then
PREV_TAG=$(git describe --tags --abbrev=0 "${NEW_TAG}^" 2>/dev/null || git describe --tags --abbrev=0 2>/dev/null || true)
fi
NOTES="## Summary"
if [[ -n "$SUMMARY" ]]; then
NOTES="${NOTES}
$(strip_bump_prefix "$SUMMARY")"
else
NOTES="${NOTES}
Automated release ${NEW_TAG}."
fi
if [[ -n "$PREV_TAG" ]]; then
NOTES="${NOTES}
## Changes since ${PREV_TAG}
$(git log "${PREV_TAG}..HEAD" --pretty=format:'- %h %s' || true)"
else
NOTES="${NOTES}
## Changes
$(git log --pretty=format:'- %h %s' -20 || true)"
fi
if [[ -n "${GITHUB_OUTPUT:-}" ]]; then
{
echo 'body<<EOF'
echo "$NOTES"
echo 'EOF'
} >> "$GITHUB_OUTPUT"
else
echo "$NOTES"
fi
+36
View File
@@ -0,0 +1,36 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=common.sh
source "${SCRIPT_DIR}/common.sh"
COMMIT_MSG="${1:-${COMMIT_MSG:-}}"
if [[ -z "$COMMIT_MSG" ]]; then
echo "Usage: parse-merge-commit.sh <commit-message>" >&2
exit 1
fi
PR_TITLE=$(extract_pr_title_from_merge_commit "$COMMIT_MSG")
if [[ -z "$PR_TITLE" ]]; then
bump="skip"
else
bump_type=$(bump_type_from_title "$PR_TITLE")
if [[ -n "$bump_type" ]]; then
bump="$bump_type"
else
bump="skip"
fi
fi
if [[ -n "${GITHUB_OUTPUT:-}" ]]; then
{
echo "pr_title=${PR_TITLE}"
echo "bump=${bump}"
} >> "$GITHUB_OUTPUT"
else
echo "pr_title=${PR_TITLE}"
echo "bump=${bump}"
fi
+12
View File
@@ -0,0 +1,12 @@
"""Shared test configuration constants."""
from python_repositories.config import MinioConfig, RedisConfig
TEST_REDIS_CONFIG = RedisConfig(uri="redis://localhost:6379")
TEST_MINIO_CONFIG = MinioConfig(
endpoint="localhost:9000",
access_key="minioadmin",
secret_key="minioadmin",
bucket="test-bucket",
secure=False,
)
+31 -42
View File
@@ -1,16 +1,19 @@
"""Integration tests configuration.""" """Integration tests configuration."""
import os import logging
from collections.abc import Generator from collections.abc import Generator
import pytest import pytest
import redis import redis
import structlog import structlog
import logging
from minio import Minio from minio import Minio
from testcontainers.redis import RedisContainer
from testcontainers.minio import MinioContainer from testcontainers.minio import MinioContainer
from python_repositories.config import MinioConfig, RedisConfig
from tests.integration.redis_container_test import REDIS_PORT, RedisTestContainer
collect_ignore = ["redis_container_test.py"]
MINIO_ACCESS_KEY = "minioadmin" MINIO_ACCESS_KEY = "minioadmin"
MINIO_SECRET_KEY = "minioadmin" MINIO_SECRET_KEY = "minioadmin"
MINIO_BUCKET = "test-bucket" MINIO_BUCKET = "test-bucket"
@@ -19,7 +22,6 @@ MINIO_BUCKET = "test-bucket"
@pytest.fixture(scope="session", autouse=True) @pytest.fixture(scope="session", autouse=True)
def configure_logging() -> None: def configure_logging() -> None:
"""Configure logging for the test session.""" """Configure logging for the test session."""
# Configure structlog
structlog.configure( structlog.configure(
processors=[ processors=[
structlog.stdlib.filter_by_level, structlog.stdlib.filter_by_level,
@@ -32,40 +34,34 @@ def configure_logging() -> None:
wrapper_class=structlog.stdlib.BoundLogger, wrapper_class=structlog.stdlib.BoundLogger,
cache_logger_on_first_use=True, cache_logger_on_first_use=True,
) )
# Set up basic logging configuration
logging.basicConfig(level=logging.ERROR) logging.basicConfig(level=logging.ERROR)
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def redis_container() -> Generator[str]: def redis_container() -> Generator[str, None, None]:
"""Set up a Redis container for testing and yield the Redis URI.""" """Set up a Redis container for testing and yield the Redis URI."""
# Start container container = RedisTestContainer(
container = RedisContainer(
image="redis/redis-stack:7.2.0-v0", image="redis/redis-stack:7.2.0-v0",
) )
container.start() container.start()
# Set environment variable for Redis URI
redis_host = container.get_container_host_ip() redis_host = container.get_container_host_ip()
redis_port = container.get_exposed_port(6379) redis_port = container.get_exposed_port(REDIS_PORT)
redis_uri = f"redis://{redis_host}:{redis_port}" redis_uri = f"redis://{redis_host}:{redis_port}"
yield redis_uri yield redis_uri
# Stop container
container.stop() container.stop()
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def minio_container() -> Generator[dict[str, str]]: def minio_container() -> Generator[dict[str, str], None, None]:
"""Set up a Minio container for testing and yield the Minio URI.""" """Set up a Minio container for testing and yield connection settings."""
# Start container
container = MinioContainer( container = MinioContainer(
image="minio/minio:latest", image="minio/minio:latest",
access_key=MINIO_ACCESS_KEY, access_key=MINIO_ACCESS_KEY,
secret_key=MINIO_SECRET_KEY, secret_key=MINIO_SECRET_KEY,
) )
container.start() container.start()
# Build environment variables dictionary
minio_host = container.get_container_host_ip() minio_host = container.get_container_host_ip()
minio_port = container.get_exposed_port(9000) minio_port = container.get_exposed_port(9000)
minio_endpoint = f"{minio_host}:{minio_port}" minio_endpoint = f"{minio_host}:{minio_port}"
@@ -74,38 +70,35 @@ def minio_container() -> Generator[dict[str, str]]:
"MINIO_ACCESS_KEY": MINIO_ACCESS_KEY, "MINIO_ACCESS_KEY": MINIO_ACCESS_KEY,
"MINIO_SECRET_KEY": MINIO_SECRET_KEY, "MINIO_SECRET_KEY": MINIO_SECRET_KEY,
"MINIO_BUCKET": MINIO_BUCKET, "MINIO_BUCKET": MINIO_BUCKET,
"MINIO_SECURE": "false",
} }
yield env_vars yield env_vars
# Stop container
container.stop() container.stop()
@pytest.fixture(scope="session", autouse=True) @pytest.fixture(scope="session")
def set_environment_variables( def redis_config(redis_container: str) -> RedisConfig:
redis_container: str, """Provide RedisConfig built from the test container."""
minio_container: dict[str, str], return RedisConfig(uri=redis_container)
) -> Generator[dict[str, str]]:
"""Set environment variables needed for tests."""
# Build environment variables dictionary
env_vars = {"REDIS_URI": redis_container}
env_vars.update(minio_container)
# Set environment variables
for key, value in env_vars.items():
os.environ[key] = value
yield env_vars
# Cleanup
for key in env_vars:
_ = os.environ.pop(key, default=None)
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def raw_redis_client(redis_container: str) -> Generator[redis.Redis]: def minio_config(minio_container: dict[str, str]) -> MinioConfig:
"""Provide MinioConfig built from the test container."""
return MinioConfig(
endpoint=minio_container["MINIO_ENDPOINT"],
access_key=minio_container["MINIO_ACCESS_KEY"],
secret_key=minio_container["MINIO_SECRET_KEY"],
bucket=minio_container["MINIO_BUCKET"],
secure=False,
)
@pytest.fixture(scope="session")
def raw_redis_client(redis_container: str) -> Generator[redis.Redis, None, None]:
"""Provide a raw Redis client connected to the test Redis container.""" """Provide a raw Redis client connected to the test Redis container."""
# Connect client
client = redis.Redis.from_url( client = redis.Redis.from_url(
url=redis_container, url=redis_container,
socket_connect_timeout=10, socket_connect_timeout=10,
@@ -113,29 +106,25 @@ def raw_redis_client(redis_container: str) -> Generator[redis.Redis]:
yield client yield client
# Cleanup
client.flushall() client.flushall()
client.close() client.close()
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def raw_minio_client(minio_container: dict[str, str]) -> Generator[Minio]: def raw_minio_client(minio_container: dict[str, str]) -> Generator[Minio, None, None]:
"""Provide a raw Minio client connected to the test Minio container.""" """Provide a raw Minio client connected to the test Minio container."""
# Connect client
client = Minio( client = Minio(
endpoint=minio_container["MINIO_ENDPOINT"], endpoint=minio_container["MINIO_ENDPOINT"],
access_key=minio_container["MINIO_ACCESS_KEY"], access_key=minio_container["MINIO_ACCESS_KEY"],
secret_key=minio_container["MINIO_SECRET_KEY"], secret_key=minio_container["MINIO_SECRET_KEY"],
secure=False, secure=False,
) )
# Ensure bucket exists
bucket_name = minio_container["MINIO_BUCKET"] bucket_name = minio_container["MINIO_BUCKET"]
if not client.bucket_exists(bucket_name): if not client.bucket_exists(bucket_name):
client.make_bucket(bucket_name) client.make_bucket(bucket_name)
yield client yield client
# Cleanup
objects = client.list_objects(bucket_name, recursive=True) objects = client.list_objects(bucket_name, recursive=True)
for obj in objects: for obj in objects:
client.remove_object(bucket_name, obj.object_name) client.remove_object(bucket_name, obj.object_name)
@@ -1,119 +0,0 @@
"""Integration tests for ConnectionAwareInterface."""
import pytest
from python_repositories.interfaces.connection_aware_interface import (
ConnectionAwareInterface,
)
def test_instantiation_fails_when_connect_not_implemented() -> None:
"""Test that instantiation fails if connect is not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement connect."""
def disconnect(self) -> None:
pass
@property
def is_connected(self) -> bool:
return False
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_disconnect_not_implemented() -> None:
"""Test that instantiation fails if disconnect is not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement disconnect."""
def connect(self) -> None:
pass
@property
def is_connected(self) -> bool:
return False
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_is_connected_not_implemented() -> None:
"""Test that instantiation fails if is_connected is not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement is_connected."""
def connect(self) -> None:
pass
def disconnect(self) -> None:
pass
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_connect_raises_not_implemented_if_not_overwritten() -> None:
"""Test that connect raises NotImplementedError if not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement connect."""
def connect(self) -> None:
super().connect() # type: ignore
def disconnect(self) -> None:
pass
@property
def is_connected(self) -> bool:
return False
instance = Incomplete()
with pytest.raises(NotImplementedError):
instance.connect()
def test_disconnect_raises_not_implemented_if_not_overwritten() -> None:
"""Test that disconnect raises NotImplementedError if not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement disconnect."""
def connect(self) -> None:
pass
def disconnect(self) -> None:
super().disconnect() # type: ignore
@property
def is_connected(self) -> bool:
return False
instance = Incomplete()
with pytest.raises(NotImplementedError):
instance.disconnect()
def test_is_connected_raises_not_implemented_if_not_overwritten() -> None:
"""Test that is_connected raises NotImplementedError if not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement is_connected."""
def connect(self) -> None:
pass
def disconnect(self) -> None:
pass
@property
def is_connected(self) -> bool:
return super().is_connected # type: ignore
instance = Incomplete()
with pytest.raises(NotImplementedError):
_ = instance.is_connected
@@ -1,72 +0,0 @@
"""Integration tests for ContextAwareInterface."""
from __future__ import annotations
import pytest
from python_repositories.interfaces.context_aware_interface import ContextAwareInterface
def test_instantiation_fails_when_enter_not_implemented() -> None:
"""Test that instantiation fails if __enter__ is not implemented."""
class Incomplete(ContextAwareInterface):
"""A class that does not implement __enter__."""
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None:
pass
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_exit_not_implemented() -> None:
"""Test that instantiation fails if __exit__ is not implemented."""
class Incomplete(ContextAwareInterface):
"""A class that does not implement __exit__."""
def __enter__(self) -> Incomplete:
return self
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_enter_raises_not_implemented_if_not_overwritten() -> None:
"""Test that __enter__ raises NotImplementedError if not implemented."""
class Incomplete(ContextAwareInterface):
"""A class that does not implement __enter__."""
def __enter__(self) -> Incomplete:
super().__enter__() # type: ignore
return self
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None:
pass
instance = Incomplete()
with pytest.raises(NotImplementedError):
instance.__enter__()
def test_exit_raises_not_implemented_if_not_overwritten() -> None:
"""Test that __exit__ raises NotImplementedError if not implemented."""
class Incomplete(ContextAwareInterface):
"""A class that does not implement __exit__."""
def __enter__(self) -> ContextAwareInterface:
return self
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None:
super().__exit__(exc_type, exc_val, exc_tb) # type: ignore
instance = Incomplete()
with pytest.raises(NotImplementedError):
instance.__exit__(None, None, None)
+72
View File
@@ -0,0 +1,72 @@
"""Integration tests for example domain repositories."""
from collections.abc import Generator
from io import BytesIO
import os
import random
import pytest
from python_repositories.examples.artifact_object_repository import (
ArtifactObjectRepository,
)
from python_repositories.examples.user_json_repository import UserJsonRepository
pytestmark = pytest.mark.integration
@pytest.fixture(scope="module", autouse=True)
def set_example_env(
redis_container: str,
minio_container: dict[str, str],
) -> Generator[None, None, None]:
"""Set env vars so example repositories can use from_env() defaults."""
env_vars = {"REDIS_URI": redis_container, **minio_container}
for key, value in env_vars.items():
os.environ[key] = value
yield
for key in env_vars:
_ = os.environ.pop(key, default=None)
@pytest.fixture(scope="module")
def user_data() -> Generator[dict[str, str], None, None]:
"""Provide sample user data for tests."""
yield {"name": "Alice", "email": "[email protected]"}
@pytest.fixture(scope="module")
def artifact_data() -> Generator[BytesIO, None, None]:
"""Provide sample artifact data for tests."""
yield BytesIO(random.randbytes(2**20))
def test_user_json_repository_save_and_get(
user_data: dict[str, str],
) -> None:
"""Test that UserJsonRepository can save and retrieve a user."""
with UserJsonRepository() as repo:
repo.save_user("alice", user_data)
assert repo.get_user("alice") == user_data
def test_user_json_repository_delete(
user_data: dict[str, str],
) -> None:
"""Test that UserJsonRepository can delete a user."""
with UserJsonRepository() as repo:
repo.save_user("alice", user_data)
repo.delete_user("alice")
assert repo.get_user("alice") is None
def test_artifact_object_repository_store_and_get(
artifact_data: BytesIO,
) -> None:
"""Test that ArtifactObjectRepository can store and retrieve an artifact."""
with ArtifactObjectRepository() as repo:
repo.store_artifact("report-1", artifact_data)
received = repo.get_artifact("report-1")
assert received is not None
artifact_data.seek(0)
assert received.read() == artifact_data.read()
+114 -203
View File
@@ -1,18 +1,20 @@
# pylint: disable=protected-access
# The above line disables pylint's protected member access warnings for this file,
# allowing tests to access MinioAdapter's internal methods as needed for integration testing.
"""Integration tests for the MinioAdapter.""" """Integration tests for the MinioAdapter."""
from collections.abc import Generator from collections.abc import Generator
import pytest
from unittest.mock import MagicMock
from minio import Minio
from io import BytesIO
import random
import os
import logging import logging
from minio import S3Error import random
from io import BytesIO
from unittest.mock import MagicMock
import pytest
from minio import Minio, S3Error
from urllib3.response import BaseHTTPResponse
from python_repositories.adapters.minio_adapter import MinioAdapter from python_repositories.adapters.minio_adapter import MinioAdapter
from python_repositories.config import MinioConfig
from tests.conftest import TEST_MINIO_CONFIG
pytestmark = pytest.mark.integration
def same_data( def same_data(
@@ -20,15 +22,10 @@ def same_data(
data_b: BytesIO, data_b: BytesIO,
) -> bool: ) -> bool:
"""Check if two BytesIO-objects contain the same data.""" """Check if two BytesIO-objects contain the same data."""
assert isinstance(data_a, BytesIO)
assert isinstance(data_b, BytesIO)
# prepare for being read
data_a.seek(0) data_a.seek(0)
data_b.seek(0) data_b.seek(0)
# convert to bytes
data_a_bytes = data_a.read() data_a_bytes = data_a.read()
data_b_bytes = data_b.read() data_b_bytes = data_b.read()
# compare size
if len(data_a_bytes) != len(data_b_bytes): if len(data_a_bytes) != len(data_b_bytes):
logging.error( logging.error(
"data has different length: %s and %s", "data has different length: %s and %s",
@@ -36,7 +33,6 @@ def same_data(
len(data_b_bytes), len(data_b_bytes),
) )
return False return False
# compare content
if data_a_bytes != data_b_bytes: if data_a_bytes != data_b_bytes:
logging.error("data has different bytes") logging.error("data has different bytes")
return False return False
@@ -44,22 +40,21 @@ def same_data(
@pytest.fixture(scope="module") @pytest.fixture(scope="module")
def data() -> Generator[BytesIO]: def data() -> Generator[BytesIO, None, None]:
"""Provide a sample data bytes for tests.""" """Provide a sample data bytes for tests."""
# Generate random bytes random_bytes = random.randbytes(2**21)
random_bytes = random.randbytes(2**21) # 2 MiB
yield BytesIO(random_bytes) yield BytesIO(random_bytes)
@pytest.fixture(scope="function") @pytest.fixture(scope="function")
def data_in_minio( def data_in_minio(
raw_minio_client: Minio, raw_minio_client: Minio,
minio_config: MinioConfig,
data: BytesIO, data: BytesIO,
) -> Generator[tuple[str, BytesIO]]: ) -> Generator[tuple[str, BytesIO], None, None]:
"""Fixture to set up a known value in Minio before each test.""" """Fixture to set up a known value in Minio before each test."""
object_name = "test_object" object_name = "test_object"
bucket_name = str(os.getenv("MINIO_BUCKET")) bucket_name = minio_config.bucket
# Upload object
num_bytes = data.getbuffer().nbytes num_bytes = data.getbuffer().nbytes
data.seek(0) data.seek(0)
raw_minio_client.put_object( raw_minio_client.put_object(
@@ -69,19 +64,17 @@ def data_in_minio(
length=num_bytes, length=num_bytes,
part_size=MinioAdapter.chunk_size, part_size=MinioAdapter.chunk_size,
) )
# Reset data for reading in tests
data.seek(0) data.seek(0)
yield object_name, data yield object_name, data
# Cleanup
raw_minio_client.remove_object(bucket_name, object_name) raw_minio_client.remove_object(bucket_name, object_name)
@pytest.fixture(scope="module") @pytest.fixture(scope="module")
def minio_adapter() -> Generator[MinioAdapter]: def minio_adapter(minio_config: MinioConfig) -> Generator[MinioAdapter, None, None]:
"""Fixture to provide a connected MinioAdapter instance.""" """Fixture to provide a connected MinioAdapter instance."""
adapter = MinioAdapter() adapter = MinioAdapter(config=minio_config)
adapter.connect() adapter.connect()
yield adapter yield adapter
adapter.disconnect() adapter.disconnect()
@@ -90,10 +83,10 @@ def minio_adapter() -> Generator[MinioAdapter]:
@pytest.fixture(scope="function", autouse=True) @pytest.fixture(scope="function", autouse=True)
def clear_minio( def clear_minio(
raw_minio_client: Minio, raw_minio_client: Minio,
minio_config: MinioConfig,
) -> None: ) -> None:
"""Fixture to clear all Minio objects before each test.""" """Fixture to clear all Minio objects before each test."""
bucket_name = str(os.getenv("MINIO_BUCKET")) bucket_name = minio_config.bucket
# Clear all objects before each test
objects = raw_minio_client.list_objects(bucket_name, recursive=True) objects = raw_minio_client.list_objects(bucket_name, recursive=True)
for obj in objects: for obj in objects:
if not obj.object_name: if not obj.object_name:
@@ -101,24 +94,6 @@ def clear_minio(
raw_minio_client.remove_object(bucket_name, obj.object_name) raw_minio_client.remove_object(bucket_name, obj.object_name)
def test_should_adhere_to_interface() -> None:
"""Test that the MinioAdapter adheres to the expected interface."""
# Instantiation fails if interface not adhered to
_ = MinioAdapter()
def test_should_have_logger_when_instantiated() -> None:
"""Test that the MinioAdapter has a logger when instantiated."""
adapter = MinioAdapter()
assert hasattr(adapter, "logger")
def test_should_not_be_connected_when_instantiated() -> None:
"""Test that the MinioAdapter is not connected when instantiated."""
adapter = MinioAdapter()
assert not adapter.is_connected
def test_should_log_info_when_already_connected( def test_should_log_info_when_already_connected(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
caplog: pytest.LogCaptureFixture, caplog: pytest.LogCaptureFixture,
@@ -129,52 +104,51 @@ def test_should_log_info_when_already_connected(
assert "Already connected to Minio" in caplog.text assert "Already connected to Minio" in caplog.text
def test_should_raise_connection_error_when_unable_to_connect( def test_should_raise_connection_error_when_unable_to_connect() -> None:
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Test that the MinioAdapter raises a ConnectionError when unable to connect.""" """Test that the MinioAdapter raises a ConnectionError when unable to connect."""
# Arrange config = MinioConfig(
monkeypatch.setenv("MINIO_ENDPOINT", "invalid_uri") endpoint="invalid_uri",
adapter = MinioAdapter() access_key="minioadmin",
secret_key="minioadmin",
bucket="test-bucket",
)
adapter = MinioAdapter(config=config)
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter.connect() adapter.connect()
assert not adapter.is_connected assert not adapter.is_connected()
def test_should_log_info_when_creating_expected_bucket( def test_should_log_info_when_creating_expected_bucket(
raw_minio_client: Minio, raw_minio_client: Minio,
minio_config: MinioConfig,
caplog: pytest.LogCaptureFixture, caplog: pytest.LogCaptureFixture,
) -> None: ) -> None:
"""Test that the MinioAdapter logs info when creating the expected bucket.""" """Test that the MinioAdapter logs info when creating the expected bucket."""
# Arrange bucket_name = minio_config.bucket
bucket_name = str(os.getenv("MINIO_BUCKET"))
raw_minio_client.remove_bucket(bucket_name) raw_minio_client.remove_bucket(bucket_name)
adapter = MinioAdapter() adapter = MinioAdapter(config=minio_config)
# Act
with caplog.at_level(logging.INFO): with caplog.at_level(logging.INFO):
adapter.connect() adapter.connect()
# Assert
assert f"Creating bucket '{bucket_name}'" in caplog.text assert f"Creating bucket '{bucket_name}'" in caplog.text
def test_should_log_error_on_exception_during_exit( def test_should_log_error_on_exception_during_exit(
minio_container: dict[str, str], minio_config: MinioConfig,
caplog: pytest.LogCaptureFixture, caplog: pytest.LogCaptureFixture,
) -> None: ) -> None:
"""Test that the MinioAdapter logs an error if an exception occurs during __exit__.""" """Test that the MinioAdapter logs an error if an exception occurs during __exit__."""
try: try:
with MinioAdapter() as adapter: with MinioAdapter(config=minio_config) as adapter:
assert adapter.is_connected assert adapter.is_connected()
raise ValueError("Simulated error") raise ValueError("Simulated error")
except ValueError: except ValueError:
pass # Expected pass
# Assert error was logged
assert "Error while exiting context" in caplog.text assert "Error while exiting context" in caplog.text
def test_should_have_context_manager() -> None: def test_should_have_context_manager(minio_config: MinioConfig) -> None:
"""Test that the MinioAdapter can be used as a context manager.""" """Test that the MinioAdapter can be used as a context manager."""
with MinioAdapter() as adapter: with MinioAdapter(config=minio_config) as adapter:
assert adapter._client is not None assert adapter._client is not None
assert adapter._client is None assert adapter._client is None
@@ -184,11 +158,8 @@ def test_should_get_data(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter can get data from a bucket.""" """Test that the MinioAdapter can get data from a bucket."""
# Arrange
object_name, expected_data = data_in_minio object_name, expected_data = data_in_minio
# Act received_data = minio_adapter.get(object_name)
received_data = minio_adapter._get(object_name)
# Assert
assert received_data is not None assert received_data is not None
assert same_data(expected_data, received_data) assert same_data(expected_data, received_data)
@@ -197,11 +168,7 @@ def test_should_get_none_for_nonexistent_object(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter returns None for a nonexistent object.""" """Test that the MinioAdapter returns None for a nonexistent object."""
# Arrange received_data = minio_adapter.get("nonexistent_object")
object_name = "nonexistent_object"
# Act
received_data = minio_adapter._get(object_name)
# Assert
assert received_data is None assert received_data is None
@@ -209,48 +176,41 @@ def test_should_raise_value_error_on_invalid_get_object_name(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ValueError when getting with an invalid object name.""" """Test that the MinioAdapter raises ValueError when getting with an invalid object name."""
# Arrange
invalid_object_names = ["", 123, None] invalid_object_names = ["", 123, None]
# Act & Assert
for object_name in invalid_object_names: for object_name in invalid_object_names:
with pytest.raises(ValueError): with pytest.raises(ValueError):
minio_adapter._get(object_name) # type: ignore minio_adapter.get(object_name) # type: ignore
def test_should_raise_connection_error_on_get_when_not_connected( def test_should_raise_connection_error_on_get_when_not_connected(
minio_adapter: MinioAdapter, minio_config: MinioConfig,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ConnectionError when getting while not connected.""" """Test that the MinioAdapter raises ConnectionError when getting while not connected."""
# Arrange adapter = MinioAdapter(config=minio_config)
adapter = MinioAdapter() # not connected
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._get("some_object") adapter.get("some_object")
def test_should_log_warning_when_getting_nonexistent_object( def test_should_log_warning_when_getting_nonexistent_object(
caplog: pytest.LogCaptureFixture, caplog: pytest.LogCaptureFixture,
) -> None: ) -> None:
"""Test that the MinioAdapter logs a warning when getting a nonexistent object.""" """Test that the MinioAdapter logs a warning when getting a nonexistent object."""
# Arrange mock_client = MagicMock(spec=Minio)
adapter = MinioAdapter() mock_client.bucket_exists.return_value = True
adapter._client = MagicMock(spec=Minio) mock_client.get_object.side_effect = S3Error(
adapter._client.get_object.side_effect = S3Error( MagicMock(spec=BaseHTTPResponse),
code="NoSuchKey", "NoSuchKey",
message="", "",
resource="", "",
request_id="", "",
host_id="", "",
response="",
bucket_name="test-bucket", bucket_name="test-bucket",
object_name="missing-object", object_name="missing-object",
) )
adapter._bucket_name = "test-bucket" adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
object_name = "missing-object" object_name = "missing-object"
# Act
with caplog.at_level("WARNING"): with caplog.at_level("WARNING"):
result = adapter._get(object_name) result = adapter.get(object_name)
# Assert
assert result is None assert result is None
assert ( assert (
f"Object '{object_name}' not found in bucket '{adapter._bucket_name}'" f"Object '{object_name}' not found in bucket '{adapter._bucket_name}'"
@@ -258,71 +218,52 @@ def test_should_log_warning_when_getting_nonexistent_object(
) )
def test_should_log_error_when_getting_with_s3error_other_than_no_such_key( def test_should_reraise_s3error_other_than_no_such_key() -> None:
caplog: pytest.LogCaptureFixture, """Test that the MinioAdapter re-raises unhandled S3 errors."""
) -> None: mock_client = MagicMock(spec=Minio)
"""Test that the MinioAdapter logs an error when getting a nonexistent object.""" mock_client.bucket_exists.return_value = True
# Arrange
adapter = MinioAdapter()
adapter._client = MagicMock(spec=Minio)
other_s3error = S3Error( other_s3error = S3Error(
code="UnhandledError", MagicMock(spec=BaseHTTPResponse),
message="", "UnhandledError",
resource="", "",
request_id="", "",
host_id="", "",
response="", "",
bucket_name="test-bucket", bucket_name="test-bucket",
object_name="missing-object", object_name="missing-object",
) )
adapter._client.get_object.side_effect = other_s3error mock_client.get_object.side_effect = other_s3error
adapter._bucket_name = "test-bucket" adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
object_name = "missing-object" with pytest.raises(S3Error) as exc_info:
# Act adapter.get("missing-object")
with caplog.at_level("ERROR"): assert exc_info.value.code == "UnhandledError"
result = adapter._get(object_name)
# Assert
assert result is None
assert repr(other_s3error) in caplog.text
def test_should_log_error_when_getting_with_general_exception( def test_should_reraise_general_exception() -> None:
caplog: pytest.LogCaptureFixture, """Test that the MinioAdapter re-raises general exceptions during get."""
) -> None: mock_client = MagicMock(spec=Minio)
"""Test that the MinioAdapter logs an error when getting a nonexistent object.""" mock_client.bucket_exists.return_value = True
# Arrange
adapter = MinioAdapter()
adapter._client = MagicMock(spec=Minio)
general_exception = Exception("General failure") general_exception = Exception("General failure")
adapter._client.get_object.side_effect = general_exception mock_client.get_object.side_effect = general_exception
adapter._bucket_name = "test-bucket" adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
object_name = "missing-object" with pytest.raises(Exception, match="General failure"):
# Act adapter.get("missing-object")
with caplog.at_level("ERROR"):
result = adapter._get(object_name)
# Assert
assert result is None
assert repr(general_exception) in caplog.text
def test_should_put_data( def test_should_put_data(
data: BytesIO, data: BytesIO,
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
minio_config: MinioConfig,
) -> None: ) -> None:
"""Test that the MinioAdapter can put data into a bucket.""" """Test that the MinioAdapter can put data into a bucket."""
# Arrange
object_name = "new_test_object" object_name = "new_test_object"
received_data = minio_adapter._get(object_name) received_data = minio_adapter.get(object_name)
assert received_data is None # ensure object does not exist yet assert received_data is None
# Act minio_adapter.put(object_name, data)
minio_adapter._put(object_name, data) received_data = minio_adapter.get(object_name)
# Assert
received_data = minio_adapter._get(object_name)
assert received_data is not None assert received_data is not None
assert same_data(data, received_data) assert same_data(data, received_data)
# Cleanup minio_adapter._client.remove_object(minio_config.bucket, object_name) # type: ignore[union-attr]
bucket_name = str(os.getenv("MINIO_BUCKET"))
minio_adapter._client.remove_object(bucket_name, object_name) # type: ignore
def test_should_update_data( def test_should_update_data(
@@ -330,16 +271,13 @@ def test_should_update_data(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter can update data in a bucket.""" """Test that the MinioAdapter can update data in a bucket."""
# Arrange
object_name, _ = data_in_minio object_name, _ = data_in_minio
new_data = BytesIO(random.randbytes(2**21)) # 2 MiB new_data = BytesIO(random.randbytes(2**21))
received_data = minio_adapter._get(object_name) received_data = minio_adapter.get(object_name)
assert received_data is not None assert received_data is not None
assert not same_data(received_data, new_data) assert not same_data(received_data, new_data)
# Act minio_adapter.put(object_name, new_data)
minio_adapter._put(object_name, new_data) received_data = minio_adapter.get(object_name)
# Assert
received_data = minio_adapter._get(object_name)
assert received_data is not None assert received_data is not None
assert same_data(new_data, received_data) assert same_data(new_data, received_data)
@@ -349,25 +287,21 @@ def test_should_raise_value_error_on_invalid_put_object_name(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ValueError when putting with an invalid object name.""" """Test that the MinioAdapter raises ValueError when putting with an invalid object name."""
# Arrange
invalid_object_names = ["", 123, None] invalid_object_names = ["", 123, None]
# Act & Assert
for object_name in invalid_object_names: for object_name in invalid_object_names:
with pytest.raises(ValueError): with pytest.raises(ValueError):
minio_adapter._put(object_name, data) # type: ignore minio_adapter.put(object_name, data) # type: ignore
def test_should_raise_value_error_on_invalid_put_data( def test_should_raise_value_error_on_invalid_put_data(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ValueError when putting with invalid data.""" """Test that the MinioAdapter raises ValueError when putting with invalid data."""
# Arrange
object_name = "valid_object_name" object_name = "valid_object_name"
invalid_data = ["not_bytesio", 123, None] invalid_data = ["not_bytesio", 123, None]
# Act & Assert for invalid in invalid_data:
for data in invalid_data:
with pytest.raises(ValueError): with pytest.raises(ValueError):
minio_adapter._put(object_name, data) # type: ignore minio_adapter.put(object_name, invalid) # type: ignore
def test_should_raise_value_error_on_invalid_put_content_type( def test_should_raise_value_error_on_invalid_put_content_type(
@@ -375,25 +309,21 @@ def test_should_raise_value_error_on_invalid_put_content_type(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ValueError when putting with an invalid content type.""" """Test that the MinioAdapter raises ValueError when putting with an invalid content type."""
# Arrange
object_name = "valid_object_name" object_name = "valid_object_name"
invalid_content_types = ["", 123, None] invalid_content_types = ["", 123, None]
# Act & Assert
for content_type in invalid_content_types: for content_type in invalid_content_types:
with pytest.raises(ValueError): with pytest.raises(ValueError):
minio_adapter._put(object_name, data, content_type) # type: ignore minio_adapter.put(object_name, data, content_type) # type: ignore
def test_should_raise_connection_error_on_put_when_not_connected( def test_should_raise_connection_error_on_put_when_not_connected(
minio_config: MinioConfig,
data: BytesIO, data: BytesIO,
minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ConnectionError when putting while not connected.""" """Test that the MinioAdapter raises ConnectionError when putting while not connected."""
# Arrange adapter = MinioAdapter(config=minio_config)
adapter = MinioAdapter() # not connected
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._put("some_object", data) adapter.put("some_object", data)
def test_should_delete_object( def test_should_delete_object(
@@ -401,38 +331,30 @@ def test_should_delete_object(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter can delete an object from a bucket.""" """Test that the MinioAdapter can delete an object from a bucket."""
# Arrange
object_name, _ = data_in_minio object_name, _ = data_in_minio
received_data = minio_adapter._get(object_name) received_data = minio_adapter.get(object_name)
assert received_data is not None # ensure object exists assert received_data is not None
# Act minio_adapter.delete(object_name)
minio_adapter._delete(object_name) assert minio_adapter.get(object_name) is None
# Assert
received_data = minio_adapter._get(object_name)
assert received_data is None
def test_should_raise_value_error_on_invalid_delete_object_name( def test_should_raise_value_error_on_invalid_delete_object_name(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ValueError when deleting with an invalid object name.""" """Test that the MinioAdapter raises ValueError when deleting with an invalid object name."""
# Arrange
invalid_object_names = ["", 123, None] invalid_object_names = ["", 123, None]
# Act & Assert
for object_name in invalid_object_names: for object_name in invalid_object_names:
with pytest.raises(ValueError): with pytest.raises(ValueError):
minio_adapter._delete(object_name) # type: ignore minio_adapter.delete(object_name) # type: ignore
def test_should_raise_connection_error_on_delete_when_not_connected( def test_should_raise_connection_error_on_delete_when_not_connected(
minio_adapter: MinioAdapter, minio_config: MinioConfig,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ConnectionError when deleting while not connected.""" """Test that the MinioAdapter raises ConnectionError when deleting while not connected."""
# Arrange adapter = MinioAdapter(config=minio_config)
adapter = MinioAdapter() # not connected
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._delete("some_object") adapter.delete("some_object")
def test_should_list_objects( def test_should_list_objects(
@@ -440,14 +362,11 @@ def test_should_list_objects(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter can list objects in a bucket.""" """Test that the MinioAdapter can list objects in a bucket."""
# Arrange
object_name, _ = data_in_minio object_name, _ = data_in_minio
new_data = BytesIO(random.randbytes(2**21)) # 2 MiB new_data = BytesIO(random.randbytes(2**21))
new_data_name = "another_test_object" new_data_name = "another_test_object"
minio_adapter._put(new_data_name, new_data) minio_adapter.put(new_data_name, new_data)
# Act objects = minio_adapter.list_objects()
objects = minio_adapter._list_objects()
# Assert
assert isinstance(objects, list) assert isinstance(objects, list)
assert len(objects) == 2 assert len(objects) == 2
assert object_name in objects assert object_name in objects
@@ -459,15 +378,12 @@ def test_should_list_objects_with_prefix(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter can list objects in a bucket with a prefix.""" """Test that the MinioAdapter can list objects in a bucket with a prefix."""
# Arrange
object_name, _ = data_in_minio object_name, _ = data_in_minio
new_data = BytesIO(random.randbytes(2**21)) # 2 MiB new_data = BytesIO(random.randbytes(2**21))
new_data_name = "prefix_test_object" new_data_name = "prefix_test_object"
minio_adapter._put(new_data_name, new_data) minio_adapter.put(new_data_name, new_data)
prefix = "prefix_" prefix = "prefix_"
# Act objects = minio_adapter.list_objects(prefix)
objects = minio_adapter._list_objects(prefix)
# Assert
assert isinstance(objects, list) assert isinstance(objects, list)
assert len(objects) == 1 assert len(objects) == 1
assert new_data_name in objects assert new_data_name in objects
@@ -478,25 +394,20 @@ def test_should_raise_value_error_on_invalid_list_objects_prefix(
minio_adapter: MinioAdapter, minio_adapter: MinioAdapter,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ValueError when listing with an invalid prefix.""" """Test that the MinioAdapter raises ValueError when listing with an invalid prefix."""
# Arrange
invalid_prefixes = [123, None] invalid_prefixes = [123, None]
# Act & Assert
for prefix in invalid_prefixes: for prefix in invalid_prefixes:
with pytest.raises(ValueError): with pytest.raises(ValueError):
minio_adapter._list_objects(prefix) # type: ignore minio_adapter.list_objects(prefix) # type: ignore
def test_should_raise_connection_error_on_list_objects_when_not_connected( def test_should_raise_connection_error_on_list_objects_when_not_connected(
minio_adapter: MinioAdapter, minio_config: MinioConfig,
) -> None: ) -> None:
"""Test that the MinioAdapter raises ConnectionError when listing while not connected.""" """Test that the MinioAdapter raises ConnectionError when listing while not connected."""
# Arrange adapter = MinioAdapter(config=minio_config)
adapter = MinioAdapter() # not connected
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._list_objects() adapter.list_objects()
# allows local debugging by running file as script
if __name__ == "__main__": if __name__ == "__main__":
pytest.main(["-s", "-v", __file__]) pytest.main(["-s", "-v", __file__])
+82 -120
View File
@@ -1,17 +1,19 @@
# pylint: disable=protected-access
# The above line disables pylint's protected member access warnings for this file,
# allowing tests to access RedisAdapter's internal methods as needed for integration testing.
"""Integration tests for the RedisAdapter.""" """Integration tests for the RedisAdapter."""
from collections.abc import Generator from collections.abc import Generator
import pytest import pytest
import redis import redis
from redis.commands.json.path import Path as RedisPath from redis.commands.json.path import Path as RedisPath
from python_repositories.adapters.redis_adapter import RedisAdapter from python_repositories.adapters.redis_adapter import RedisAdapter
from python_repositories.config import RedisConfig
pytestmark = pytest.mark.integration
@pytest.fixture(scope="module") @pytest.fixture(scope="module")
def data() -> Generator[dict[str, str]]: def data() -> Generator[dict[str, str], None, None]:
"""Provide a sample data dictionary for tests.""" """Provide a sample data dictionary for tests."""
yield {"foo": "bar"} yield {"foo": "bar"}
@@ -20,7 +22,7 @@ def data() -> Generator[dict[str, str]]:
def data_in_redis( def data_in_redis(
raw_redis_client: redis.Redis, raw_redis_client: redis.Redis,
data: dict[str, str], data: dict[str, str],
) -> Generator[tuple[str, dict[str, str]]]: ) -> Generator[tuple[str, dict[str, str]], None, None]:
"""Fixture to set up a known value in Redis before each test.""" """Fixture to set up a known value in Redis before each test."""
key = "test_key" key = "test_key"
path = RedisPath.root_path() path = RedisPath.root_path()
@@ -28,14 +30,13 @@ def data_in_redis(
yield key, data yield key, data
# Cleanup
raw_redis_client.delete(key) raw_redis_client.delete(key)
@pytest.fixture(scope="module") @pytest.fixture(scope="module")
def redis_adapter(redis_container: str) -> Generator[RedisAdapter]: def redis_adapter(redis_config: RedisConfig) -> Generator[RedisAdapter, None, None]:
"""Fixture to provide a connected RedisAdapter instance.""" """Fixture to provide a connected RedisAdapter instance."""
adapter = RedisAdapter() adapter = RedisAdapter(config=redis_config)
adapter.connect() adapter.connect()
yield adapter yield adapter
adapter.disconnect() adapter.disconnect()
@@ -44,84 +45,53 @@ def redis_adapter(redis_container: str) -> Generator[RedisAdapter]:
@pytest.fixture(scope="function", autouse=True) @pytest.fixture(scope="function", autouse=True)
def clear_redis(raw_redis_client: redis.Redis) -> None: def clear_redis(raw_redis_client: redis.Redis) -> None:
"""Fixture to clear all Redis keys before each test.""" """Fixture to clear all Redis keys before each test."""
# Clear all keys before each test
raw_redis_client.flushall() raw_redis_client.flushall()
def test_should_adhere_to_interface(redis_container: str) -> None: def test_should_raise_connection_error_when_unable_to_connect() -> None:
"""Test that the RedisAdapter adheres to the expected interface."""
# Instantiation fails if interface not adhered to
_ = RedisAdapter()
def test_should_have_logger_when_instantiated(redis_container: str) -> None:
"""Test that the RedisAdapter has a logger when instantiated."""
adapter = RedisAdapter()
assert hasattr(adapter, "logger")
assert adapter.logger is not None
def test_should_not_be_connected_when_instantiated(redis_container: str) -> None:
"""Test that the RedisAdapter is not connected when instantiated."""
adapter = RedisAdapter()
assert adapter._client is None
assert not adapter.is_connected
def test_should_raise_connection_error_when_unable_to_connect(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Test that the RedisAdapter raises ConnectionError when unable to connect.""" """Test that the RedisAdapter raises ConnectionError when unable to connect."""
# Arrange adapter = RedisAdapter(config=RedisConfig(uri="redis://invalid:6379"))
monkeypatch.setenv("REDIS_URI", "redis://invalid:6379")
adapter = RedisAdapter()
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter.connect() adapter.connect()
assert adapter._client is None assert adapter._client is None
assert not adapter.is_connected assert not adapter.is_connected()
def test_connect_raises_connection_error_when_unable_to_ping( def test_connect_raises_connection_error_when_unable_to_ping(
monkeypatch: pytest.MonkeyPatch, monkeypatch: pytest.MonkeyPatch,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ConnectionError when ping fails.""" """Test that the RedisAdapter raises ConnectionError when ping fails."""
# Set an invalid URI
monkeypatch.setenv("REDIS_URI", "redis://invalid:6379")
# Monkeypatch redis.Redis.from_url to return a mock client
class MockRedis: class MockRedis:
"""A mock Redis client that simulates a failed ping.""" """A mock Redis client that simulates a failed ping."""
def ping(self) -> bool: def ping(self) -> bool:
"""Simulate a failed ping.""" return False
return False # Simulate failed ping
monkeypatch.setattr("redis.Redis.from_url", lambda *a, **kw: MockRedis()) monkeypatch.setattr("redis.Redis.from_url", lambda *a, **kw: MockRedis())
adapter = RedisAdapter() adapter = RedisAdapter(config=RedisConfig(uri="redis://invalid:6379"))
with pytest.raises(ConnectionError, match="Could not connect to Redis"): with pytest.raises(ConnectionError, match="Could not connect to Redis"):
adapter.connect() adapter.connect()
def test_should_log_error_on_exception_during_exit( def test_should_log_error_on_exception_during_exit(
redis_container: str, redis_config: RedisConfig,
caplog: pytest.LogCaptureFixture, caplog: pytest.LogCaptureFixture,
) -> None: ) -> None:
"""Test that the RedisAdapter logs an error when an exception occurs during context exit.""" """Test that the RedisAdapter logs an error when an exception occurs during context exit."""
try: try:
with RedisAdapter() as adapter: with RedisAdapter(config=redis_config) as adapter:
assert adapter.is_connected assert adapter.is_connected()
raise ValueError("Simulated error") raise ValueError("Simulated error")
except ValueError: except ValueError:
pass # Expected pass
# Assert error was logged
assert "Error while exiting context" in caplog.text assert "Error while exiting context" in caplog.text
def test_should_have_context_manager(redis_container: str) -> None: def test_should_have_context_manager(redis_config: RedisConfig) -> None:
"""Test that the RedisAdapter can be used as a context manager.""" """Test that the RedisAdapter can be used as a context manager."""
with RedisAdapter() as adapter: with RedisAdapter(config=redis_config) as adapter:
assert adapter._client is not None assert adapter._client is not None
assert adapter._client is None assert adapter._client is None
@@ -131,11 +101,8 @@ def test_should_get_value(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter can get a value.""" """Test that the RedisAdapter can get a value."""
# Arrange
key, data = data_in_redis key, data = data_in_redis
# Act value = redis_adapter.get(key)
value = redis_adapter._get(key)
# Assert
assert value is not None assert value is not None
assert value == data assert value == data
@@ -144,9 +111,7 @@ def test_should_get_none_for_missing_key(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that getting a non-existent key returns None.""" """Test that getting a non-existent key returns None."""
# Act value = redis_adapter.get("nonexistent_key")
value = redis_adapter._get("nonexistent_key")
# Assert
assert value is None assert value is None
@@ -154,23 +119,19 @@ def test_should_raise_value_error_on_invalid_get_key(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ValueError when getting with an invalid key.""" """Test that the RedisAdapter raises ValueError when getting with an invalid key."""
# Arrange
invalid_keys = ["", 123, None] invalid_keys = ["", 123, None]
# Act & Assert
for key in invalid_keys: for key in invalid_keys:
with pytest.raises(ValueError): with pytest.raises(ValueError):
redis_adapter._get(key) # type: ignore redis_adapter.get(key) # type: ignore
def test_should_raise_connection_error_on_get_when_not_connected( def test_should_raise_connection_error_on_get_when_not_connected(
redis_adapter: RedisAdapter, redis_config: RedisConfig,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ConnectionError when getting while not connected.""" """Test that the RedisAdapter raises ConnectionError when getting while not connected."""
# Arrange adapter = RedisAdapter(config=redis_config)
adapter = RedisAdapter() # not connected
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._get("some_key") adapter.get("some_key")
def test_should_set_value( def test_should_set_value(
@@ -178,14 +139,11 @@ def test_should_set_value(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter can set a value.""" """Test that the RedisAdapter can set a value."""
# Arrange
key = "test_key" key = "test_key"
received_data = redis_adapter._get(key) received_data = redis_adapter.get(key)
assert received_data is None # Ensure key does not exist assert received_data is None
# Act redis_adapter.set(key, data)
redis_adapter._set(key, data) received_data = redis_adapter.get(key)
# Assert
received_data = redis_adapter._get(key)
assert received_data is not None assert received_data is not None
assert received_data == data assert received_data == data
@@ -195,16 +153,13 @@ def test_should_update_value(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter can update an existing value.""" """Test that the RedisAdapter can update an existing value."""
# Arrange
key, _ = data_in_redis key, _ = data_in_redis
new_data = {"new_key": "new_value"} new_data = {"new_key": "new_value"}
received_data = redis_adapter._get(key) received_data = redis_adapter.get(key)
assert received_data is not None assert received_data is not None
assert received_data != new_data assert received_data != new_data
# Act redis_adapter.set(key, new_data)
redis_adapter._set(key, new_data) assert redis_adapter.get(key) == new_data
# Assert
assert redis_adapter._get(key) == new_data
def test_should_raise_value_error_on_invalid_set_key( def test_should_raise_value_error_on_invalid_set_key(
@@ -212,38 +167,31 @@ def test_should_raise_value_error_on_invalid_set_key(
data: dict[str, str], data: dict[str, str],
) -> None: ) -> None:
"""Test that the RedisAdapter raises ValueError when setting with an invalid key.""" """Test that the RedisAdapter raises ValueError when setting with an invalid key."""
# Arrange
invalid_keys = ["", 123, None] invalid_keys = ["", 123, None]
# Act & Assert
for key in invalid_keys: for key in invalid_keys:
with pytest.raises(ValueError): with pytest.raises(ValueError):
redis_adapter._set(key, data) # type: ignore redis_adapter.set(key, data) # type: ignore
def test_should_raise_value_error_on_invalid_set_data( def test_should_raise_value_error_on_invalid_set_data(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ValueError when setting with invalid data.""" """Test that the RedisAdapter raises ValueError when setting with invalid data."""
# Arrange
key = "test_key" key = "test_key"
invalid_data = ["", 123, None, [], {}] invalid_data = ["", 123, None, [], {}]
# Act & Assert
for data in invalid_data: for data in invalid_data:
with pytest.raises(ValueError): with pytest.raises(ValueError):
redis_adapter._set(key, data) # type: ignore redis_adapter.set(key, data) # type: ignore
def test_should_raise_connection_error_on_set_when_not_connected( def test_should_raise_connection_error_on_set_when_not_connected(
redis_adapter: RedisAdapter, redis_config: RedisConfig,
data: dict[str, str], data: dict[str, str],
) -> None: ) -> None:
"""Test that the RedisAdapter raises ConnectionError when setting while not connected.""" """Test that the RedisAdapter raises ConnectionError when setting while not connected."""
# Arrange adapter = RedisAdapter(config=redis_config)
adapter = RedisAdapter()
key = "test_key"
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._set(key, data) adapter.set("test_key", data)
def test_should_delete_key( def test_should_delete_key(
@@ -251,49 +199,39 @@ def test_should_delete_key(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that deleting a key removes it from Redis.""" """Test that deleting a key removes it from Redis."""
# Arrange
key, _ = data_in_redis key, _ = data_in_redis
received_data = redis_adapter._get(key) received_data = redis_adapter.get(key)
assert received_data is not None # Ensure key exists assert received_data is not None
# Act redis_adapter.delete(key)
redis_adapter._delete(key) assert redis_adapter.get(key) is None
# Assert
assert redis_adapter._get(key) is None
def test_should_raise_value_error_on_invalid_delete_key( def test_should_raise_value_error_on_invalid_delete_key(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ValueError when deleting with an invalid key.""" """Test that the RedisAdapter raises ValueError when deleting with an invalid key."""
# Arrange
invalid_keys = ["", 123, None] invalid_keys = ["", 123, None]
# Act & Assert
for key in invalid_keys: for key in invalid_keys:
with pytest.raises(ValueError): with pytest.raises(ValueError):
redis_adapter._delete(key) # type: ignore redis_adapter.delete(key) # type: ignore
def test_should_raise_connection_error_on_delete_when_not_connected( def test_should_raise_connection_error_on_delete_when_not_connected(
redis_adapter: RedisAdapter, redis_config: RedisConfig,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ConnectionError when deleting while not connected.""" """Test that the RedisAdapter raises ConnectionError when deleting while not connected."""
# Arrange adapter = RedisAdapter(config=redis_config)
adapter = RedisAdapter()
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._delete("some_key") adapter.delete("some_key")
def test_should_list_keys( def test_should_list_keys(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test listing keys matching a pattern returns correct keys.""" """Test listing keys matching a pattern returns correct keys."""
# Arrange redis_adapter.set("key1", {"a": 1})
redis_adapter._set("key1", {"a": 1}) redis_adapter.set("key2", {"b": 2})
redis_adapter._set("key2", {"b": 2}) keys = redis_adapter.list_keys("key*")
# Act
keys = redis_adapter._list_keys("key*")
# Assert
assert set(keys) == {"key1", "key2"} assert set(keys) == {"key1", "key2"}
@@ -301,25 +239,49 @@ def test_should_raise_value_error_on_invalid_list_keys_pattern(
redis_adapter: RedisAdapter, redis_adapter: RedisAdapter,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ValueError when listing keys with an invalid pattern.""" """Test that the RedisAdapter raises ValueError when listing keys with an invalid pattern."""
# Arrange
invalid_patterns = ["", 123, None] invalid_patterns = ["", 123, None]
# Act & Assert
for pattern in invalid_patterns: for pattern in invalid_patterns:
with pytest.raises(ValueError): with pytest.raises(ValueError):
redis_adapter._list_keys(pattern) # type: ignore redis_adapter.list_keys(pattern) # type: ignore
def test_should_raise_connection_error_on_list_keys_when_not_connected( def test_should_raise_connection_error_on_list_keys_when_not_connected(
redis_adapter: RedisAdapter, redis_config: RedisConfig,
) -> None: ) -> None:
"""Test that the RedisAdapter raises ConnectionError when listing keys while not connected.""" """Test that the RedisAdapter raises ConnectionError when listing keys while not connected."""
# Arrange adapter = RedisAdapter(config=redis_config)
adapter = RedisAdapter()
# Act & Assert
with pytest.raises(ConnectionError): with pytest.raises(ConnectionError):
adapter._list_keys("some_pattern") adapter.list_keys("some_pattern")
def test_should_scan_keys(
redis_adapter: RedisAdapter,
) -> None:
"""Test scanning keys matching a pattern returns correct keys."""
redis_adapter.set("key1", {"a": 1})
redis_adapter.set("key2", {"b": 2})
keys = set(redis_adapter.scan_keys("key*"))
assert keys == {"key1", "key2"}
def test_should_raise_value_error_on_invalid_scan_keys_pattern(
redis_adapter: RedisAdapter,
) -> None:
"""Test that the RedisAdapter raises ValueError when scanning keys with an invalid pattern."""
invalid_patterns = ["", 123, None]
for pattern in invalid_patterns:
with pytest.raises(ValueError):
list(redis_adapter.scan_keys(pattern)) # type: ignore[arg-type]
def test_should_raise_connection_error_on_scan_keys_when_not_connected(
redis_config: RedisConfig,
) -> None:
"""Test that the RedisAdapter raises ConnectionError when scanning keys while not connected."""
adapter = RedisAdapter(config=redis_config)
with pytest.raises(ConnectionError):
list(adapter.scan_keys("some_pattern"))
# allows local debugging by running file as script
if __name__ == "__main__": if __name__ == "__main__":
pytest.main(["-s", "-v", __file__]) pytest.main(["-s", "-v", __file__])
+36
View File
@@ -0,0 +1,36 @@
"""Redis test container without testcontainers' deprecated wait decorator."""
from typing import Any, cast
import redis
from testcontainers.core.container import DockerContainer
from testcontainers.core.waiting_utils import WaitStrategy, WaitStrategyTarget
REDIS_PORT = 6379
class _RedisPingWaitStrategy(WaitStrategy):
def __init__(self) -> None:
super().__init__()
self.with_transient_exceptions(redis.exceptions.ConnectionError)
def wait_until_ready(self, container: WaitStrategyTarget) -> None:
redis_container = cast("RedisTestContainer", container)
if not self._poll(lambda: redis_container.get_client().ping()):
raise redis.exceptions.ConnectionError("Could not connect to Redis")
class RedisTestContainer(DockerContainer):
"""Redis container using wait strategies instead of the deprecated decorator."""
def __init__(self, image: str, port: int = REDIS_PORT) -> None:
super().__init__(image, _wait_strategy=_RedisPingWaitStrategy())
self.port = port
self.with_exposed_ports(self.port)
def get_client(self, **kwargs: Any) -> redis.Redis:
return redis.Redis(
host=self.get_container_host_ip(),
port=self.get_exposed_port(self.port),
**kwargs,
)
+140
View File
@@ -0,0 +1,140 @@
"""Unit tests for lazy adapter loading in adapters subpackage."""
from __future__ import annotations
import builtins
import importlib
import os
import subprocess
import sys
from collections.abc import Callable, Mapping, Sequence
from pathlib import Path
from types import ModuleType
from unittest.mock import patch
import pytest
import python_repositories
_ROOT = Path(__file__).resolve().parents[2]
def _block_backend_import(blocked_prefix: str) -> Callable[..., ModuleType]:
real_import = builtins.__import__
def fake_import(
name: str,
globals: Mapping[str, object] | None = None,
locals: Mapping[str, object] | None = None,
fromlist: Sequence[str] = (),
level: int = 0,
) -> ModuleType:
if name == blocked_prefix or name.startswith(f"{blocked_prefix}."):
raise ImportError(f"No module named '{name}'")
return real_import(name, globals, locals, fromlist, level)
return fake_import
def test_base_import_does_not_load_adapters() -> None:
"""Base package import does not eagerly load backend adapter modules."""
script = """
import sys
from python_repositories import JsonRepositoryInterface
assert JsonRepositoryInterface is not None
assert "python_repositories.adapters.redis_adapter" not in sys.modules
assert "python_repositories.adapters.minio_adapter" not in sys.modules
"""
result = subprocess.run(
[sys.executable, "-c", script],
cwd=_ROOT,
env={**os.environ, "PYTHONPATH": str(_ROOT)},
capture_output=True,
text=True,
)
assert result.returncode == 0, result.stderr or result.stdout
def test_lazy_adapter_load_succeeds_when_extra_present() -> None:
"""Adapters load when their optional dependencies are installed."""
from python_repositories import MinioAdapter, RedisAdapter
assert RedisAdapter.__name__ == "RedisAdapter"
assert MinioAdapter.__name__ == "MinioAdapter"
def test_redis_adapter_import_error_without_extra() -> None:
"""Missing redis extra raises ImportError with install hint."""
import python_repositories.adapters.redis_adapter as redis_adapter_module
with patch.object(builtins, "__import__", new=_block_backend_import("redis")):
with pytest.raises(ImportError, match=r"python-repositories\[redis\]"):
importlib.reload(redis_adapter_module)
importlib.reload(redis_adapter_module)
def test_minio_adapter_import_error_without_extra() -> None:
"""Missing minio extra raises ImportError with install hint."""
import python_repositories.adapters.minio_adapter as minio_adapter_module
with patch.object(builtins, "__import__", new=_block_backend_import("minio")):
with pytest.raises(ImportError, match=r"python-repositories\[minio\]"):
importlib.reload(minio_adapter_module)
importlib.reload(minio_adapter_module)
def test_top_level_lazy_import_propagates_redis_import_error() -> None:
"""Top-level RedisAdapter access surfaces adapter import errors."""
with patch(
"importlib.import_module",
side_effect=ImportError(
"Redis support requires the redis extra. "
"Install with: pip install python-repositories[redis]"
),
):
with pytest.raises(ImportError, match=r"python-repositories\[redis\]"):
_ = python_repositories.RedisAdapter
def test_top_level_lazy_import_propagates_minio_import_error() -> None:
"""Top-level MinioAdapter access surfaces adapter import errors."""
with patch(
"importlib.import_module",
side_effect=ImportError(
"MinIO support requires the minio extra. "
"Install with: pip install python-repositories[minio]"
),
):
with pytest.raises(ImportError, match=r"python-repositories\[minio\]"):
_ = python_repositories.MinioAdapter
def test_adapters_subpackage_lazy_import_succeeds() -> None:
"""Adapter subpackage imports delegate to the same lazy loader."""
from python_repositories.adapters import RedisAdapter
assert RedisAdapter.__name__ == "RedisAdapter"
def test_adapters_dir_exposes_lazy_exports() -> None:
"""dir(adapters) includes lazy adapter names for tab completion."""
import python_repositories.adapters as adapters
assert {"RedisAdapter", "MinioAdapter"}.issubset(set(dir(adapters)))
def test_adapters_getattr_raises_for_unknown() -> None:
"""Unknown adapter names raise AttributeError."""
import python_repositories.adapters as adapters
with pytest.raises(AttributeError, match="has no attribute 'NoSuchAdapter'"):
_ = adapters.NoSuchAdapter
def test_top_level_dir_exposes_lazy_exports() -> None:
"""dir(python_repositories) includes lazy adapter names for tab completion."""
assert "RedisAdapter" in dir(python_repositories)
assert "MinioAdapter" in dir(python_repositories)
+27
View File
@@ -0,0 +1,27 @@
"""Unit test fixtures for mocked adapters."""
from __future__ import annotations
from unittest.mock import MagicMock
import pytest
import redis
from minio import Minio
from python_repositories.adapters.minio_adapter import MinioAdapter
from python_repositories.adapters.redis_adapter import RedisAdapter
from tests.conftest import TEST_MINIO_CONFIG, TEST_REDIS_CONFIG
@pytest.fixture
def redis_adapter() -> RedisAdapter:
"""Provide a RedisAdapter with an injected mock client."""
mock_client = MagicMock(spec=redis.Redis)
return RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
@pytest.fixture
def minio_adapter() -> MinioAdapter:
"""Provide a MinioAdapter with an injected mock client."""
mock_client = MagicMock(spec=Minio)
return MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
+163
View File
@@ -0,0 +1,163 @@
"""Unit tests for TTL-cached connection health checks on ConnectionAwareAdapter."""
from __future__ import annotations
from typing import cast
from unittest.mock import MagicMock, patch
import redis
from python_repositories.adapters.minio_adapter import MinioAdapter
from python_repositories.adapters.redis_adapter import RedisAdapter
from tests.conftest import TEST_MINIO_CONFIG, TEST_REDIS_CONFIG
class TestRedisConnectionHealth:
def test_not_connected_when_no_client(self) -> None:
adapter = RedisAdapter(config=TEST_REDIS_CONFIG)
assert not adapter.is_connected()
def test_connected_when_probe_succeeds(self, redis_adapter: RedisAdapter) -> None:
mock_client = cast(MagicMock, redis_adapter._client)
mock_client.ping.return_value = True
assert redis_adapter.is_connected()
mock_client.ping.assert_called_once()
def test_stale_connection_when_probe_fails(
self, redis_adapter: RedisAdapter
) -> None:
cast(MagicMock, redis_adapter._client).ping.side_effect = redis.ConnectionError(
"connection lost"
)
assert not redis_adapter.is_connected()
def test_cache_hit_avoids_second_probe(self, redis_adapter: RedisAdapter) -> None:
mock_client = cast(MagicMock, redis_adapter._client)
mock_client.ping.return_value = True
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
return_value=100.0,
):
assert redis_adapter.is_connected()
assert redis_adapter.is_connected()
mock_client.ping.assert_called_once()
def test_cache_miss_runs_probe_again(self, redis_adapter: RedisAdapter) -> None:
mock_client = cast(MagicMock, redis_adapter._client)
mock_client.ping.return_value = True
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
side_effect=[100.0, 102.0],
):
assert redis_adapter.is_connected()
assert redis_adapter.is_connected()
assert mock_client.ping.call_count == 2
def test_disconnect_clears_cache(self, redis_adapter: RedisAdapter) -> None:
mock_client = cast(MagicMock, redis_adapter._client)
mock_client.ping.return_value = True
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
return_value=100.0,
):
assert redis_adapter.is_connected()
redis_adapter.disconnect()
reinjected = RedisAdapter(
config=redis_adapter._config,
client=mock_client,
)
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
return_value=100.0,
):
assert reinjected.is_connected()
assert mock_client.ping.call_count == 2
class TestMinioConnectionHealth:
def test_not_connected_when_no_client(self) -> None:
adapter = MinioAdapter(config=TEST_MINIO_CONFIG)
assert not adapter.is_connected()
def test_not_connected_when_bucket_name_missing(
self, minio_adapter: MinioAdapter
) -> None:
minio_adapter._bucket_name = None
assert not minio_adapter.is_connected()
def test_connected_when_probe_succeeds(self, minio_adapter: MinioAdapter) -> None:
mock_client = cast(MagicMock, minio_adapter._client)
mock_client.bucket_exists.return_value = True
assert minio_adapter.is_connected()
mock_client.bucket_exists.assert_called_once_with("test-bucket")
def test_stale_connection_when_probe_fails(
self, minio_adapter: MinioAdapter
) -> None:
cast(MagicMock, minio_adapter._client).bucket_exists.side_effect = Exception(
"connection lost"
)
assert not minio_adapter.is_connected()
def test_cache_hit_avoids_second_probe(self, minio_adapter: MinioAdapter) -> None:
mock_client = cast(MagicMock, minio_adapter._client)
mock_client.bucket_exists.return_value = True
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
return_value=100.0,
):
assert minio_adapter.is_connected()
assert minio_adapter.is_connected()
mock_client.bucket_exists.assert_called_once()
def test_cache_miss_runs_probe_again(self, minio_adapter: MinioAdapter) -> None:
mock_client = cast(MagicMock, minio_adapter._client)
mock_client.bucket_exists.return_value = True
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
side_effect=[100.0, 102.0],
):
assert minio_adapter.is_connected()
assert minio_adapter.is_connected()
assert mock_client.bucket_exists.call_count == 2
def test_disconnect_clears_cache(self, minio_adapter: MinioAdapter) -> None:
mock_client = cast(MagicMock, minio_adapter._client)
mock_client.bucket_exists.return_value = True
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
return_value=100.0,
):
assert minio_adapter.is_connected()
minio_adapter.disconnect()
reinjected = MinioAdapter(
config=minio_adapter._config,
client=mock_client,
)
with patch(
"python_repositories.adapters.connection_aware_adapter.time.monotonic",
return_value=100.0,
):
assert reinjected.is_connected()
assert mock_client.bucket_exists.call_count == 2
@@ -0,0 +1,54 @@
"""Unit tests for ConnectionAwareInterface."""
import pytest
from python_repositories.interfaces.connection_aware_interface import (
ConnectionAwareInterface,
)
def test_instantiation_fails_when_connect_not_implemented() -> None:
"""Test that instantiation fails if connect is not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement connect."""
def disconnect(self) -> None:
pass
def is_connected(self) -> bool:
return False
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_disconnect_not_implemented() -> None:
"""Test that instantiation fails if disconnect is not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement disconnect."""
def connect(self) -> None:
pass
def is_connected(self) -> bool:
return False
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_is_connected_not_implemented() -> None:
"""Test that instantiation fails if is_connected is not implemented."""
class Incomplete(ConnectionAwareInterface):
"""A class that does not implement is_connected."""
def connect(self) -> None:
pass
def disconnect(self) -> None:
pass
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
@@ -0,0 +1,34 @@
"""Unit tests for ContextAwareInterface."""
from __future__ import annotations
import pytest
from python_repositories.interfaces.context_aware_interface import ContextAwareInterface
def test_instantiation_fails_when_enter_not_implemented() -> None:
"""Test that instantiation fails if __enter__ is not implemented."""
class Incomplete(ContextAwareInterface):
"""A class that does not implement __enter__."""
def __exit__(
self, exc_type: type | None, exc_val: object | None, exc_tb: object | None
) -> None:
pass
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_exit_not_implemented() -> None:
"""Test that instantiation fails if __exit__ is not implemented."""
class Incomplete(ContextAwareInterface):
"""A class that does not implement __exit__."""
def __enter__(self) -> Incomplete:
return self
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
+26
View File
@@ -0,0 +1,26 @@
"""Unit tests for dotenv_loader."""
from __future__ import annotations
import os
from pathlib import Path
import pytest
from python_repositories.config.dotenv_loader import load_dotenv
def test_load_dotenv_loads_file(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
env_file = tmp_path / ".env"
env_file.write_text("DOTENV_TEST_VAR=loaded_value\n")
monkeypatch.delenv("DOTENV_TEST_VAR", raising=False)
loaded = load_dotenv(env_file)
assert loaded is True
assert os.getenv("DOTENV_TEST_VAR") == "loaded_value"
def test_load_dotenv_returns_false_for_missing_file(tmp_path: Path) -> None:
missing = tmp_path / "missing.env"
assert load_dotenv(missing) is False
@@ -0,0 +1,103 @@
"""Unit tests for JsonRepositoryInterface."""
import pytest
from python_repositories.interfaces.json_repository_interface import (
JsonRepositoryInterface,
)
def test_instantiation_fails_when_get_not_implemented() -> None:
"""Test that instantiation fails if get is not implemented."""
class Incomplete(JsonRepositoryInterface):
"""A class that does not implement get."""
def set(self, key: str, data: dict) -> None:
pass
def delete(self, key: str) -> None:
pass
def list_keys(self, pattern: str) -> list[str]:
return []
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_set_not_implemented() -> None:
"""Test that instantiation fails if set is not implemented."""
class Incomplete(JsonRepositoryInterface):
"""A class that does not implement set."""
def get(self, key: str) -> dict | None:
return None
def delete(self, key: str) -> None:
pass
def list_keys(self, pattern: str) -> list[str]:
return []
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_delete_not_implemented() -> None:
"""Test that instantiation fails if delete is not implemented."""
class Incomplete(JsonRepositoryInterface):
"""A class that does not implement delete."""
def get(self, key: str) -> dict | None:
return None
def set(self, key: str, data: dict) -> None:
pass
def list_keys(self, pattern: str) -> list[str]:
return []
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_list_keys_not_implemented() -> None:
"""Test that instantiation fails if list_keys is not implemented."""
class Incomplete(JsonRepositoryInterface):
"""A class that does not implement list_keys."""
def get(self, key: str) -> dict | None:
return None
def set(self, key: str, data: dict) -> None:
pass
def delete(self, key: str) -> None:
pass
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_scan_keys_defaults_to_list_keys() -> None:
"""Test that the default scan_keys implementation delegates to list_keys."""
class Complete(JsonRepositoryInterface):
def get(self, key: str) -> dict | None:
return None
def set(self, key: str, data: dict) -> None:
pass
def delete(self, key: str) -> None:
pass
def list_keys(self, pattern: str) -> list[str]:
return [f"{pattern}-1", f"{pattern}-2"]
repository = Complete()
assert list(repository.scan_keys("user")) == ["user-1", "user-2"]
+182
View File
@@ -0,0 +1,182 @@
"""Unit tests for MinioAdapter instantiation and injection."""
from __future__ import annotations
from unittest.mock import MagicMock
import pytest
from minio import Minio, S3Error
from urllib3.response import BaseHTTPResponse
from python_repositories.adapters.minio_adapter import MinioAdapter
from python_repositories.interfaces import ObjectRepositoryInterface
from tests.conftest import TEST_MINIO_CONFIG
def test_should_adhere_to_interface() -> None:
assert issubclass(MinioAdapter, ObjectRepositoryInterface)
_ = MinioAdapter(config=TEST_MINIO_CONFIG)
def test_should_have_logger_when_instantiated() -> None:
adapter = MinioAdapter(config=TEST_MINIO_CONFIG)
assert hasattr(adapter, "logger")
assert adapter.logger is not None
def test_should_not_be_connected_when_instantiated() -> None:
adapter = MinioAdapter(config=TEST_MINIO_CONFIG)
assert not adapter.is_connected()
def test_constructs_with_injected_config_without_env(
monkeypatch: pytest.MonkeyPatch,
) -> None:
for var in (
"MINIO_ENDPOINT",
"MINIO_ACCESS_KEY",
"MINIO_SECRET_KEY",
"MINIO_BUCKET",
):
monkeypatch.delenv(var, raising=False)
adapter = MinioAdapter(config=TEST_MINIO_CONFIG)
assert adapter._config == TEST_MINIO_CONFIG
def test_injected_client_sets_bucket_name() -> None:
mock_client = MagicMock(spec=Minio)
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
assert adapter._bucket_name == "test-bucket"
assert adapter._client is mock_client
def test_raises_when_client_provided_without_config() -> None:
mock_client = MagicMock(spec=Minio)
with pytest.raises(ValueError, match="config is required"):
MinioAdapter(client=mock_client)
def test_connect_with_injected_client_succeeds() -> None:
mock_client = MagicMock(spec=Minio)
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
adapter.connect()
mock_client.list_buckets.assert_called_once()
def test_connect_with_injected_client_raises_on_failure() -> None:
mock_client = MagicMock(spec=Minio)
mock_client.list_buckets.side_effect = Exception("connection lost")
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
with pytest.raises(ConnectionError, match="Could not connect to Minio"):
adapter.connect()
def test_connect_disconnects_before_reconnect(
monkeypatch: pytest.MonkeyPatch,
) -> None:
stale_client = MagicMock(spec=Minio)
new_client = MagicMock(spec=Minio)
adapter = MinioAdapter(config=TEST_MINIO_CONFIG)
adapter._client = stale_client
adapter._bucket_name = None
monkeypatch.setattr(
"python_repositories.adapters.minio_adapter.minio.Minio",
lambda *args, **kwargs: new_client,
)
adapter.connect()
assert adapter._client is new_client
new_client.list_buckets.assert_called_once()
def test_get_closes_response_on_success() -> None:
"""get() must close and release the get_object HTTP response."""
mock_client = MagicMock(spec=Minio)
mock_client.bucket_exists.return_value = True
mock_response = MagicMock()
mock_response.read.side_effect = [b"data", b""]
mock_client.get_object.return_value = mock_response
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
result = adapter.get("some-object")
assert result is not None
assert result.read() == b"data"
mock_response.close.assert_called_once()
mock_response.release_conn.assert_called_once()
def test_get_closes_response_when_read_fails() -> None:
"""get() must close and release the response even if read() raises."""
mock_client = MagicMock(spec=Minio)
mock_client.bucket_exists.return_value = True
mock_response = MagicMock()
mock_response.read.side_effect = OSError("connection reset")
mock_client.get_object.return_value = mock_response
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
with pytest.raises(OSError, match="connection reset"):
adapter.get("some-object")
mock_response.close.assert_called_once()
mock_response.release_conn.assert_called_once()
def test_get_returns_none_for_no_such_key() -> None:
"""get() returns None when the object does not exist."""
mock_client = MagicMock(spec=Minio)
mock_client.bucket_exists.return_value = True
mock_client.get_object.side_effect = S3Error(
MagicMock(spec=BaseHTTPResponse),
"NoSuchKey",
"",
"",
"",
"",
bucket_name="test-bucket",
object_name="missing-object",
)
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
result = adapter.get("missing-object")
assert result is None
def test_get_reraises_other_s3_errors() -> None:
"""get() re-raises S3 errors other than NoSuchKey."""
mock_client = MagicMock(spec=Minio)
mock_client.bucket_exists.return_value = True
other_s3error = S3Error(
MagicMock(spec=BaseHTTPResponse),
"AccessDenied",
"",
"",
"",
"",
bucket_name="test-bucket",
object_name="some-object",
)
mock_client.get_object.side_effect = other_s3error
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
with pytest.raises(S3Error) as exc_info:
adapter.get("some-object")
assert exc_info.value.code == "AccessDenied"
def test_get_reraises_general_exception_from_get_object() -> None:
"""get() re-raises unexpected exceptions from get_object."""
mock_client = MagicMock(spec=Minio)
mock_client.bucket_exists.return_value = True
mock_client.get_object.side_effect = Exception("General failure")
adapter = MinioAdapter(config=TEST_MINIO_CONFIG, client=mock_client)
with pytest.raises(Exception, match="General failure"):
adapter.get("some-object")
+73
View File
@@ -0,0 +1,73 @@
"""Unit tests for MinioConfig."""
from __future__ import annotations
import pytest
from python_repositories.config import MinioConfig
def _set_required_minio_env(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("MINIO_ENDPOINT", "localhost:9000")
monkeypatch.setenv("MINIO_ACCESS_KEY", "access")
monkeypatch.setenv("MINIO_SECRET_KEY", "secret")
monkeypatch.setenv("MINIO_BUCKET", "my-bucket")
def test_from_env_loads_all_fields(monkeypatch: pytest.MonkeyPatch) -> None:
_set_required_minio_env(monkeypatch)
config = MinioConfig.from_env(use_dotenv=False)
assert config.endpoint == "localhost:9000"
assert config.access_key == "access"
assert config.secret_key == "secret"
assert config.bucket == "my-bucket"
assert config.secure is True
def test_from_env_defaults_secure_to_true_when_unset(
monkeypatch: pytest.MonkeyPatch,
) -> None:
_set_required_minio_env(monkeypatch)
monkeypatch.delenv("MINIO_SECURE", raising=False)
config = MinioConfig.from_env(use_dotenv=False)
assert config.secure is True
@pytest.mark.parametrize(
("value", "expected"),
[
("true", True),
("1", True),
("yes", True),
("false", False),
("0", False),
("no", False),
],
)
def test_from_env_parses_secure(
monkeypatch: pytest.MonkeyPatch,
value: str,
expected: bool,
) -> None:
_set_required_minio_env(monkeypatch)
monkeypatch.setenv("MINIO_SECURE", value)
config = MinioConfig.from_env(use_dotenv=False)
assert config.secure is expected
def test_from_env_raises_for_invalid_secure(monkeypatch: pytest.MonkeyPatch) -> None:
_set_required_minio_env(monkeypatch)
monkeypatch.setenv("MINIO_SECURE", "not-a-bool")
with pytest.raises(ValueError, match="MINIO_SECURE"):
MinioConfig.from_env(use_dotenv=False)
def test_from_env_raises_when_endpoint_missing(
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.delenv("MINIO_ENDPOINT", raising=False)
monkeypatch.setenv("MINIO_ACCESS_KEY", "access")
monkeypatch.setenv("MINIO_SECRET_KEY", "secret")
monkeypatch.setenv("MINIO_BUCKET", "my-bucket")
with pytest.raises(Exception):
MinioConfig.from_env(use_dotenv=False)
@@ -0,0 +1,99 @@
"""Unit tests for ObjectRepositoryInterface."""
from io import BytesIO
import pytest
from python_repositories.interfaces.object_repository_interface import (
ObjectRepositoryInterface,
)
def test_instantiation_fails_when_get_not_implemented() -> None:
"""Test that instantiation fails if get is not implemented."""
class Incomplete(ObjectRepositoryInterface):
"""A class that does not implement get."""
def put(
self,
object_name: str,
data: BytesIO,
content_type: str = "application/octet-stream",
) -> None:
pass
def delete(self, object_name: str) -> None:
pass
def list_objects(self, prefix: str = "") -> list[str]:
return []
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_put_not_implemented() -> None:
"""Test that instantiation fails if put is not implemented."""
class Incomplete(ObjectRepositoryInterface):
"""A class that does not implement put."""
def get(self, object_name: str) -> BytesIO | None:
return None
def delete(self, object_name: str) -> None:
pass
def list_objects(self, prefix: str = "") -> list[str]:
return []
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_delete_not_implemented() -> None:
"""Test that instantiation fails if delete is not implemented."""
class Incomplete(ObjectRepositoryInterface):
"""A class that does not implement delete."""
def get(self, object_name: str) -> BytesIO | None:
return None
def put(
self,
object_name: str,
data: BytesIO,
content_type: str = "application/octet-stream",
) -> None:
pass
def list_objects(self, prefix: str = "") -> list[str]:
return []
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
def test_instantiation_fails_when_list_objects_not_implemented() -> None:
"""Test that instantiation fails if list_objects is not implemented."""
class Incomplete(ObjectRepositoryInterface):
"""A class that does not implement list_objects."""
def get(self, object_name: str) -> BytesIO | None:
return None
def put(
self,
object_name: str,
data: BytesIO,
content_type: str = "application/octet-stream",
) -> None:
pass
def delete(self, object_name: str) -> None:
pass
with pytest.raises(TypeError):
_ = Incomplete() # type: ignore
+166
View File
@@ -0,0 +1,166 @@
"""Unit tests for RedisAdapter instantiation and injection."""
from __future__ import annotations
from unittest.mock import MagicMock
import pytest
import redis
from python_repositories.adapters.redis_adapter import RedisAdapter
from python_repositories.interfaces import JsonRepositoryInterface
from tests.conftest import TEST_REDIS_CONFIG
def test_should_adhere_to_interface() -> None:
assert issubclass(RedisAdapter, JsonRepositoryInterface)
_ = RedisAdapter(config=TEST_REDIS_CONFIG)
def test_should_have_logger_when_instantiated() -> None:
adapter = RedisAdapter(config=TEST_REDIS_CONFIG)
assert hasattr(adapter, "logger")
assert adapter.logger is not None
def test_should_not_be_connected_when_instantiated() -> None:
adapter = RedisAdapter(config=TEST_REDIS_CONFIG)
assert adapter._client is None
assert not adapter.is_connected()
def test_constructs_with_injected_config_without_env(
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.delenv("REDIS_URI", raising=False)
adapter = RedisAdapter(config=TEST_REDIS_CONFIG)
assert adapter._config == TEST_REDIS_CONFIG
def test_constructs_with_injected_client_without_env(
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.delenv("REDIS_URI", raising=False)
mock_client = MagicMock(spec=redis.Redis)
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
assert adapter._client is mock_client
assert adapter._client_injected is True
def test_raises_when_client_provided_without_config() -> None:
mock_client = MagicMock(spec=redis.Redis)
with pytest.raises(ValueError, match="config is required"):
RedisAdapter(client=mock_client)
def test_disconnect_does_not_close_injected_client() -> None:
mock_client = MagicMock(spec=redis.Redis)
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
adapter.disconnect()
mock_client.close.assert_not_called()
assert adapter._client is None
class CustomEnvRedisAdapter(RedisAdapter):
uri_env_var_name = "CUSTOM_REDIS_URI"
def test_subclass_custom_env_var_name(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("CUSTOM_REDIS_URI", "redis://custom:6379")
adapter = CustomEnvRedisAdapter()
assert adapter._config.uri == "redis://custom:6379"
def test_connect_with_injected_client_succeeds_when_ping_ok() -> None:
mock_client = MagicMock(spec=redis.Redis)
mock_client.ping.return_value = True
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
adapter.connect()
mock_client.ping.assert_called_once()
def test_connect_with_injected_client_raises_when_ping_false() -> None:
mock_client = MagicMock(spec=redis.Redis)
mock_client.ping.return_value = False
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
with pytest.raises(ConnectionError, match="Could not connect to Redis"):
adapter.connect()
def test_connect_with_injected_client_raises_on_redis_error() -> None:
mock_client = MagicMock(spec=redis.Redis)
mock_client.ping.side_effect = redis.ConnectionError("connection lost")
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
with pytest.raises(ConnectionError, match="Could not connect to Redis"):
adapter.connect()
def test_connect_closes_existing_non_injected_client(
monkeypatch: pytest.MonkeyPatch,
) -> None:
stale_client = MagicMock(spec=redis.Redis)
new_client = MagicMock(spec=redis.Redis)
new_client.ping.return_value = True
adapter = RedisAdapter(config=TEST_REDIS_CONFIG)
adapter._client = stale_client
monkeypatch.setattr("redis.Redis.from_url", lambda *args, **kwargs: new_client)
adapter.connect()
stale_client.close.assert_called_once()
assert adapter._client is new_client
def test_scan_keys_yields_decoded_keys() -> None:
mock_client = MagicMock(spec=redis.Redis)
mock_client.scan_iter.return_value = iter([b"key1", b"key2"])
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
keys = list(adapter.scan_keys("key*"))
assert keys == ["key1", "key2"]
mock_client.scan_iter.assert_called_once_with(match="key*")
mock_client.keys.assert_not_called()
def test_scan_keys_forwards_count() -> None:
mock_client = MagicMock(spec=redis.Redis)
mock_client.scan_iter.return_value = iter([b"key1"])
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
keys = list(adapter.scan_keys("key*", count=50))
assert keys == ["key1"]
mock_client.scan_iter.assert_called_once_with(match="key*", count=50)
def test_list_keys_raises_value_error_on_invalid_pattern() -> None:
mock_client = MagicMock(spec=redis.Redis)
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
invalid_patterns = ["", 123, None]
for pattern in invalid_patterns:
with pytest.raises(ValueError, match="Pattern must be a non-empty string"):
adapter.list_keys(pattern) # type: ignore[arg-type]
def test_scan_keys_raises_value_error_on_invalid_pattern() -> None:
mock_client = MagicMock(spec=redis.Redis)
adapter = RedisAdapter(config=TEST_REDIS_CONFIG, client=mock_client)
invalid_patterns = ["", 123, None]
for pattern in invalid_patterns:
with pytest.raises(ValueError, match="Pattern must be a non-empty string"):
list(adapter.scan_keys(pattern)) # type: ignore[arg-type]
def test_scan_keys_raises_connection_error_when_not_connected() -> None:
adapter = RedisAdapter(config=TEST_REDIS_CONFIG)
with pytest.raises(ConnectionError):
list(adapter.scan_keys("key*"))
+27
View File
@@ -0,0 +1,27 @@
"""Unit tests for RedisConfig."""
from __future__ import annotations
import pytest
from python_repositories.config import RedisConfig
def test_from_env_loads_uri(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("REDIS_URI", "redis://example:6379")
config = RedisConfig.from_env(use_dotenv=False)
assert config.uri == "redis://example:6379"
def test_from_env_raises_when_uri_missing(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.delenv("REDIS_URI", raising=False)
with pytest.raises(Exception):
RedisConfig.from_env(use_dotenv=False)
def test_from_env_respects_custom_env_var_name(
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.setenv("CUSTOM_REDIS_URI", "redis://custom:6379")
config = RedisConfig.from_env("CUSTOM_REDIS_URI", use_dotenv=False)
assert config.uri == "redis://custom:6379"
Generated
+1041 -739
View File
File diff suppressed because it is too large Load Diff