You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix: deployment script and test tooling bugs found in docs audit - #10264
Fixes four bugs found while auditing the repo docs (docs PR: #10263):
Swarm installer can't exit from the menu.deployments/swarm/community/swarm.sh validated the action with ^[1-6]$, so choosing 7) Exit printed "invalid selection". The regex now accepts 1-7.
Two CLI plane.env settings had no effect. In deployments/cli/community/docker-compose.yml:
GUNICORN_WORKERS was hardcoded to 1.
AUTHENTICATION_RATE_LIMIT, which plane/authentication/rate_limit.py reads for the sign-in/sign-up throttle, was never passed to the containers.
Both are now passed through with the same defaults (1, 10/minute), so existing installs behave the same unless they set the variables.
Also removed the commented DOCKER_PLATFORM hint from variables.env; nothing reads it.
Swarm deploys the same compose file and sources plane.env, so the fix covers it too.
apps/api/run_tests.sh was broken. It exec'd tests/run_tests.sh, which has never existed in the repo's history. It now cds to apps/api and runs uv run python run_tests.py "$@". uv run syncs inexactly, so it is safe inside the dev/test images.
Test mock fixtures were never loaded.conftest_external.py is not a conftest.py, so pytest never saw mock_redis, mock_elasticsearch or mock_celery, even though the test docs advertise them.
mock_redis and mock_celery are now imported into conftest.py, the same way it already imports django_db_setup.
mock_elasticsearch is removed: Elasticsearch is not a dependency, so the fixture would fail whenever it was used.
New test_external_fixtures.py covers both remaining fixtures.
Type of Change
Bug fix (non-breaking change which fixes an issue)
Feature (non-breaking change which adds functionality)
Improvement (change that would cause existing functionality to not work as expected)
Code refactoring
Performance improvements
Documentation update
Screenshots and Media (if applicable)
Test Scenarios
Ran in the Docker test stack: pytest plane/tests/unit/test_external_fixtures.py (2 passed), pytest --collect-only (1563 collected, no errors), pytest -m unit (581 passed).
docker compose -f deployments/cli/community/docker-compose.yml --env-file <plane.env with GUNICORN_WORKERS=3, AUTHENTICATION_RATE_LIMIT=20/minute> config renders those values on the app services; without them it renders the defaults 1 and 10/minute.
apps/api/run_tests.sh --help, run from another directory, prints the run_tests.py usage.
Swarm: run ./setup.sh from swarm.sh and choose 7; the script now exits instead of re-prompting.
- swarm.sh: the action prompt only accepted 1-6, so "7) Exit" was
rejected as an invalid selection
- CLI docker-compose.yml: GUNICORN_WORKERS was hardcoded to 1 and
AUTHENTICATION_RATE_LIMIT was never passed to the API, so both
plane.env settings had no effect; pass them through with the same
defaults. Drop the DOCKER_PLATFORM comment, which nothing reads
- apps/api/run_tests.sh exec'd tests/run_tests.sh, which never existed;
run run_tests.py through uv from apps/api instead
- conftest_external.py fixtures were never loaded by pytest; import
mock_redis and mock_celery into conftest.py and drop mock_elasticsearch
(Elasticsearch is not a dependency). Add a test that both fixtures work
No actionable comments were generated in the recent review.
Walkthrough
The changes update API test fixtures and the test wrapper, adjust community CLI deployment environment settings, and allow selection 7 in the Swarm menu.
Changes: API Test Setup
Layer / File(s)
Summary
External fixture setup and tests apps/api/plane/tests/conftest.py, apps/api/plane/tests/conftest_external.py, apps/api/plane/tests/unit/test_external_fixtures.py
The main conftest imports mock_redis and mock_celery. The mock_elasticsearch fixture is removed. New unit tests check the Redis and Celery fixtures.
API test runner apps/api/run_tests.sh
The wrapper changes to the API directory and runs run_tests.py through uv, forwarding its arguments.
GUNICORN_WORKERS is configurable with a default of 1. AUTHENTICATION_RATE_LIMIT is configurable with a default of 10/minute. The variables file no longer includes the commented platform setting or ARM64 guidance.
Swarm Community Deployment
Layer / File(s)
Summary
Menu selection range deployments/swarm/community/swarm.sh
Menu validation accepts selections 1–7, allowing selection 7 to reach the existing Exit action.
This change fixes a Swarm exit menu option, makes two documented settings take effect in compose deployments, and corrects test tooling. No concrete merge-blocking risk was found.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title clearly identifies deployment script and test tooling bug fixes, which are central changes in the pull request.
Description check
The description includes all required sections, explains the changes, identifies the change type, documents test scenarios, and provides a reference.
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Finishing Touches
Generate docstrings
Commit to this branch
Create a new PR
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 6 remain after this review.
* docs: verify and refresh repo documentation against the code
Audit every Markdown doc in the repo against the current code and config
and fix what had drifted:
- README, CONTRIBUTING, AGENTS, SECURITY: versions, setup steps, PR flow,
i18n structure, private vulnerability reporting, Forum instead of
GitHub Discussions, broken links
- linting, copyright check, Copilot instructions: match oxlint/oxfmt
config, the CI copyright check and the repo's TS settings
- apps/api docs: test runner, fixtures, routes, openapi and exporters
module contents; mark the Django 5.2 plan as done
- deployments: CLI menu/backup/restore/env vars, AIO services, secrets,
build and env precedence, Helm install steps
- packages: decorators, logger, editor, codemods and tailwind-config docs
rewritten from the real exports and tokens; skill docs updated
* docs(api): describe mock_redis/mock_celery fixtures registered in #10264
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes four bugs found while auditing the repo docs (docs PR: #10263):
deployments/swarm/community/swarm.shvalidated the action with^[1-6]$, so choosing7) Exitprinted "invalid selection". The regex now accepts 1-7.plane.envsettings had no effect. Indeployments/cli/community/docker-compose.yml:GUNICORN_WORKERSwas hardcoded to1.AUTHENTICATION_RATE_LIMIT, whichplane/authentication/rate_limit.pyreads for the sign-in/sign-up throttle, was never passed to the containers.1,10/minute), so existing installs behave the same unless they set the variables.DOCKER_PLATFORMhint fromvariables.env; nothing reads it.plane.env, so the fix covers it too.apps/api/run_tests.shwas broken. It exec'dtests/run_tests.sh, which has never existed in the repo's history. It nowcds toapps/apiand runsuv run python run_tests.py "$@".uv runsyncs inexactly, so it is safe inside the dev/test images.conftest_external.pyis not aconftest.py, so pytest never sawmock_redis,mock_elasticsearchormock_celery, even though the test docs advertise them.mock_redisandmock_celeryare now imported intoconftest.py, the same way it already importsdjango_db_setup.mock_elasticsearchis removed: Elasticsearch is not a dependency, so the fixture would fail whenever it was used.test_external_fixtures.pycovers both remaining fixtures.Type of Change
Screenshots and Media (if applicable)
Test Scenarios
pytest plane/tests/unit/test_external_fixtures.py(2 passed),pytest --collect-only(1563 collected, no errors),pytest -m unit(581 passed).docker compose -f deployments/cli/community/docker-compose.yml --env-file <plane.env with GUNICORN_WORKERS=3, AUTHENTICATION_RATE_LIMIT=20/minute> configrenders those values on the app services; without them it renders the defaults1and10/minute.apps/api/run_tests.sh --help, run from another directory, prints therun_tests.pyusage../setup.shfromswarm.shand choose7; the script now exits instead of re-prompting.References
Generated with Claude Code
Summary by CodeRabbit