Skip to content

Latest commit

 

History

History
167 lines (110 loc) · 9.44 KB

README.md

File metadata and controls

167 lines (110 loc) · 9.44 KB
Raw

vscode-opa

This plugin provides a number of features to help you work with Open Policy Agent (OPA) policies in Visual Studio Code.

Features

  • Evaluate Packages
  • Evaluate Selections
  • Partially Evaluate Selections
  • Trace Selections
  • Profile Selections
  • Run Tests in Workspace
  • Toggle Coverage in Workspace
  • Toggle Coverage of Selections

Additionally, users may choose to install Regal, which adds the following features via the Language Server Protocol (LSP):

  • Diagnostics (linting)
  • Hover / tooltips (for inline docs on built-in functions)
  • Go to definition (ctrl/cmd + click on a reference to go to definition)
  • Folding ranges (expand/collapse blocks, imports, comments)
  • Document and workspace symbols (navigate to rules, functions, packages)
  • Inlay hints (show names of built-in function arguments next to their values)
  • Formatting (opa fmt, opa fmt --rego-v1 or regal fix, see Configuration below)
  • Code actions (quick fixes for linting issues)
  • Code completions
  • Code lenses (click to evaluate any package or rule in the editor, and have the result displayed directly on the same line)

To learn more about each language server feature, see the Regal language server documentation.

Use of the extension to lint and eval Rego code

Regal also adds the ability to debug Rego modules via the Debug Adapter Protocol (DAP):

  • Launching eval debug sessions
  • Setting and halting on breakpoints
  • Stepping over, into, and out of rules, functions, every-statements, and comprehensions
  • Inspecting the data and input documents
  • Inspecting local variable values
  • Inspecting values in the Virtual Cache (global results of rule and function evaluations)

Requirements

  • This plugin requires the Open Policy Agent executable (opa) to be installed in your $PATH. Alternatively, you can configure the opa.dependency_paths.opa setting to point to the executable. If you do not have OPA installed, the plugin will prompt you to install the executable the first time you evaluate a policy, run tests, etc.

Installation

To install the extension, visit the Visual Studio Code Marketplace or search for "Open Policy Agent" in the 'Extensions' panel.

Tip

This extension has built-in support for linting and hover tooltips through a native integration with Regal. See the 'Getting Started' guide for more information about installing Regal.

Configuration

Field Default Description
opa.dependency_paths.opa null Set path of OPA executable. If the path contains the string ${workspaceFolder} it will be replaced with the current workspace root. E.g., if the path is set to ${workspaceFolder}/bin/opa and the current workspace root is /home/alice/project, the OPA executable path will resolve to /home/alice/project/bin/opa.
opa.checkOnSave false Enable automatic checking of .rego files on save.
opa.strictMode false Enable strict-mode for the OPA: Check File Syntax command.
opa.roots [${workspaceFolder}] List of paths to load as bundles for policy and data. Defaults to a single entry which is the current workspace root. The variable ${workspaceFolder} will be resolved as the current workspace root. The variable ${fileDirname} will be resolved as the directory of the file currently opened in the active window.
opa.bundleMode true Enable treating the workspace as a bundle to avoid loading erroneous data JSON/YAML files. It is NOT recommended to disable this.
opa.schema null Path to the schema file or directory. If set to null, schema evaluation is disabled. As for opa.roots, ${workspaceFolder} and ${fileDirname} variables can be used in the path.
opa.languageServers null An array of enabled language servers (currently ["regal"] is supported)
opa.env {} Object of environment variables passed to the process running OPA (e.g. {"key": "value"})
opa.formatter opa-fmt Name of the OPA formatter to use. Requires Regal. One of opa-fmt, opa-fmt-rego-v1 and regal-fix. This value is sent as an initialization option to the language server, so the change won't take effect before the project (or VS Code) is reloaded. See the documentation for the regal fix command for more information

Note that the ${workspaceFolder} variable will expand to a full URI of the workspace, as expected by most VS Code commands. The ${workspacePath} variable may additionally be used where only the path component (i.e. without the file:// schema component) of the workspace URI is required.

For bundle documentation refer to https://www.openpolicyagent.org/docs/latest/management/#bundle-file-format. Note that data files MUST be named either data.json or data.yaml.

Using opa.env to set OPA command line flags

From OPA v0.62.0 and onwards, it's possible to set any command line flag via environment variables as an alternative to arguments to the various opa commands. This allows using the opa.env object for setting any flag to the commmands executed by the extension. The format of the environment variables follows the pattern OPA_<COMMAND>_<FLAG> where COMMAND is the command name in uppercase (like EVAL) and FLAG is the flag name in uppercase (like IGNORE). For example, to set the --capabilities flag for the opa check and opa eval command, use the following configuration in your .vscode/settings.json file:

{
    "opa.env": {
        "OPA_CHECK_CAPABILITIES": "${workspacePath}/misc/capabilities.json",
        "OPA_EVAL_CAPABILITIES": "${workspacePath}/misc/capabilities.json"
    }
}

Tips

Set the input document by creating input.json

The extension will look for a file called input.json in the current directory of the policy file being evaluated, or at the root of the workspace, and will use it as the input document when evaluating policies. If you modify this file and re-run evaluation you will see the affect of the changes.

The code lens evaluation feature (with Regal installed) shows an "Evaluate" button over any package or rule declaration, which when clicked displays the result of evaluation directly on the same line as the package or rule. Providing input for this type of evaluation is done the same way, i.e. via an input.json file.

We recommend adding input.json to the .gitignore file of your project, so that you can evaluate policy anywhere without the risk of accidentally committing the input.

Bind keyboard shortcuts for frequently used commands

Open the keyboard shortcuts file (keybindings.json) for VS Code (⌘ Shift p → Preferences: Open Keyboard Shortcuts File) and add the following JSON snippets.

Bind the OPA: Evaluate Selection command to a keyboard shortcut (e.g., ⌘ e) to quickly evaluate visually selected blocks in the policy.

{
    "key": "cmd+e",
    "command": "opa.eval.selection",
    "when": "editorLangId == rego"
}

Bind the OPA: Evaluate Package command to a keyboard shortcut (e.g., ⌘ Shift a) to quickly evaluate the entire package and see all of the decisions.

{
    "key": "shift+cmd+a",
    "command": "opa.eval.package",
    "when": "editorLangId == rego"
}

Loading arbitrary JSON/YAML as data

If unable to use data.json or data.yaml files with opa.bundleMode enabled you can disable the configuration option and ALL *.json and *.yaml files will be loaded from the workspace.

Disabling linting

If you want to disable linting for a specific workspace while retaining the other features Regal provides — for example when working with code that you can't change — you can do so by providing a .regal/config.yaml file at the root of the workspace. To disable linting entirely, your config file could look like this:

rules:
  default:
    level: ignore

Regal additionally scans for a .regal/config.yaml file above the workspace, which can be used to disable linting for all workspaces that inherit from it, or to use a common configuration file across multiple workspaces.

Debugging OPA command evaluation

In case some command isn't behaving as you expect, you can see exactly what command was executed by opening the developer tools from the Help menu and check the Console tab.

Development

If you want to hack on the extension itself, you should clone this repository, install the dependencies (npm install --include=dev) and use Visual Studio Code's Debugger (F5) to test your changes.

ROADMAP

  • highlight syntax errors in file (available when using Regal language server)
  • run opa test on package instead of entire workspace