docs: plan for #298 — custom test extension scaffolding#299
docs: plan for #298 — custom test extension scaffolding#299posit-vip-triage[bot] wants to merge 3 commits into
Conversation
Add plan for a vip scaffold subcommand and comprehensive GxP validation example showing how to verify specific R/Python versions and packages across Workbench and Connect. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
posit-vip-triage
Bot
requested review from
bdeitte,
ian-flores and
statik
as code owners
|
Preview Links
|
| - **UNCONFIRMED:** Should the example test directory be named `examples/gxp_validation/` or something more generic like `examples/cross_product_validation/`? | ||
| - **Leaning toward:** `examples/cross_product_validation/` because the pattern applies beyond GxP (any customer who needs to lock runtime/package versions). |
There was a problem hiding this comment.
Updated the plan to use examples/cross_product_validation/ throughout — all gxp_validation references replaced and the naming question marked as CONFIRMED. (commit: docs: confirm cross_product_validation naming, update all references)
| - **UNCONFIRMED:** Should the scaffold command default to copying from `examples/cross_product_validation/` or should it be extensible (multiple scaffold templates)? | ||
| - **Leaning toward:** single template for now; extensibility can be added later if demand emerges. |
There was a problem hiding this comment.
Confirmed — marked as single template for now with extensibility added later if needed.
|
|
||
| ## Out of scope | ||
|
|
||
| - Modifying the existing `examples/custom_tests/` directory (it serves a different purpose: minimal HTTP check). The new example is complementary, not a replacement. |
There was a problem hiding this comment.
@copilot it is weird to have one folder named custom_tests while another is named cross_product_validation. How many others example could we think of adding and if so we should add a way to support multiple.
There was a problem hiding this comment.
Added new open question about renaming custom_tests → http_health_check for consistency. Listed potential future examples (SSL validation, API performance, user provisioning) and noted the Architecture section can support --template option for multi-template scaffolding.
Co-authored-by: ian-flores <18703558+ian-flores@users.noreply.github.com>
Co-authored-by: ian-flores <18703558+ian-flores@users.noreply.github.com>
This plan outlines adding a
vip scaffoldsubcommand and a comprehensive example showing how to extend VIP with custom tests for cross-product validation scenarios (verifying specific R/Python versions and packages across Workbench and Connect).The plan also addresses naming consistency across example directories and considers future extensibility for multi-template scaffolding support, including potential examples for SSL certificate validation, API performance testing, and user provisioning verification.
Merging this PR will trigger an implementation PR — comment to iterate on the plan first.
> Generated by Triage open issues on
posit-dev/vipfor issue #298 · ● 7.9M · ◷