lsp/server: Cache AllRegoVersions at config load #1325
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| package lsp | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/open-policy-agent/opa/v1/ast" | ||
|
|
||
| "github.com/styrainc/regal/internal/lsp/clients" | ||
| "github.com/styrainc/regal/internal/lsp/log" | ||
| "github.com/styrainc/regal/internal/lsp/uri" | ||
| "github.com/styrainc/regal/pkg/config" | ||
| ) | ||
|
|
||
| func TestAllRegoVersions(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| testCases := map[string]struct { | ||
| FileKey string | ||
| ExpectedVersion ast.RegoVersion | ||
| DiskContents map[string]string | ||
| }{ | ||
| "unknown version": { | ||
| FileKey: "foo/bar.rego", | ||
| DiskContents: map[string]string{ | ||
| "foo/bar.rego": "package foo", | ||
| ".regal/config.yaml": "", | ||
| }, | ||
| ExpectedVersion: ast.RegoV1, | ||
| }, | ||
| "version set in project config": { | ||
| FileKey: "foo/bar.rego", | ||
| DiskContents: map[string]string{ | ||
| "foo/bar.rego": "package foo", | ||
| ".regal/config.yaml": ` | ||
| project: | ||
| rego-version: 0 | ||
| `, | ||
| }, | ||
| ExpectedVersion: ast.RegoV0, | ||
| }, | ||
| "version set in root config": { | ||
| FileKey: "foo/bar.rego", | ||
| DiskContents: map[string]string{ | ||
| "foo/bar.rego": "package foo", | ||
| ".regal/config.yaml": ` | ||
| project: | ||
| rego-version: 1 | ||
| roots: | ||
| - path: foo | ||
| rego-version: 0 | ||
| `, | ||
| }, | ||
| ExpectedVersion: ast.RegoV0, | ||
| }, | ||
| "version set in manifest": { | ||
| FileKey: "foo/bar.rego", | ||
| DiskContents: map[string]string{ | ||
| "foo/bar.rego": "package foo", | ||
| "foo/.manifest": `{"rego_version": 0}`, | ||
| ".regal/config.yaml": ``, | ||
| }, | ||
| ExpectedVersion: ast.RegoV0, | ||
| }, | ||
| "version set in manifest, overridden by config": { | ||
| FileKey: "foo/bar.rego", | ||
| DiskContents: map[string]string{ | ||
| "foo/bar.rego": "package foo", | ||
| "foo/.manifest": `{"rego_version": 1}`, | ||
| ".regal/config.yaml": ` | ||
| project: | ||
| roots: | ||
| - path: foo | ||
| rego-version: 0 | ||
| `, | ||
| }, | ||
| ExpectedVersion: ast.RegoV0, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range testCases { | ||
| t.Run(name, func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| td := t.TempDir() | ||
|
|
||
| // init the state on disk | ||
| for f, c := range tc.DiskContents { | ||
| dir := filepath.Dir(f) | ||
|
|
||
| if err := os.MkdirAll(filepath.Join(td, dir), 0o755); err != nil { | ||
| t.Fatalf("failed to create directory %s: %s", dir, err) | ||
| } | ||
|
|
||
| if err := os.WriteFile(filepath.Join(td, f), []byte(c), 0o600); err != nil { | ||
| t.Fatalf("failed to write file %s: %s", f, err) | ||
| } | ||
| } | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
|
|
||
| ls := NewLanguageServer(ctx, &LanguageServerOptions{LogWriter: newTestLogger(t), LogLevel: log.LevelDebug}) | ||
| ls.workspaceRootURI = uri.FromPath(clients.IdentifierGeneric, td) | ||
|
|
||
| // have the server load the config | ||
| go ls.StartConfigWorker(ctx) | ||
|
|
||
| configFile, err := config.FindConfig(td) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %s", err) | ||
| } | ||
|
|
||
| ls.configWatcher.Watch(configFile.Name()) | ||
|
|
||
| // wait for ls.loadedConfig to be set | ||
| timeout := time.NewTimer(determineTimeout()) | ||
| defer timeout.Stop() | ||
|
|
||
| for success := false; !success; { | ||
| select { | ||
| default: | ||
| if ls.getLoadedConfig() != nil { | ||
| success = true | ||
|
|
||
| break | ||
| } | ||
|
|
||
| time.Sleep(500 * time.Millisecond) | ||
| case <-timeout.C: | ||
| t.Fatalf("timed out waiting for config to be set") | ||
| } | ||
| } | ||
|
|
||
| // check it has the correct version for the file of interest | ||
| fileURI := uri.FromPath(clients.IdentifierGeneric, filepath.Join(td, tc.FileKey)) | ||
|
|
||
| version := ls.determineVersionForFile(fileURI) | ||
|
|
||
| if version != tc.ExpectedVersion { | ||
| t.Errorf("expected version %v, got %v", tc.ExpectedVersion, version) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neat :)