Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add terraform version command #1016

Merged
merged 9 commits into from
Aug 2, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions internal/langserver/handlers/command/terraform.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
package command

import (
"context"
"fmt"

"github.com/creachadair/jrpc2/code"
"github.com/hashicorp/terraform-ls/internal/langserver/cmd"
"github.com/hashicorp/terraform-ls/internal/langserver/progress"
"github.com/hashicorp/terraform-ls/internal/uri"
)

const terraformVersionRequestVersion = 0

type terraformInfoResponse struct {
FormatVersion int `json:"v"`
RequiredVersion string `json:"required_version,omitempty"`
DiscoveredVersion string `json:"discovered_version,omitempty"`
}

func (h *CmdHandler) TerraformVersionRequestHandler(ctx context.Context, args cmd.CommandArgs) (interface{}, error) {
progress.Begin(ctx, "Initializing")
defer func() {
progress.End(ctx, "Finished")
}()

response := terraformInfoResponse{
FormatVersion: terraformVersionRequestVersion,
}

progress.Report(ctx, "Finding current module info ...")
modUri, ok := args.GetString("uri")
if !ok || modUri == "" {
return response, fmt.Errorf("%w: expected module uri argument to be set", code.InvalidParams.Err())
}

if !uri.IsURIValid(modUri) {
return response, fmt.Errorf("URI %q is not valid", modUri)
}

modPath, err := uri.PathFromURI(modUri)
if err != nil {
return response, err
}

mod, _ := h.StateStore.Modules.ModuleByPath(modPath)
if mod == nil {
return response, nil
}

progress.Report(ctx, "Recording terraform version info ...")
if mod.TerraformVersion != nil {
response.DiscoveredVersion = mod.TerraformVersion.String()
}
if mod.Meta.CoreRequirements != nil {
response.RequiredVersion = mod.Meta.CoreRequirements.String()
}

progress.Report(ctx, "Sending response ...")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is getting the data from memory, it should be pretty quick (definitely sub-second, low milliseconds in most cases), so I'm not sure there's much value in the progress reporting for this particular command?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The method is a no-op if a token isn't provided in the request, so this technically doesn't do anything yet.

My thinking along this lines is that we enable progress information everywhere as we go, instead of having to add when there's a problem. Then we can dial back if it's too much.


return response, nil
}
1 change: 1 addition & 0 deletions internal/langserver/handlers/execute_command.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ func cmdHandlers(svc *service) cmd.Handlers {
cmd.Name("terraform.validate"): cmdHandler.TerraformValidateHandler,
cmd.Name("module.calls"): cmdHandler.ModuleCallsHandler,
cmd.Name("module.providers"): cmdHandler.ModuleProvidersHandler,
cmd.Name("module.terraform"): cmdHandler.TerraformVersionRequestHandler,
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
package handlers

import (
"fmt"
"testing"

"github.com/hashicorp/go-version"
"github.com/hashicorp/terraform-ls/internal/document"
"github.com/hashicorp/terraform-ls/internal/langserver"
"github.com/hashicorp/terraform-ls/internal/langserver/cmd"
"github.com/hashicorp/terraform-ls/internal/state"
"github.com/hashicorp/terraform-ls/internal/terraform/exec"
"github.com/hashicorp/terraform-ls/internal/uri"
"github.com/hashicorp/terraform-ls/internal/walker"
tfaddr "github.com/hashicorp/terraform-registry-address"
tfmod "github.com/hashicorp/terraform-schema/module"
"github.com/stretchr/testify/mock"
)

func TestLangServer_workspaceExecuteCommand_terraformVersion_basic(t *testing.T) {
modDir := t.TempDir()
modUri := uri.FromPath(modDir)

s, err := state.NewStateStore()
if err != nil {
t.Fatal(err)
}

err = s.Modules.Add(modDir)
if err != nil {
t.Fatal(err)
}

metadata := &tfmod.Meta{
Path: modDir,
CoreRequirements: testConstraint(t, "~> 0.15"),
}

err = s.Modules.UpdateMetadata(modDir, metadata, nil)
if err != nil {
t.Fatal(err)
}

ver, err := version.NewVersion("1.1.0")
if err != nil {
t.Fatal(err)
}

err = s.Modules.UpdateTerraformVersion(modDir, ver, map[tfaddr.Provider]*version.Version{}, nil)
if err != nil {
t.Fatal(err)
}

wc := walker.NewWalkerCollector()

ls := langserver.NewLangServerMock(t, NewMockSession(&MockSessionInput{
TerraformCalls: &exec.TerraformMockCalls{
PerWorkDir: map[string][]*mock.Call{
modDir: validTfMockCalls(),
},
},
StateStore: s,
WalkerCollector: wc,
}))
stop := ls.Start(t)
defer stop()

ls.Call(t, &langserver.CallRequest{
Method: "initialize",
ReqParams: fmt.Sprintf(`{
"capabilities": {},
"rootUri": %q,
"processId": 12345
}`, modUri)})
waitForWalkerPath(t, s, wc, document.DirHandleFromURI(modUri))
ls.Notify(t, &langserver.CallRequest{
Method: "initialized",
ReqParams: "{}",
})

ls.CallAndExpectResponse(t, &langserver.CallRequest{
Method: "workspace/executeCommand",
ReqParams: fmt.Sprintf(`{
"command": %q,
"arguments": ["uri=%s"]
}`, cmd.Name("module.terraform"), modUri)}, `{
"jsonrpc": "2.0",
"id": 2,
"result": {
"v": 0,
"required_version": "~\u003e 0.15",
"discovered_version": "1.1.0"
}
}`)
}