add integration test that uses extended types

Author: theMomax

IntegrationTests/Package.swift

@@ -30,6 +30,7 @@ let package = Package(
                 .copy("Fixtures/MixedTargets"),
                 .copy("Fixtures/TargetWithDocCCatalog"),
                 .copy("Fixtures/PackageWithSnippets"),
+                .copy("Fixtures/LibraryTargetWithExtensionSymbols"),
             ]
         ),
     ]

IntegrationTests/Tests/Fixtures/LibraryTargetWithExtensionSymbols/Package.swift

@@ -0,0 +1,30 @@
+// swift-tools-version: 5.6
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 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 Swift project authors
+
+import Foundation
+import PackageDescription
+
+let package = Package(
+    name: "LibraryTargetWithExtensionSymbols",
+    targets: [
+        .target(name: "Library"),
+    ]
+)
+
+// We only expect 'swift-docc-plugin' to be a sibling when this package
+// is running as part of a test.
+//
+// This allows the package to compile outside of tests for easier
+// test development.
+if FileManager.default.fileExists(atPath: "../swift-docc-plugin") {
+    package.dependencies += [
+        .package(path: "../swift-docc-plugin"),
+    ]
+}

IntegrationTests/Tests/Fixtures/LibraryTargetWithExtensionSymbols/Sources/Library/Library.swift

@@ -0,0 +1,62 @@
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 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 Swift project authors
+
+/// This is foo's documentation.
+///
+/// Foo is a public struct and should be included in documentation.
+public struct Foo {
+    public func foo() {}
+}
+
+/// This is the documentation for ``Swift/Array``.
+///
+/// This is the extension to ``Array`` with the longest documentation
+/// comment, thus it is used for doucmenting the extended type in this
+/// target.
+extension Array {
+    /// This is the documentation for the ``isArray`` property
+    /// we added to ``Swift/Array``.
+    ///
+    /// This is a public extension to an external type and should be included
+    /// in the documentation.
+    public var isArray: Bool { true }
+}
+
+/// This is the documentation for ``Swift/Int``.
+///
+/// This is the extension to ``Int`` with the longest documentation
+/// comment, thus it is used for doucmenting the extended type in this
+/// target.
+extension Int {
+    /// This is the documentation for the ``isArray`` property
+    /// we added to ``Swift/Int``.
+    ///
+    /// This is a public extension to an external type and should be included
+    /// in the documentation.
+    public var isArray: Bool { false }
+}
+
+
+/// This is the documentation for ``CustomFooConvertible``.
+///
+/// This is a public protocol and should be included in the documentation.
+public protocol CustomFooConvertible {
+    /// This is the documentation for ``CustomFooConvertible/asFoo``.
+    ///
+    /// This is a public protocol requirement and should be included in the documentation.
+    var asFoo: Foo { get }
+}
+
+/// This is not used as the documentation comment for ``Swift/Int``
+/// as it is shorter than the comment on the other extension to `Int`.
+extension Int: CustomFooConvertible {
+    /// This is the documentation for ``Swift/Int/asFoo``.
+    ///
+    /// This is a public protocol requirement implementation and should be included in the documentation.
+    public var asFoo: Foo { Foo() }
+}

IntegrationTests/Tests/TargetWithSwiftExtensionsTests.swift

@@ -0,0 +1,91 @@
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 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 Swift project authors
+
+import Foundation
+import XCTest
+
+final class TargetWithSwiftExtensionsTests: ConcurrencyRequiringTestCase {
+#if swift(>=5.8)
+    let supportsIncludingSwiftExtendedTypes = true
+#else
+    let supportsIncludingSwiftExtendedTypes = false
+#endif
+    
+    override func setUpWithError() throws {
+        try XCTSkipUnless(
+            supportsIncludingSwiftExtendedTypes,
+            "The current toolchain does not support symbol graph generation for extended types."
+        )
+        
+        try super.setUpWithError()
+    }
+    
+    func testGenerateDocumentationWithoutEnablementFlag() throws {
+        let result = try swiftPackage(
+            "generate-documentation",
+            workingDirectory: try setupTemporaryDirectoryForFixture(named: "LibraryTargetWithExtensionSymbols")
+        )
+        
+        result.assertExitStatusEquals(0)
+        XCTAssertEqual(result.referencedDocCArchives.count, 1)
+        
+        let doccArchiveURL = try XCTUnwrap(result.referencedDocCArchives.first)
+        
+        let dataDirectoryContents = try filesIn(.dataSubdirectory, of: doccArchiveURL)
+        
+        XCTAssertEqual(
+            Set(dataDirectoryContents.map(\.lastTwoPathComponents)),
+            [
+                "documentation/library.json",
+                
+                "library/foo.json",
+                "foo/foo().json",
+                
+                "library/customfooconvertible.json",
+                "customfooconvertible/asfoo.json",
+            ]
+        )
+    }
+    
+    func testGenerateDocumentationWithEnablementFlag() throws {
+        let result = try swiftPackage(
+            "generate-documentation",
+            "--include-extended-types",
+            workingDirectory: try setupTemporaryDirectoryForFixture(named: "LibraryTargetWithExtensionSymbols")
+        )
+        
+        result.assertExitStatusEquals(0)
+        XCTAssertEqual(result.referencedDocCArchives.count, 1)
+        
+        let doccArchiveURL = try XCTUnwrap(result.referencedDocCArchives.first)
+        
+        let dataDirectoryContents = try filesIn(.dataSubdirectory, of: doccArchiveURL)
+        
+        XCTAssertEqual(
+            Set(dataDirectoryContents.map(\.lastTwoPathComponents)),
+            [
+                "documentation/library.json",
+                "library/swift.json",
+                
+                "swift/int.json",
+                "int/isarray.json",
+                "int/asfoo.json",
+                "int/customfooconvertible-implementations.json",
+                
+                "swift/array.json",
+                "array/isarray.json",
+                
+                "library/foo.json",
+                "foo/foo().json",
+                
+                "library/customfooconvertible.json",
+                "customfooconvertible/asfoo.json",
+            ]
+        )
+    }
+}