updates to support unittest copy

Author: eleanorjboyd

package.json

@@ -1240,7 +1240,7 @@
                 {
                     "command": "python.copyTestId",
                     "group": "navigation",
-                    "when": "resourceLangId == 'python'"
+                    "when": "controllerId == 'python-tests'"
                 }
             ],
             "commandPalette": [

src/client/testing/main.ts

@@ -30,7 +30,8 @@ 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 { traceLog, traceVerbose } from '../logging';
+import { traceVerbose } from '../logging';
+import { writeTestIdToClipboard } from './utils';
 
 @injectable()
 export class TestingService implements ITestingService {
@@ -205,10 +206,7 @@ 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);
-                }
+                writeTestIdToClipboard(testItem);
             }),
         );
     }

src/client/testing/utils.ts

@@ -0,0 +1,49 @@
+import { TestItem, env } from 'vscode';
+import { traceLog } from '../logging';
+
+export async function writeTestIdToClipboard(testItem: TestItem): Promise<void> {
+    if (testItem && typeof testItem.id === 'string') {
+        if (testItem.id.includes('\\') && testItem.id.indexOf('::') === -1) {
+            // Convert the id to a module.class.method format as this is a unittest
+            const moduleClassMethod = idToModuleClassMethod(testItem.id);
+            if (moduleClassMethod) {
+                await env.clipboard.writeText(moduleClassMethod);
+                traceLog('Testing: Copied test id to clipboard, id: ' + moduleClassMethod);
+                return;
+            }
+        }
+        // Otherwise use the id as is for pytest
+        await clipboardWriteText(testItem.id);
+        traceLog('Testing: Copied test id to clipboard, id: ' + testItem.id);
+    }
+}
+
+export function idToModuleClassMethod(id: string): string | undefined {
+    // Split by backslash
+    const parts = id.split('\\');
+    if (parts.length === 1) {
+        // Only one part, likely a parent folder or file
+        return parts[0];
+    }
+    if (parts.length === 2) {
+        // Two parts: filePath and className
+        const [filePath, className] = parts.slice(-2);
+        const fileName = filePath.split(/[\\/]/).pop();
+        if (!fileName) {
+            return undefined;
+        }
+        const module = fileName.replace(/\.py$/, '');
+        return `${module}.${className}`;
+    }
+    // Three or more parts: filePath, className, methodName
+    const [filePath, className, methodName] = parts.slice(-3);
+    const fileName = filePath.split(/[\\/]/).pop();
+    if (!fileName) {
+        return undefined;
+    }
+    const module = fileName.replace(/\.py$/, '');
+    return `${module}.${className}.${methodName}`;
+}
+export function clipboardWriteText(text: string): Thenable<void> {
+    return env.clipboard.writeText(text);
+}

src/test/testing/utils.unit.test.ts

@@ -0,0 +1,51 @@
+import { expect, use } from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+import * as utils from '../../client/testing/utils';
+import sinon from 'sinon';
+use(chaiAsPromised.default);
+
+describe('idToModuleClassMethod', () => {
+    it('returns the only part if there is one', () => {
+        expect(utils.idToModuleClassMethod('foo')).to.equal('foo');
+    });
+    it('returns module.class for two parts', () => {
+        expect(utils.idToModuleClassMethod('a/b/c.py\\MyClass')).to.equal('c.MyClass');
+    });
+    it('returns module.class.method for three parts', () => {
+        expect(utils.idToModuleClassMethod('a/b/c.py\\MyClass\\my_method')).to.equal('c.MyClass.my_method');
+    });
+    it('returns undefined if fileName is missing', () => {
+        expect(utils.idToModuleClassMethod('\\MyClass')).to.be.undefined;
+    });
+});
+
+describe('writeTestIdToClipboard', () => {
+    let clipboardStub: sinon.SinonStub;
+
+    afterEach(() => {
+        sinon.restore();
+    });
+
+    it('writes module.class.method for unittest id', async () => {
+        clipboardStub = sinon.stub(utils, 'clipboardWriteText').resolves();
+        const { writeTestIdToClipboard } = utils;
+        const testItem = { id: 'a/b/c.py\\MyClass\\my_method' };
+        await writeTestIdToClipboard(testItem as any);
+        sinon.assert.calledOnceWithExactly(clipboardStub, 'c.MyClass.my_method');
+    });
+
+    it('writes id as is for pytest id', async () => {
+        clipboardStub = sinon.stub(utils, 'clipboardWriteText').resolves();
+        const { writeTestIdToClipboard } = utils;
+        const testItem = { id: 'tests/test_foo.py::TestClass::test_method' };
+        await writeTestIdToClipboard(testItem as any);
+        sinon.assert.calledOnceWithExactly(clipboardStub, 'tests/test_foo.py::TestClass::test_method');
+    });
+
+    it('does nothing if testItem is undefined', async () => {
+        clipboardStub = sinon.stub(utils, 'clipboardWriteText').resolves();
+        const { writeTestIdToClipboard } = utils;
+        await writeTestIdToClipboard(undefined as any);
+        sinon.assert.notCalled(clipboardStub);
+    });
+});