Implementation for the `swift run` command #1187

hartbit · 2017-05-15T22:38:05Z

No description provided.

ddunbar · 2017-05-15T22:39:50Z

Sources/Commands/SwiftRunTool.swift

+
+    /// Executes and returns execution status. Prints output on standard streams.
+    private func run(path: AbsolutePath) throws {
+        let process = Process(arguments: [path.asString] + options.arguments, redirectOutput: false)


On UNIX, we should exec the process rather than run it in a subprocess. These will ensure that we don't influence the programs behavior w.r.t. signal handling, buffering, etc.

ankitspd · 2017-05-16T04:40:25Z

Sources/Commands/SwiftRunTool.swift

+    /// Builds the "executable" target if enabled in options.
+    ///
+    /// - Returns: The path to the executable binary.
+    private func buildIfNeeded() throws -> AbsolutePath {


It feels weird that this returns path to the executable. We can just inline this for now.

Agreed. I was just reproducing the structure of swift test in case that's what you preferred. Will inline it.

ankitspd · 2017-05-16T04:41:22Z

Sources/Commands/SwiftRunTool.swift

+
+        return buildPath
+            .appending(RelativePath(options.config.dirname))
+            .appending(component: executable.name)


We should be using buildplan to get the path to executable, can you land the refactor first?

ddunbar · 2017-05-31T20:26:19Z

We accepted SE-179 with revisions:
https://lists.swift.org/pipermail/swift-evolution/Week-of-Mon-20170529/036909.html
which we should incorporate here.

hartbit · 2017-05-31T20:42:16Z

I have an implementation ready for the accepted (revised) version. Just need to wait for #1215 to be merged first.

ankitspd · 2017-06-01T05:46:07Z

Sources/Commands/SwiftRunTool.swift

+        case .executableNotFound(let executable):
+            return "could not find executable '\(executable)'"
+        case .multipleExecutables:
+            return "multiple products defined"


We should make this more descriptive, maybe something like: "There are multiple executable products in the package. Use 'swift run ' to run one of the executable".

It might be nice to also list the executables, so users don't then have to look up the names.

ankitspd · 2017-06-01T05:46:38Z

Sources/Commands/SwiftRunTool.swift

+private enum RunError: Swift.Error {
+    case noExecutableFound
+    case executableNotFound(String)
+    case multipleExecutables


doc comments

ankitspd · 2017-06-01T05:47:45Z

Sources/Commands/SwiftRunTool.swift

+        }
+    }
+
+    /// Executes and returns execution status. Prints output on standard streams.


Stale comment

ankitspd · 2017-06-01T05:49:41Z

Sources/Commands/SwiftRunTool.swift

+
+            let product = try findExecutable(in: plan)
+            let path = plan.buildParameters.buildPath.appending(component: product.name)
+            try run(at: path)


This sounds wrong. Maybe findExectuable can return the path of the exe and then we can do this:

... let executable = try findExecutable(in: plan) try run(executable) ...

ankitspd · 2017-06-01T05:50:41Z

Sources/Commands/SwiftRunTool.swift

+            }
+
+            return executableProduct
+        } else {


Else is not required

What do you mean by that?

That you can just put the else branch after the if, since it early returns.

Ok, got it!

ankitspd · 2017-06-01T05:51:07Z

Sources/Commands/SwiftRunTool.swift

+                throw RunError.multipleExecutables
+            }
+
+            return executableProducts.first!


nit: return executableProducts[0] feels nicer for some reason.

Maybe we should have an extension .only which returns the only item iff array has one element, this is a not uncommon pattern, and that utility works nicely in guard.

Sounds like a nice utility! Separate PR I guess?

Ya, I wouldn't block this one on it, just update it to use it if we decide it is a good idea.

ankitspd · 2017-06-01T05:53:58Z

Sources/Commands/SwiftRunTool.swift

