Attachments Support

Work in progress patch to support swift-testing attachments. Currently
prints the attachments out as a report at the end of a test run. In
order to leverage them we need to set the --attachment-path, which is
not available on the command line so we add a configuration json file.

There is still more work to do to allow the user to specify their own
attachment path on a per workspace basis.

This will currently only work with swiftlang/swift-testing#770
as it isn't merged yet.

Author: plemarquand

.vscode/launch.json

@@ -45,6 +45,24 @@
       "request": "launch",
       "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
       "runtimeArgs": ["${workspaceFolder}/scripts/update_swift_docc_render.ts"]
+    },
+    {
+      "type": "lldb",
+      "request": "launch",
+      "args": [],
+      "cwd": "${workspaceFolder:vscode-swift}/assets/test/defaultPackage",
+      "name": "Debug PackageExe (assets/test/defaultPackage)",
+      "program": "${workspaceFolder:vscode-swift}/assets/test/defaultPackage/.build/debug/PackageExe",
+      "preLaunchTask": "swift: Build Debug PackageExe (assets/test/defaultPackage)"
+    },
+    {
+      "type": "lldb",
+      "request": "launch",
+      "args": [],
+      "cwd": "${workspaceFolder:vscode-swift}/assets/test/defaultPackage",
+      "name": "Release PackageExe (assets/test/defaultPackage)",
+      "program": "${workspaceFolder:vscode-swift}/assets/test/defaultPackage/.build/release/PackageExe",
+      "preLaunchTask": "swift: Build Release PackageExe (assets/test/defaultPackage)"
     }
   ]
 }

src/TestExplorer/TestParsers/SwiftTestingOutputParser.ts

@@ -52,7 +52,8 @@ export type EventRecordPayload =
     | TestCaseEnded
     | IssueRecorded
     | TestSkipped
-    | RunEnded;
+    | RunEnded
+    | ValueAttached;
 
 export interface EventRecord extends VersionedRecord {
     kind: "event";
@@ -95,6 +96,15 @@ interface RunEnded {
     messages: EventMessage[];
 }
 
+interface ValueAttached {
+    kind: "valueAttached";
+    _attachment: {
+        path?: string;
+    };
+    testID: string;
+    messages: EventMessage[];
+}
+
 interface Instant {
     absolute: number;
     since1970: number;
@@ -148,6 +158,7 @@ export enum TestSymbol {
     difference = "difference",
     warning = "warning",
     details = "details",
+    attachment = "attachment",
     none = "none",
 }
 
@@ -169,7 +180,8 @@ export class SwiftTestingOutputParser {
 
     constructor(
         public testRunStarted: () => void,
-        public addParameterizedTestCase: (testClass: TestClass, parentIndex: number) => void
+        public addParameterizedTestCase: (testClass: TestClass, parentIndex: number) => void,
+        public onAttachment: (testIndex: number, path: string) => void
     ) {}
 
     /**
@@ -457,6 +469,12 @@ export class SwiftTestingOutputParser {
                 this.completionMap.set(testIndex, true);
                 runState.completed(testIndex, { timestamp: item.payload.instant.absolute });
                 return;
+            } else if (item.payload.kind === "valueAttached" && item.payload._attachment.path) {
+                const testID = this.idFromOptionalTestCase(item.payload.testID);
+                const testIndex = this.getTestCaseIndex(runState, testID);
+
+                this.onAttachment(testIndex, item.payload._attachment.path);
+                return;
             }
         }
     }
@@ -521,6 +539,8 @@ export class SymbolRenderer {
                     return "\u{25B2}"; // Unicode: BLACK UP-POINTING TRIANGLE
                 case TestSymbol.details:
                     return "\u{2192}"; // Unicode: RIGHTWARDS ARROW
+                case TestSymbol.attachment:
+                    return "\u{2399}"; // Unicode: PRINT SCREEN SYMBOL
                 case TestSymbol.none:
                     return "";
             }
@@ -540,6 +560,8 @@ export class SymbolRenderer {
                     return "\u{26A0}\u{FE0E}"; // Unicode: WARNING SIGN + VARIATION SELECTOR-15 (disable emoji)
                 case TestSymbol.details:
                     return "\u{21B3}"; // Unicode: DOWNWARDS ARROW WITH TIP RIGHTWARDS
+                case TestSymbol.attachment:
+                    return "\u{2399}"; // Unicode: PRINT SCREEN SYMBOL
                 case TestSymbol.none:
                     return " ";
             }
@@ -562,6 +584,8 @@ export class SymbolRenderer {
                 return `${SymbolRenderer.ansiEscapeCodePrefix}91m${symbol}${SymbolRenderer.resetANSIEscapeCode}`;
             case TestSymbol.warning:
                 return `${SymbolRenderer.ansiEscapeCodePrefix}93m${symbol}${SymbolRenderer.resetANSIEscapeCode}`;
+            case TestSymbol.attachment:
+                return `${SymbolRenderer.ansiEscapeCodePrefix}94m${symbol}${SymbolRenderer.resetANSIEscapeCode}`;
             case TestSymbol.none:
             default:
                 return symbol;