completed sequential/parallel execution of targets, renamed Want to Targets

Author: OlegZee

XakeLibTests/CommandLineTests.fs

@@ -59,7 +59,7 @@ type CommandLineTests() =
 
         let finalOptions = !scriptOptions
         Assert.AreEqual(31, finalOptions.Threads)
-        Assert.AreEqual(["target1"; "target2"], finalOptions.Want)
+        Assert.AreEqual(["target1"; "target2"], finalOptions.Targets)
         Assert.IsTrue !executed2
 
 
@@ -80,7 +80,7 @@ type CommandLineTests() =
             ["/t"; "33"; "/R"; currentDir; "/LL"; "Loud";
             "/FL"; "aaaaa"; "target"]
 
-        do xakeArgs args {XakeOptions with IgnoreCommandLine = true; Threads = 2; FileLog = "ss"; Want = ["main"]} {
+        do xakeArgs args {XakeOptions with IgnoreCommandLine = true; Threads = 2; FileLog = "ss"; Targets = ["main"]} {
             rules [
               "main" => action {
                   let! opts = getCtxOptions()
@@ -92,4 +92,4 @@ type CommandLineTests() =
         let finalOptions = !scriptOptions
         Assert.AreEqual(2, finalOptions.Threads)
         Assert.AreEqual("ss", finalOptions.FileLog)
-        Assert.AreEqual(["main"], finalOptions.Want)
+        Assert.AreEqual(["main"], finalOptions.Targets)

XakeLibTests/FileTasksTests.fs

@@ -12,7 +12,7 @@ open Xake.Storage
 [<TestFixture>]
 type FileTasksTests() = 
 
-    let TestOptions = {XakeOptions with Threads = 1; Want = ["main"]; ConLogLevel = Chatty; FileLogLevel = Silent}
+    let TestOptions = {XakeOptions with Threads = 1; Targets = ["main"]; ConLogLevel = Chatty; FileLogLevel = Silent}
 
     [<Test>]
     member this.DeleteSimple() =

XakeLibTests/MiscTests.fs

@@ -326,7 +326,7 @@ type MiscTests() =
 
         let count = ref 0
 
-        do xake {XakeOptions with Want = ["xxx"]; Threads = 1; FileLog=""} {  // one thread to avoid simultaneous access to 'wasExecuted'
+        do xake {XakeOptions with Targets = ["xxx"]; Threads = 1; FileLog=""} {  // one thread to avoid simultaneous access to 'wasExecuted'
             rules [
               "main" => action {
                   count := !count + 1

core/Program.fs

@@ -18,8 +18,24 @@ module internal ParseArgs = begin
     let parseTopLevel (arg:string) optionsSoFar = 
         match arg.ToLowerInvariant() with 
 
-        // TODO support sequential/parallel runs e.g. "clean release-build;debug-build"
-
+        | "-h" | "/h" ->
+            printf """
+Usage:
+ fsi <script file> [-- options target..]
+
+Options:
+  -h                  - displays help screen
+  -t <task count>     - parallelize execution to <task count> processes. Defaults to CPU cores
+  -r <root path>      - override the root path. Default is current directory
+  -ll <log level>     - console log level (Silent | Quiet | Normal | Loud | Chatty | Diag)
+  -fl <file log path> - specifies the name of the log file
+  -fll <log level>    - specifies the logging level to a log file
+  target1 .. targetN  - define the list of targets to be executed sequentially
+  target1;target2;..targetN -- execute the targets simultaneously
+  -d <name>=<value>   - defines a script variable value
+
+            """
+            exit(0)
         | "-t" | "/t" -> 
             (optionsSoFar, Number ("thread count", fun o v -> {o with XakeOptionsType.Threads = v}))
         | "-r" | "/r" -> 
@@ -32,14 +48,14 @@ module internal ParseArgs = begin
             (optionsSoFar, String ("console verbosity", fun o s -> {o with ConLogLevel = s |> parseVerbosity }))
         | "-fll" | "/fll" -> 
             (optionsSoFar, String ("filelog verbosity", fun o s -> {o with FileLogLevel = s |> parseVerbosity }))
+        | "-nologo" -> 
+            ({optionsSoFar with Nologo = true}, TopLevel)
 
-        // handle unrecognized option
         | x when x.StartsWith("-") || x.StartsWith("/") ->
-            // TODO write errors to log?
             printfn "Option '%s' is unrecognized" x
             (optionsSoFar, TopLevel)
         | x -> 
-            ({optionsSoFar with Want = optionsSoFar.Want @ [x]}, TopLevel)
+            ({optionsSoFar with Targets = optionsSoFar.Targets @ [x]}, TopLevel)
 
     let (|NumberVar|_|) str =
         match System.Int32.TryParse str with
@@ -105,6 +121,10 @@ module Main =
         let options =
             if initialOptions.IgnoreCommandLine then initialOptions
             else args |> List.fold foldFunction (initialOptions, TopLevel) |> fst
+        
+        if not options.Nologo then
+            printf "XAKE build tool %s\n\n" Xake.Const.Version
+
         new RulesBuilder (options)
 
     /// <summary>

core/Xake.Core.fsproj

@@ -56,15 +56,14 @@
     <Compile Include="WorkerPool.fs" />
     <Compile Include="Progress.fs" />
     <Compile Include="XakeScript.fs" />
-    <Compile Include="Program.fs" />
     <Compile Include="CommonTasks.fs" />
     <Compile Include="FileTasks.fs" />
     <Compile Include="ResourceFileset.fs" />
     <Compile Include="DotNetFwk.fs" />
     <Compile Include="DotnetTasks.fs" />
-    <None Include="filesets.fsx" />
     <Compile Include="VersionInfo.fs" />
     <Compile Include="AssemblyInfo.fs" />
+    <Compile Include="Program.fs" />
   </ItemGroup>
   <PropertyGroup>
     <MinimumVisualStudioVersion Condition="'$(MinimumVisualStudioVersion)' == ''">11</MinimumVisualStudioVersion>

core/XakeScript.fs

@@ -22,14 +22,19 @@ module XakeScript =
         /// Console output verbosity level. Default is Warn
         ConLogLevel: Verbosity
         /// Overrides "want", i.e. target list
-        Want: string list
+        Targets: string list
+
+        /// Global script variables
         Vars: (string * string) list
 
         /// Defines whether `run` should throw exception if script fails
         FailOnError: bool
 
         /// Ignores command line swithes
         IgnoreCommandLine: bool
+
+        /// Disable logo message
+        Nologo: bool
     }
 
     type private ExecStatus = | Succeed | Skipped | JustFile
@@ -71,10 +76,11 @@ module XakeScript =
         CustomLogger = CustomLogger (fun _ -> false) ignore
         FileLog = "build.log"
         FileLogLevel = Chatty
-        Want = []
+        Targets = []
         FailOnError = false
         Vars = List<string*string>.Empty
         IgnoreCommandLine = false
+        Nologo = false
         }
 
     module private Impl = begin
@@ -328,7 +334,7 @@ module XakeScript =
         /// <summary>
         /// Executes several artifacts in parallel.
         /// </summary>
-        and private execMany ctx = Seq.ofList >> Seq.map (execOne ctx) >> Async.Parallel
+        and private execParallel ctx = Seq.ofList >> Seq.map (execOne ctx) >> Async.Parallel
 
         /// <summary>
         /// Gets the status of dependency artifacts (obtained from 'need' calls).
@@ -341,7 +347,7 @@ module XakeScript =
                 ctx.Tgt |> Option.iter (Progress.TaskSuspend >> ctx.Progress.Post)
 
                 do ctx.Throttler.Release() |> ignore
-                let! statuses = targets |> execMany ctx
+                let! statuses = targets |> execParallel ctx
                 do! ctx.Throttler.WaitAsync(-1) |> Async.AwaitTask |> Async.Ignore
 
                 ctx.Tgt |> Option.iter (Progress.TaskResume >> ctx.Progress.Post)
@@ -393,40 +399,39 @@ module XakeScript =
                 NeedRebuild = fun _ -> false
                 Tgt = None
                 }
-            // TODO wrap more elegantly
-            let rec get_changed_deps = CommonLib.memoize (getDepsImpl ctx (fun x -> get_changed_deps x)) in
-
-            let check_rebuild target =
-                get_changed_deps >>
-                function
-                | [] -> false, ""
-                | DepState.Other reason::_            -> true, reason
-                | DepState.Depends (t,_) ::_          -> true, "Depends on target " + (getFullName t)
-                | DepState.FilesChanged (file::_) ::_ -> true, "File(s) changed " + file
-                | reasons -> true, sprintf "Some reason %A" reasons
-                >>
-                function
-                | false, _ -> false
-                | true, reason ->
-                    do ctx.Logger.Log Info "Rebuild %A: %s" (getShortname target) reason
-                    true
-                <| target
-
-            // define targets
-            let targets =
-                match options.Want with
-                | [] ->
-                    do logger.Log Level.Message "No target(s) specified. Defaulting to 'main'"
-                    ["main"]
-                | tt -> tt
-                |> List.map (makeTarget ctx)
-
-            let getDurationDeps t =
-                let collectTargets = List.collect (function |Depends (t,_) -> [t] | _ -> [])
-                (getExecTime ctx t) / 1000<ms>, get_changed_deps t |> collectTargets
-            let progressSink = Progress.openProgress getDurationDeps options.Threads targets
-
-            let ctx = {ctx with NeedRebuild = check_rebuild; Progress = progressSink}
+
+            let runStep targetNames =
+                // TODO wrap more elegantly
+                let rec get_changed_deps = CommonLib.memoize (getDepsImpl ctx (fun x -> get_changed_deps x)) in
+
+                let check_rebuild target =
+                    get_changed_deps >>
+                    function
+                    | [] -> false, ""
+                    | DepState.Other reason::_            -> true, reason
+                    | DepState.Depends (t,_) ::_          -> true, "Depends on target " + (getFullName t)
+                    | DepState.FilesChanged (file::_) ::_ -> true, "File(s) changed " + file
+                    | reasons -> true, sprintf "Some reason %A" reasons
+                    >>
+                    function
+                    | false, _ -> false
+                    | true, reason ->
+                        do ctx.Logger.Log Info "Rebuild %A: %s" (getShortname target) reason
+                        true
+                    <| target
+
+                let targets = targetNames |> List.map (makeTarget ctx)
+                let getDurationDeps t =
+                    let collectTargets = List.collect (function |Depends (t,_) -> [t] | _ -> [])
+                    (getExecTime ctx t) / 1000<ms>, get_changed_deps t |> collectTargets
+                let progressSink = Progress.openProgress getDurationDeps options.Threads targets
+
+                let stepCtx = {ctx with NeedRebuild = check_rebuild; Progress = progressSink}
+
+                try
+                    targets |> execParallel stepCtx |> Async.RunSynchronously |> ignore
+                finally
+                    do Progress.Finish |> progressSink.Post
 
             logger.Log Info "Options: %A" options
 
@@ -436,9 +441,20 @@ module XakeScript =
                     | a -> yield a
                 }
 
+            // splits list of targets ["t1;t2"; "t3;t4"] into list of list.
+            let targetLists =
+                options.Targets
+                |> function
+                    | [] ->
+                        do logger.Log Level.Message "No target(s) specified. Defaulting to 'main'"
+                        [["main"]]
+                    | tt ->
+                        tt |> List.map (fun s -> s.Split(';', '|') |> List.ofArray)
+                    
             try
                 try
-                    targets |> execMany ctx |> Async.RunSynchronously |> ignore
+                    for list in targetLists do
+                        runStep list
                     logger.Log Message "\n\n\tBuild completed in %A\n" (System.DateTime.Now - start)
                 with 
                     | exn ->
@@ -448,7 +464,6 @@ module XakeScript =
                         logger.Log Message "\n\n\tBuild failed after running for %A\n" (System.DateTime.Now - start)
             finally
                 db.PostAndReply Storage.CloseWait
-                do Progress.Finish |> ctx.Progress.Post
 
         /// <summary>
         /// "need" implementation
@@ -478,7 +493,7 @@ module XakeScript =
     type RulesBuilder(options) =
 
         let updRules (XakeScript (options,rules)) f = XakeScript (options, f(rules))
-        let updTargets (XakeScript (options,rules)) f = XakeScript ({options with Want = f(options.Want)}, rules)
+        let updTargets (XakeScript (options,rules)) f = XakeScript ({options with Targets = f(options.Targets)}, rules)
 
         member o.Bind(x,f) = f x
         member o.Zero() = XakeScript (options, Rules [])

docs/implnotes.md

@@ -92,6 +92,7 @@ where "clean" "build" and "deploy" are target names.
 
 The full list of parameters:
 
+ * -h -- displays help screen
  * -t <task count> -- use <task count> simultaneous processes to execute the build tasks. * Default value is the number of processors
  * -r <root path> -- override the root path. All the targets and filesets are resolved relatively to this path. Default is current directory
  * -ll <log level> -- console log level (Silent | Quiet | Normal | Loud | Chatty | Diag)
@@ -100,6 +101,7 @@ The full list of parameters:
  * target1 .. targetN -- define the list of targets. Targets are executed in strict order, the second one starts only after the first one is complete.
  * target1;target2;..targetN -- execute the targets simultaneously
  * -d <name>=<value> -- defines a script variable value
+ * -nologo -- remove logo string
 
 ### Do not allow to override options
 Command line arguments override the script options (XakeOptions type) unless you define options.IgnoreCommandLine = true.

samples/build-parms.fsx

@@ -18,4 +18,11 @@ do xake {XakeOptions with FileLog = "build.log"; Threads = 4 } {
     return ()
     })
 
+  rules [
+    "t1" => action {do! writeLog Message "t1!"}
+    "t2" => action {do! writeLog Message "t2!"}
+    "t3" => action {do! writeLog Message "t3!"}
+    "t4" => action {do! writeLog Message "t4!"}
+  ]
+
 }

xake.sln

@@ -42,6 +42,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Project files", "Project files", "{CA08F45F-D8B4-46D4-B7EC-38C68C7AF0B2}"
 	ProjectSection(SolutionItems) = preProject
 		.travis.yml = .travis.yml
+		core\filesets.fsx = core\filesets.fsx
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{0D5E4046-AD73-4D3F-BF54-5D7E31450641}"