-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for function signature help (#1077)
* Bump hcl-lang to 3faa6c * Add functions to PathContext * Add SignatureHelp handler * Test SignatureHelp handler * Set signature help trigger characters * Review feedback * Move ActiveParameter
- Loading branch information
Showing
11 changed files
with
410 additions
and
4 deletions.
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
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,41 @@ | ||
| package decoder | ||
|
|
||
| import ( | ||
| "github.com/hashicorp/go-version" | ||
| "github.com/hashicorp/hcl-lang/schema" | ||
| "github.com/hashicorp/terraform-ls/internal/state" | ||
| tfschema "github.com/hashicorp/terraform-schema/schema" | ||
| ) | ||
|
|
||
| func coreFunctions(mod *state.Module) map[string]schema.FunctionSignature { | ||
| if mod.TerraformVersion != nil { | ||
| s, err := tfschema.FunctionsForVersion(mod.TerraformVersion) | ||
| if err == nil { | ||
| return s | ||
| } | ||
| if mod.TerraformVersion.LessThan(tfschema.OldestAvailableVersion) { | ||
| return mustFunctionsForVersion(tfschema.OldestAvailableVersion) | ||
| } | ||
|
|
||
| return mustFunctionsForVersion(tfschema.LatestAvailableVersion) | ||
| } | ||
|
|
||
| s, err := tfschema.FunctionsForConstraint(mod.Meta.CoreRequirements) | ||
| if err == nil { | ||
| return s | ||
| } | ||
| if mod.Meta.CoreRequirements.Check(tfschema.OldestAvailableVersion) { | ||
| return mustFunctionsForVersion(tfschema.OldestAvailableVersion) | ||
| } | ||
|
|
||
| return mustFunctionsForVersion(tfschema.LatestAvailableVersion) | ||
| } | ||
|
|
||
| func mustFunctionsForVersion(v *version.Version) map[string]schema.FunctionSignature { | ||
| s, err := tfschema.FunctionsForVersion(v) | ||
| if err != nil { | ||
| // this should never happen | ||
| panic(err) | ||
| } | ||
| return s | ||
| } |
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
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,38 @@ | ||
| package handlers | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| ilsp "github.com/hashicorp/terraform-ls/internal/lsp" | ||
| lsp "github.com/hashicorp/terraform-ls/internal/protocol" | ||
| ) | ||
|
|
||
| func (svc *service) SignatureHelp(ctx context.Context, params lsp.SignatureHelpParams) (*lsp.SignatureHelp, error) { | ||
| _, err := ilsp.ClientCapabilities(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| dh := ilsp.HandleFromDocumentURI(params.TextDocument.URI) | ||
| doc, err := svc.stateStore.DocumentStore.GetDocument(dh) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| d, err := svc.decoderForDocument(ctx, doc) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| pos, err := ilsp.HCLPositionFromLspPosition(params.Position, doc) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| sig, err := d.SignatureAtPos(doc.Filename, pos) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return ilsp.ToSignatureHelp(sig), nil | ||
| } |
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,150 @@ | ||
| package handlers | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/hashicorp/go-version" | ||
| tfjson "github.com/hashicorp/terraform-json" | ||
| "github.com/hashicorp/terraform-ls/internal/langserver" | ||
| "github.com/hashicorp/terraform-ls/internal/langserver/session" | ||
| "github.com/hashicorp/terraform-ls/internal/state" | ||
| "github.com/hashicorp/terraform-ls/internal/terraform/exec" | ||
| "github.com/hashicorp/terraform-ls/internal/walker" | ||
| "github.com/stretchr/testify/mock" | ||
| ) | ||
|
|
||
| func TestSignatureHelp_withoutInitialization(t *testing.T) { | ||
| ls := langserver.NewLangServerMock(t, NewMockSession(nil)) | ||
| stop := ls.Start(t) | ||
| defer stop() | ||
|
|
||
| ls.CallAndExpectError(t, &langserver.CallRequest{ | ||
| Method: "textDocument/signatureHelp", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "textDocument": { | ||
| "uri": "%s/main.tf" | ||
| }, | ||
| "position": { | ||
| "character": 0, | ||
| "line": 1 | ||
| }, | ||
| "context": { | ||
| "isRetrigger": false, | ||
| "triggerCharacter": "(", | ||
| "triggerKind": 2 | ||
| } | ||
| }`, TempDir(t).URI)}, session.SessionNotInitialized.Err()) | ||
| } | ||
|
|
||
| func TestSignatureHelp_withValidData(t *testing.T) { | ||
| tmpDir := TempDir(t) | ||
| InitPluginCache(t, tmpDir.Path()) | ||
|
|
||
| var testSchema tfjson.ProviderSchemas | ||
| err := json.Unmarshal([]byte(testModuleSchemaOutput), &testSchema) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| ss, err := state.NewStateStore() | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| wc := walker.NewWalkerCollector() | ||
|
|
||
| ls := langserver.NewLangServerMock(t, NewMockSession(&MockSessionInput{ | ||
| TerraformCalls: &exec.TerraformMockCalls{ | ||
| PerWorkDir: map[string][]*mock.Call{ | ||
| tmpDir.Path(): { | ||
| { | ||
| Method: "Version", | ||
| Repeatability: 1, | ||
| Arguments: []interface{}{ | ||
| mock.AnythingOfType(""), | ||
| }, | ||
| ReturnArguments: []interface{}{ | ||
| version.Must(version.NewVersion("0.12.0")), | ||
| nil, | ||
| nil, | ||
| }, | ||
| }, | ||
| { | ||
| Method: "GetExecPath", | ||
| Repeatability: 1, | ||
| ReturnArguments: []interface{}{ | ||
| "", | ||
| }, | ||
| }, | ||
| { | ||
| Method: "ProviderSchemas", | ||
| Repeatability: 1, | ||
| Arguments: []interface{}{ | ||
| mock.AnythingOfType(""), | ||
| }, | ||
| ReturnArguments: []interface{}{ | ||
| &testSchema, | ||
| nil, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| StateStore: ss, | ||
| WalkerCollector: wc, | ||
| })) | ||
| stop := ls.Start(t) | ||
| defer stop() | ||
|
|
||
| ls.Call(t, &langserver.CallRequest{ | ||
| Method: "initialize", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "capabilities": {}, | ||
| "rootUri": %q, | ||
| "processId": 12345 | ||
| }`, tmpDir.URI)}) | ||
| waitForWalkerPath(t, ss, wc, tmpDir) | ||
| ls.Notify(t, &langserver.CallRequest{ | ||
| Method: "initialized", | ||
| ReqParams: "{}", | ||
| }) | ||
| ls.Call(t, &langserver.CallRequest{ | ||
| Method: "textDocument/didOpen", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "textDocument": { | ||
| "version": 0, | ||
| "languageId": "terraform", | ||
| "text": "variable \"name\" {\n default = file(\"~/foo\")\n}", | ||
| "uri": "%s/main.tf" | ||
| } | ||
| }`, TempDir(t).URI)}) | ||
| waitForAllJobs(t, ss) | ||
|
|
||
| ls.CallAndExpectResponse(t, &langserver.CallRequest{ | ||
| Method: "textDocument/signatureHelp", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "textDocument": { | ||
| "uri": "%s/main.tf" | ||
| }, | ||
| "position": { | ||
| "character": 16, | ||
| "line": 1 | ||
| }, | ||
| "context": { | ||
| "isRetrigger": false, | ||
| "triggerCharacter": "(", | ||
| "triggerKind": 2 | ||
| } | ||
| }`, TempDir(t).URI)}, `{ | ||
| "jsonrpc": "2.0", | ||
| "id": 3, | ||
| "result": { | ||
| "signatures": [{ | ||
| "label": "file(path string) string", | ||
| "documentation": "file reads the contents of a file at the given path and returns them as a string.", | ||
| "parameters": [{"label": "path"}] | ||
| }] | ||
| } | ||
| }`) | ||
| } |
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,35 @@ | ||
| package lsp | ||
|
|
||
| import ( | ||
| "github.com/hashicorp/hcl-lang/lang" | ||
| "github.com/hashicorp/terraform-ls/internal/mdplain" | ||
| lsp "github.com/hashicorp/terraform-ls/internal/protocol" | ||
| ) | ||
|
|
||
| func ToSignatureHelp(signature *lang.FunctionSignature) *lsp.SignatureHelp { | ||
| if signature == nil { | ||
| return nil | ||
| } | ||
|
|
||
| parameters := make([]lsp.ParameterInformation, 0, len(signature.Parameters)) | ||
| for _, p := range signature.Parameters { | ||
| parameters = append(parameters, lsp.ParameterInformation{ | ||
| Label: p.Name, | ||
| // TODO: Support markdown per https://github.com/hashicorp/terraform-ls/issues/1212 | ||
| Documentation: mdplain.Clean(p.Description.Value), | ||
| }) | ||
| } | ||
|
|
||
| return &lsp.SignatureHelp{ | ||
| Signatures: []lsp.SignatureInformation{ | ||
| { | ||
| Label: signature.Name, | ||
| // TODO: Support markdown per https://github.com/hashicorp/terraform-ls/issues/1212 | ||
| Documentation: mdplain.Clean(signature.Description.Value), | ||
| Parameters: parameters, | ||
| }, | ||
| }, | ||
| ActiveParameter: signature.ActiveParameter, | ||
| ActiveSignature: 0, | ||
| } | ||
| } |
Oops, something went wrong.