+
+    /// Executes and returns execution status. Prints output on standard streams.
+    private func run(at path: AbsolutePath) throws {
+        if let workingDirectory = options.workingDirectory {


Where is this set?

I think this became dead code, and the option can be removed.

ankitspd · 2017-06-01T05:55:51Z

Sources/Commands/SwiftRunTool.swift

+            try POSIX.chdir(workingDirectory.asString)
+        }
+
+        let relativePath = path.relative(to: currentWorkingDirectory)


currentWorkingDirectory -> originalWorkingDirectory

We should have a test case that fails w/o this fix.

I'm confused. Looking at the code, it seems originalWorkingDirectory is currently only set once to currentWorkingDirectory. Not quite sure what its use case is.

ankitspd · 2017-06-01T05:56:11Z

Sources/Utility/ArgumentParser.swift

@@ -929,6 +929,18 @@ public final class ArgumentBinder<Options> {
        }
    }

+    /// Bind an array positional argument.
+    public func bindArray<T>(


Please add this in a separate commit/PR

ankitspd · 2017-06-01T05:57:11Z

Tests/CommandsTests/RunToolTests.swift

+
+    func testVersion() throws {
+        XCTAssert(try execute(["--version"]).contains("Swift Package Manager"))
+    }


We should add a basic functional test. We can extend one of the executable related functional test.

ddunbar · 2017-06-01T16:54:23Z

Sources/Commands/SwiftRunTool.swift

+        case .executableNotFound(let executable):
+            return "could not find executable '\(executable)'"
+        case .multipleExecutables:
+            return "multiple products defined"


It might be nice to also list the executables, so users don't then have to look up the names.

ddunbar · 2017-06-01T16:54:57Z

Sources/Commands/SwiftRunTool.swift

+
+    /// Executes and returns execution status. Prints output on standard streams.
+    private func run(at path: AbsolutePath) throws {
+        if let workingDirectory = options.workingDirectory {


I think this became dead code, and the option can be removed.

ddunbar · 2017-06-01T19:07:29Z

Sources/Commands/SwiftRunTool.swift

+   public convenience init(args: [String]) {
+       self.init(
+            toolName: "run",
+            usage: "[options] [executable <arguments>]",


This is somewhat unconventional syntax for usage, I would spell it as:
[executable [arguments ...]]

ddunbar · 2017-06-01T19:09:34Z

Sources/Commands/SwiftRunTool.swift

+                throw RunError.multipleExecutables
+            }
+
+            return executableProducts.first!


Maybe we should have an extension .only which returns the only item iff array has one element, this is a not uncommon pattern, and that utility works nicely in guard.

ddunbar · 2017-06-01T19:09:55Z

Sources/Commands/SwiftRunTool.swift

+            try POSIX.chdir(workingDirectory.asString)
+        }
+
+        let relativePath = path.relative(to: currentWorkingDirectory)


We should have a test case that fails w/o this fix.

ankitspd · 2017-06-13T14:11:00Z

Sources/Commands/SwiftRunTool.swift

+        }
+    }
+
+    /// Find executable path based on options.


nit: The API guidelines recommend wording the doc comments in terms of what the method returns. Something like Returns executable path ... will be more appropriate.

ankitspd · 2017-06-13T14:11:36Z

Sources/Commands/SwiftRunTool.swift

+            product = executableProducts[0]
+        }
+
+        return plan.buildParameters.buildPath.appending(component: product.name)


nit: Consider adding some high level comments on whats going on in this method.

ankitspd · 2017-06-13T14:12:30Z

Sources/Commands/SwiftRunTool.swift

