add copy test id menu item for pytest

Author: eleanorjboyd

package.json

@@ -272,6 +272,11 @@
                 "category": "Python",
                 "command": "python.createNewFile"
             },
+            {
+                "category": "Python",
+                "command": "python.copyTestId",
+                "title": "%python.command.python.testing.copyTestId.title%"
+            },
             {
                 "category": "Python",
                 "command": "python.analysis.restartLanguageServer",
@@ -1231,6 +1236,13 @@
                     "command": "python.reportIssue"
                 }
             ],
+            "testing/item/context": [
+                {
+                    "command": "python.copyTestId",
+                    "group": "navigation",
+                    "when": "resourceLangId == 'python'"
+                }
+            ],
             "commandPalette": [
                 {
                     "category": "Python",
@@ -1306,6 +1318,12 @@
                     "title": "%python.command.python.execSelectionInTerminal.title%",
                     "when": "!virtualWorkspace && shellExecutionSupported && editorLangId == python"
                 },
+                {
+                    "category": "Python",
+                    "command": "python.copyTestId",
+                    "title": "%python.command.python.testing.copyTestId.title%",
+                    "when": "false"
+                },
                 {
                     "category": "Python",
                     "command": "python.execInREPL",

package.nls.json

@@ -27,6 +27,7 @@
     "python.command.python.analysis.restartLanguageServer.title": "Restart Language Server",
     "python.command.python.launchTensorBoard.title": "Launch TensorBoard",
     "python.command.python.refreshTensorBoard.title": "Refresh TensorBoard",
+    "python.command.python.testing.copyTestId.title": "Copy Test Id",
     "python.createEnvironment.contentButton.description": "Show or hide Create Environment button in the editor for `requirements.txt` or other dependency files.",
     "python.createEnvironment.trigger.description": "Detect if environment creation is required for the current project",
     "python.menu.createNewFile.title": "Python File",

src/client/common/application/commands.ts

@@ -3,7 +3,7 @@
 
 'use strict';
 
-import { CancellationToken, Position, TextDocument, Uri } from 'vscode';
+import { CancellationToken, Position, TestItem, TextDocument, Uri } from 'vscode';
 import { Commands as LSCommands } from '../../activation/commands';
 import { Channel, Commands, CommandSource } from '../constants';
 import { CreateEnvironmentOptions } from '../../pythonEnvironments/creation/proposed.createEnvApis';
@@ -50,6 +50,7 @@ export type AllCommands = keyof ICommandNameArgumentTypeMapping;
  * Used to provide strong typing for command & args.
  */
 export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgumentTypeMapping {
+    [Commands.CopyTestId]: [TestItem];
     [Commands.Create_Environment]: [CreateEnvironmentOptions];
     ['vscode.openWith']: [Uri, string];
     ['workbench.action.quickOpen']: [string];

src/client/common/constants.ts

@@ -39,6 +39,7 @@ export namespace Commands {
     export const CreateNewFile = 'python.createNewFile';
     export const ClearWorkspaceInterpreter = 'python.clearWorkspaceInterpreter';
     export const Create_Environment = 'python.createEnvironment';
+    export const CopyTestId = 'python.copyTestId';
     export const Create_Environment_Button = 'python.createEnvironment-button';
     export const Create_Environment_Check = 'python.createEnvironmentCheck';
     export const Create_Terminal = 'python.createTerminal';

src/client/testing/main.ts

@@ -1,7 +1,17 @@
 'use strict';
 
 import { inject, injectable } from 'inversify';
-import { ConfigurationChangeEvent, Disposable, Uri, tests, TestResultState, WorkspaceFolder, Command } from 'vscode';
+import {
+    ConfigurationChangeEvent,
+    Disposable,
+    Uri,
+    tests,
+    TestResultState,
+    WorkspaceFolder,
+    Command,
+    TestItem,
+} from 'vscode';
+import { env } from 'vscode';
 import { IApplicationShell, ICommandManager, IContextKeyManager, IWorkspaceService } from '../common/application/types';
 import * as constants from '../common/constants';
 import '../common/extensions';
@@ -20,7 +30,7 @@ import { DelayedTrigger, IDelayedTrigger } from '../common/utils/delayTrigger';
 import { ExtensionContextKey } from '../common/application/contextKeys';
 import { checkForFailedTests, updateTestResultMap } from './testController/common/testItemUtilities';
 import { Testing } from '../common/utils/localize';
-import { traceVerbose } from '../logging';
+import { traceLog, traceVerbose } from '../logging';
 
 @injectable()
 export class TestingService implements ITestingService {
@@ -158,7 +168,6 @@ export class UnitTestManagementService implements IExtensionActivationService {
 
     private registerCommands(): void {
         const commandManager = this.serviceContainer.get<ICommandManager>(ICommandManager);
-
         this.disposableRegistry.push(
             commandManager.registerCommand(
                 constants.Commands.Tests_Configure,
@@ -195,6 +204,12 @@ export class UnitTestManagementService implements IExtensionActivationService {
                     },
                 };
             }),
+            commandManager.registerCommand(constants.Commands.CopyTestId, async (testItem: TestItem) => {
+                if (testItem && typeof testItem.id === 'string') {
+                    await env.clipboard.writeText(testItem.id);
+                    traceLog('Testing: Copied test id to clipboard, id: ' + testItem.id);
+                }
+            }),
         );
     }