[FIX] Replace unmaintained pytest-dotenv with direct dotenv loading by jaseemjaskp · Pull Request #1992 · Zipstack/unstract

jaseemjaskp · 2026-05-25T13:25:53Z

What

Replace the unmaintained pytest-dotenv==0.5.2 plugin with a 4-line conftest.py that calls python-dotenv directly. Affects backend/ and prompt-service/ only.

Why

pytest-dotenv has not had a release since February 2020 (~6 years). It monkey-patches private _pytest.config.Config internals to inject its env-loading hook, which makes it a recurring break risk across pytest major upgrades (7 → 8 → 9). Surfaced as a MEDIUM finding in the review of #1981.

The plugin's entire behavior in this repo is one side effect: read env_files from [tool.pytest.ini_options] and call dotenv.load_dotenv() before collection. We can do that ourselves in 4 lines and drop a third-party dep that touches pytest internals.

How

Backend (backend/):

Removed pytest-dotenv==0.5.2 from [dependency-groups].test
Removed env_files = "test.env" from [tool.pytest.ini_options]
Added backend/conftest.py that calls load_dotenv(Path(__file__).parent / "test.env", override=False) — override=False mirrors pytest-dotenv's default of letting existing env vars win

Prompt-service (prompt-service/):

Removed pytest-dotenv==0.5.2 from [dependency-groups].test
Added prompt-service/conftest.py that calls load_dotenv(Path(__file__).parent / ".env", override=False) — pytest-dotenv's default with no env_files set is to load .env from rootdir, so this preserves exact prior behavior

python-dotenv is already in both lockfiles (transitive via unstract-sdk1 and direct in prompt-service), so no new dependency is added — pytest-dotenv is the only thing removed.

Can this PR break any existing features. If yes, please list possible items. If no, please explain why. (PS: Admins do not merge the PR without this section filled)

No behavior change expected. The new conftest.py replicates pytest-dotenv's semantics 1:1:

Behavior	pytest-dotenv	New conftest.py
When env file is loaded	Before collection (`pytest_load_initial_conftests` hook)	At top-level conftest import (also before collection)
Missing file	Silently tolerated	Silently tolerated (load_dotenv default)
Existing env var precedence	Process env wins (default)	`override=False` → process env wins
File path resolution	Relative to rootdir	`Path(__file__).parent / "file"` → service root (same place)

Possible (low-likelihood) edge cases:

If any code relied on pytest-dotenv being importable as a package (it isn't — no public API; we don't import it anywhere)
If any test runs pytest from a non-default working directory: pytest-dotenv resolved paths against rootdir; the new conftest resolves against its own location. These are the same directory in both repos.

Database Migrations

None.

Env Config

No new env vars. The same test.env (backend) and .env (prompt-service) files are still consumed.

Relevant Docs

pytest-dotenv PyPI page — confirms last release 2020
python-dotenv docs — what we now call directly

Related Issues or PRs

Follow-up to review feedback on Bump the uv group across 15 directories with 11 updates #1981 — the reviewer's MEDIUM-severity comment recommended this replacement contingent on --collect-only breakage. Collection didn't break under pytest 9 in Bump the uv group across 15 directories with 11 updates #1981, but the underlying maintenance concern is independent of that bump and worth landing on its own.

Dependencies Versions

Removed: pytest-dotenv==0.5.2
Used (existing): python-dotenv==1.0.1 (already in both lockfiles)

Notes on Testing

uv run pytest --collect-only -q from prompt-service/: 19 tests collected (same as before the change).
Standalone python-dotenv round-trip: confirmed load_dotenv(Path('.env')) correctly populates PG_BE_HOST / PG_BE_PORT from prompt-service's local .env.
All pre-commit hooks (ruff, ruff-format, pycln, pyupgrade, secret-detection) pass on the new conftest.py files.
Backend uv sync hit unrelated issues in local environment (django-celery-beat==2.5.0 wheel-zip corruption, psycopg2-binary build) — both pre-existing and unrelated to this change; CI will exercise the full backend collection.

Screenshots

N/A — config-only change.

Checklist

I have read and understood the Contribution Guidelines.

