[release] prepare v0.17.0 release

322e058 0.16.2 release CHANGELOG
368fc43 src/util.ts: allow getGoVersion when there is no active text editor
c23df8f src/goLanguageServer.ts: restart if go.toolsEnvVars changes
f8bce8c src/goBuild: remove misleading error message in modules mode
dcea773 src/goCover.ts: correct windows absolute filepath handling
02869c8 src/goPackages.ts: pass GOROOT to gopkgs
0b32079 docs/switch-version.md: add Go version switching documentation
1080e21 src/util.ts,goLanguageServer.ts: set cwd for cp.execFile
d594eec build: add setup_env to all.bash and update contributing.md
c705adf src/goInstallTools: report `go env` failure
f2fd351 src/debugAdapter: make filepaths in errors absolute
52260e0 src/goCover.ts: provide explicit directory for running go list
859bb8a src/goTools.ts: recognize gofumpt, gofumports formatters
d05379e test/integration: increase extension test timeout
43d6d04 package.json: let some commands activate extension
5a7752c src/debugAdapter: add delve 'call' command support
575abde src/goEnvironmentStatus: fix PATH mutation logic in osx
77bda0a test/gopls: print gopls traces when test fails
2c287db src/goDebugConfiguration: expand '~' in cwd attribute
bd77a6f src/testUtils.ts: always run test in package list mode
a7b1705 test/integration: add extra tests for env var combining
3ffb96e src/goCover: remove obsolete go.coverageDecorator support
da7328b package.json: disable debug config's showGlobalVariables by default
4b52e43 package.json: disable go.installDependenciesWhenBuilding by default
c7c4188 src/goDebugConfiguration: combine envFile and env
cd41bd1 .github/workflows, build: install dlv in containers
c169d13 src/utils/envUtils.ts: add parseEnvFiles
eeb2512 src/utils: move env var utilities to its own module
95570ec goLanguageServer: attach gopls version to issue reports
e15a8a2 docs: link to more VS Code docs, add alternative ways to start
8f16fe4 tools/generate.go: add defaults and enums to settings.md
9167ad2 docs: add stdlib.md
7f493bf src/goEnvironmentStatus.ts: notify user of available Go updates
1e4dbe2 src/testUtils.ts: fix parsing of the compiler error file expansion
47e2496 docs: fix out-of-sync documentation
139fd7d src/goCover.go: add go.coverMode to display coverage data and counts
d41272c src/util.ts: log `go version` output
6aa134d src/goInstallTools.ts: fix the installation failure message
e1603dd package.json: allow additional properties for alternateTools
56f2f9e src/goLanguageServer.ts: update middleware arguments to match gopls
5089f49 build,.github/workflows: use go1.15
2bd6cd6 docs: expand debugging instructions
f4f147c build: add line breaks to build/Dockerfile
116a0a0 package.json: prepare for 0.17.0 dev
bc9db1e CHANGELOG.md: cherry-pick v0.16.1 CHANGELOG update
aabbc51 src/goLanguageServer.ts: add config to overwrite vscode-go codelens
bec9cf3 src/testUtil.ts: switch to -json mode only if -v is set
9bdb768 build,.github/workflows: install all tools in modules mode
f9c0454 src/debugAdapter2: launch as an external process, and fix config
c3f97ff goLanguageServer: change survey prompt probability to 2.75%
d1404a0 src/goLanguageServer.ts: handle missing filterText in completion items
6a84918 src/goEnv.ts: readd go.toolsEnvVars variable substitution
c6695aa src/goMain.ts: reinstate the goroot var interpolation
c22bbe5 CHANGELOG.md: v0.16.0 release note
9523e4b src/goInstallTools.ts: avoid type check error
18eaf7e src/goEnvironmentStatus.ts: ignore uninstalled Go on network failure
fe3c6b5 package.json: require vscode 1.46 or up
9d1620b src/goLanguageServer.ts: add "debug test" and "debug benchmark" codelens
e3aa3a2 src: npm run fix-lint
d8f9560 src/goEnvironmentStatus.ts: handle failed getGoVersion call
dc9de1c src/util.ts: attempt to fix version parsing again
bd41c5e src/goLanguageServer.ts: fix broken event forwarding in middleware

Change-Id: I19a6f21822f3ea65b8868a26dd15f1522f8eb7d9

Author: hyangah

.github/workflows/release-nightly.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v1
         with:
-         go-version: '1.14'
+         go-version: '1.15'
 
       - name: Install dependencies
         run: npm ci
