Skip to main content

identically-named-tests

Summary: Multiple tests with same name

Category: Testing

Avoid

package policy_test

import data.policy

test_allow_if_admin {
    policy.allow with input as {"user": {"roles": ["admin"]}}
}

test_allow_if_admin {
    policy.allow with input as {"user": {"roles": ["superadmin"]}}
}

Prefer

package policy_test

import data.policy

test_allow_if_admin {
    policy.allow with input as {"user": {"roles": ["admin"]}}
}

test_allow_if_superadmin {
    policy.allow with input as {"user": {"roles": ["superadmin"]}}
}

Rationale​

While OPA allows multiple tests with the same name, using unique names for tests makes for easier to read test code, as well as more informative test output. Since a single test may include any number of assertions, there's no need to reuse test names within the same test package.

Configuration Options​

This linter rule provides the following configuration options:

rules: 
  testing:
    identically-named-tests:
      # one of "error", "warning", "ignore"
      level: error

Community​

If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules, or just talk about Regal in general, please join us in the #regal channel in the Styra Community Slack!