Skip to content

docs: clarify PostgreSQL requirement for full test suite#2230

Open
Sanjay-VK07 wants to merge 1 commit intoaboutcode-org:mainfrom
Sanjay-VK07:docs/sqlite-test-clarification
Open

docs: clarify PostgreSQL requirement for full test suite#2230
Sanjay-VK07 wants to merge 1 commit intoaboutcode-org:mainfrom
Sanjay-VK07:docs/sqlite-test-clarification

Conversation

@Sanjay-VK07
Copy link

@Sanjay-VK07 Sanjay-VK07 commented Mar 22, 2026

Summary

Clarify that SQLite works for quick local development, but the complete test suite requires PostgreSQL-specific database features.

What I observed

While setting up VulnerableCode locally in Codespaces:

  • make sqlite worked for local setup
  • make run started the development server successfully
  • make test failed under SQLite because some tests rely on PostgreSQL-specific features such as DISTINCT ON queries and JSON containment lookups

Change in this PR

This updates the installation docs to clarify that:

  • SQLite is suitable for quick local development
  • PostgreSQL should be used when running the full test suite

Related to #2229

Signed-off-by: Sanjay <vksanjay28@gmail.com>
@Sanjay-VK07
Copy link
Author

Hi maintainers, this PR documents an issue I ran into while setting up VulnerableCode in Codespaces with SQLite for local development.

The app ran successfully with make sqlite and make run, but make test failed because some tests rely on PostgreSQL-specific features. I added a small clarification in the installation docs so new contributors know SQLite is fine for quick local setup, while PostgreSQL is needed for the full test suite.

Happy to update the wording if you’d prefer a different phrasing. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant