Make easy 1 command api experience for development #23

rh-amarin · 2025-12-17T10:45:37Z

In order to test other CLM components they need a working hyperfleet-api which adds friction to the experience

Adding a make dev target so it:

Starts a testcontainer with PostgreSQL
Does hyperfleet-api migrate on the container
Starts the hyperfleet-api with --enable-auth=false --enable-jwt=false

Summary by CodeRabbit

New Features
- Added make dev command for local development, which runs the API with an embedded PostgreSQL database via testcontainers, with JWT and authorization disabled for easier testing.
- Implemented graceful shutdown handling for the API server.
Documentation
- Added guides for the new local development workflow and embedded PostgreSQL setup.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

openshift-ci · 2025-12-17T10:45:43Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign crizzo71 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

coderabbitai · 2025-12-17T10:45:48Z

Walkthrough

This pull request introduces a new embedded development environment for local development that uses testcontainers to run a PostgreSQL database at runtime, bypassing JWT and authorization requirements. The changes add a Makefile target dev to launch the API with this environment, implement the corresponding environment configuration in Go, and update documentation. Graceful shutdown handling is added via signal interception (SIGINT/SIGTERM) to ensure proper resource cleanup of the testcontainer before exit.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Signal handling in cmd.go: Verify that environments.Environment().Teardown() is called correctly and that the graceful shutdown doesn't leave dangling processes or containers.
Environment overrides in e_embedded_development.go: Ensure all security feature disables (JWT, authz, HTTPS) are intentional and appropriate for development mode only.
Testcontainers integration: Confirm that the embedded PostgreSQL setup works reliably across different local environments and that migrations run correctly.

Suggested labels

lgtm, approved

Suggested reviewers

ciaranRoche
vkareh

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly aligns with the main objective: enabling a single `make dev` command for easy API development. It captures the core purpose of reducing friction for development workflows.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

cmd/hyperfleet-api/servecmd/cmd.go (1)

55-62: Consider graceful server shutdown before exit.

The signal handling correctly triggers environment teardown, but the servers (API, metrics, healthcheck) started in goroutines are not gracefully shut down. In-flight requests may be interrupted. While acceptable for the development workflow, consider implementing graceful server shutdown (e.g., using context cancellation or server.Shutdown() calls) to drain connections before exit.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0520ff0 and deae427.

📒 Files selected for processing (7)

Makefile (2 hunks)
cmd/hyperfleet-api/environments/e_embedded_development.go (1 hunks)
cmd/hyperfleet-api/environments/framework.go (1 hunks)
cmd/hyperfleet-api/environments/types.go (1 hunks)
cmd/hyperfleet-api/servecmd/cmd.go (2 hunks)
docs/development.md (2 hunks)
docs/testcontainers.md (1 hunks)

🧰 Additional context used

🧠 Learnings (6)

📓 Common learnings

Learnt from: CR
Repo: openshift-hyperfleet/hyperfleet-api PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-12T11:04:29.971Z
Learning: Applies to test/integration/**/*.go : Use Testcontainers to spin up isolated PostgreSQL instances for integration tests