+
+    /// Executes the executable at the specified path.
+    private func run(_ excutablePath: AbsolutePath) throws {
+        let relativePath = excutablePath.relative(to: originalWorkingDirectory)


The name relativePath is too vague.

ankitspd · 2017-06-13T14:13:01Z

Sources/Commands/SwiftRunTool.swift

+See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import class Foundation.ProcessInfo


Is this needed?

hartbit · 2017-06-16T14:26:00Z

@swift-ci please smoke test

hartbit · 2017-06-16T14:26:14Z

@swift-ci please smoke test

hartbit · 2017-06-16T15:05:29Z

@swift-ci please smoke test

hartbit · 2017-06-16T15:05:41Z

@swift-ci please smoke test

hartbit · 2017-06-16T15:05:51Z

@swift-ci please smoke test

hartbit · 2017-06-17T15:39:58Z

@swift-ci please smoke test

hartbit · 2017-06-17T15:40:11Z

@swift-ci please smoke test

ddunbar reviewed May 15, 2017

View reviewed changes

ankitspd reviewed May 16, 2017

View reviewed changes

hartbit force-pushed the swift-run branch from 689f82f to 5d2fc94 Compare May 17, 2017 18:00

ankitspd assigned hartbit May 21, 2017

ankitspd added the WIP Work in progress label May 21, 2017

hartbit force-pushed the swift-run branch 2 times, most recently from 66f7067 to 32e47e2 Compare May 31, 2017 22:11

hartbit assigned ddunbar and ankitspd and unassigned hartbit May 31, 2017

hartbit added pending evolution proposal and removed WIP Work in progress labels May 31, 2017

hartbit changed the title ~~[WIP] Implementation for the swift run command~~ Implementation for the swift run command May 31, 2017

ankitspd requested changes Jun 1, 2017

View reviewed changes

ankitspd added WIP Work in progress and removed pending evolution proposal labels Jun 1, 2017

ankitspd removed their assignment Jun 1, 2017

ddunbar requested changes Jun 1, 2017

View reviewed changes

ddunbar assigned hartbit and unassigned ddunbar Jun 1, 2017

hartbit force-pushed the swift-run branch 3 times, most recently from 815cde3 to ffc6e67 Compare June 4, 2017 21:24

hartbit assigned ddunbar and ankitspd and unassigned hartbit Jun 4, 2017

hartbit added the pending evolution proposal label Jun 4, 2017

ankitspd reviewed Jun 13, 2017

View reviewed changes

ankitspd assigned hartbit and unassigned ankitspd Jun 13, 2017

ankitspd added WIP Work in progress and removed pending evolution proposal labels Jun 13, 2017

hartbit force-pushed the swift-run branch from 25c3e6c to ca4af45 Compare June 14, 2017 22:19

hartbit added pending evolution proposal and removed WIP Work in progress labels Jun 16, 2017

hartbit assigned ankitspd and unassigned hartbit Jun 16, 2017

hartbit force-pushed the swift-run branch from ca4af45 to 088b6eb Compare June 16, 2017 14:09

hartbit unassigned ddunbar Jun 16, 2017

ankitspd approved these changes Jun 16, 2017

View reviewed changes

ddunbar approved these changes Jun 16, 2017

View reviewed changes

hartbit force-pushed the swift-run branch from 088b6eb to 733b9b1 Compare June 16, 2017 15:05

hartbit removed the pending evolution proposal label Jun 16, 2017

Implement the swift run tool

1fe9ea2

hartbit force-pushed the swift-run branch from 733b9b1 to 1fe9ea2 Compare June 17, 2017 15:39

hartbit merged commit b4d728c into apple:master Jun 17, 2017

hartbit deleted the swift-run branch June 27, 2017 19:52

Implementation for the swift run command #1187

Implementation for the swift run command #1187

Conversation

hartbit commented May 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ddunbar commented May 31, 2017

hartbit commented May 31, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ankitspd Jun 13, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hartbit commented Jun 16, 2017

hartbit commented Jun 16, 2017

hartbit commented Jun 16, 2017

hartbit commented Jun 16, 2017

hartbit commented Jun 16, 2017

hartbit commented Jun 17, 2017

hartbit commented Jun 17, 2017

Implementation for the `swift run` command #1187

Implementation for the `swift run` command #1187

ankitspd Jun 13, 2017 •

edited