Add possibility to run executables from dependency packages

Nimble's run command is extended to be able to run executables not only
from the current package but also from some of its dependencies. The
package from which we want to run an executable is specified with a
newly added to Nimble `--package` command-line option. There are two
cases:

 - For installed in the Nimble cache packages the build step is skipped
   and the installed package binary is being run.

 - For develop mode packages first the package's binary is being built
   with provided compilation flags and the package is being run.

Author: bobeff

src/nimble.nim

@@ -703,14 +703,18 @@ proc getDependenciesPaths(pkgInfo: PackageInfo, options: Options):
   let deps = pkgInfo.processAllDependencies(options)
   return deps.map(dep => dep.getRealDir())
 
-proc build(options: Options) =
-  let dir = getCurrentDir()
-  let pkgInfo = getPkgInfo(dir, options)
+proc build(pkgInfo: PackageInfo, options: Options) =
+  ## Builds the package `pkgInfo`.
   nimScriptHint(pkgInfo)
   let paths = pkgInfo.getDependenciesPaths(options)
   var args = options.getCompilationFlags()
   buildFromDir(pkgInfo, paths, args, options)
 
+proc build(options: Options) =
+  let dir = getCurrentDir()
+  let pkgInfo = getPkgInfo(dir, options)
+  pkgInfo.build(options)
+
 proc clean(options: Options) =
   let dir = getCurrentDir()
   let pkgInfo = getPkgInfo(dir, options)
@@ -1829,21 +1833,40 @@ proc setup(options: Options) =
   setupNimbleConfig(options)
   setupVcsIgnoreFile()
 
+proc getPackageForAction(pkgInfo: PackageInfo, options: Options): PackageInfo =
+  ## Returns the `PackageInfo` for the package in `pkgInfo`'s dependencies tree
+  ## with the name specified in `options.package`. If `options.package` is empty
+  ## or it matches the name of the `pkgInfo` then `pkgInfo` is returned. Raises
+  ## a `NimbleError` if the package with the provided name is not found.
+  
+  result = initPackageInfo()
+
+  if options.package.len == 0 or pkgInfo.basicInfo.name == options.package:
+    return pkgInfo
+
+  let deps = pkgInfo.processAllDependencies(options)
+  for dep in deps:
+    if dep.basicInfo.name == options.package:
+      return dep.toFullInfo(options)
+
+  raise nimbleError(notFoundPkgWithNameInPkgDepTree(options.package))
+
 proc run(options: Options) =
-  # Verify parameters.
   var pkgInfo = getPkgInfo(getCurrentDir(), options)
+  pkgInfo = getPackageForAction(pkgInfo, options)
 
   let binary = options.getCompilationBinary(pkgInfo).get("")
   if binary.len == 0:
     raise nimbleError("Please specify a binary to run")
 
   if binary notin pkgInfo.bin:
-    raise nimbleError(
-      "Binary '$#' is not defined in '$#' package." % [binary, pkgInfo.basicInfo.name]
-    )
+    raise nimbleError(binaryNotDefinedInPkgMsg(binary, pkgInfo.basicInfo.name))
 
-  # Build the binary.
-  build(options)
+  if pkgInfo.isLink:
+    # If this is not installed package then build the binary.
+    pkgInfo.build(options)
+  elif options.getCompilationFlags.len > 0:
+    displayWarning(ignoringCompilationFlagsMsg)
 
   let binaryPath = pkgInfo.getOutputDir(binary)
   let cmd = quoteShellCommand(binaryPath & options.action.runFlags)

src/nimblepkg/displaymessages.nim

@@ -34,6 +34,9 @@ const
   multipleDevelopFileOptionsGivenMsg* =
     "Multiple develop file options are given."
 
+  ignoringCompilationFlagsMsg* =
+    "Ignoring compilation flags for installed package."
+
   updatingTheLockFileMsg* = "Updating the lock file..."
   generatingTheLockFileMsg* = "Generating the lock file..."
   lockFileIsUpdatedMsg* = "The lock file is updated."
@@ -157,3 +160,10 @@ proc pkgAlreadyExistsInTheCacheMsg*(pkgInfo: PackageInfo): string =
 proc skipDownloadingInAlreadyExistingDirectoryMsg*(dir, name: string): string =
   &"The download directory \"{dir}\" already exists.\n" &
   &"Skipping the download of \"{name}\"."
+
+proc binaryNotDefinedInPkgMsg*(binaryName, pkgName: string): string =
+  &"Binary '{binaryName}' is not defined in '{pkgName}' package."
+
+proc notFoundPkgWithNameInPkgDepTree*(pkgName: string): string =
+  &"Not found package with name '{pkgName}' in the current package's " &
+   "dependency tree."

src/nimblepkg/options.nim

@@ -43,6 +43,10 @@ type
     developLocaldeps*: bool # True if local deps + nimble develop pkg1 ...
     disableSslCertCheck*: bool
     enableTarballs*: bool # Enable downloading of packages as tarballs from GitHub.
+    package*: string
+      # For which package in the dependency tree the command should be executed.
+      # If not provided by default it applies to the current directory package.
+      # For now, it is used only by the run action and it is ignored by others.
 
   ActionType* = enum
     actionNil, actionRefresh, actionInit, actionDump, actionPublish,
@@ -189,7 +193,12 @@ Nimble Options:
   -v, --version                   Print version information.
   -y, --accept                    Accept all interactive prompts.
   -n, --reject                    Reject all interactive prompts.
