Introduce CI via automated tests #4

piyush-jaiswal · 2025-07-30T20:58:48Z

Summary by CodeRabbit

Chores
- Added automated testing workflow to run tests on the "master" branch and pull requests.
- Configured environment setup to support secure testing processes.

vercel · 2025-07-30T20:58:52Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
ecommerce-rest-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 31, 2025 3:04pm

coderabbitai · 2025-07-30T20:58:54Z

Walkthrough

A new GitHub Actions workflow named "Tests" has been added to automate testing on the "master" branch. Additionally, the test setup now includes setting a random JWT secret key environment variable before app initialization to support testing with JWT authentication.

Changes

Cohort / File(s)	Change Summary
CI Workflow Addition `.github/workflows/tests.yml`	Adds a GitHub Actions workflow to run tests on the "master" branch with Python setup, dependency installation, and pytest execution.
Test Environment Setup `tests/conftest.py`	Adds an environment variable `JWT_SECRET_KEY` with a random 24-byte hex string before importing app modules for testing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

In the burrow, code hops anew,
With workflows set for tests to do.
A secret key, fresh and bright,
Guards the tokens through the night.
On pushes, pulls, or when you wish,
Pytest runs with a bunny’s swish!
Green checks blooming everywhere—
A rabbit’s cheer for code so fair! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fd1764 and c6ff8d2.

📒 Files selected for processing (1)

tests/conftest.py (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: the application doesn't follow the flask app factory pattern, so the database is initialized with th...

Learnt from: piyush-jaiswal
PR: piyush-jaiswal/ecommerce-rest-api#3
File: tests/conftest.py:4-7
Timestamp: 2025-05-14T08:17:57.963Z
Learning: The application doesn't follow the Flask app factory pattern, so the database is initialized with the default connection when importing the app. This requires setting environment variables before importing for test configurations.

Applied to files:

tests/conftest.py

🔇 Additional comments (1)

tests/conftest.py (1)

7-7: LGTM! Secure JWT secret key setup for testing.

The addition of a randomly generated JWT secret key is correctly placed before the app import, following the established pattern for environment variable configuration. Using os.urandom(24).hex() generates a cryptographically secure 48-character hex string, which is appropriate for testing scenarios.

Note that the random key generation ensures each test run uses a different secret, which enhances security but means JWT tokens won't be portable between test sessions (which is generally desirable for isolated testing).

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch ci/add-tests-workflow

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (4)

.github/workflows/tests.yml (4)
3-8: Broaden triggers to cover main and non-default PR targets

Restricting both push and pull_request events to only the master branch means:

Contributors working on the now-common main branch won’t get CI;

PRs opened against long-lived release branches (e.g., release/*) will silently skip tests.

Consider either removing the branches filters or extending them, e.g.:
-    push:
-        branches: [ "master" ]
-    pull_request:
-        branches: [ "master" ]
+    push:
+        branches: [ "master", "main", "release/*" ]
+    pull_request:
+        branches: [ "master", "main", "release/*" ]
18-24: Run the test matrix on multiple Python versions

Hard-coding a single interpreter version misses regressions on earlier or future releases.
A minimal matrix (3.10‒3.12) catches most compatibility issues at little additional cost:
-    test:
-        runs-on: ubuntu-latest
+    test:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ["3.10", "3.11", "3.12"]
Then reference matrix.python-version instead of the version file:
-                python-version-file: ".python-version"
+                python-version: ${{ matrix.python-version }}
Keep the .python-version file for local tools (pyenv, poetry) if desired.

27-28: Demote the cache-hit echo to debug-only output

The unconditional echo adds noise to every build. Gate it behind the runner’s debug flag (settable in the UI) or remove it after verification:
-            - name: Check cache hit
-              run: echo "${{ steps.cp312.outputs.cache-hit }}"
+            - name: Cache diagnostics (debug)
+              if: ${{ runner.debug }}
+              run: echo "pip cache hit → ${{ steps.cp312.outputs.cache-hit }}"
31-37: Add test-time safety nets: exit-on-fail & coverage

Minor but useful tweaks:

set -e (or the default shell option) is off inside the multi-line run; a failing pip install won’t fail the step if later commands succeed.

Collecting coverage now prevents retrofit pain later.
-              run: |
-                  python -m pip install --upgrade pip
-                  pip install -r requirements-test.txt
+              run: |
+                  set -e
+                  python -m pip install --upgrade pip
+                  pip install -r requirements-test.txt
-                  pytest --disable-warnings -q -rA
+                  pytest --disable-warnings --cov=. -q -rA

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 82bb87a and 3fd1764.

📒 Files selected for processing (1)

.github/workflows/tests.yml (1 hunks)

piyush-jaiswal · 2025-07-31T15:11:03Z

@coderabbitai The tests were failing, I pushed a new commit c6ff8d2. Review.

coderabbitai · 2025-07-31T15:12:36Z

🧩 Analysis chain

I'll examine the latest commit to understand what was fixed and then review the changes.

🏁 Script executed:

#!/bin/bash
# Check the latest commit details
git log -1 --oneline c6ff8d2

# Show the changes in the latest commit
git show c6ff8d2 --name-only

# Show the actual changes in the commit
git show c6ff8d2

Length of output: 81934

@piyush-jaiswal I can see that commit c6ff8d2 added the JWT_SECRET_KEY environment variable to tests/conftest.py to fix the test configuration issue. This appears to be the initial addition of your complete ecommerce REST API codebase including the CI workflow, application code, tests, and database migrations.

I'll review all the changes now.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Introduce CI via automated tests

3fd1764

coderabbitai bot reviewed Jul 30, 2025

View reviewed changes

Add JWT key in conftest.py. Fix later

c6ff8d2

vercel bot deployed to Preview July 31, 2025 15:04 View deployment

piyush-jaiswal merged commit 54af3f1 into master Jul 31, 2025
4 checks passed

piyush-jaiswal deleted the ci/add-tests-workflow branch July 31, 2025 15:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce CI via automated tests #4

Introduce CI via automated tests #4

Uh oh!

piyush-jaiswal commented Jul 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 30, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

piyush-jaiswal commented Jul 31, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Introduce CI via automated tests #4

Introduce CI via automated tests #4

Uh oh!

Conversation

piyush-jaiswal commented Jul 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

piyush-jaiswal commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

piyush-jaiswal commented Jul 30, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 30, 2025 •

edited

Loading

coderabbitai bot commented Jul 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

piyush-jaiswal commented Jul 31, 2025 •

edited

Loading