new 'shell' with wider options set compared to 'system'

Author: OlegZee

XakeLibTests/MiscTests.fs

@@ -4,6 +4,7 @@ open System.IO
 open NUnit.Framework
 
 open Xake
+open Xake.SystemTasks
 
 let xakeOptions = ExecOptions.Default
 
@@ -92,7 +93,7 @@ let ``script exits with errorlevel on script failure``() =
         rules [
             "one" => action {
                 do! need ["1/script.fsx"]
-                let! ec = system fsiApp ["1/script.fsx"]
+                let! ec = system id fsiApp ["1/script.fsx"]
                 errorCode := ec
             }
             "1/script.fsx" *> fun src -> action {

XakeLibTests/XakeScriptTests.fs

@@ -202,7 +202,7 @@ let ``allows to define target in parameters``() =
     Assert.AreEqual(0, !mainCount)
     Assert.AreEqual(1, !xxxCount)
 
-[<Test; Explicit("Fails on unix")>]
+[<Test; Platform("Win")>]
 let ``target could be a relative``() =
 
     let needExecuteCount = ref 0
@@ -275,7 +275,7 @@ let ``matching groups in rule name``(tgt,mask,expect:string) =
 
 type Runtime = {Ver: string; Folder: string}
 
-[<Test; Explicit("Fails on unix")>]
+[<Test; Platform("Win")>]
 let ``target could be a relative2``() =
 
     let needExecuteCount = ref 0

build.fsx

@@ -79,7 +79,7 @@ do xake {ExecOptions.Default with Vars = ["NETFX-TARGET", "4.5"]; FileLog = "bui
                 includes "WorkerPool.fs"
                 includes "Progress.fs"
                 includes "XakeScript.fs"
-                includes "CommonTasks.fs"
+                includes "SystemTasks.fs"
                 includes "FileTasks.fs"
                 includes "ResourceFileset.fs"
                 includes "DotNetFwk.fs"

core/DotNetFwk.fs

@@ -5,7 +5,7 @@ open System.IO
 
 module (* internal *) pkg_config =
 
-    open Xake.CommonTasks.impl
+    open SystemTasks
 
     let private pkgcgf args =
         let outp = ref option<string>.None

core/DotnetTasks.fs

@@ -108,7 +108,7 @@ module DotNetTaskTypes =
 [<AutoOpen>]
 module DotnetTasks =
 
-    open CommonTasks.impl
+    open Xake.SystemTasks
 
     /// Default setting for CSC task so that you could only override required settings
     let CscSettings = {
@@ -327,13 +327,13 @@ module DotnetTasks =
             do! trace Debug "Command line: '%s %s'" fwkInfo.CscTool (args |> Seq.map Impl.escapeArgument |> String.concat "\r\n\t")
 
             let options = {
-                SystemOptions.Default with
+                SystemTasks.Options.Default with
                     LogPrefix = "[CSC] "
                     StdOutLevel = fun _ -> Level.Verbose
                     ErrOutLevel = Impl.levelFromString Level.Verbose
                     EnvVars = fwkInfo.EnvVars
                 }
-            let! exitCode = _system options fwkInfo.CscTool commandLine
+            let! exitCode = SystemTasks._system options fwkInfo.CscTool commandLine
 
             do! trace Level.Verbose "Deleting temporary files"
             seq {
@@ -477,12 +477,12 @@ module DotnetTasks =
             do! trace Debug "Command line: '%s'" args
 
             let options = {
-                SystemOptions.Default with
+                SystemTasks.Options.Default with
                     LogPrefix = pfx
                     StdOutLevel = fun _ -> Level.Info
                     ErrOutLevel = Impl.levelFromString Level.Verbose
                 }
-            let! exitCode = args |> _system options fwkInfo.MsbuildTool
+            let! exitCode = args |> SystemTasks._system options fwkInfo.MsbuildTool
 
             do! trace Info "%s done '%s'" pfx settings.BuildFile
             if exitCode <> 0 then
@@ -595,13 +595,13 @@ module DotnetTasks =
             do! trace Debug "Command line: '%s %s'" fsc (args |> Seq.map Impl.escapeArgument |> String.concat "\r\n\t")
 
             let options = {
-                SystemOptions.Default with
+                SystemTasks.Options.Default with
                     LogPrefix = "[FSC] "
                     StdOutLevel = fun _ -> Level.Verbose
                     ErrOutLevel = Impl.levelFromString Level.Verbose
                     EnvVars = fwkInfo.EnvVars
                 }
-            let! exitCode = _system options fsc (args |> String.concat " ")
+            let! exitCode = SystemTasks._system options fsc (args |> String.concat " ")
 
             do! trace Level.Verbose "Deleting temporary files"
             seq {

core/CommonTasks.fs core/SystemTasks.fscore/CommonTasks.fs renamed to core/SystemTasks.fs

@@ -1,16 +1,14 @@
 // common tasks
+namespace Xake
 
-[<AutoOpen>]
-module Xake.CommonTasks
-
-module internal impl =
-
+module SystemTasks =
     open Xake
     open Xake.Env
+
     open System.Diagnostics
 
     // internal implementation
-    let _pexec handleStd handleErr cmd args (envvars:(string * string) list) =
+    let internal _pexec handleStd handleErr cmd args (envvars:(string * string) list) =
         let pinfo =
           ProcessStartInfo
             (cmd, args,
@@ -42,27 +40,27 @@ module internal impl =
                 return proc.ExitCode
         }
 
-    type SystemOptions = {
+    type Options = {
         LogPrefix:string;
         StdOutLevel: string -> Level; ErrOutLevel: string -> Level;
         EnvVars: (string * string) list
 
         /// Indicates command has to be executed under mono/.net runtime
         UseClr: bool
         FailOnErrorLevel: bool
-        }
+    }
     with static member Default = {
-        LogPrefix = ""; StdOutLevel = (fun _ -> Level.Info); ErrOutLevel = (fun _ -> Level.Error);
-        EnvVars = []
-        UseClr = false
-        FailOnErrorLevel = false
+            LogPrefix = ""; StdOutLevel = (fun _ -> Level.Info); ErrOutLevel = (fun _ -> Level.Error);
+            EnvVars = []
+            UseClr = false
+            FailOnErrorLevel = false
         }
 
     /// <summary>
     /// Executes system command. E.g. '_system SystemOptions "dir" []'
     /// </summary>
     let _system settings cmd args =
-
+      
       let isExt file ext = System.IO.Path.GetExtension(file).Equals(ext, System.StringComparison.OrdinalIgnoreCase)
 
       action {
@@ -87,20 +85,32 @@ module internal impl =
         return errorlevel
     }
 
-// TODO expose settings
-open impl
+    type OptionsFn = Options -> Options
 
-/// <summary>
-/// Executes external process and waits until it completes
-/// </summary>
-/// <param name="cmd">Command or executable name.</param>
-/// <param name="args">Command arguments.</param>
-let system cmd args =
-  action {
-    do! trace Info "[system] starting '%s'" cmd
-    let! exitCode = _system SystemOptions.Default cmd (args |> String.concat " ")
-    do! trace Info "[system] completed '%s' exitcode: %d" cmd exitCode
+    /// <summary>
+    /// Executes external process and waits until it completes
+    /// </summary>
+    /// <param name="opts">Options setters</param>
+    /// <param name="cmd">Command or executable name.</param>
+    /// <param name="args">Command arguments.</param>
+    let system (opts: OptionsFn) (cmd: string) (args: string seq) =
+      action {
+        do! trace Info "[shell.run] starting '%s'" cmd
+        let! exitCode = _system (opts Options.Default) cmd (args |> String.concat " ")
+        do! trace Info "[shell.run] completed '%s' exitcode: %d" cmd exitCode
+
+        return exitCode
+      }
 
-    return exitCode
-  }
+    let useClr: OptionsFn = fun o -> {o with UseClr = true}
+    let checkErrorLevel: OptionsFn = fun o -> {o with FailOnErrorLevel = true}
 
+[<AutoOpen>]
+module CommonTasks =
+    /// <summary>
+    /// Executes external process and waits until it completes
+    /// </summary>
+    /// <param name="cmd">Command or executable name.</param>
+    /// <param name="args">Command arguments.</param>
+    [<System.Obsolete("Use shell id... instead")>]
+    let system cmd args = SystemTasks.system id cmd args

docs/tasks.md

@@ -2,6 +2,25 @@
 
 // TBD
 
+### Common tasks
+
+#### Xake.SystemTasks
+Module shell provides actions related to command shell.
+Usage:
+```fsharp
+open Xake.SystemTasks
+let! errorlevel = system (fun o -> o) "ls" ["-lr"]
+```
+
+There two predefined function for passing task settings:
+```fsharp
+open Xake.SystemTasks
+let! errorlevel = system (useClr >> checkErrorLevel) "ls" ["-lr"]
+```
+The first sets `UseClr` which instructs system command to run `mono <cmd>`. The second one instructs **system** to fail when command returned non-zero errorlevel.
+
+> Notice there's another `system` action in Xake.CommonTasks. It lacks the first parameter (for settings) and is marked as obsolete.
+
 ### File tasks
 
 These tasks allows to perform various file operations. Using these tasks ensures the dependencies are properly resolved are recorded.