-  -l, --localdeps                 Run in project local dependency mode
+  -l, --localdeps                 Run in project local dependency mode.
+  -p, --package                   For which package in the dependency tree the
+                                  command should be executed. If not provided by
+                                  default it applies to the current directory
+                                  package. For now, it is used only by the run
+                                  action and it is ignored by others.
   -t, --tarballs                  Enable downloading of packages as tarballs
                                   when working with GitHub repositories.
       --ver                       Query remote server for package version
@@ -485,6 +494,7 @@ proc parseFlag*(flag, val: string, result: var Options, kind = cmdLongOption) =
   of "localdeps", "l": result.localdeps = true
   of "nosslcheck": result.disableSslCertCheck = true
   of "tarballs", "t": result.enableTarballs = true
+  of "package", "p": result.package = val
   else: isGlobalFlag = false
 
   var wasFlagHandled = true

tests/runDependencyBinary/dependency/binary.nim

@@ -0,0 +1,4 @@
+when isMainModule:
+  import os
+  for i in 1 .. paramCount():
+    echo paramStr(i)

tests/runDependencyBinary/dependency/dependency.nim

@@ -0,0 +1,2 @@
+proc foo* =
+  echo "Hello from dependency.foo"

tests/runDependencyBinary/dependency/dependency.nimble

@@ -0,0 +1,8 @@
+version       = "0.1.0"
+author        = "Ivan Bobev"
+description   = "Test package."
+license       = "MIT"
+
+bin = @["binary"]
+
+requires "nim >= 1.7.1"

tests/runDependencyBinary/dependent/dependent.nimble

@@ -0,0 +1,6 @@
+version       = "0.1.0"
+author        = "Ivan Bobev"
+description   = "Test package."
+license       = "MIT"
+
+requires "nim >= 1.7.1", "dependency"

tests/truncommand.nim

@@ -5,7 +5,9 @@
 
 import unittest, os, strutils
 import testscommon
+import nimblepkg/displaymessages
 from nimblepkg/common import cd
+from nimblepkg/developfile import developFileName
 
 suite "nimble run":
   test "Invalid binary":
@@ -162,3 +164,68 @@ suite "nimble run":
                             [$DirSep, "run".changeFileExt(ExeExt)])
       check output.contains("""Testing `nimble run`: @["--test"]""")
       check output.contains("""Whee!""")
+
+  const
+    testPkgsPath = "runDependencyBinary"
+    dependencyPkgPath = testPkgsPath / "dependency"
+    dependentPkgPath = testPkgsPath / "dependent"
+    dependencyPkgBinary = dependencyPkgPath / "binary".addFileExt(ExeExt)
+    dependentPkgDevelopFile = dependentPkgPath / developFileName
+    packagesFilePath = "develop/packages.json"
+
+  test "Run binary from dependency in Nimble cache":
+    cleanDir installDir
+    cleanFile dependencyPkgBinary
+    usePackageListFile(packagesFilePath):
+      cd dependencyPkgPath:
+        let (_, exitCode) = execNimble("install")
+        check exitCode == QuitSuccess
+      cd dependentPkgPath:
+        let (output, exitCode) = execNimble("--package:dependency", "run",
+          "-d:danger", "binary", "--arg1", "--arg2")
+        check exitCode == QuitSuccess
+        var lines = output.processOutput
+        check lines.inLinesOrdered(ignoringCompilationFlagsMsg)
+        check lines.inLinesOrdered("--arg1")
+        check lines.inLinesOrdered("--arg2")
+
+  test "Run binary from develop mode dependency":
+    cleanDir installDir
+    cleanFiles dependencyPkgBinary, dependentPkgDevelopFile
+    usePackageListFile(packagesFilePath):
+      cd dependentPkgPath:
+        var (output, exitCode) = execNimble("develop", "-a:../dependency")
+        check exitCode == QuitSuccess
+        (output, exitCode) = execNimble("--package:dependency", "run",
+          "-d:danger", "binary", "--arg1", "--arg2")
+        check exitCode == QuitSuccess
+        var lines = output.processOutput
+        check lines.inLinesOrdered("Building dependency/binary using c backend")
+        check lines.inLinesOrdered("--arg1")
+        check lines.inLinesOrdered("--arg2")
+
+  test "Error when specified package does not exist":
+    cleanDir installDir
+    cleanFile dependencyPkgBinary
+    usePackageListFile(packagesFilePath):
+      cd dependencyPkgPath:
+        let (_, exitCode) = execNimble("install")
+        check exitCode == QuitSuccess
+      cd dependentPkgPath:
+        let (output, exitCode) = execNimble("--package:dep", "run",
+          "-d:danger", "binary", "--arg1", "--arg2")
+        check exitCode == QuitFailure
+        check output.contains(notFoundPkgWithNameInPkgDepTree("dep"))
+
+  test "Error when specified binary does not exist in specified package":
+    cleanDir installDir
+    cleanFile dependencyPkgBinary
+    usePackageListFile(packagesFilePath):
+      cd dependencyPkgPath:
+        let (_, exitCode) = execNimble("install")
+        check exitCode == QuitSuccess
+      cd dependentPkgPath:
+        let (output, exitCode) = execNimble("--package:dependency", "run",
+          "-d:danger", "bin", "--arg1", "--arg2")
+        check exitCode == QuitFailure
+        check output.contains(binaryNotDefinedInPkgMsg("bin", "dependency"))