Merge pull request swiftlang#567 from artemcm/OptionalFrontendParseable

Add an option that causes individual `swift-frontend` invocations to emit parseable output, instead of the driver.

Author: artemcm

Sources/SwiftDriver/Driver/Driver.swift

@@ -503,6 +503,7 @@ public struct Driver {
  fileSystem: fileSystem,
  workingDirectory: workingDirectory,
  diagnosticEngine: diagnosticEngine)
+ Self.validateParseableOutputArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
  Self.validateCompilationConditionArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
  Self.validateFrameworkSearchPathArgs(&parsedOptions, diagnosticEngine: diagnosticEngine)
  Self.validateCoverageArgs(&parsedOptions, diagnosticsEngine: diagnosticEngine)
@@ -2092,6 +2093,14 @@ extension Driver {
  }
  }
 
+ static func validateParseableOutputArgs(_ parsedOptions: inout ParsedOptions,
+ diagnosticEngine: DiagnosticsEngine) {
+ if parsedOptions.contains(.parseableOutput) &&
+ parsedOptions.contains(.useFrontendParseableOutput) {
+ diagnosticEngine.emit(Error.conflictingOptions(.parseableOutput, .useFrontendParseableOutput))
+ }
+ }
+
  static func validateCompilationConditionArgs(_ parsedOptions: inout ParsedOptions,
  diagnosticEngine: DiagnosticsEngine) {
  for arg in parsedOptions.arguments(for: .D).map(\.argument.asSingle) {

Sources/SwiftDriver/Jobs/FrontendJobHelpers.swift

@@ -242,6 +242,11 @@ extension Driver {
  commandLine.appendFlags("-module-name", moduleOutputInfo.name)
  }
 
+ // Enable frontend Parseable-output, if needed.
+ if parsedOptions.contains(.useFrontendParseableOutput) {
+ commandLine.appendFlag("-frontend-parseable-output")
+ }
+
  try toolchain.addPlatformSpecificCommonFrontendOptions(commandLine: &commandLine,
  inputs: &inputs,
  frontendTargetInfo: frontendTargetInfo)

Sources/SwiftOptions/ExtraOptions.swift

@@ -13,16 +13,18 @@ extension Option {
  public static let driverPrintGraphviz: Option = Option("-driver-print-graphviz", .flag, attributes: [.helpHidden, .doesNotAffectIncrementalBuild], helpText: "Write the job graph as a graphviz file", group: .internalDebug)
  public static let driverExplicitModuleBuild: Option = Option("-experimental-explicit-module-build", .flag, attributes: [.helpHidden], helpText: "Prebuild module dependencies to make them explicit")
  public static let driverScanDependenciesNonLib: Option = Option("-nonlib-dependency-scanner", .flag, attributes: [.helpHidden], helpText: "Use calls to `swift-frontend -scan-dependencies` instead of dedicated dependency scanning library")
- public static let driverWarnUnusedOptions: Option = Option("-driver-warn-unused-options", .flag, attributes: [.helpHidden], helpText: "Emit warnings for any provided options which are unused by the driver.")
+ public static let driverWarnUnusedOptions: Option = Option("-driver-warn-unused-options", .flag, attributes: [.helpHidden], helpText: "Emit warnings for any provided options which are unused by the driver")
  public static let emitModuleSeparately: Option = Option("-experimental-emit-module-separately", .flag, attributes: [.helpHidden], helpText: "Emit module files as a distinct job")
+ public static let useFrontendParseableOutput: Option = Option("-use-frontend-parseable-output", .flag, attributes: [.helpHidden], helpText: "Emit parseable-output from swift-frontend jobs instead of from the driver")
 
  public static var extraOptions: [Option] {
  return [
  Option.driverPrintGraphviz,
  Option.driverExplicitModuleBuild,
  Option.driverScanDependenciesNonLib,
  Option.driverWarnUnusedOptions,
- Option.emitModuleSeparately
+ Option.emitModuleSeparately,
+ Option.useFrontendParseableOutput
  ]
  }
 }

Tests/SwiftDriverTests/ParsableMessageTests.swift

@@ -11,6 +11,8 @@
 //===----------------------------------------------------------------------===//
 import XCTest
 import Foundation
+import TSCBasic
+import TSCUtility
 
 @_spi(Testing) import SwiftDriver
 
@@ -88,4 +90,56 @@ final class ParsableMessageTests: XCTestCase {
  }
  """)
  }
+
+ func testFrontendMessages() throws {
+ do {
+ try withTemporaryDirectory { path in
+ let main = path.appending(component: "main.swift")
+ let output = path.appending(component: "main.o")
+ try localFileSystem.writeFileContents(main) {
+ $0 <<< "print(\"hello, world!\")"
+ }
+ let diags = DiagnosticsEngine()
+ var driver = try Driver(args: ["swiftc", main.pathString,
+ "-use-frontend-parseable-output",
+ "-o", output.pathString],
+ env: ProcessEnv.vars,
+ diagnosticsEngine: diags,
+ fileSystem: localFileSystem)
+ let jobs = try driver.planBuild()
+ XCTAssertEqual(jobs.removingAutolinkExtractJobs().map(\.kind), [.compile, .link])
+ XCTAssertEqual(jobs[0].outputs.count, 1)
+ let compileArgs = jobs[0].commandLine
+ XCTAssertTrue(compileArgs.contains((.flag("-frontend-parseable-output"))))
+
+ // Replace the error stream with one we capture here.
+ let errorStream = stderrStream
+ let errorOutputFile = path.appending(component: "dummy_error_stream")
+ TSCBasic.stderrStream = try! ThreadSafeOutputByteStream(LocalFileOutputByteStream(errorOutputFile))
+
+ try driver.run(jobs: jobs)
+ let invocationErrorOutput = try localFileSystem.readFileContents(errorOutputFile).description
+ XCTAssertTrue(invocationErrorOutput.contains("""
+{
+ "kind": "began",
+ "name": "compile",
+"""))
+ XCTAssertTrue(invocationErrorOutput.contains("""
+{
+ "kind": "finished",
+ "name": "compile",
+"""))
+ // Restore the error stream to what it was
+ TSCBasic.stderrStream = errorStream
+ }
+ }
+
+ do {
+ try assertDriverDiagnostics(args: ["swiftc", "foo.swift", "-parseable-output",
+ "-use-frontend-parseable-output"]) {
+ $1.expect(.error(Driver.Error.conflictingOptions(.parseableOutput,
+ .useFrontendParseableOutput)))
+ }
+ }
+ }
 }