Extend LLBuildManifestWriter to let shell commands specify environment and initial working directory (#3332)

Author: abertelrud

Sources/LLBuildManifest/BuildManifest.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+ Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See http://swift.org/LICENSE.txt for license information
@@ -96,13 +96,17 @@ public struct BuildManifest {
         inputs: [Node],
         outputs: [Node],
         args: [String],
+        environ: [String: String] = [:],
+        workingDir: String? = nil,
         allowMissingInputs: Bool = false
     ) {
         let tool = ShellTool(
             description: description,
             inputs: inputs,
             outputs: outputs,
             args: args,
+            environ: environ,
+            workingDir: workingDir,
             allowMissingInputs: allowMissingInputs
         )
         commands[name] = Command(name: name, tool: tool)

Sources/LLBuildManifest/ManifestWriter.swift

@@ -134,6 +134,16 @@ public final class ManifestToolStream {
             stream <<< "    \(key): " <<< Format.asJSON(newValue) <<< "\n"
         }
     }
+
+    public subscript(key: String) -> [String: String] {
+        get { fatalError() }
+        set {
+            stream <<< "    \(key):\n"
+            for (key, value) in newValue.sorted(by: { $0.key < $1.key }) {
+                stream <<< "      " <<< Format.asJSON(key) <<< ": " <<< Format.asJSON(value) <<< "\n"
+            }
+        }
+    }
 }
 
 extension Format {

Sources/LLBuildManifest/Tools.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+ Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See http://swift.org/LICENSE.txt for license information
@@ -97,25 +97,37 @@ public struct ShellTool: ToolProtocol {
     public var inputs: [Node]
     public var outputs: [Node]
     public var args: [String]
+    public var environ: [String: String]
+    public var workingDir: String?
     public var allowMissingInputs: Bool
 
     init(
         description: String,
         inputs: [Node],
         outputs: [Node],
         args: [String],
+        environ: [String: String] = [:],
+        workingDir: String? = nil,
         allowMissingInputs: Bool = false
     ) {
         self.description = description
         self.inputs = inputs
         self.outputs = outputs
         self.args = args
+        self.environ = environ
+        self.workingDir = workingDir
         self.allowMissingInputs = allowMissingInputs
     }
 
     public func write(to stream: ManifestToolStream) {
         stream["description"] = description
         stream["args"] = args
+        if !environ.isEmpty {
+            stream["env"] = environ
+        }
+        if let workingDir = workingDir {
+            stream["working-directory"] = workingDir
+        }
         if allowMissingInputs {
             stream["allow-missing-inputs"] = true
         }

Tests/BuildTests/LLBuildManifestTests.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+ Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See http://swift.org/LICENSE.txt for license information
@@ -53,6 +53,61 @@ final class LLBuildManifestTests: XCTestCase {
                 outputs: ["<Foo>"]
 
 
+            """)
+    }
+
+    func testShellCommands() throws {
+        var manifest = BuildManifest()
+
+        manifest.defaultTarget = "main"
+        manifest.addShellCmd(
+            name: "shelley",
+            description: "Shelley, Keats, and Byron",
+            inputs: [
+                .file(AbsolutePath("/file.in]"))
+            ],
+            outputs: [
+                .file(AbsolutePath("/file.out"))
+            ],
+            args: [
+                "foo", "bar", "baz"
+            ],
+            environ: [
+                "ABC": "DEF",
+                "G H": "I J K",
+            ],
+            workingDir: "/wdir",
+            allowMissingInputs: true
+        )
+
+        manifest.addNode(.file(AbsolutePath("/file.out")), toTarget: "main")
+
+        let fs = InMemoryFileSystem()
+        try ManifestWriter(fs).write(manifest, at: AbsolutePath("/manifest.yaml"))
+
+        let contents = try fs.readFileContents(AbsolutePath("/manifest.yaml"))
+
+        XCTAssertEqual(contents, """
+            client:
+              name: basic
+            tools: {}
+            targets:
+              "main": ["/file.out"]
+            default: "main"
+            commands:
+              "shelley":
+                tool: shell
+                inputs: ["/file.in]"]
+                outputs: ["/file.out"]
+                description: "Shelley, Keats, and Byron"
+                args: ["foo","bar","baz"]
+                env:
+                  "ABC": "DEF"
+                  "G H": "I J K"
+                working-directory: "/wdir"
+                allow-missing-inputs: true
+
+
             """)
     }
 }