posit-vip 0.31.1

Verified Installation of Posit - An extensible test suite for validating Posit Team deployments

VIP - Verified Installation of Posit

An open-source, extensible test suite that validates Posit Team deployments are installed correctly and functioning properly.

VIP uses BDD-style tests (pytest-bdd + Playwright) to verify Connect, Workbench, and Package Manager. Results are compiled into an HTML report that can be published to a Connect server.

Documentation: https://posit-dev.github.io/vip/

Quick start

uv venv
source .venv/bin/activate
uv pip install posit-vip
uv run vip install
vip verify --connect-url https://connect.example.com --interactive-auth

On a headless server (no display), use --headless-auth instead:

vip verify --config vip.toml --headless-auth

Run a specific test by name:

vip verify --connect-url https://connect.example.com --filter test_login

With a configuration file:

cp vip.toml.example vip.toml     # edit with your deployment details
vip verify --config vip.toml

Uninstalling

To reverse what vip install (or just setup) did:

uv run vip uninstall        # dry run; prints the full plan including any sudo command
uv run vip uninstall --yes  # remove Playwright cache + manifest; prints the sudo command
                            # for any system packages so you can remove them yourself

vip uninstall only removes packages and files that vip install recorded in .vip-install.json; anything that was already on your machine before running vip install is left alone.

If a Connect URL is configured (in vip.toml or via --connect-url), vip uninstall chains vip cleanup first to remove _vip_test-tagged content from Connect.

CLI commands

Command	Description
vip verify	Run verification tests against a Posit Team deployment
vip status	Quick health check for each configured product
vip cleanup	Delete VIP test credentials and resources
vip report	Render the HTML report from test results (requires Quarto CLI)
vip app	Launch the Shiny GUI for interactive test running
vip auth	Authentication tools (e.g. mint Connect API keys)
vip cluster	Cluster connection tools for Kubernetes deployments

Run vip --help or vip <command> --help for full usage details.

Shiny app (graphical test runner)

VIP includes a Shiny for Python app that lets you select test categories, run tests, and view the report — all from a browser. This is especially convenient inside a Posit Workbench session (RStudio or Positron) where the app opens in the Viewer pane.

uv run vip app

See the Shiny App guide for details.

Development

See docs/development.md for dev setup, linting, and formatting.

For the test architecture and four-layer design, see docs/test-architecture.md.

License

MIT — see LICENSE.