Add support for '-explicit-dependency-graph-format=' flag

Author: artemcm

Sources/SwiftDriver/Driver/Driver.swift

@@ -634,6 +634,7 @@ public struct Driver {
                                fileSystem: fileSystem,
                                workingDirectory: workingDirectory,
                                diagnosticEngine: diagnosticEngine)
+    Self.validateEmitDependencyGraphArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
     Self.validateParseableOutputArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
     Self.validateCompilationConditionArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
     Self.validateFrameworkSearchPathArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
@@ -2646,6 +2647,28 @@ extension Driver {
     }
   }
 
+  static func validateEmitDependencyGraphArgs(_ parsedOptions: inout ParsedOptions,
+                                              diagnosticEngine: DiagnosticsEngine) {
+    // '-print-explicit-dependency-graph' requires '-explicit-module-build'
+    if parsedOptions.hasArgument(.printExplicitDependencyGraph) &&
+        !parsedOptions.hasArgument(.driverExplicitModuleBuild) {
+      diagnosticEngine.emit(Error.optionRequiresAnother(Option.printExplicitDependencyGraph.spelling,
+                                                        Option.driverExplicitModuleBuild.spelling))
+    }
+    // '-explicit-dependency-graph-format=' requires '-print-explicit-dependency-graph'
+    if parsedOptions.hasArgument(.explicitDependencyGraphFormat) &&
+        !parsedOptions.hasArgument(.printExplicitDependencyGraph) {
+      diagnosticEngine.emit(Error.optionRequiresAnother(Option.explicitDependencyGraphFormat.spelling,
+                                                        Option.printExplicitDependencyGraph.spelling))
+    }
+    // '-explicit-dependency-graph-format=' only supports values 'json' and 'dot'
+    if let formatArg = parsedOptions.getLastArgument(.explicitDependencyGraphFormat)?.asSingle {
+      if formatArg != "json" && formatArg != "dot" {
+        diagnosticEngine.emit(.error_unsupported_argument(argument: formatArg,
+                                                          option: .explicitDependencyGraphFormat))
+      }
+    }
+  }
 
   static func validateProfilingArgs(_ parsedOptions: inout ParsedOptions,
                                     fileSystem: FileSystem,

Sources/SwiftDriver/Jobs/Planning.swift

@@ -660,7 +660,12 @@ extension Driver {
     try resolveDependencyModulePaths(dependencyGraph: &dependencyGraph)
 
     if parsedOptions.hasArgument(.printExplicitDependencyGraph) {
-      try stdoutStream <<< dependencyGraph.toJSONString()
+      let outputFormat = parsedOptions.getLastArgument(.explicitDependencyGraphFormat)?.asSingle
+      if outputFormat == nil || outputFormat == "json" {
+        try stdoutStream <<< dependencyGraph.toJSONString()
+      } else if outputFormat == "dot" {
+        DOTModuleDependencyGraphSerializer(dependencyGraph).writeDOT(to: &stdoutStream)
+      }
       stdoutStream.flush()
     }
 

Sources/SwiftOptions/Options.swift

@@ -217,7 +217,6 @@ extension Option {
   public static let dumpApiPath: Option = Option("-dump-api-path", .separate, attributes: [.helpHidden, .frontend, .noDriver], helpText: "The path to output swift interface files for the compiled source files")
   public static let dumpAst: Option = Option("-dump-ast", .flag, attributes: [.frontend, .noInteractive, .doesNotAffectIncrementalBuild], helpText: "Parse and type-check input file(s) and dump AST(s)", group: .modes)
   public static let dumpClangDiagnostics: Option = Option("-dump-clang-diagnostics", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Dump Clang diagnostics to stderr")
-  public static let dumpInterModuleDependencyGraph: Option = Option("-dump-inter-module-dependency-graph=", .joined, attributes: [.helpHidden, .doesNotAffectIncrementalBuild], helpText: "Emit the inter-module dependency graph of this target to output")
   public static let dumpInterfaceHash: Option = Option("-dump-interface-hash", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Parse input file(s) and dump interface token hash(es)", group: .modes)
   public static let dumpJit: Option = Option("-dump-jit", .joinedOrSeparate, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Dump JIT contents")
   public static let dumpMigrationStatesDir: Option = Option("-dump-migration-states-dir", .separate, attributes: [.frontend, .noInteractive, .doesNotAffectIncrementalBuild, .argumentIsPath], metaVar: "<path>", helpText: "Dump the input text, output text, and states for migration to <path>")
@@ -390,6 +389,7 @@ extension Option {
   public static let experimentalSkipNonInlinableFunctionBodies: Option = Option("-experimental-skip-non-inlinable-function-bodies", .flag, attributes: [.helpHidden, .frontend], helpText: "Skip type-checking and SIL generation for non-inlinable function bodies")
   public static let experimentalSpiImports: Option = Option("-experimental-spi-imports", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Enable experimental support for SPI imports")
   public static let experimentalSpiOnlyImports: Option = Option("-experimental-spi-only-imports", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Enable use of @_spiOnly imports")
+  public static let explicitDependencyGraphFormat: Option = Option("-explicit-dependency-graph-format=", .joined, attributes: [.helpHidden, .doesNotAffectIncrementalBuild], helpText: "Specify the explicit dependency graph output format to either 'json' or 'dot'")
   public static let explicitInterfaceModuleBuild: Option = Option("-explicit-interface-module-build", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Use the specified command-line to build the module from interface, instead of flags specified in the interface")
   public static let driverExplicitModuleBuild: Option = Option("-explicit-module-build", .flag, attributes: [.helpHidden], helpText: "Prebuild module dependencies to make them explicit")
   public static let explicitSwiftModuleMap: Option = Option("-explicit-swift-module-map-file", .separate, attributes: [.frontend, .noDriver], metaVar: "<path>", helpText: "Specify a JSON file containing information of explicit Swift modules")
@@ -549,7 +549,7 @@ extension Option {
   public static let printAst: Option = Option("-print-ast", .flag, attributes: [.frontend, .noInteractive, .doesNotAffectIncrementalBuild], helpText: "Parse and type-check input file(s) and pretty print AST(s)", group: .modes)
   public static let printClangStats: Option = Option("-print-clang-stats", .flag, attributes: [.frontend, .noDriver], helpText: "Print Clang importer statistics")
   public static let printEducationalNotes: Option = Option("-print-educational-notes", .flag, attributes: [.frontend, .doesNotAffectIncrementalBuild], helpText: "Include educational notes in printed diagnostic output, if available")
-  public static let printExplicitDependencyGraph: Option = Option("-print-explicit-dependency-graph", .flag, attributes: [.helpHidden], helpText: "Print the result of module dependency scanning after external module resolution to output")
+  public static let printExplicitDependencyGraph: Option = Option("-print-explicit-dependency-graph", .flag, attributes: [.helpHidden, .doesNotAffectIncrementalBuild], helpText: "Print the result of module dependency scanning after external module resolution to output")
   public static let printInstCounts: Option = Option("-print-inst-counts", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Before IRGen, count all the various SIL instructions. Must be used in conjunction with -print-stats.")
   public static let printLlvmInlineTree: Option = Option("-print-llvm-inline-tree", .flag, attributes: [.helpHidden, .frontend, .noDriver], helpText: "Print the LLVM inline tree.")
   public static let printModule: Option = Option("-print-module", .flag, attributes: [.noDriver], helpText: "Print module names in diagnostics")
@@ -933,7 +933,6 @@ extension Option {
       Option.dumpApiPath,
       Option.dumpAst,
       Option.dumpClangDiagnostics,
-      Option.dumpInterModuleDependencyGraph,
       Option.dumpInterfaceHash,
       Option.dumpJit,
       Option.dumpMigrationStatesDir,
@@ -1106,6 +1105,7 @@ extension Option {
       Option.experimentalSkipNonInlinableFunctionBodies,
       Option.experimentalSpiImports,
       Option.experimentalSpiOnlyImports,
+      Option.explicitDependencyGraphFormat,
       Option.explicitInterfaceModuleBuild,
       Option.driverExplicitModuleBuild,
       Option.explicitSwiftModuleMap,

Tests/SwiftDriverTests/ExplicitModuleBuildTests.swift

@@ -1076,8 +1076,7 @@ final class ExplicitModuleBuildTests: XCTestCase {
       return
     }
     guard try dependencyOracle.supportsScannerDiagnostics() else {
-      XCTSkip("libSwiftScan does not support diagnostics query.")
-      return
+      throw XCTSkip("libSwiftScan does not support diagnostics query.")
     }
 
     try withTemporaryDirectory { path in
@@ -1240,6 +1239,98 @@ final class ExplicitModuleBuildTests: XCTestCase {
     }
   }
 
+  func testPrintingExplicitDependencyGraph() throws {
+    try withTemporaryDirectory { path in
+      let main = path.appending(component: "testPrintingExplicitDependencyGraph.swift")
+      try localFileSystem.writeFileContents(main) {
+        $0 <<< "import C;"
+        $0 <<< "import E;"
+        $0 <<< "import G;"
+      }
+      let cHeadersPath: AbsolutePath = testInputsPath.appending(component: "ExplicitModuleBuilds").appending(component: "CHeaders")
+      let swiftModuleInterfacesPath: AbsolutePath = testInputsPath.appending(component: "ExplicitModuleBuilds").appending(component: "Swift")
+      let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
+
+      let baseCommandLine = ["swiftc",
+                             "-target", "x86_64-apple-macosx11.0",
+                             "-I", cHeadersPath.nativePathString(escaped: true),
+                             "-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
+                             main.nativePathString(escaped: true)] + sdkArgumentsForTesting
+      do {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-print-explicit-dependency-graph"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertTrue(diagnosticEngine.hasErrors)
+        XCTAssertEqual(diagnosticEngine.diagnostics.first?.message.data.description,
+                       "'-print-explicit-dependency-graph' cannot be specified if '-explicit-module-build' is not present")
+      }
+      do {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-explicit-module-build",
+                                                         "-explicit-dependency-graph-format=json"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertTrue(diagnosticEngine.hasErrors)
+        XCTAssertEqual(diagnosticEngine.diagnostics.first?.message.data.description,
+                       "'-explicit-dependency-graph-format=' cannot be specified if '-print-explicit-dependency-graph' is not present")
+      }
+      do {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-explicit-module-build",
+                                                         "-print-explicit-dependency-graph",
+                                                         "-explicit-dependency-graph-format=watercolor"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertTrue(diagnosticEngine.hasErrors)
+        XCTAssertEqual(diagnosticEngine.diagnostics.first?.message.data.description,
+                       "unsupported argument \'watercolor\' to option \'-explicit-dependency-graph-format=\'")
+      }
+      
+      let _ = try withHijackedOutputStream {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-explicit-module-build",
+                                                         "-print-explicit-dependency-graph",
+                                                         "-explicit-dependency-graph-format=json"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertFalse(diagnosticEngine.hasErrors)
+      }
+
+      let output = try withHijackedOutputStream {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-explicit-module-build",
+                                                         "-print-explicit-dependency-graph",
+                                                         "-explicit-dependency-graph-format=json"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertFalse(diagnosticEngine.hasErrors)
+      }
+      XCTAssertTrue(output.contains("\"mainModuleName\" : \"testPrintingExplicitDependencyGraph\","))
+
+      let output2 = try withHijackedOutputStream {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-explicit-module-build",
+                                                         "-print-explicit-dependency-graph",
+                                                         "-explicit-dependency-graph-format=dot"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertFalse(diagnosticEngine.hasErrors)
+      }
+      XCTAssertTrue(output2.contains("\"testPrintingExplicitDependencyGraph\" [shape=box, style=bold, color=navy"))
+
+      let output3 = try withHijackedOutputStream {
+        let diagnosticEngine = DiagnosticsEngine()
+        var driver = try Driver(args: baseCommandLine + ["-explicit-module-build",
+                                                         "-print-explicit-dependency-graph"],
+                                diagnosticsEngine: diagnosticEngine)
+        let _ = try driver.planBuild()
+        XCTAssertFalse(diagnosticEngine.hasErrors)
+      }
+      XCTAssertTrue(output3.contains("\"mainModuleName\" : \"testPrintingExplicitDependencyGraph\","))
+    }
+  }
+
   func testDependencyGraphDotSerialization() throws {
       let (stdlibPath, shimsPath, toolchain, hostTriple) = try getDriverArtifactsForScanning()
       let dependencyOracle = InterModuleDependencyOracle()