pytest-dotenv 0.5.2 has not been released since Feb 2020. It monkey-patches private pytest Config internals to inject its env-loading hook, which makes it a recurring break risk across pytest major upgrades (7 → 8 → 9). It also has open issues against newer pytest versions and no path to maintenance. The plugin's only behavior in this repo is a 1-line side effect: read 'env_files' from [tool.pytest.ini_options] and call python-dotenv before collection. Replacing it with a 4-line top-level conftest.py removes a third-party dependency that touches pytest internals, with no behavior change. Backend: - Remove pytest-dotenv from [dependency-groups].test - Remove 'env_files = "test.env"' from [tool.pytest.ini_options] - Add backend/conftest.py that calls load_dotenv(Path(__file__).parent / 'test.env', override=False) (override=False matches pytest-dotenv's default of letting existing env vars win) Prompt-service: - Remove pytest-dotenv from [dependency-groups].test - Add prompt-service/conftest.py that calls load_dotenv(Path(__file__).parent / '.env', override=False) (pytest-dotenv's default is to load '.env' from rootdir when env_files is unset, so this preserves exact previous behavior) python-dotenv is already present as a direct or transitive dependency in both packages (unstract-sdk1 pins python-dotenv==1.0.1, and prompt-service pins it directly), so no new dependency is added. Verified: - prompt-service: 'uv run pytest --collect-only -q' collects 19/19 tests cleanly, matching pre-change count. - conftest.py round-trip: load_dotenv reads .env and populates os.environ for PG_BE_HOST/PG_BE_PORT as expected. Follow-up to review feedback on #1981.

coderabbitai · 2026-05-25T13:26:08Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 54e14de9-1158-4b97-b92e-bf7c1de29762

📥 Commits

Reviewing files that changed from the base of the PR and between b83ed7d and 189b0d2.

⛔ Files ignored due to path filters (2)

backend/uv.lock is excluded by !**/*.lock
prompt-service/uv.lock is excluded by !**/*.lock

📒 Files selected for processing (1)

backend/conftest.py

Summary by CodeRabbit

Chores
- Updated test environment variable loading mechanism for improved reliability and maintainability.
- Removed unmaintained test dependency and updated test infrastructure configuration.

Walkthrough

This PR migrates test environment loading from the unmaintained pytest-dotenv plugin to direct python-dotenv configuration via pytest's conftest.py mechanism. A new conftest.py loads test.env at import time, and pyproject.toml files are updated to remove the old plugin and add explicit pytest constraints.

Changes

Test environment setup migration

Layer / File(s)	Summary
Conftest environment loading implementation `backend/conftest.py`	New conftest.py imports Path and load_dotenv, loads test.env from the backend directory at module import time with override=False to preserve ambient environment variables, and emits a debug message if the env file is not found.
Dependency and configuration updates `backend/pyproject.toml`, `prompt-service/pyproject.toml`	backend/pyproject.toml removes pytest-dotenv==0.5.2 from dev dependencies, adds pytest>=8.0.1, removes env_files setting from pytest configuration, and adds comments documenting that test.env is loaded by conftest.py via python-dotenv directly; prompt-service/pyproject.toml removes pytest-dotenv==0.5.2 from test dependencies.

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: replacing an unmaintained pytest-dotenv dependency with direct dotenv loading in conftest.py.
Description check	✅ Passed	The pull request description comprehensively covers all required template sections with detailed explanations, including what/why/how, breakage analysis, testing notes, and dependency changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch fix/replace-pytest-dotenv-with-conftest

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

greptile-apps · 2026-05-25T13:28:26Z

Greptile Summary

This PR removes the unmaintained pytest-dotenv==0.5.2 plugin from both backend/ and prompt-service/, replacing it with direct python-dotenv calls in a top-level conftest.py.

backend/: Correctly completed — backend/conftest.py is added, env_files removed from [tool.pytest.ini_options], and the lockfile is updated.
prompt-service/: Incomplete — pytest-dotenv is removed from pyproject.toml and uv.lock, but the replacement prompt-service/conftest.py described in the PR is absent from the diff and does not exist in the repository. Env vars from prompt-service/.env will not be loaded before test collection.
Lockfile changes for both services are correct and consistent with their respective pyproject.toml changes.

Confidence Score: 4/5

Safe to merge for backend; prompt-service tests will silently run without their .env loaded until the missing conftest.py is added.

The backend half of this change is complete and correct. The prompt-service half removes pytest-dotenv but omits the replacement conftest.py that was described in the PR — env vars from prompt-service/.env will not be injected before test collection, which can cause silent test failures for any test that depends on those variables.

prompt-service/pyproject.toml — the corresponding prompt-service/conftest.py is missing from the change.

Important Files Changed

Filename	Overview
backend/conftest.py	New top-level conftest that replaces pytest-dotenv for backend; correctly loads test.env with override=False and logs when the file is absent.
backend/pyproject.toml	Removes pytest-dotenv from test deps and removes env_files from pytest.ini_options, with a comment pointing to the new conftest.py.
prompt-service/pyproject.toml	Removes pytest-dotenv from test deps but the promised replacement conftest.py was never added, leaving .env loading unhooked for prompt-service tests.
backend/uv.lock	Lockfile updated to remove pytest-dotenv entry; consistent with pyproject.toml change.
prompt-service/uv.lock	Lockfile updated to remove pytest-dotenv entry; consistent with pyproject.toml change.

Sequence Diagram

sequenceDiagram
    participant pytest
    participant conftest.py
    participant load_dotenv
    participant test_env as test.env / .env
    participant tests

    Note over pytest,tests: Before (pytest-dotenv plugin)
    pytest->>pytest: pytest_load_initial_conftests hook
    pytest->>test_env: read env_files from pytest.ini
    test_env-->>pytest: env vars injected

    Note over pytest,tests: After (new conftest.py)
    pytest->>conftest.py: import conftest at startup
    conftest.py->>load_dotenv: "load_dotenv(Path / "test.env", override=False)"
    load_dotenv->>test_env: read file
    test_env-->>load_dotenv: vars
    load_dotenv-->>pytest: env vars set
    pytest->>tests: "collect & run"

Comments Outside Diff (1)

prompt-service/pyproject.toml, line 30-37 (link)

Missing prompt-service/conftest.py replacement

pytest-dotenv has been removed from the test dependencies, but the replacement prompt-service/conftest.py described in the PR is absent from both the diff and the repository. Without it, no load_dotenv() call runs before collection, so any env vars that tests rely on from prompt-service/.env will be silently missing at test time.

Prompt To Fix With AI

This is a comment left during a code review.
Path: prompt-service/pyproject.toml
Line: 30-37

Comment:
**Missing `prompt-service/conftest.py` replacement**

`pytest-dotenv` has been removed from the test dependencies, but the replacement `prompt-service/conftest.py` described in the PR is absent from both the diff and the repository. Without it, no `load_dotenv()` call runs before collection, so any env vars that tests rely on from `prompt-service/.env` will be silently missing at test time.

How can I resolve this? If you propose a fix, please make it concise.

Prompt To Fix All With AI

Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
prompt-service/pyproject.toml:30-37
**Missing `prompt-service/conftest.py` replacement**

`pytest-dotenv` has been removed from the test dependencies, but the replacement `prompt-service/conftest.py` described in the PR is absent from both the diff and the repository. Without it, no `load_dotenv()` call runs before collection, so any env vars that tests rely on from `prompt-service/.env` will be silently missing at test time.

_{Reviews (3): Last reviewed commit: "Merge branch 'main' into fix/replace-pyt..." | Re-trigger Greptile}

jaseemjaskp

Automated multi-agent review (PR Review Toolkit: Comment Analyzer, PR Test Analyzer, Silent Failure Hunter, Type Design Analyzer, Code Reviewer, Code Simplifier).

Intent is sound — dropping an unmaintained, internals-touching plugin is the right call, override=False correctly mirrors pytest-dotenv's env_override_existing_values=0 default, and python-dotenv==1.0.1 is already in both lockfiles (no new dependency). Type Design Analyzer found nothing (no new types).

Two issues, however, undercut the PR's central "preserves exact prior behavior" claim: (1) the prompt-service conftest is skipped by --noconftest in CI, and (2) the uv.lock revision was bumped 2→3 by a newer local uv than CI's pinned 0.6.14. Details inline.

PR review on #1992 surfaced three valid issues: 1. HIGH — prompt-service/conftest.py was skipped by tox's --noconftest anyway (tox.ini:62), and pytest-dotenv was effectively dead code in prompt-service to begin with: with no 'env_files' configured, the plugin defaulted to '<rootdir>/.env', and pytest's rootdir resolves to the repo root (where [tool.pytest.ini_options] lives) — which has no .env file. So nothing was being loaded under any path. Drop the conftest entirely; there is no behavior to preserve. 2. MEDIUM — backend/uv.lock and prompt-service/uv.lock had their 'revision' header bumped 2→3 by local uv 0.9.5, but CI pins uv 0.6.14 in .github/workflows/ci-test.yaml:32. Restored the lockfiles from main (revision 2) and surgically removed only the pytest-dotenv entries — diff is now 15 deletions per lock, no revision change, validated against uv 0.6.14 with 'uv lock --check'. 3. LOW — backend/conftest.py docstring softened (pytest-dotenv used the documented pytest_load_initial_conftests hook, not 'monkey-patched private pytest internals'), and the duplicated comment was removed. Added a small print on missing test.env to make a mis-located file debuggable rather than silently empty ('-s' is set in pyproject so prints surface). Also documents that backend tests don't run under tox in CI today, so this file only affects local/IDE runs. Verified: - prompt-service 'uv run pytest --collect-only -q': 19/19 tests collect - 'uv lock --check' on both locks passes under uv 0.6.14 (CI version)

github-actions · 2026-05-27T12:31:43Z

Test Results

Summary

✅ Runner Tests: 11 passed, 0 failed (11 total)
✅ SDK1 Tests: 347 passed, 0 failed (347 total)

Runner Tests - Full Report

filepath	function	$$\textcolor{#23d18b}{\tt{passed}}$$	SUBTOTAL
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_logs}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_cleanup}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_cleanup\_skip}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_client\_init}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image\_exists}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_container\_run\_config}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_container\_run\_config\_without\_mount}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_run\_container}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_get\_image\_for\_sidecar}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{runner/src/unstract/runner/clients/test\_docker.py}}$$	$$\textcolor{#23d18b}{\tt{test\_sidecar\_container}}$$	$$\textcolor{#23d18b}{\tt{1}}$$	$$\textcolor{#23d18b}{\tt{1}}$$
$$\textcolor{#23d18b}{\tt{TOTAL}}$$		$$\textcolor{#23d18b}{\tt{11}}$$	$$\textcolor{#23d18b}{\tt{11}}$$

SDK1 Tests - Full Report

sonarqubecloud · 2026-05-27T12:31:48Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

jaseemjaskp commented May 25, 2026

View reviewed changes

jaseemjaskp requested review from chandrasekharan-zipstack and pk-zipstack May 25, 2026 14:16

jaseemjaskp requested a review from muhammad-ali-e May 27, 2026 07:21

chandrasekharan-zipstack approved these changes May 27, 2026

View reviewed changes

muhammad-ali-e approved these changes May 27, 2026

View reviewed changes

Merge branch 'main' into fix/replace-pytest-dotenv-with-conftest

a773a66

chandrasekharan-zipstack merged commit 12e06dd into main May 27, 2026
9 checks passed

chandrasekharan-zipstack deleted the fix/replace-pytest-dotenv-with-conftest branch May 27, 2026 12:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIX] Replace unmaintained pytest-dotenv with direct dotenv loading#1992

[FIX] Replace unmaintained pytest-dotenv with direct dotenv loading#1992
chandrasekharan-zipstack merged 3 commits into
mainfrom
fix/replace-pytest-dotenv-with-conftest

jaseemjaskp commented May 25, 2026

Uh oh!

coderabbitai Bot commented May 25, 2026 •

edited

Loading

Uh oh!

greptile-apps Bot commented May 25, 2026 •

edited

Loading

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Sequence Diagram

Comments Outside Diff (1)

Uh oh!

jaseemjaskp left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

sonarqubecloud Bot commented May 27, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jaseemjaskp commented May 25, 2026

What

Why

How

Can this PR break any existing features. If yes, please list possible items. If no, please explain why. (PS: Admins do not merge the PR without this section filled)

Database Migrations

Env Config

Relevant Docs

Related Issues or PRs

Dependencies Versions

Notes on Testing

Screenshots

Checklist

Uh oh!

coderabbitai Bot commented May 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Uh oh!

greptile-apps Bot commented May 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Sequence Diagram

Comments Outside Diff (1)

Uh oh!

jaseemjaskp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 27, 2026

Test Results

Uh oh!

sonarqubecloud Bot commented May 27, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai Bot commented May 25, 2026 •

edited

Loading

greptile-apps Bot commented May 25, 2026 •

edited

Loading