test(cerebro): add backup and restore integration test#738
Conversation
- Add comprehensive backup_restore_test.rs that validates: * Data persistence through backup/restore cycle * Memory count preservation (10 test memories) * Individual memory retrieval after restore * Search functionality post-restore - Add test helpers for: * Starting/stopping Cerebro server with custom config * Creating test memories via MCP calls * Waiting for service readiness - Update operations.md with detailed backup/restore procedures: * Step-by-step backup instructions * Restore workflow with verification steps * Best practices and safety guidelines - Add fs_extra dependency for directory operations in tests The test validates the complete backup/restore workflow: 1. Start Cerebro with embedded SurrealDB 2. Create test data via MCP mem_save calls 3. Verify data exists via mem_stats and mem_search 4. Gracefully shutdown and copy storage directory 5. Simulate data loss by removing original storage 6. Restore from backup copy 7. Restart Cerebro and verify all data is intact All Cerebro tests pass (63 tests total).
Deploying corvus with
|
| Latest commit: |
fee7878
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7c5621a1.corvus-42x.pages.dev |
| Branch Preview URL: | https://feat-cerebro-backup-restore.corvus-42x.pages.dev |
📝 WalkthroughWalkthroughThis PR improves test infrastructure by capturing server handles from async operations, strengthens backup/restore test assertions by validating actual data content, updates API documentation to reflect authentication requirements and parameter format changes, and bumps dependency versions for Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@clients/cerebro/tests/backup_restore_test.rs`:
- Around line 121-127: Reformat the shutdown block to satisfy rustfmt by
removing the extra blank lines and aligning comments and statements on
consecutive lines: send on shutdown_tx (let _ = shutdown_tx.send(true);), then
drop(service); and then await tokio::time::sleep(Duration::from_secs(2)).await;
so the three statements and their comments are compactly arranged without stray
blank lines to fix the formatter failure.
- Around line 113-117: The test currently only checks that search_body["result"]
is an object which doesn't verify actual hits; update the assertions at the two
places around the search response parsing (the code that builds search_body from
search_resp.json().await and currently asserts
search_body["result"].is_object()) to instead assert that search_body["result"]
contains a non-empty hits array and that at least one hit matches the memory we
created (e.g., by id or by expected text/content field). Locate the occurrences
using the symbols search_resp, search_body and the mem_search-related assertions
and replace the generic is_object() check with an assert that
search_body["result"]["hits"].as_array() is Some and has length > 0 and that one
of the hits contains the expected memory identifier or content.
In `@clients/cerebro/tests/helpers/mod.rs`:
- Around line 44-62: The helper start_cerebro_server spawns the axum server but
doesn't return the tokio::task::JoinHandle, forcing callers to guess shutdown
timing; change start_cerebro_server to return the JoinHandle
(tokio::task::JoinHandle<()>) as part of its Result tuple, capture the result of
tokio::spawn into a variable (e.g., server_handle) instead of discarding it, and
return that handle alongside (service, shutdown_tx, base_url) so callers can set
the shutdown watch sender, await wait_for_shutdown, and then .await the returned
JoinHandle to observe proper shutdown and any panics from the axum::serve task
(keep existing wait_for_shutdown usage).
In `@clients/web/apps/dashboard/package.json`:
- Line 48: The PostCSS version is inconsistent:
clients/web/apps/dashboard/package.json declares "postcss": "^8.5.13" while the
root pnpm.overrides.postcss is "^8.5.10"; update the root override to match the
dashboard package (set pnpm.overrides.postcss to "^8.5.13") or alternatively
change the dashboard package to "^8.5.10" so both locations match, then run pnpm
install to regenerate pnpm-lock.yaml (ensure the lockfile records the chosen
version).
In `@clients/web/apps/docs/src/content/docs/cerebro/operations.md`:
- Around line 344-370: The MCP verification curl examples call the protected
/mcp endpoints (mem_stats, mem_search, and tools/list) but omit Authorization so
they'll 401; update each curl to include the Authorization header (e.g., add -H
"Authorization: Bearer <TOKEN>") or insert a short explicit note above the
commands instructing users to include a valid Bearer token when hitting /mcp so
mem_stats, mem_search, and tools/list succeed in token-protected deployments.
In `@clients/web/apps/marketing/package.json`:
- Line 25: Update the pinned Astro version in the root pnpm.overrides to match
the marketing package's "astro" range (^6.2.1) and then regenerate the lockfile
(run a workspace install such as pnpm install) so pnpm-lock.yaml reflects the
new override; verify the marketing package.json "astro" entry and the
pnpm.overrides "astro" entry are identical and that frozen-lockfile validation
passes.
In `@package.json`:
- Around line 3-4: The workspace has inconsistent TypeScript/@astrojs/check
versions between root and catalog causing mixed type checking; update the
catalog entries for "typescript" to 6.0.3 and "@astrojs/check" to 0.9.9 to match
the root package.json, then regenerate the lockfile (pnpm-lock.yaml) by running
the workspace install (e.g., pnpm install) so the new catalog versions are
resolved and the lockfile is updated.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: bd17eeb7-3651-42fd-8ae4-44d73713f056
⛔ Files ignored due to path filters (3)
clients/agent-runtime/Cargo.lockis excluded by!**/*.lockclients/cerebro/Cargo.lockis excluded by!**/*.lockpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (9)
clients/cerebro/Cargo.tomlclients/cerebro/tests/backup_restore_test.rsclients/cerebro/tests/helpers/mod.rsclients/web/apps/dashboard/package.jsonclients/web/apps/docs/package.jsonclients/web/apps/docs/src/content/docs/cerebro/operations.mdclients/web/apps/marketing/package.jsonclients/web/package.jsonpackage.json
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🧰 Additional context used
📓 Path-based instructions (3)
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/marketing/package.jsonclients/cerebro/Cargo.tomlclients/web/package.jsonpackage.jsonclients/web/apps/dashboard/package.jsonclients/web/apps/docs/package.jsonclients/cerebro/tests/backup_restore_test.rsclients/web/apps/docs/src/content/docs/cerebro/operations.mdclients/cerebro/tests/helpers/mod.rs
**/*.rs
⚙️ CodeRabbit configuration file
**/*.rs: Focus on Rust idioms, memory safety, and ownership/borrowing correctness.
Flag unnecessary clones, unchecked panics in production paths, and weak error context.
Prioritize unsafe blocks, FFI boundaries, concurrency races, and secret handling.
Files:
clients/cerebro/tests/backup_restore_test.rsclients/cerebro/tests/helpers/mod.rs
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/web/apps/docs/src/content/docs/cerebro/operations.md
🧠 Learnings (3)
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/Cargo.toml : Do not add heavy dependencies for minor convenience; justify new crate additions
Applied to files:
clients/cerebro/Cargo.toml
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/Cargo.toml : Preserve release-size profile assumptions in `Cargo.toml` and avoid adding heavy dependencies unless clearly justified
Applied to files:
clients/cerebro/Cargo.toml
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/*.rs : Run `cargo fmt --all -- --check`, `cargo clippy --all-targets -- -D warnings`, and `cargo test` for code validation, or document which checks were skipped and why
Applied to files:
clients/cerebro/Cargo.toml
🪛 GitHub Actions: PR Checks
clients/cerebro/tests/backup_restore_test.rs
[error] 119-120: cargo fmt --check failed: formatting diff detected (whitespace/blank line changes around shutdown_tx.send(true) and drop(service)).
clients/cerebro/tests/helpers/mod.rs
[error] 130-130: cargo fmt --check failed: formatting diff detected (whitespace/blank line changes around resp.json().await?).
[error] 137-138: cargo fmt --check failed: formatting diff detected (ok_or_else closure formatting for anyhow::anyhow(...) expression).
🪛 GitHub Actions: SonarQube Analysis
clients/web/apps/marketing/package.json
[error] 1-1: pnpm install --frozen-lockfile failed because pnpm-lock.yaml specifiers do not match package.json. Consider updating the lockfile (or run without --frozen-lockfile).
clients/web/package.json
[error] 1-1: pnpm install --frozen-lockfile failed because pnpm-lock.yaml specifiers do not match package.json. Consider updating the lockfile (or run without --frozen-lockfile).
package.json
[error] 1-1: pnpm install --frozen-lockfile failed because pnpm-lock.yaml specifiers do not match package.json. Consider updating the lockfile (or run without --frozen-lockfile).
clients/web/apps/dashboard/package.json
[error] 1-1: pnpm install --frozen-lockfile failed because pnpm-lock.yaml specifiers do not match package.json. Consider updating the lockfile (or run without --frozen-lockfile).
clients/web/apps/docs/package.json
[error] 1-1: pnpm install --frozen-lockfile failed because pnpm-lock.yaml specifiers do not match package.json. Consider updating the lockfile (or run without --frozen-lockfile).
🪛 LanguageTool
clients/web/apps/docs/src/content/docs/cerebro/operations.md
[uncategorized] ~231-~231: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...db ### Cold Backup Procedure #### Bare Metal Deployment bash # 1. Stop Cerebro g...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~284-~284: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...erebro ### Restore Procedure #### Bare Metal Deployment bash # 1. Stop Cerebro s...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.22.1)
clients/web/apps/docs/src/content/docs/cerebro/operations.md
[warning] 339-339: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 345-345: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 355-355: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 365-365: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🔇 Additional comments (3)
clients/web/apps/docs/package.json (1)
22-22: Duplicate: same Astro override conflict as the marketing app.The root
pnpm.overrides.astroentry still pins^6.1.6, so this^6.2.1specifier is likely to be masked until the root override and lockfile are updated.clients/web/package.json (1)
37-37: LGTM.This is a localized Stylelint version bump and doesn't require any manifest or script changes.
clients/cerebro/tests/helpers/mod.rs (1)
132-137:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix the failing
cargo fmtdiff in this parsing block.The whitespace/closure layout here is already tripping
cargo fmt --check, so CI will stay red until this block is reformatted.⛔ Skipped due to learnings
Learnt from: CR Repo: dallay/corvus PR: 0 File: clients/agent-runtime/AGENTS.md:0-0 Timestamp: 2026-02-17T12:31:17.076Z Learning: Applies to clients/agent-runtime/**/*.rs : Run `cargo fmt --all -- --check`, `cargo clippy --all-targets -- -D warnings`, and `cargo test` for code validation, or document which checks were skipped and why
github-actions
Bot
added
size/xs
- Fix rustfmt formatting in backup_restore_test.rs shutdown block - Update search assertions to verify actual hits with summary field - Return JoinHandle from start_cerebro_server for proper shutdown tracking - Fix PostCSS version inconsistency (^8.5.10 -> ^8.5.13) - Fix Astro version inconsistency (^6.1.6 -> ^6.2.1) - Add Authorization headers to MCP curl examples in operations.md - Update pnpm lockfile with new dependency versions
github-actions
Bot
added
size/m
|
1 participant
Summary
Adds comprehensive backup and restore integration test for Cerebro with detailed operational documentation.
Closes #694
Changes
Integration Test (
backup_restore_test.rs):Test Helpers (
tests/helpers/mod.rs):start_cerebro_server()- starts server with custom config and returns JoinHandlewait_for_ready()- polls health endpoint with timeoutcreate_test_memories()- creates test data via MCPDocumentation (
operations.md):Dependencies:
fs_extrafor directory operations in testsTest Results
All 63 Cerebro tests pass, including the new backup/restore test (~2.2s).
Validation
The test validates:
Code Review Fixes