extension/src: add generate test command using gopls.add_test

Command which uses third party tool "gotests" will be marked as
"legacy" in both editor context menu and command palette. Legacy
command is "go.test.generate.function.legacy".

Instead, the original command will be pointing to the gopls's
implementation.

For #1594

Change-Id: If2d7ff67ff479ee82da3fd7322a6dad313306928
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/692575
Reviewed-by: Madeline Kalil <mkalil@google.com>
kokoro-CI: kokoro <noreply+kokoro@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>

Author: h9jiang

docs/commands.md

@@ -117,15 +117,19 @@ Displays test coverage in the current package.
 
 ### `Go: Generate Unit Tests For Package`
 
-Generates unit tests for the current package
+Generates unit tests for the current package using gotests
 
 ### `Go: Generate Unit Tests For File`
 
-Generates unit tests for the current file
+Generates unit tests for the current file using gotests
 
 ### `Go: Generate Unit Tests For Function`
 
-Generates unit tests for the selected function in the current file
+Generates unit tests for the selected function in the current file using gopls
+
+### `Go: Generate Unit Tests For Function (legacy)`
+
+Generates unit tests for the selected function in the current file using gotests
 
 ### `Go: Generate Interface Stubs`
 

extension/package.json

@@ -336,17 +336,22 @@
       {
         "command": "go.test.generate.package",
         "title": "Go: Generate Unit Tests For Package",
-        "description": "Generates unit tests for the current package"
+        "description": "Generates unit tests for the current package using gotests"
       },
       {
         "command": "go.test.generate.file",
         "title": "Go: Generate Unit Tests For File",
-        "description": "Generates unit tests for the current file"
+        "description": "Generates unit tests for the current file using gotests"
       },
       {
         "command": "go.test.generate.function",
         "title": "Go: Generate Unit Tests For Function",
-        "description": "Generates unit tests for the selected function in the current file"
+        "description": "Generates unit tests for the selected function in the current file using gopls"
+      },
+      {
+        "command": "go.test.generate.function.legacy",
+        "title": "Go: Generate Unit Tests For Function (legacy)",
+        "description": "Generates unit tests for the selected function in the current file using gotests"
       },
       {
         "command": "go.impl.cursor",
@@ -3536,6 +3541,11 @@
           "command": "go.test.generate.function",
           "group": "Go group 1"
         },
+        {
+          "when": "editorTextFocus && config.go.editorContextMenuCommands.generateTestForFunction && resourceLangId == go",
+          "command": "go.test.generate.function.legacy",
+          "group": "Go group 1"
+        },
         {
           "when": "editorTextFocus && config.go.editorContextMenuCommands.generateTestForFile && resourceLangId == go",
           "command": "go.test.generate.file",

extension/src/goGenerateTests.ts

@@ -23,6 +23,8 @@ import { TelemetryKey, telemetryReporter } from './goTelemetry';
 
 const generatedWord = 'Generated ';
 
+const COMMAND = 'gopls.add_test';
+
 /**
  * If current active editor has a Go file, returns the editor.
  */
@@ -105,6 +107,26 @@ export const generateTestCurrentFile: CommandFactory = (ctx, goCtx) => () => {
 	);
 };
 
+/**
+ * Generates a test for the selected function using 'gopls.add_test'.
+ */
+export const goplsGenerateTest: CommandFactory = (_, goCtx) => async () => {
+	if (!goCtx.serverInfo?.Commands?.includes(COMMAND)) {
+		vscode.window.showWarningMessage(`Please upgrade gopls to use the '${COMMAND}' command`);
+		return;
+	}
+
+	const editor = checkActiveEditor();
+	if (!editor) {
+		return;
+	}
+
+	await vscode.commands.executeCommand(COMMAND, {
+		URI: editor.document.uri.toString(),
+		range: editor.selection
+	});
+};
+
 export const generateTestCurrentFunction: CommandFactory = (ctx, goCtx) => async () => {
 	const editor = checkActiveEditor();
 	if (!editor) {

extension/src/goMain.ts

@@ -194,7 +194,8 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<ExtensionA
 
 	registerCommand('go.test.generate.package', goGenerateTests.generateTestCurrentPackage);
 	registerCommand('go.test.generate.file', goGenerateTests.generateTestCurrentFile);
-	registerCommand('go.test.generate.function', goGenerateTests.generateTestCurrentFunction);
+	registerCommand('go.test.generate.function.legacy', goGenerateTests.generateTestCurrentFunction);
+	registerCommand('go.test.generate.function', goGenerateTests.goplsGenerateTest);
 	registerCommand('go.toggle.test.file', goGenerateTests.toggleTestFile);
 	registerCommand('go.debug.startSession', commands.startDebugSession);
 	registerCommand('go.show.commands', commands.showCommands);

extension/test/integration/extension.test.ts

@@ -251,7 +251,6 @@ const testAll = (isModuleMode: boolean) => {
 	});
 
 	test('Test Generate unit tests skeleton for file', async () => {
-		const gotestsPath = getBinPath('gotests');
 		const uri = vscode.Uri.file(path.join(generateTestsSourcePath, 'generatetests.go'));
 		const document = await vscode.workspace.openTextDocument(uri);
 		await vscode.window.showTextDocument(document);
@@ -263,7 +262,6 @@ const testAll = (isModuleMode: boolean) => {
 	});
 
 	test('Test Generate unit tests skeleton for a function', async () => {
-		const gotestsPath = getBinPath('gotests');
 		const uri = vscode.Uri.file(path.join(generateFunctionTestSourcePath, 'generatetests.go'));
 		const document = await vscode.workspace.openTextDocument(uri);
 		const editor = await vscode.window.showTextDocument(document);
@@ -276,7 +274,6 @@ const testAll = (isModuleMode: boolean) => {
 	});
 
 	test('Test Generate unit tests skeleton for package', async () => {
-		const gotestsPath = getBinPath('gotests');
 		const uri = vscode.Uri.file(path.join(generatePackageTestSourcePath, 'generatetests.go'));
 		const document = await vscode.workspace.openTextDocument(uri);
 		await vscode.window.showTextDocument(document);