ContextQMD
Back to Opa

invalid-regexp

docs/projects/regal/rules/bugs/invalid-regexp.md

1.16.11.2 KB
Original Source

invalid-regexp

Summary: Invalid regular expression

Category: Bugs

Avoid

rego
package policy

invalid if regex.match(`[abc`, input.text)

Prefer

rego
package policy

valid if regex.match(`[abc]`, input.text)

Rationale

An invalid regular expression typically fails silently (i.e. the result is undefined) at runtime when OPA evaluates the function call, or with a runtime error if the show-builtin-errors option is enabled. While hopefully caught by unit tests, tracking down a typo in a regular expression is still time consuming. This rule instead analyzes any regular expressions found in a policy as you author it (using OPA's own regex.is_valid function) and reports invalid patterns directly.

Configuration Options

This linter rule provides the following configuration options:

yaml
rules:
  bugs:
    invalid-regexp:
      # one of "error", "warning", "ignore"
      level: error