Merge pull request #1149 from ahoppen/ahoppen/structured-tests

Return tests discovered by `workspace/tests` and `textDocument/tests` in a hierarchical format

Author: ahoppen

Sources/LanguageServerProtocol/CMakeLists.txt

@@ -124,6 +124,7 @@ add_library(LanguageServerProtocol STATIC
   SupportTypes/SKCompletionOptions.swift
   SupportTypes/StringOrMarkupContent.swift
   SupportTypes/SymbolKind.swift
+  SupportTypes/TestItem.swift
   SupportTypes/TextDocumentContentChangeEvent.swift
   SupportTypes/TextDocumentEdit.swift
   SupportTypes/TextDocumentIdentifier.swift

Sources/LanguageServerProtocol/Requests/DocumentTestsRequest.swift

@@ -15,7 +15,7 @@
 /// **(LSP Extension)**
 public struct DocumentTestsRequest: TextDocumentRequest, Hashable {
   public static let method: String = "textDocument/tests"
-  public typealias Response = [WorkspaceSymbolItem]?
+  public typealias Response = [TestItem]
 
   public var textDocument: TextDocumentIdentifier
 

Sources/LanguageServerProtocol/Requests/WorkspaceTestsRequest.swift

@@ -15,7 +15,7 @@
 /// **(LSP Extension)**
 public struct WorkspaceTestsRequest: RequestType, Hashable {
   public static let method: String = "workspace/tests"
-  public typealias Response = [WorkspaceSymbolItem]?
+  public typealias Response = [TestItem]
 
   public init() {}
 }

Sources/LanguageServerProtocol/SupportTypes/TestItem.swift

@@ -0,0 +1,70 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+public struct TestTag: Codable, Equatable, Sendable {
+  /// ID of the test tag. `TestTag` instances with the same ID are considered to be identical.
+  public let id: String
+
+  public init(id: String) {
+    self.id = id
+  }
+}
+
+/// A test item that can be shown an a client's test explorer or used to identify tests alongside a source file.
+///
+/// A `TestItem` can represent either a test suite or a test itself, since they both have similar capabilities.
+public struct TestItem: ResponseType, Equatable {
+  /// Identifier for the `TestItem`.
+  ///
+  /// This identifier uniquely identifies the test case or test suite. It can be used to run an individual test (suite).
+  public let id: String
+
+  /// Display name describing the test.
+  public let label: String
+
+  /// Optional description that appears next to the label.
+  public let description: String?
+
+  /// A string that should be used when comparing this item with other items.
+  ///
+  /// When `nil` the `label` is used.
+  public let sortText: String?
+
+  /// The location of the test item in the source code.
+  public let location: Location
+
+  /// The children of this test item.
+  ///
+  /// For a test suite, this may contain the individual test cases or nested suites.
+  public let children: [TestItem]
+
+  /// Tags associated with this test item.
+  public let tags: [TestTag]
+
+  public init(
+    id: String,
+    label: String,
+    description: String? = nil,
+    sortText: String? = nil,
+    location: Location,
+    children: [TestItem],
+    tags: [TestTag]
+  ) {
+    self.id = id
+    self.label = label
+    self.description = description
+    self.sortText = sortText
+    self.location = location
+    self.children = children
+    self.tags = tags
+  }
+}

Sources/SourceKitLSP/LanguageService.swift

@@ -198,7 +198,7 @@ public protocol LanguageService: AnyObject {
   /// Perform a syntactic scan of the file at the given URI for test cases and test classes.
   ///
   /// This is used as a fallback to show the test cases in a file if the index for a given file is not up-to-date.
-  func syntacticDocumentTests(for uri: DocumentURI) async throws -> [WorkspaceSymbolItem]?
+  func syntacticDocumentTests(for uri: DocumentURI) async throws -> [TestItem]
 
   /// Crash the language server. Should be used for crash recovery testing only.
   func _crash() async

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -1317,8 +1317,8 @@ extension SourceKitLSPServer {
       semanticTokensProvider: semanticTokensOptions,
       inlayHintProvider: inlayHintOptions,
       experimental: .dictionary([
-        "workspace/tests": .dictionary(["version": .int(1)]),
-        "textDocument/tests": .dictionary(["version": .int(1)]),
+        "workspace/tests": .dictionary(["version": .int(2)]),
+        "textDocument/tests": .dictionary(["version": .int(2)]),
       ])
     )
   }