Improve PR based on feedback (#780)

- Fix extra "test" added in diagnostic warning for curating modules
- Use SourceLocations test bundles instead of creating one
- Change test article descriptions to add more context/information
- Verify that relation is created between root and module in ancestor test
- Change `hasTechnologyRoot` to not rely on subtle behavior

Author: Anthony Eid

Sources/SwiftDocC/Infrastructure/DocumentationCurator.swift

@@ -235,20 +235,20 @@ struct DocumentationCurator {
                 // be an error messsage. This is an if statement instead of a guard because
                 // when there's no warning we still curate the node
                 if childDocumentationNode.kind == .module {
-
-                    var hasTechnologyRoot = documentationNode.kind.isSymbol == false
-
-                    hasTechnologyRoot = hasTechnologyRoot || context.pathsTo(nodeReference).contains { path in
-                        if path.count == 0 {
-                            return false
-                        }
-
-                        let node = context.topicGraph.nodeWithReference(path[0])
-                        return node?.kind == .module && node?.kind.isSymbol == false
+                    
+                    func isTechnologyRoot(_ reference: ResolvedTopicReference) -> Bool {
+                        guard let node = context.topicGraph.nodeWithReference(reference) else {return false}
+                        return node.kind == .module && documentationNode.kind.isSymbol == false
+                    }
+        
+                    
+                    let hasTechnologyRoot = isTechnologyRoot(nodeReference) || context.pathsTo(nodeReference).contains { path in
+                        guard let root = path.first else {return false}
+                        return isTechnologyRoot(root)
                     }
 
                     if !hasTechnologyRoot {
-                    problems.append(Problem(diagnostic: Diagnostic(source: source(), severity: .warning, range: range(), identifier: "org.swift.docc.ModuleCuration", summary: "Linking to \((link.destination ?? "").singleQuoted) from a Topics group in \(nodeReference.absoluteString.singleQuoted) isn't allowed", explanation: "The former is a module test, and modules only exist at the root"), possibleSolutions: []))
+                    problems.append(Problem(diagnostic: Diagnostic(source: source(), severity: .warning, range: range(), identifier: "org.swift.docc.ModuleCuration", summary: "Linking to \((link.destination ?? "").singleQuoted) from a Topics group in \(nodeReference.absoluteString.singleQuoted) isn't allowed", explanation: "The former is a module, and modules only exist at the root"), possibleSolutions: []))
                     continue
                     }
 

Tests/SwiftDocCTests/Infrastructure/DocumentationCuratorTests.swift

@@ -146,24 +146,19 @@ class DocumentationCuratorTests: XCTestCase {
     }
 
     func testModuleUnderTechnologyRoot() throws {
-        let (_, bundle, context) = try testBundleAndContext(copying: "ModuleUnderTechnologyRoot") { url in
+        let (_, bundle, context) = try testBundleAndContext(copying: "SourceLocations") { url in
             try """
-            # Another Awesome Project
-            
-            Technology Root
-            
+            # Root curating a module
+
             @Metadata {
                @TechnologyRoot
             }
             
-            ## Overview
-            
-            This shouldn't create a warning because it's a technologyRoot
+            Curating a module from a technology root should not generated any warnings.
             
             ## Topics
             
-            ### Code Reference
-            - ``MyAwesomeApp``
+            - ``SourceLocations``
             
             """.write(to: url.appendingPathComponent("Root.md"), atomically: true, encoding: .utf8)
         }
@@ -180,58 +175,48 @@ class DocumentationCuratorTests: XCTestCase {
     }
 
     func testModuleUnderAncestorOfTechnologyRoot() throws {
-        let (_, bundle, context) = try testBundleAndContext(copying: "ModuleUnderTechnologyRoot") { url in
+        let (_, bundle, context) = try testBundleAndContext(copying: "SourceLocations") { url in
             try """
-            # Another Awesome Project
+            # Root with ancestor curatings a module
             
-            Technology Root
+            This is a root article that enables testing the behavior of it's ancestors.
             
             @Metadata {
                @TechnologyRoot
             }
             
-            ## Overview
-            
-            This shouldn't create a warning because it's a technologyRoot
-            
             ## Topics
             - <doc:Ancestor>
             
-            ### Code Reference
             
             """.write(to: url.appendingPathComponent("Root.md"), atomically: true, encoding: .utf8)
 
             try """
-            # MyAwesomeApp Project
+            # Ancestor of root
             
-            Random summary
-
-            ## Overview
-
-            This is a project to test that no errors are created when a technology root refers to a
-            module.
-            
-            This should create a warning because it links to a module without being a technology root
+            Linking to a module shouldn't raise errors due to this article being an ancestor of a technology root.
 
             ## Topics
-
-
-            ### Code Reference
-
-            - ``MyAwesomeApp``
+            - ``SourceLocations``
 
             """.write(to: url.appendingPathComponent("Ancestor.md"), atomically: true, encoding: .utf8)
         }
 
-        var crawler = DocumentationCurator.init(in: context, bundle: bundle)
+        let crawler = DocumentationCurator.init(in: context, bundle: bundle)
         XCTAssert(context.problems.isEmpty, "Expected no problems. Found: \(context.problems.map(\.diagnostic.summary))")
 
-        for node in context.rootModules {
-            XCTAssertNoThrow(try crawler.crawlChildren(of: node, prepareForCuration: { _ in }, relateNodes: { _, _ in }))
+        
+
+        
+        guard let moduleNode = context.nodeWithSymbolIdentifier("SourceLocations"),
+              let pathToRoot = context.pathsTo(moduleNode.reference).first,
+              let root = pathToRoot.first else {
+            
+            XCTFail("Module doesn't have technology root as a predecessor in its path")
+            return
         }
 
-       
-        XCTAssertEqual(crawler.problems.count, 0)
+        XCTAssertEqual(root.path, "/documentation/Root")
     }