Merge pull request #299 from recca0120/fix/pest-path

recca0120 · web-flow · commit 804ab05da5ca · 2025-04-08T05:40:55.000+08:00
fix pest link
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "displayName": "PHPUnit Test Explorer",
   "icon": "img/icon.png",
   "publisher": "recca0120",
-  "version": "3.6.0",
+  "version": "3.6.1",
   "private": true,
   "license": "MIT",
   "repository": {
diff --git a/src/Handler.ts b/src/Handler.ts
@@ -7,16 +7,20 @@ import {
 } from 'vscode';
 import { CloverParser } from './CloverParser';
 import { Configuration } from './Configuration';
-import { CollisionPrinter, OutputChannelObserver, TestResultObserver } from './Observers';
+import { OutputChannelObserver, Printer, TestResultObserver } from './Observers';
 import { MessageObserver } from './Observers/MessageObserver';
 import { CommandBuilder, TestRunner, TestRunnerEvent, TestType } from './PHPUnit';
 import { TestCase, TestCollection } from './TestCollection';
 
 export class Handler {
     private previousRequest: TestRunRequest | undefined;
-    private printer = new CollisionPrinter();
 
-    constructor(private ctrl: TestController, private configuration: Configuration, private testCollection: TestCollection, private outputChannel: OutputChannel) { }
+    constructor(
+        private ctrl: TestController,
+        private configuration: Configuration,
+        private testCollection: TestCollection, private outputChannel: OutputChannel,
+        private printer: Printer,
+    ) { }
 
     getPreviousRequest() {
         return this.previousRequest;
@@ -55,7 +59,7 @@ export class Handler {
 
         const runner = new TestRunner();
         runner.observe(new TestResultObserver(queue, testRun));
-        runner.observe(new OutputChannelObserver(this.outputChannel, this.configuration, request, this.printer));
+        runner.observe(new OutputChannelObserver(this.outputChannel, this.configuration, this.printer, request));
         runner.observe(new MessageObserver(this.configuration));
 
         let tmpd: string | undefined;
diff --git a/src/Observers/OutputChannelObserver.test.ts b/src/Observers/OutputChannelObserver.test.ts
@@ -25,8 +25,8 @@ describe('OutputChannelObserver', () => {
         const observer = new OutputChannelObserver(
             outputChannel,
             configuration,
-            { continuous: false } as TestRunRequest,
             new PrettyPrinter(),
+            { continuous: false } as TestRunRequest,
         );
         testRunner.observe(observer);
     });
diff --git a/src/Observers/OutputChannelObserver.ts b/src/Observers/OutputChannelObserver.ts
@@ -4,7 +4,7 @@ import {
     TestProcesses, TestResult, TestResultSummary, TestRunnerObserver, TestRuntime, TestStarted, TestSuiteFinished,
     TestSuiteStarted, TestVersion,
 } from '../PHPUnit';
-import { PrettyPrinter, Printer } from './Printers';
+import { Printer } from './Printers';
 
 enum ShowOutputState {
     always = 'always',
@@ -15,12 +15,7 @@ enum ShowOutputState {
 export class OutputChannelObserver implements TestRunnerObserver {
     private lastCommand = '';
 
-    constructor(
-        private outputChannel: OutputChannel,
-        private configuration: IConfiguration,
-        private request: TestRunRequest,
-        private printer: Printer = new PrettyPrinter(),
-    ) {}
+    constructor(private outputChannel: OutputChannel, private configuration: IConfiguration, private printer: Printer, private request: TestRunRequest) {}
 
     run(command: CommandBuilder): void {
         this.clearOutputOnRun();
diff --git a/src/Observers/Printers/CollisionPrinter.test.ts b/src/Observers/Printers/CollisionPrinter.test.ts
@@ -1,10 +1,11 @@
-import { EOL, TeamcityEvent } from '../../PHPUnit';
+import { EOL, PHPUnitXML, TeamcityEvent } from '../../PHPUnit';
 import { phpUnitProject } from '../../PHPUnit/__tests__/utils';
 import { CollisionPrinter } from './CollisionPrinter';
 import { Printer } from './Printer';
 
 describe('CollisionPrinter', () => {
-    const printer = new CollisionPrinter();
+    const phpUnitXML = new PHPUnitXML().setRoot(phpUnitProject(''));
+    const printer = new CollisionPrinter(phpUnitXML);
 
     beforeEach(() => printer.start());
     afterEach(() => printer.close());
diff --git a/src/Observers/Printers/CollisionPrinter.ts b/src/Observers/Printers/CollisionPrinter.ts
@@ -5,6 +5,7 @@ import { Printer } from './Printer';
 export class CollisionPrinter extends Printer {
     private errors: TestFailed[] = [];
 
+
     start() {
         super.start();
         this.errors = [];
@@ -72,16 +73,17 @@ export class CollisionPrinter extends Printer {
     }
 
     private getFileContent(result: TestFailed) {
-        const detail = result.details.find(({ file }) => {
-            return file === result.file;
-        })!;
+        let detail = result.details.find(({ file }) => file === result.file)!;
+        if (result.details.length > 0) {
+            detail = result.details[0];
+        }
 
         if (!detail) {
             return undefined;
         }
 
         try {
-            const data = readFileSync(detail.file, 'utf8');
+            const data = readFileSync(this.absolutePath(detail.file), 'utf8');
             const position = detail.line - 5;
             const lines = data.split(/\r\n|\n/).splice(position, 10).map((line, index) => {
                 const currentPosition = position + index + 1;
diff --git a/src/Observers/Printers/PrettyPrinter.test.ts b/src/Observers/Printers/PrettyPrinter.test.ts
@@ -1,10 +1,11 @@
-import { EOL, TeamcityEvent } from '../../PHPUnit';
+import { EOL, PHPUnitXML, TeamcityEvent } from '../../PHPUnit';
 import { phpUnitProject } from '../../PHPUnit/__tests__/utils';
 import { PrettyPrinter } from './PrettyPrinter';
 import { Printer } from './Printer';
 
 describe('PrettyPrinter', () => {
-    const printer = new PrettyPrinter();
+    const phpUnitXML = new PHPUnitXML().setRoot(phpUnitProject(''));
+    const printer = new PrettyPrinter(phpUnitXML);
 
     beforeEach(() => printer.start());
     afterEach(() => printer.close());
diff --git a/src/Observers/Printers/Printer.ts b/src/Observers/Printers/Printer.ts
@@ -1,6 +1,7 @@
+import { isAbsolute, join } from 'node:path';
 import {
-    EOL, TeamcityEvent, TestConfiguration, TestDuration, TestFailed, TestFinished, TestProcesses, TestResult,
-    TestResultSummary, TestRuntime, TestStarted, TestSuiteFinished, TestSuiteStarted, TestVersion,
+    EOL, PHPUnitXML, TeamcityEvent, TestConfiguration, TestDuration, TestFailed, TestFinished, TestProcesses,
+    TestResult, TestResultSummary, TestRuntime, TestStarted, TestSuiteFinished, TestSuiteStarted, TestVersion,
 } from '../../PHPUnit';
 
 class OutputBuffer {
@@ -47,6 +48,8 @@ export abstract class Printer {
         [TeamcityEvent.testIgnored, ['➖', 'IGNORED']],
     ]);
 
+    constructor(private phpUnitXML: PHPUnitXML) {}
+
     static fileFormat(file: string, line: number) {
         return `${file}:${line}`;
     }
@@ -139,6 +142,12 @@ export abstract class Printer {
         this.outputBuffer.append(line);
     }
 
+    protected absolutePath(filePath: string): string {
+        const root = this.phpUnitXML.root();
+
+        return isAbsolute(filePath) && root ? filePath : join(root, filePath);
+    }
+
     private setCurrent(current?: string) {
         this.outputBuffer.setCurrent(current);
     }
diff --git a/src/PHPUnitLinkProvider.test.ts b/src/PHPUnitLinkProvider.test.ts
@@ -1,5 +1,6 @@
-import { relative } from 'path';
+import { relative } from 'node:path';
 import { DocumentLink, Position, Range } from 'vscode';
+import { PHPUnitXML } from './PHPUnit';
 import { phpUnitProject } from './PHPUnit/__tests__/utils';
 import { PHPUnitLinkProvider } from './PHPUnitLinkProvider';
 
@@ -30,9 +31,16 @@ class TextDocument {
 
 describe('PHPUnitLinkProvider', () => {
     const root = phpUnitProject('');
-    const normalizePath = (file: string) => relative(root, file).replace(/\\/g, '/');
+    const phpUnitXML = new PHPUnitXML().setRoot(root);
+    const normalizePath = (file: string) => {
+        return relative(root, file).replace(/\\/g, '/');
+    };
 
-    const text = `❌ FAILED  Calculator (Tests\Calculator) > Sum item method not call
+    let provider: PHPUnitLinkProvider;
+    beforeEach(() => provider = new PHPUnitLinkProvider(phpUnitXML));
+
+    it('get PHPUnit links', () => {
+        const document = new TextDocument(`❌ FAILED  Calculator (Tests\Calculator) > Sum item method not call
 Mockery\Exception\InvalidCountException: Method test(<Any Arguments>) from Mockery_0_App_Item_App_Item should be called
  exactly 1 times but called 0 times.
 
@@ -44,13 +52,7 @@ Mockery\Exception\InvalidCountException: Method test(<Any Arguments>) from Mocke
 6. ${phpUnitProject('vendor/mockery/mockery/library/Mockery.php')}:176
 7. ${phpUnitProject('vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegration.php')}:49
 8. ${phpUnitProject('vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegration.php')}:61
-9. ${phpUnitProject('vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegrationAssertPostConditions.php')}:19`;
-
-    let provider: PHPUnitLinkProvider;
-    beforeEach(() => provider = new PHPUnitLinkProvider());
-
-    it('get links', () => {
-        const document = new TextDocument(text);
+9. ${phpUnitProject('vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegrationAssertPostConditions.php')}:19`);
 
         const links = (provider.provideDocumentLinks(document as any, {} as any) as DocumentLink[])
             .map((link) => [normalizePath(link.target!.fsPath), link.target!.fragment]);
@@ -67,4 +69,53 @@ Mockery\Exception\InvalidCountException: Method test(<Any Arguments>) from Mocke
             ['vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/MockeryPHPUnitIntegrationAssertPostConditions.php', 'L19'],
         ]);
     });
+
+    it('get PEST links', () => {
+        const document = new TextDocument(`❌ FAILED  tests/Unit/ArchTest.php > preset  → strict 
+Expecting 'src/Calculator.php' to be final.
+
+at src/Calculator.php:7
+   3 ▕ namespace App;
+   4 ▕ 
+   5 ▕ use Exception;
+   6 ▕ 
+➜  7 ▕ class Calculator
+   8 ▕ {
+   9 ▕     public function sum($a, $b)
+  10 ▕     {
+  11 ▕         return $a + $b;
+  12 ▕     }
+
+1. src/Calculator.php:7
+2. vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php:43
+3. vendor/pestphp/pest-plugin-arch/src/Blueprint.php:137
+4. vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php:40
+5. vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php:156
+6. vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php:140
+7. src/Calculator.php:1
+8. vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php:43
+9. vendor/pestphp/pest-plugin-arch/src/Blueprint.php:137
+10. vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php:40
+11. vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php:156
+12. vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php:140`);
+
+        const links = (provider.provideDocumentLinks(document as any, {} as any) as DocumentLink[])
+            .map((link) => [normalizePath(link.target!.fsPath), link.target!.fragment]);
+
+        expect(links).toEqual([
+            ['src/Calculator.php', 'L7'],
+            ['src/Calculator.php', 'L7'],
+            ['vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php', 'L43'],
+            ['vendor/pestphp/pest-plugin-arch/src/Blueprint.php', 'L137'],
+            ['vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php', 'L40'],
+            ['vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php', 'L156'],
+            ['vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php', 'L140'],
+            ['src/Calculator.php', 'L1'],
+            ['vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php', 'L43'],
+            ['vendor/pestphp/pest-plugin-arch/src/Blueprint.php', 'L137'],
+            ['vendor/pestphp/pest-plugin-arch/src/Expectations/Targeted.php', 'L40'],
+            ['vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php', 'L156'],
+            ['vendor/pestphp/pest-plugin-arch/src/SingleArchExpectation.php', 'L140'],
+        ]);
+    });
 });
diff --git a/src/PHPUnitLinkProvider.ts b/src/PHPUnitLinkProvider.ts
@@ -1,11 +1,15 @@
+import { isAbsolute, join } from 'node:path';
 import {
     CancellationToken, DocumentLink, DocumentLinkProvider, Position, ProviderResult, Range, TextDocument,
 } from 'vscode';
 import { URI } from 'vscode-uri';
+import { PHPUnitXML } from './PHPUnit';
 
 export class PHPUnitLinkProvider implements DocumentLinkProvider {
     private regex = /((?:[A-Z]:)?(?:\.{0,2}[\\/])?[^\s:]+\.php):(\d+)(?::(\d+))?/gi;
 
+    constructor(private phpUnitXML: PHPUnitXML) {}
+
     provideDocumentLinks(document: TextDocument, _token: CancellationToken): ProviderResult<DocumentLink[]> {
         const links: DocumentLink[] = [];
 
@@ -14,10 +18,10 @@ export class PHPUnitLinkProvider implements DocumentLinkProvider {
             let match: RegExpExecArray | null;
 
             while ((match = this.regex.exec(line.text)) !== null) {
-                const [fullMatch, filePath, lineStr, colStr] = match;
+                const [fullMatch, filePath, lineStr] = match;
                 const lineNumber = parseInt(lineStr, 10);
 
-                const targetUri = URI.file(filePath).with({ fragment: `L${lineNumber}` });
+                const targetUri = URI.file(this.absolutePath(filePath)).with({ fragment: `L${lineNumber}` });
                 const start = new Position(lineIndex, match.index);
                 const end = new Position(lineIndex, match.index + fullMatch.length);
                 const range = new Range(start, end);
@@ -28,4 +32,10 @@ export class PHPUnitLinkProvider implements DocumentLinkProvider {
 
         return links;
     }
+
+    private absolutePath(filePath: string): string {
+        const root = this.phpUnitXML.root();
+
+        return isAbsolute(filePath) && root ? filePath : join(root, filePath);
+    }
 }
diff --git a/src/extension.ts b/src/extension.ts
@@ -6,11 +6,13 @@ import { PHPUnitFileCoverage } from './CloverParser';
 import { CommandHandler } from './CommandHandler';
 import { Configuration } from './Configuration';
 import { Handler } from './Handler';
+import { CollisionPrinter } from './Observers';
 import { Pattern, PHPUnitXML } from './PHPUnit';
 import { PHPUnitLinkProvider } from './PHPUnitLinkProvider';
 import { TestCollection } from './TestCollection';
 
 const phpUnitXML = new PHPUnitXML();
+const printer = new CollisionPrinter(phpUnitXML);
 let testCollection: TestCollection;
 
 export async function activate(context: ExtensionContext) {
@@ -21,7 +23,7 @@ export async function activate(context: ExtensionContext) {
     const outputChannel = window.createOutputChannel('PHPUnit', 'phpunit');
     context.subscriptions.push(outputChannel);
 
-    context.subscriptions.push(languages.registerDocumentLinkProvider({ language: 'phpunit' }, new PHPUnitLinkProvider()));
+    context.subscriptions.push(languages.registerDocumentLinkProvider({ language: 'phpunit' }, new PHPUnitLinkProvider(phpUnitXML)));
 
     const configuration = new Configuration(workspace.getConfiguration('phpunit'));
     context.subscriptions.push(workspace.onDidChangeConfiguration(() => configuration.updateWorkspaceConfiguration(workspace.getConfiguration('phpunit'))));
@@ -57,7 +59,7 @@ export async function activate(context: ExtensionContext) {
         }
     };
 
-    const handler = new Handler(ctrl, configuration, testCollection, outputChannel);
+    const handler = new Handler(ctrl, configuration, testCollection, outputChannel, printer);
 
     const fileChangedEmitter = new EventEmitter<Uri>();
     const watchingTests = new Map<TestItem | 'ALL', TestRunProfile | undefined>();
