Skip to main content

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

Project description

PyPI CI Python

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 across standalone, Kubernetes, and Snowflake Native App deployments. 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

posit_vip-0.49.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

posit_vip-0.49.0-py3-none-any.whl (321.1 kB view details)

Uploaded Python 3

File details

Details for the file posit_vip-0.49.0.tar.gz.

File metadata

  • Download URL: posit_vip-0.49.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for posit_vip-0.49.0.tar.gz
Algorithm Hash digest
SHA256 23b01c333566e7dc8c573c801501914949eb3aae9b10445b4d61d824d64e09a0
MD5 fc9261aa4c79eb73c33c503965bc4faa
BLAKE2b-256 4aff07d809624ee7063cc837c9298685547ffdb29da4182a243d084fc7e72a61

See more details on using hashes here.

Provenance

The following attestation bundles were made for posit_vip-0.49.0.tar.gz:

Publisher: publish.yml on posit-dev/vip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file posit_vip-0.49.0-py3-none-any.whl.

File metadata

  • Download URL: posit_vip-0.49.0-py3-none-any.whl
  • Upload date:
  • Size: 321.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for posit_vip-0.49.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd1dc422de399cbc0fc4644250810ab62ec17f935eca8a70dd2a4419ec958d46
MD5 7348016b9a5dec579f046bcf65aed11a
BLAKE2b-256 038175238a1dc110cc5afdb42e501813386d93babae05c8fc5d264470e941772

See more details on using hashes here.

Provenance

The following attestation bundles were made for posit_vip-0.49.0-py3-none-any.whl:

Publisher: publish.yml on posit-dev/vip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page