Replace some Styra references (#1904)

And a few other minor things:
- Bump golangci-lint to latest and fix or ignore a few new things
- Some tweaks in built-in markdown templating, and another unit test to verify functionality

Signed-off-by: Anders Eknert <anders.eknert@apple.com>

Author: anderseknert

.github/workflows/build.yaml

@@ -65,7 +65,7 @@ jobs:
       - uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # v9.2.0
         if: matrix.os.name == 'linux'
         with:
-          version: v2.9.0
+          version: v2.10.1
       - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
         with:
           name: regal-${{ matrix.os.name }}

.golangci.yaml

@@ -51,6 +51,12 @@ linters:
         - whyNoLint # not all nolint comments need explanations
         - hugeParam # investigate later, but some of these breaks API signatures
         - unnamedResult
+    gosec:
+      excludes:
+        # taint analysis. not relevant as Regal assumes trusted user
+        - G703
+        - G704
+        - G706
     govet:
       disable:
         - shadow

build/do.rq

@@ -219,14 +219,14 @@ fetch_eopa_caps if {
 	#	],
 	#	...
 
-	print("fetching tags for enterprise-opa repository")
+	print("fetching tags for eopa repository")
 
 	eopa_tags_result := rq.run(
 		[
 			"git",
 			"ls-remote",
 			"--tags",
-			"https://github.com/styrainc/enterprise-opa",
+			"https://github.com/open-policy-agent/eopa",
 		],
 		{"stdout_spec": {
 			"format": "raw",
@@ -283,7 +283,7 @@ fetch_eopa_caps if {
 		not eopa_caps_tree[p]
 
 		# construct the URL to fetch the content from
-		r := rq.template("https://raw.githubusercontent.com/StyraInc/enterprise-opa/main/capabilities/{{.tag}}.json", {"tag": t})
+		r := rq.template("https://raw.githubusercontent.com/open-policy-agent/eopa/main/capabilities/{{.tag}}.json", {"tag": t})
 	}
 
 	print(sprintf("fetching %d capabilities files missing locally", [count(missing_locally)]))

bundle/regal/lsp/clients/clients.rego

@@ -24,7 +24,7 @@ gotest := 2
 # description: The Zed Editor, via zed-rego
 # related_resources:
 #   - https://zed.dev/docs/languages/rego
-#   - https://github.com/styrainc/zed-rego
+#   - https://github.com/styraoss/zed-rego
 zed := 3
 
 # METADATA

bundle/regal/lsp/template/template.rego

@@ -7,13 +7,14 @@ package regal.lsp.template
 render_for_builtin(builtin) := content if {
 	category := _category(builtin)
 	builtin_safe := _to_safe_builtin(builtin)
+	args := concat(", ", [arg.name | some arg in builtin_safe.decl.args])
 
 	content := replace(
 		strings.render_template(_builtin_template, {
 			"builtin": builtin_safe,
 			"category": category,
 			"link": _docs_link(builtin_safe, category),
-			"snippet": _example_snippet(builtin_safe),
+			"snippet": $"```rego\n{builtin_safe.decl.result.name} := {builtin_safe.name}({args})\n```",
 		}),
 		"<bt>", "`",
 	)
@@ -22,7 +23,7 @@ render_for_builtin(builtin) := content if {
 _docs_link(builtin, category) := link if {
 	builtin.categories != []
 
-	link := [substring(bc, 4, -1) |
+	link := [trim_prefix(bc, "url=") |
 		some bc in builtin.categories
 		startswith(bc, "url=")
 	][0]
@@ -56,15 +57,6 @@ _category(builtin) := builtin.categories[0] if {
 	i != -1
 } else := builtin.name
 
-_example_snippet(builtin) := snippet if {
-	args := [arg.name | some arg in builtin.decl.args]
-	snippet := sprintf("```rego\n%s := %s(%s)\n```", [
-		builtin.decl.result.name,
-		builtin.name,
-		concat(", ", args),
-	])
-}
-
 # here to work around the **extremely** annoying behavior of strings.render_template
 # where missing keys are treated as fatal errors instead of giving template authors a
 # chance to handle this: https://github.com/open-policy-agent/opa/issues/7931
@@ -83,11 +75,9 @@ _to_safe_builtin(builtin) := safe if {
 	}
 
 	merged := object.union(safe_attributes, builtin)
-	safe := object.union(merged, {"decl": {"args": _safe_args(merged.decl.args)}})
+	safe := object.union(merged, {"decl": {"args": [_to_safe_arg(i, arg) | some i, arg in merged.decl.args]}})
 }
 
-_safe_args(args) := [_to_safe_arg(i, arg) | some i, arg in args]
-
 _to_safe_arg(i, arg) := arg if {
 	_safe_arg(arg)
 } else := object.union(

bundle/regal/lsp/template/template_test.rego

@@ -2,11 +2,58 @@ package regal.lsp.template_test
 
 import data.regal.lsp.template
 
+test_template_common_builtin_function if {
+	builtin := {
+		"categories": ["strings"],
+		"decl": {
+			"args": [
+				{
+					"description": "search string",
+					"name": "search",
+					"type": "string",
+				},
+				{
+					"description": "base string",
+					"name": "base",
+					"type": "string",
+				},
+			],
+			"result": {
+				"description": "result of the prefix check",
+				"name": "result",
+				"type": "boolean",
+			},
+			"type": "function",
+		},
+		"description": "Returns true if the search string begins with the base string.",
+		"name": "startswith",
+	}
+	rendered := template.render_for_builtin(builtin)
+
+	rendered == concat("\n", [
+		`### [startswith](https://www.openpolicyagent.org/docs/policy-reference/#builtin-strings-startswith)`,
+		"",
+		"```rego",
+		"result := startswith(search, base)",
+		"```",
+		"",
+		"Returns true if the search string begins with the base string.",
+		"",
+		"#### Arguments",
+		"",
+		"- `search` string: search string",
+		"- `base` string: base string",
+		"",
+		"Returns `result` of type `boolean`: result of the prefix check",
+		"",
+	])
+}
+
 test_template_eopa_builtin if {
 	builtin := {
 		"name": "neo4j.query",
 		"description": "Returns results for the given neo4j query.",
-		"categories": ["url=https://docs.styra.com/enterprise-opa/reference/built-in-functions/neo4j"],
+		"categories": ["url=https://github.com/open-policy-agent/eopa/blob/main/docs/eopa/reference/built-in-functions/neo4j.md"],
 		"decl": {
 			"args": [{
 				"description": "query object",

docs/adopters.md

@@ -35,8 +35,9 @@ Public open source projects integrating Regal for linting in their CI/CD pipelin
 Projects and products that integrate Regal into their offerings.
 
 <!-- cspell:disable -->
+- [Code Rabbit](https://docs.coderabbit.ai/tools/regal)
 - [Dependency Management Data](https://gitlab.com/tanna.dev/dependency-management-data)
-- [Enterprise OPA](https://github.com/styrainc/enterprise-opa)
+- [EOPA](https://github.com/open-policy-agent/eopa)
 - [The Rego Playground](https://play.openpolicyagent.org)
 - [Trunk Check](https://trunk.io/)
 - [reviewdog/action-regal](https://github.com/reviewdog/action-regal)
@@ -74,7 +75,6 @@ Some companies and organizations using Regal.
 - [Red Hat](https://www.redhat.com)
 - [Spacelift](https://www.spacelift.io)
 - [Stacklok](https://stacklok.com)
-- [Styra](https://www.styra.com)
 - [UNIwise](https://uniwise.eu/)
 - [VodafoneZiggo](https://www.vodafoneziggo.nl)
 <!-- cspell:enable-->

docs/configuration/capabilities.md

@@ -43,18 +43,18 @@ capabilities:
     version: v0.58.0
   minus:
     builtins:
-    # exclude rules that depend on the http.send built-in function
-    - name: http.send
+      # exclude rules that depend on the http.send built-in function
+      - name: http.send
   plus:
     builtins:
-    # make Regal aware of a custom "ldap.query" function
-    - name: ldap.query
-      type: function
-      decl:
-        args:
-        - type: string
-      result:
-        type: object
+      # make Regal aware of a custom "ldap.query" function
+      - name: ldap.query
+        type: function
+        decl:
+          args:
+            - type: string
+        result:
+          type: object
 ```
 
 ## Loading Capabilities from URLs
@@ -73,10 +73,10 @@ capabilities:
 
 Regal includes capabilities files for the following engines:
 
-| Engine | Website                                                         | Description          |
-| ------ | --------------------------------------------------------------- | -------------------- |
-| `opa`  | [OPA website](https://www.openpolicyagent.org/)                 | Open Policy Agent    |
-| `eopa` | [Enterprise OPA website](https://www.styra.com/enterprise-opa/) | Styra Enterprise OPA |
-| `rq`   | [rq website](https://git.sr.ht/~charles/rq)                     | Rego Query (`rq`)    |
+| Engine | Website                                                      | Description       |
+| ------ | ------------------------------------------------------------ | ----------------- |
+| `opa`  | [OPA website](https://www.openpolicyagent.org/)              | Open Policy Agent |
+| `eopa` | [EOPA repository](https://github.com/open-policy-agent/eopa) | EOPA              |
+| `rq`   | [rq website](https://git.sr.ht/~charles/rq)                  | Rego Query (`rq`) |
 
 **`rq` support note**: `rq` scripts must include `package` statements to be compatible with Regal.

internal/lsp/semantictokens_test.go

@@ -161,13 +161,13 @@ func generateLargePolicy(numFunctions int) string {
 	policy.WriteString("package regal.woo\n\n")
 
 	for i := range numFunctions {
-		policy.WriteString(fmt.Sprintf(`test_function_%d(param1, param2) := result if {
+		fmt.Fprintf(&policy, `test_function_%d(param1, param2) := result if {
 	calc1 := param1 * %d
 	calc2 := param2 + %d
 	result := calc1 + calc2
 }
 
-`, i, i+1, i+10))
+`, i, i+1, i+10)
 	}
 
 	return policy.String()

pkg/roast/rast/rast_test.go

@@ -63,7 +63,7 @@ func TestStructToValueTagWithTrailingComma(t *testing.T) {
 	t.Parallel()
 
 	type testStruct struct {
-		Field string `json:"field,"`
+		Field string `json:"field,"` //nolint:staticcheck
 	}
 
 	got := rast.StructToValue(testStruct{Field: "value"})