Skip to content

Commit

Permalink
rules: VersionsMap for all instances of input
Browse files Browse the repository at this point in the history
This adapts the LSP and fixer to use the versionsMap functionality in
the same way as the linter.

Signed-off-by: Charlie Egan <charlie@styra.com>
  • Loading branch information
charlieegan3 committed Jan 15, 2025
1 parent ada2575 commit 2bc0e1d
Show file tree
Hide file tree
Showing 13 changed files with 240 additions and 274 deletions.
6 changes: 6 additions & 0 deletions cmd/fix.go
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,15 @@ func fix(args []string, params *fixCommandParams) error {
return fmt.Errorf("could not find potential roots: %w", err)
}

versionsMap, err := config.AllRegoVersions(regalDir.Name(), &userConfig)
if err != nil {
return fmt.Errorf("failed to get all Rego versions: %w", err)
}

f := fixer.NewFixer()
f.RegisterRoots(roots...)
f.RegisterFixes(fixes.NewDefaultFixes()...)
f.SetRegoVersionsMap(versionsMap)

if !slices.Contains([]string{"error", "rename"}, params.conflictMode) {
return fmt.Errorf("invalid conflict mode: %s, expected 'error' or 'rename'", params.conflictMode)
Expand Down
10 changes: 6 additions & 4 deletions cmd/lint.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,10 @@ func init() {
warningsFound := 0

for _, violation := range rep.Violations {
if violation.Level == "error" {
switch violation.Level {
case "error":
errorsFound++
} else if violation.Level == "warning" {
case "warning":
warningsFound++
}
}
Expand Down Expand Up @@ -407,7 +408,8 @@ func getWriterForOutputFile(filename string) (io.Writer, error) {

func formatError(format string, err error) error {
// currently, JSON and SARIF will get the same generic JSON error format
if format == formatJSON || format == formatSarif {
switch format {
case formatJSON, formatSarif:
bs, err := json.MarshalIndent(map[string]interface{}{
"errors": []string{err.Error()},
}, "", " ")
Expand All @@ -416,7 +418,7 @@ func formatError(format string, err error) error {
}

return fmt.Errorf("%s", string(bs))
} else if format == formatJunit {
case formatJunit:
testSuites := junit.Testsuites{
Name: "regal",
}
Expand Down
4 changes: 2 additions & 2 deletions e2e/cli_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ func TestLintV0WithRegoV1ImportViolations(t *testing.T) {
expectExitCode(t, err, 3, &stdout, &stderr)

if exp, act := "", stderr.String(); exp != act {
t.Errorf("expected stderr %q, got %q", exp, act)
t.Errorf("expected stderr:\n%s\ngot\n%s", exp, act)
}

var rep report.Report
Expand Down Expand Up @@ -865,7 +865,7 @@ project:
- path: v0
rego-version: 0
- path: v1
rego-version: 0
rego-version: 1
`,
"foo/main.rego": `package wow
Expand Down
52 changes: 20 additions & 32 deletions internal/lsp/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import (
"github.com/styrainc/regal/pkg/fixer/fixes"
"github.com/styrainc/regal/pkg/linter"
"github.com/styrainc/regal/pkg/report"
"github.com/styrainc/regal/pkg/rules"
"github.com/styrainc/regal/pkg/version"
)

Expand Down Expand Up @@ -1068,32 +1069,6 @@ func (l *LanguageServer) StartWebServer(ctx context.Context) {
l.webServer.Start(ctx)
}

func (l *LanguageServer) determineVersionForFile(fileURI string) ast.RegoVersion {
var versionedDirs []string

// if we have no information, then we can return the default
if l.loadedConfigAllRegoVersions.Len() == 0 {
return ast.RegoV1
}

versionedDirs = util.Keys(l.loadedConfigAllRegoVersions.Clone())
slices.Sort(versionedDirs)
slices.Reverse(versionedDirs)

path := strings.TrimPrefix(fileURI, l.workspaceRootURI+"/")

for _, versionedDir := range versionedDirs {
if strings.HasPrefix(path, versionedDir) {
val, ok := l.loadedConfigAllRegoVersions.Get(versionedDir)
if ok {
return val
}
}
}

return ast.RegoV1
}

func (l *LanguageServer) templateContentsForFile(fileURI string) (string, error) {
// this function should not be called with files in the root, but if it is,
// then it is an error to prevent unwanted behavior.
Expand Down Expand Up @@ -1181,7 +1156,14 @@ func (l *LanguageServer) templateContentsForFile(fileURI string) (string, error)
pkg += "_test"
}

version := l.determineVersionForFile(fileURI)
version := ast.RegoUndefined
if l.loadedConfigAllRegoVersions != nil {
version = rules.RegoVersionFromVersionsMap(
l.loadedConfigAllRegoVersions.Clone(),
strings.TrimPrefix(uri.ToPath(l.clientIdentifier, fileURI), uri.ToPath(l.clientIdentifier, l.workspaceRootURI)),
ast.RegoUndefined,
)
}

if version == ast.RegoV0 {
return fmt.Sprintf("package %s\n\nimport rego.v1\n", pkg), nil
Expand Down Expand Up @@ -1785,7 +1767,11 @@ func (l *LanguageServer) handleTextDocumentCompletion(
ClientIdentifier: l.clientIdentifier,
RootURI: l.workspaceRootURI,
Builtins: l.builtinsForCurrentCapabilities(),
RegoVersion: l.determineVersionForFile(params.TextDocument.URI),
RegoVersion: rules.RegoVersionFromVersionsMap(
l.loadedConfigAllRegoVersions.Clone(),
strings.TrimPrefix(params.TextDocument.URI, l.workspaceRootURI),
ast.RegoUndefined,
),
})
if err != nil {
return nil, fmt.Errorf("failed to find completions: %w", err)
Expand Down Expand Up @@ -2189,7 +2175,11 @@ func (l *LanguageServer) handleTextDocumentFormatting(
switch formatter {
case "opa-fmt", "opa-fmt-rego-v1":
opts := format.Opts{
RegoVersion: l.determineVersionForFile(params.TextDocument.URI),
RegoVersion: rules.RegoVersionFromVersionsMap(
l.loadedConfigAllRegoVersions.Clone(),
strings.TrimPrefix(params.TextDocument.URI, l.workspaceRootURI),
ast.RegoUndefined,
),
}

if formatter == "opa-fmt-rego-v1" {
Expand Down Expand Up @@ -2223,9 +2213,7 @@ func (l *LanguageServer) handleTextDocumentFormatting(
params.TextDocument.URI: oldContent,
})

input, err := memfp.ToInput(func(fileName string) ast.RegoVersion {
return l.determineVersionForFile(uri.FromPath(l.clientIdentifier, fileName))
})
input, err := memfp.ToInput(l.loadedConfigAllRegoVersions.Clone())
if err != nil {
return nil, fmt.Errorf("failed to create fixer input: %w", err)
}
Expand Down
148 changes: 0 additions & 148 deletions internal/lsp/server_all_rego_versions_test.go

This file was deleted.

23 changes: 5 additions & 18 deletions pkg/fixer/fileprovider/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import (
"github.com/styrainc/regal/internal/lsp/cache"
"github.com/styrainc/regal/internal/lsp/clients"
"github.com/styrainc/regal/internal/lsp/uri"
"github.com/styrainc/regal/internal/parse"
"github.com/styrainc/regal/internal/util"
"github.com/styrainc/regal/pkg/rules"
)
Expand Down Expand Up @@ -90,23 +89,11 @@ func (c *CacheFileProvider) Rename(from, to string) error {
return nil
}

func (c *CacheFileProvider) ToInput(versionLookup func(string) ast.RegoVersion) (rules.Input, error) {
strContents := make(map[string]string)
modules := make(map[string]*ast.Module)

for filename, content := range c.Cache.GetAllFiles() {
var err error

strContents[filename] = content

po := parse.ParserOptions()
po.RegoVersion = versionLookup(filename)

modules[filename], err = parse.ModuleWithOpts(filename, strContents[filename], po)
if err != nil {
return rules.Input{}, fmt.Errorf("failed to parse module %s: %w", filename, err)
}
func (c *CacheFileProvider) ToInput(versionsMap map[string]ast.RegoVersion) (rules.Input, error) {
input, err := rules.InputFromMap(c.Cache.GetAllFiles(), versionsMap)
if err != nil {
return rules.Input{}, fmt.Errorf("failed to create input: %w", err)
}

return rules.NewInput(strContents, modules), nil
return input, nil
}
2 changes: 1 addition & 1 deletion pkg/fixer/fileprovider/fp.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type FileProvider interface {
Delete(string) error
Rename(string, string) error

ToInput(versionLookup func(string) ast.RegoVersion) (rules.Input, error)
ToInput(versionsMap map[string]ast.RegoVersion) (rules.Input, error)
}

type RenameConflictError struct {
Expand Down
20 changes: 5 additions & 15 deletions pkg/fixer/fileprovider/inmem.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (

"github.com/open-policy-agent/opa/v1/ast"

"github.com/styrainc/regal/internal/parse"
"github.com/styrainc/regal/internal/util"
"github.com/styrainc/regal/pkg/rules"
)
Expand Down Expand Up @@ -112,20 +111,11 @@ func (p *InMemoryFileProvider) DeletedFiles() []string {
return util.Keys(p.deletedFiles)
}

func (p *InMemoryFileProvider) ToInput(versionLookup func(string) ast.RegoVersion) (rules.Input, error) {
modules := make(map[string]*ast.Module)

for filename, content := range p.files {
var err error

po := parse.ParserOptions()
po.RegoVersion = versionLookup(filename)

modules[filename], err = parse.ModuleWithOpts(filename, content, po)
if err != nil {
return rules.Input{}, fmt.Errorf("failed to parse module %s: %w", filename, err)
}
func (p *InMemoryFileProvider) ToInput(versionsMap map[string]ast.RegoVersion) (rules.Input, error) {
input, err := rules.InputFromMap(p.files, versionsMap)
if err != nil {
return rules.Input{}, fmt.Errorf("failed to create input: %w", err)
}

return rules.NewInput(p.files, modules), nil
return input, nil
}
Loading

0 comments on commit 2bc0e1d

Please # to comment.