@@ -55,18 +55,12 @@ jobs:
             go get golang.org/x/lint/golint
             go get golang.org/x/tools/cmd/gorename
             go get golang.org/x/tools/gopls
+            go get github.com/cweill/gotests/...
+            go get github.com/rogpeppe/godef
+            go get github.com/ramya-rao-a/go-outline
+            go get github.com/go-delve/delve/cmd/dlv
         env:
           GO111MODULE: on   
-          
-      - name: Install Go tools (GOPATH mode)
-        run: |
-          go version
-          go get github.com/cweill/gotests/...
-          go get github.com/rogpeppe/godef
-          go get github.com/ramya-rao-a/go-outline
-            # Because some tests depend on the source code checked in GOPATH. TODO: FIX THEM.
-        env:
-          GO111MODULE: off
 
       - name: Run unit tests
         run: npm run unit-test

.github/workflows/test-long.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v1
         with:
-         go-version: '1.14'
+         go-version: '1.15'
 
       - name: Install dependencies
         run: npm ci
@@ -54,19 +54,13 @@ jobs:
             go get golang.org/x/lint/golint
             go get golang.org/x/tools/cmd/gorename
             go get golang.org/x/tools/gopls
+            go get github.com/cweill/gotests/...
+            go get github.com/rogpeppe/godef
+            go get github.com/ramya-rao-a/go-outline
+            go get github.com/go-delve/delve/cmd/dlv
         env:
           GO111MODULE: on   
 
-      - name: Install Go tools (GOPATH mode)
-        run: |
-          go version
-          go get github.com/cweill/gotests/...
-          go get github.com/rogpeppe/godef
-          go get github.com/ramya-rao-a/go-outline
-            # Because some tests depend on the source code checked in GOPATH. TODO: FIX THEM.
-        env:
-          GO111MODULE: off
-      
       - name: Run unit tests
         run: npm run unit-test
 

.github/workflows/test-smoke.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v1
         with:
-         go-version: '1.14'
+         go-version: '1.15'
 
       - name: Install dependencies
         run: npm ci
@@ -50,18 +50,12 @@ jobs:
             go get golang.org/x/lint/golint
             go get golang.org/x/tools/cmd/gorename
             go get golang.org/x/tools/gopls
+            go get github.com/cweill/gotests/...
+            go get github.com/rogpeppe/godef
+            go get github.com/ramya-rao-a/go-outline
+            go get github.com/go-delve/delve/cmd/dlv
         env:
-          GO111MODULE: on   
-          
-      - name: Install Go tools (GOPATH mode)
-        run: |
-          go version
-          go get github.com/cweill/gotests/...
-          go get github.com/rogpeppe/godef
-          go get github.com/ramya-rao-a/go-outline
-            # Because some tests depend on the source code checked in GOPATH. TODO: FIX THEM.
-        env:
-          GO111MODULE: off
+          GO111MODULE: on             
 
       - name: Run unit tests
         run: npm run unit-test
@@ -75,4 +69,4 @@ jobs:
 
       - name: Lint check
         run: npm run lint
-        if: ${{ matrix.os }} == 'ubuntu-latest'
+        if: ${{ matrix.os }} == 'ubuntu-latest'

CHANGELOG.md

