1
0
mirror of https://github.com/golang/go synced 2024-10-01 15:58:33 -06:00
go/internal/lsp/regtest/env_test.go
Rob Findley 46dc332f25 internal/lsp: instrument work done reporting to use in regtests
In order for regtests to wait until file diagnostics are complete,
instrument diagnostics with verbose WorkDone reporting. In order for
this to be granular enough for use, the modification source needed to be
threaded through to the didModifyFiles function (which is where the
diagnostic goroutine is spun off).

A new expectation is added: CompletedWork, to allow specifying that a
specific work item has been completed. The problem with using
NoOutstandingWork was that it required a continuous chain of work to
prevent the regtest from succeeding when the bug was present, meaning
that by the time we have sent the didChange notification successfully
the server must have started work on its behalf. This was inherently
racy, and too tricky to get right.

Additionally, a couple bugs are fixed:
 - EmptyDiagnostics is corrected to account for the case where we have
   received zero diagnostics for a given file.
 - A deadlock is fixed in Await when expectations are immediately met.

Updates golang/go#36879
Fixes golang/go#32149

Change-Id: I49ee011860351eed96a3b4f6795804b57a10dc60
Reviewed-on: https://go-review.googlesource.com/c/tools/+/229777
Run-TryBot: Robert Findley <rfindley@google.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-04-28 20:46:32 +00:00

68 lines
1.7 KiB
Go

// Copyright 2020 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package regtest
import (
"context"
"encoding/json"
"testing"
"golang.org/x/tools/internal/lsp/protocol"
)
func TestProgressUpdating(t *testing.T) {
e := &Env{
state: State{
outstandingWork: make(map[string]*workProgress),
completedWork: make(map[string]int),
},
}
ctx := context.Background()
if err := e.onWorkDoneProgressCreate(ctx, &protocol.WorkDoneProgressCreateParams{
Token: "foo",
}); err != nil {
t.Fatal(err)
}
if err := e.onWorkDoneProgressCreate(ctx, &protocol.WorkDoneProgressCreateParams{
Token: "bar",
}); err != nil {
t.Fatal(err)
}
updates := []struct {
token string
value interface{}
}{
{"foo", protocol.WorkDoneProgressBegin{Kind: "begin", Title: "foo work"}},
{"bar", protocol.WorkDoneProgressBegin{Kind: "begin", Title: "bar work"}},
{"foo", protocol.WorkDoneProgressEnd{Kind: "end"}},
{"bar", protocol.WorkDoneProgressReport{Kind: "report", Percentage: 42}},
}
for _, update := range updates {
params := &protocol.ProgressParams{
Token: update.token,
Value: update.value,
}
data, err := json.Marshal(params)
if err != nil {
t.Fatal(err)
}
var unmarshaled protocol.ProgressParams
if err := json.Unmarshal(data, &unmarshaled); err != nil {
t.Fatal(err)
}
if err := e.onProgress(ctx, &unmarshaled); err != nil {
t.Fatal(err)
}
}
if _, ok := e.state.outstandingWork["foo"]; ok {
t.Error("got work entry for \"foo\", want none")
}
got := *e.state.outstandingWork["bar"]
want := workProgress{title: "bar work", percent: 42}
if got != want {
t.Errorf("work progress for \"bar\": %v, want %v", got, want)
}
}