Add test cases that document formatting picks up .swift-format configuration files from the workspace

Co-Authored-By: cukr <[email protected]>

Author: ahoppen

Sources/SKTestSupport/INPUTS/Formatting/.swift-format

@@ -0,0 +1,4 @@
+This file is intentionally an invalid swift-format configuration file. It is used to test 
+the behavior when program cannot find a valid file. We cannot just left this directory blank, 
+because swift-format searches for the configuration in parent directories, and it's possible 
+that user has another configuration file somewhere outside the Tests.

Sources/SKTestSupport/INPUTS/Formatting/Directory/.swift-format

@@ -0,0 +1,6 @@
+{
+    "version": 1,
+    "indentation": {
+        "spaces": 1
+    },
+}

Sources/SKTestSupport/INPUTS/Formatting/Directory/Directory.swift

@@ -0,0 +1,4 @@
+/*Directory*/
+struct Directory {
+var bar = 123
+}

Sources/SKTestSupport/INPUTS/Formatting/Directory/NestedWithConfig/.swift-format

@@ -0,0 +1,6 @@
+{
+    "version": 1,
+    "indentation": {
+        "spaces": 4
+    },
+}

Sources/SKTestSupport/INPUTS/Formatting/Directory/NestedWithConfig/NestedWithConfig.swift

@@ -0,0 +1,4 @@
+/*NestedWithConfig*/
+struct NestedWithConfig {
+var bar = 123
+}

Sources/SKTestSupport/INPUTS/Formatting/Directory/NestedWithoutConfig/NestedWithoutConfig.swift

@@ -0,0 +1,4 @@
+/*NestedWithoutConfig*/
+struct NestedWithoutConfig {
+var bar = 123
+}

Sources/SKTestSupport/INPUTS/Formatting/Root.swift

@@ -0,0 +1,4 @@
+/*Root*/
+struct Root {
+var bar = 123
+}

Sources/SKTestSupport/INPUTS/Formatting/project.json

@@ -0,0 +1,8 @@
+{
+  "sources": [
+    "Root.swift", 
+    "Directory/Directory.swift", 
+    "Directory/NestedWithConfig/NestedWithConfig.swift", 
+    "Directory/NestedWithoutConfig/NestedWithoutConfig.swift"
+  ]
+}

Tests/SourceKitLSPTests/WorkspaceFormattingTests.swift

@@ -0,0 +1,133 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+import LanguageServerProtocol
+import SKTestSupport
+import XCTest
+import ISDBTestSupport
+
+// Note that none of the indentation values choosen are equal to the default
+// indentation level, which is two spaces.
+final class WorkspaceFormattingTests: XCTestCase {
+ var workspace: SKTibsTestWorkspace! = nil
+
+  override func setUp() {
+   workspace = try! XCTUnwrap(staticSourceKitTibsWorkspace(name: "Formatting"))
+   try! workspace.buildAndIndex()
+   try! workspace.openDocument(workspace.testLoc("Root").url, language: .swift)
+   try! workspace.openDocument(workspace.testLoc("Directory").url, language: .swift)
+   try! workspace.openDocument(workspace.testLoc("NestedWithConfig").url, language: .swift)
+   try! workspace.openDocument(workspace.testLoc("NestedWithoutConfig").url, language: .swift)
+ }
+
+ override func tearDown() {
+   workspace = nil
+ }
+
+ func performFormattingRequest(file url: URL, options: FormattingOptions) throws -> [TextEdit]? {
+   let request = DocumentFormattingRequest(
+     textDocument: TextDocumentIdentifier(url),
+     options: options
+   )
+   return try workspace.sk.sendSync(request)
+ }
+
+ func testSpaces() throws {
+   let url = workspace.testLoc("Root").url
+   let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+   let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+   XCTAssertEqual(edits.count, 1)
+   let edit = try XCTUnwrap(edits.first)
+   XCTAssertEqual(edit.range, Position(line: 0, utf16index: 0)..<Position(line: 3, utf16index: 1))
+   // var bar needs to be indented with three spaces
+   // which is the value from lsp
+   XCTAssertEqual(edit.newText, """
+   /*Root*/
+   struct Root {
+      var bar = 123
+   }
+
+   """)
+ }
+
+ func testTabs() throws {
+   let url = workspace.testLoc("Root").url
+   let options = FormattingOptions(tabSize: 3, insertSpaces: false)
+   let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+   XCTAssertEqual(edits.count, 1)
+   let edit = try XCTUnwrap(edits.first)
+   XCTAssertEqual(edit.range, Position(line: 0, utf16index: 0)..<Position(line: 3, utf16index: 1))
+   // var bar needs to be indented with a tab
+   // which is the value from lsp
+   XCTAssertEqual(edit.newText, """
+   /*Root*/
+   struct Root {
+   \tvar bar = 123
+   }
+
+   """)
+ }
+
+ func testConfigFile() throws {
+   let url = workspace.testLoc("Directory").url
+   let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+   let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+   XCTAssertEqual(edits.count, 1)
+   let edit = try XCTUnwrap(edits.first)
+   XCTAssertEqual(edit.range, Position(line: 0, utf16index: 0)..<Position(line: 3, utf16index: 1))
+   // var bar needs to be indented with one space
+   // which is the value from ".swift-format" in "Directory"
+   XCTAssertEqual(edit.newText, """
+   /*Directory*/
+   struct Directory {
+    var bar = 123
+   }
+   
+   """)
+ }
+
+ func testConfigFileInParentDirectory() throws {
+   let url = workspace.testLoc("NestedWithoutConfig").url
+   let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+   let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+   XCTAssertEqual(edits.count, 1)
+   let edit = try XCTUnwrap(edits.first)
+   XCTAssertEqual(edit.range, Position(line: 0, utf16index: 0)..<Position(line: 3, utf16index: 1))
+   // var bar needs to be indented with one space
+   // which is the value from ".swift-format" in "Directory"
+   XCTAssertEqual(edit.newText, """
+   /*NestedWithoutConfig*/
+   struct NestedWithoutConfig {
+    var bar = 123
+   }
+
+   """)
+ }
+
+ func testConfigFileInNestedDirectory() throws {
+   let url = workspace.testLoc("NestedWithConfig").url
+   let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+   let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+   XCTAssertEqual(edits.count, 1)
+   let edit = try XCTUnwrap(edits.first)
+   XCTAssertEqual(edit.range, Position(line: 0, utf16index: 0)..<Position(line: 3, utf16index: 1))
+   // var bar needs to be indented with four spaces
+   // which is the value from ".swift-format" in "NestedWithConfig"
+   XCTAssertEqual(edit.newText, """
+   /*NestedWithConfig*/
+   struct NestedWithConfig {
+       var bar = 123
+   }
+   
+   """)
+ }
+}