@@ -6,7 +6,7 @@
 - Fixed the regression that caused to run tests in the local directory mode and
   result in more verbose output than the package list mode. ([Issue 528](https://github.com/golang/vscode-go/issues/528)).
 - Fixed `"go.alternateTools"` settings to accept any tool names without
-  settings.json diagnostics warning. ([Issue 526](https://github.com/golang/vscode-go/issues/526)
+  settings.json diagnostics warning. ([Issue 526](https://github.com/golang/vscode-go/issues/526))
 
 
 ## v0.16.1 - 5th Aug, 2020
@@ -94,7 +94,6 @@ can see the details of the test results, but we will continue working to make th
 
 Thank you for your contribution, fujimoto kyosuke, OneOfOne, Aditya Thakral, Oleg Butuzov, Rebecca Stambler, Peter Weinberger, Brayden Cloud, Eli Bendersky, Robert Findley, Hana Kim!
 
-
 ## v0.15.2 - 21st July, 2020
 
 ### Fixed

build/Dockerfile

@@ -1,11 +1,14 @@
 # This Docker container is used for testing on GCB.
 
-FROM golang:1.14 AS gobuilder
+FROM golang:1.15 AS gobuilder
 
 ENV GO111MODULE on
 ENV GOBIN /gobin
-ENV GOPROXY https://proxy.golang.org
-RUN cd $(mktemp -d) && go get golang.org/x/tools/gopls@latest
+
+# Install other Go tools tests depend on
+RUN mkdir -p /scratch/build
+ADD build/all.bash /scratch/build/all.bash
+RUN /scratch/build/all.bash setup_env
 
 FROM node:latest
 
@@ -14,28 +17,11 @@ RUN mkdir /go
 COPY --from=gobuilder /gobin /go/bin
 COPY --from=gobuilder /usr/local/go /usr/local/go
 
-# TODO(hyangah): some tests fail if GOPATH is not set. Fix them.
-ENV GOPATH=/go
-ENV PATH=${GOPATH}/bin:/usr/local/go/bin:${PATH}
+ENV GOPATH /go
+ENV PATH ${GOPATH}/bin:/usr/local/go/bin:${PATH}
 ENV DEBIAN_FRONTEND noninteractive
 
 RUN apt-get update && apt-get install -y libnss3 libgtk-3-dev libxss1 libasound2 xvfb libsecret-1-0
 
-# Install other Go tools tests depend on
-RUN go get -u -v \
-	github.com/acroca/go-symbols \
-	github.com/cweill/gotests/... \
-  	github.com/davidrjenni/reftools/cmd/fillstruct \
-  	github.com/haya14busa/goplay/cmd/goplay \
-  	github.com/mdempsky/gocode \
-  	github.com/ramya-rao-a/go-outline \
-  	github.com/rogpeppe/godef \
-  	github.com/sqs/goreturns \
-  	github.com/uudashr/gopkgs/v2/cmd/gopkgs \
-  	github.com/zmb3/gogetdoc \
-  	golang.org/x/lint/golint \
-  	golang.org/x/tools/cmd/gorename
-
-
 WORKDIR /workspace
 ENTRYPOINT ["build/all.bash"]

build/all.bash

@@ -11,6 +11,7 @@ Available subcommands:
   help      - display this help message.
   test      - build and test locally. Some tests may fail if vscode is already in use.
   testlocal - build and test in a locally built container.
+  setup_env - setup environment for test. This installs tools under GOPATH/bin.
   ci        - build and test with headless vscode. Requires Xvfb.
 EOUSAGE
 }
@@ -88,6 +89,24 @@ prepare_nightly() {
   cp build/nightly/const.ts src/const.ts
 }
 
+# setup dependencies required for tests.
+install_dependencies() {
+	GO111MODULE=on go get -x -v golang.org/x/tools/gopls
+	GO111MODULE=on go get -x -v github.com/acroca/go-symbols
+	GO111MODULE=on go get -x -v github.com/cweill/gotests/...
+	GO111MODULE=on go get -x -v github.com/davidrjenni/reftools/cmd/fillstruct
+	GO111MODULE=on go get -x -v github.com/haya14busa/goplay/cmd/goplay
+	GO111MODULE=on go get -x -v github.com/mdempsky/gocode
+	GO111MODULE=on go get -x -v github.com/ramya-rao-a/go-outline
+	GO111MODULE=on go get -x -v github.com/rogpeppe/godef
+	GO111MODULE=on go get -x -v github.com/sqs/goreturns
+	GO111MODULE=on go get -x -v github.com/uudashr/gopkgs/v2/cmd/gopkgs
+	GO111MODULE=on go get -x -v github.com/zmb3/gogetdoc
+	GO111MODULE=on go get -x -v golang.org/x/lint/golint
+	GO111MODULE=on go get -x -v golang.org/x/tools/cmd/gorename
+	GO111MODULE=on go get -x -v github.com/go-delve/delve/cmd/dlv
+}
+
 main() {
   cd "$(root_dir)"  # always run from the script root.
   case "$1" in
@@ -110,6 +129,9 @@ main() {
     "prepare_nightly")
       prepare_nightly
       ;;
+    "setup_env")
+      install_dependencies
+      ;;
     *)
       usage
       exit 2

docs/contributing.md

@@ -62,6 +62,15 @@ If you make subsequent edits in the codebase, you can reload (`Ctrl+R`) the `[Ex
 
 ## Test
 
+Simple unit tests that do not require interaction with VS Code are located in `test/unit`. 
+Tests in `test/integration` and `test/gopls` directories are integration tests. They involve invocation of the VS Code API and 
+require external Go tools installed in `GOPATH`. The command `setup_env` in [`build/all.bash`](https://github.com/golang/vscode-go/blob/master/build/all.bash)
+installs all the tool dependencies in `GOPATH`. 
+
+1. `export GOPATH=/path/to/gopath/for/test`
+1. `build/all.bash setup_env`
+1. Unfortunately, VS Code test framework inherits your user settings when running tests [Issue 43](https://github.com/golang/vscode-go/issues/43). Make sure VS Code user settings do not contain any go related configuration, except `go.gopath` or `go.toolsGopath` in case you installed the tools for testing in a different `GOPATH`.
+
 There are currently three test launch configurations: (1) `Launch Extension Tests`, (2) `Launch Extension Tests with Gopls`, and (3) `Launch Unit Tests`. To run the tests locally, open the Run view (`Ctrl+Shift+D`), select the relevant launch configuration, and hit the Play button (`F5`).
 
 ## Sideload

docs/debugging.md

@@ -28,13 +28,29 @@ This document explains how to debug your Go programs in VS Code. The Go debugger
 
 [Delve] should be installed by default when you install this extension.
 
+You may need to update `dlv` to the latest version to support the latest version
+of Go—see [Installation](#installation) below.
+
 ### Installation
 
-You can also install it manually in one of two ways:
+You can also install Delve manually in one of two ways:
 
-1. Open the Command Palette (Ctrl+Shift+P), select [`Go: Install/Update Tools`](settings.md#go-installupdate-tools), and select [`dlv`](tools.md#dlv).
+1. Open the [Command Palette][] (Windows/Linux: Ctrl+Shift+P; OSX: Shift+Command+P), select [`Go: Install/Update Tools`](settings.md#go-installupdate-tools), and select [`dlv`](tools.md#dlv).
 2. Follow the [Delve installation instructions](https://github.com/go-delve/delve/tree/master/Documentation/installation).
 
+### Start debugging
+
+1. Open the `package main` source file or the test file you want to debug.
+2. Start debugging using one of the following options:
+   * Open the [Command Palette][], select
+     `Debug: Start Debugging`, then select `Go`.
+   * Open the debug window (Windows/Linux: Ctrl+Shift+D; OSX: Shift+Command+D) and click
+     `Run and Debug`, then select `Go`.
+   * Select **Run > Start Debugging** from the main menu.
+
+   See [the VS Code Debugging documentation](https://code.visualstudio.com/docs/editor/debugging)
+   for more information.
+
 ### Configuration
 
 You may not need to configure any settings to start debugging your programs, but you should be aware that the debugger looks at the following settings.
@@ -50,7 +66,7 @@ You may not need to configure any settings to start debugging your programs, but
     * `maxStructFields`: Maximum number of fields read from a struct. A setting of `-1` indicates that all fields should be read (default: `-1`).
     * `maxVariableRecurse`: How far to recurse when evaluating nested types (default: `1`).
     * `followPointers`: Automatically dereference pointers (default: `true`).
-  * `showGlobalVariables`: Show global variables in the Debug view (default: `true`).
+  * `showGlobalVariables`: Show global variables in the Debug view (default: `false`).
 
 There are some common cases when you might want to tweak the Delve configurations.
 
@@ -362,3 +378,4 @@ This error can show up for Mac users using Delve versions 0.12.2 and above. `xco
 [Delve]: https://github.com/go-delve/delve
 [VS Code variables]: https://code.visualstudio.com/docs/editor/variables-reference
 [snippets]: https://code.visualstudio.com/docs/editor/userdefinedsnippets
+[Command Palette]: https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette

docs/go-version.md

@@ -0,0 +1,17 @@
+# Managing Your Go Version
+
+## Using The Go Status Bar
+
+You can view the current Go version by looking at the status bar item in the bottom left corner of VS Code. Clicking this button will present you with a menu from which you can select any version of Go that exists in your $HOME/sdk directory or on <https://golang.org/dl>.
+
+Previously, the `go.goroot` and `go.alternateTools` settings controlled the Go version used by VS Code Go. If you have configured these settings, they are no longer needed and should be deleted.
+
+[](https://i.imgur.com/8qh2Tu2.png)
+
+The "Clear Selection" option resets your Go version to the one found first in either `go.alternateTools`, `go.goroot` or your PATH.
+
+## Installing a New Go Version
+
+After selecting any Go version that has not yet been installed (such as Go 1.14.6 in the screenshot above), the binary will be automatically installed in $HOME/sdk and put to use in your environment.
+
+Once the download completes, VS Code Go will make use of this new Go version.