Vapora/docs/adrs/0023-testing-strategy.html

498 lines
20 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>0023: Testing Strategy - VAPORA Platform Documentation</title>
<!-- Custom HTML head -->
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
<!-- Provide site root and default themes to javascript -->
<script>
const path_to_root = "../";
const default_light_theme = "light";
const default_dark_theme = "dark";
</script>
<!-- Start loading toc.js asap -->
<script src="../toc.js"></script>
</head>
<body>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd></kbd> or <kbd></kbd> to navigate between chapters</p>
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
</div>
</div>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
let theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
let sidebar = null;
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">VAPORA Platform Documentation</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0023-testing-strategy.md" title="Suggest an edit" aria-label="Suggest an edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="adr-023-multi-layer-testing-strategy"><a class="header" href="#adr-023-multi-layer-testing-strategy">ADR-023: Multi-Layer Testing Strategy</a></h1>
<p><strong>Status</strong>: Accepted | Implemented
<strong>Date</strong>: 2024-11-01
<strong>Deciders</strong>: Quality Assurance Team
<strong>Technical Story</strong>: Building confidence through unit, integration, and real-database tests</p>
<hr />
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
<p>Implementar <strong>multi-layer testing</strong>: unit tests (inline), integration tests (tests/ dir), real DB connections.</p>
<hr />
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
<ol>
<li><strong>Unit Tests</strong>: Fast feedback on logic changes</li>
<li><strong>Integration Tests</strong>: Verify components work together</li>
<li><strong>Real DB Tests</strong>: Catch database schema/query issues</li>
<li><strong>218+ Tests</strong>: Comprehensive coverage across 13 crates</li>
</ol>
<hr />
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
<h3 id="-unit-tests-only"><a class="header" href="#-unit-tests-only">❌ Unit Tests Only</a></h3>
<ul>
<li><strong>Pros</strong>: Fast</li>
<li><strong>Cons</strong>: Miss integration bugs, schema issues</li>
</ul>
<h3 id="-integration-tests-only"><a class="header" href="#-integration-tests-only">❌ Integration Tests Only</a></h3>
<ul>
<li><strong>Pros</strong>: Comprehensive</li>
<li><strong>Cons</strong>: Slow, harder to debug</li>
</ul>
<h3 id="-multi-layer-chosen"><a class="header" href="#-multi-layer-chosen">✅ Multi-Layer (CHOSEN)</a></h3>
<ul>
<li>All three layers catch different issues</li>
</ul>
<hr />
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
<p><strong>Pros</strong>:</p>
<ul>
<li>✅ Fast feedback (unit)</li>
<li>✅ Integration validation (integration)</li>
<li>✅ Real-world confidence (real DB)</li>
<li>✅ 218+ tests total coverage</li>
</ul>
<p><strong>Cons</strong>:</p>
<ul>
<li>⚠️ Slow full test suite (~5 minutes)</li>
<li>⚠️ DB tests require test environment</li>
<li>⚠️ More test code to maintain</li>
</ul>
<hr />
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
<p><strong>Unit Tests (Inline)</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// crates/vapora-agents/src/learning_profile.rs
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_expertise_score_empty() {
let profile = TaskTypeLearning {
agent_id: "test".to_string(),
task_type: "architecture".to_string(),
executions_total: 0,
records: vec![],
..Default::default()
};
assert_eq!(profile.expertise_score(), 0.0);
}
#[test]
fn test_confidence_weighting() {
let profile = TaskTypeLearning {
executions_total: 20,
..Default::default()
};
assert_eq!(profile.confidence(), 1.0);
let profile_partial = TaskTypeLearning {
executions_total: 10,
..Default::default()
};
assert_eq!(profile_partial.confidence(), 0.5);
}
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Integration Tests</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// crates/vapora-backend/tests/integration_tests.rs
#[tokio::test]
async fn test_create_project_full_flow() {
// Setup: create test database
let db = setup_test_db().await;
let app_state = create_test_app_state(db.clone()).await;
// Execute: create project via HTTP
let response = app_state
.handle_request(
"POST",
"/api/projects",
json!({
"title": "Test Project",
"description": "A test",
}),
)
.await;
// Verify: response is 201 Created
assert_eq!(response.status(), 201);
// Verify: project in database
let project = db
.query("SELECT * FROM projects LIMIT 1")
.await
.unwrap()
.take::&lt;Project&gt;(0)
.unwrap()
.unwrap();
assert_eq!(project.title, "Test Project");
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Real Database Tests</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// crates/vapora-backend/tests/database_tests.rs
#[tokio::test]
async fn test_multi_tenant_isolation() {
let db = setup_real_surrealdb().await;
// Create projects for two tenants
let project_1 = db
.create("projects")
.content(Project {
tenant_id: "tenant:1".to_string(),
title: "Project 1".to_string(),
..Default::default()
})
.await
.unwrap();
let project_2 = db
.create("projects")
.content(Project {
tenant_id: "tenant:2".to_string(),
title: "Project 2".to_string(),
..Default::default()
})
.await
.unwrap();
// Query: tenant 1 should only see their project
let results = db
.query("SELECT * FROM projects WHERE tenant_id = 'tenant:1'")
.await
.unwrap()
.take::&lt;Vec&lt;Project&gt;&gt;(0)
.unwrap();
assert_eq!(results.len(), 1);
assert_eq!(results[0].title, "Project 1");
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Test Utilities</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// crates/vapora-backend/tests/common/mod.rs
pub async fn setup_test_db() -&gt; Surreal&lt;Mem&gt; {
let db = Surreal::new::&lt;surrealdb::engine::local::Mem&gt;()
.await
.unwrap();
db.use_ns("vapora").use_db("test").await.unwrap();
// Initialize schema
init_schema(&amp;db).await.unwrap();
db
}
pub async fn setup_real_surrealdb() -&gt; Surreal&lt;Ws&gt; {
// Connect to test SurrealDB instance
let db = Surreal::new::&lt;Ws&gt;("ws://localhost:8000")
.await
.unwrap();
db.signin(/* test credentials */).await.unwrap();
db.use_ns("test").use_db("test").await.unwrap();
db
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Running Tests</strong>:</p>
<pre><code class="language-bash"># Run all tests
cargo test --workspace
# Run unit tests only (fast)
cargo test --workspace --lib
# Run integration tests
cargo test --workspace --test "*"
# Run with output
cargo test --workspace -- --nocapture
# Run specific test
cargo test -p vapora-backend test_multi_tenant_isolation
# Coverage report
cargo tarpaulin --workspace --out Html
</code></pre>
<p><strong>Key Files</strong>:</p>
<ul>
<li><code>crates/*/src/</code> (unit tests inline)</li>
<li><code>crates/*/tests/</code> (integration tests)</li>
<li><code>crates/*/tests/common/</code> (test utilities)</li>
</ul>
<hr />
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
<pre><code class="language-bash"># Count tests across workspace
cargo test --workspace -- --list | grep "test " | wc -l
# Run all tests with statistics
cargo test --workspace 2&gt;&amp;1 | grep -E "^test |passed|failed"
# Coverage report
cargo tarpaulin --workspace --out Html
# Output: coverage/index.html
</code></pre>
<p><strong>Expected Output</strong>:</p>
<ul>
<li>218+ tests total</li>
<li>All tests passing</li>
<li>Coverage &gt; 70%</li>
<li>Unit tests &lt; 5 seconds</li>
<li>Integration tests &lt; 60 seconds</li>
</ul>
<hr />
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
<h3 id="testing-cadence"><a class="header" href="#testing-cadence">Testing Cadence</a></h3>
<ul>
<li>Pre-commit: run unit tests</li>
<li>PR: run all tests</li>
<li>CI/CD: run all tests + coverage</li>
</ul>
<h3 id="test-environment"><a class="header" href="#test-environment">Test Environment</a></h3>
<ul>
<li>Unit tests: in-memory databases</li>
<li>Integration: SurrealDB in-memory</li>
<li>Real DB: Docker container (CI/CD only)</li>
</ul>
<h3 id="debugging"><a class="header" href="#debugging">Debugging</a></h3>
<ul>
<li>Unit test failure: easy to debug (isolated)</li>
<li>Integration failure: check component interaction</li>
<li>DB failure: verify schema and queries</li>
</ul>
<hr />
<h2 id="references"><a class="header" href="#references">References</a></h2>
<ul>
<li><a href="https://doc.rust-lang.org/book/ch11-00-testing.html">Rust Testing Documentation</a></li>
<li><code>crates/*/tests/</code> (integration tests)</li>
<li><code>crates/vapora-backend/tests/common/</code> (test utilities)</li>
</ul>
<hr />
<p><strong>Related ADRs</strong>: ADR-022 (Error Handling), ADR-004 (SurrealDB)</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../../adrs/0022-error-handling.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../adrs/0024-service-architecture.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../../adrs/0022-error-handling.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../adrs/0024-service-architecture.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js"></script>
<script src="../mark.min.js"></script>
<script src="../searcher.js"></script>
<script src="../clipboard.min.js"></script>
<script src="../highlight.js"></script>
<script src="../book.js"></script>
<!-- Custom JS scripts -->
</div>
</body>
</html>