vr-app-cli

A CLI used for running the VR APP

Environment variables needed for this CLI to run correctly -

• STORAGE_CONNECTION_STRING
• VR_APP_CLIENT_SECRET
• VR_APP_CLIENT_ID
• VR_APP_API_URL

Usage: vr-app [options] [command]

• Options:

  • -V, --version output the version number
  • -h, --help display help for command

• Commands:

  • create-policy [options] Create PR policy by VR App
  • run-diff [options] Run VR Tests for screenshots
  • help [command] display help for command

Usage: vr-app create-policy [options]

• Create PR policy by VR App

• Options:

  • --buildType pr/release (choices: "pr", "release")
  • --groupConfigs Group Configs (Stringified JSON with properties { groupKey: string, groupName: string, isBlocking: boolean }[])
  • -h, --help display help for command

• This is used to create the VR policy on the PR.

Usage: vr-app run-diff [options]

• Run VR Tests for screenshots

• Options:

  • --buildType pr/release (choices: "pr", "release")
  • --groupKey Group key
  • --groupName Group Name
  • --ciDefinitionId CI Build Definition Id
  • --screenshotsDirectory Directory for screenshots
  • --workingDirectory Working Directory relative to repo root - used when having multiple repos in git repo (default: ".")
  • -h, --help display help for command

• If buildType is PR this command

  • Figures out baseline build
  • Download baseline build
  • Compares with candidate screenshot
  • Uploads result to blob storage
  • Uploads candidate screenshots to blob storage
  • Post comment on PR

• If buildType is release this command

  • Uploads baseline (screenshotsDirectory input) to blob storage