Merge pull request #82 from MangelMaxime/feature/remaining_args

feat: add support for remaining args

Author: albertwoo

Fun.Build.Tests/PipelineBuilderTests.fs

@@ -485,3 +485,61 @@ let ``runBeforeEachStage and runAfterEachStage should work`` () =
     Assert.Equal(4, j)
     Assert.Equal(3, ti)
     Assert.Equal(3, tj)
+
+[<Fact>]
+let ``check GetAllCmdArgs and RemainingArgs works when remaining args is not empty`` () =
+    let mutable actualAllCmdArgs = []
+    let mutable actualRemainingArgs = []
+
+    pipeline "demo" {
+        cmdArgs [ "-p"; "demo"; "test1"; "v1"; "--"; "test2"; "v2" ]
+        stage "shows arguments" {
+            run (fun ctx ->
+                actualAllCmdArgs <- ctx.GetAllCmdArgs()
+                actualRemainingArgs <- ctx.GetRemainingCmdArgs()
+            )
+        }
+        runImmediate
+    }
+
+    Assert.Equal<string list>([ "-p"; "demo"; "test1"; "v1" ], actualAllCmdArgs)
+    Assert.Equal<string list>([ "test2"; "v2" ], actualRemainingArgs)
+
+[<Fact>]
+let ``check GetAllCmdArgs and RemainingArgs works when remaining args is provided but empty`` () =
+    let mutable actualAllCmdArgs = []
+    let mutable actualRemainingArgs = []
+
+    pipeline "demo" {
+        cmdArgs [ "-p"; "demo"; "test1"; "v1"; "--" ]
+        stage "shows arguments" {
+            run (fun ctx ->
+                actualAllCmdArgs <- ctx.GetAllCmdArgs()
+                actualRemainingArgs <- ctx.GetRemainingCmdArgs()
+            )
+        }
+        runImmediate
+    }
+
+    Assert.Equal<string list>([ "-p"; "demo"; "test1"; "v1" ], actualAllCmdArgs)
+    Assert.Equal<string list>([], actualRemainingArgs)
+
+
+[<Fact>]
+let ``check GetAllCmdArgs and RemainingArgs works when remaining args is not provided`` () =
+    let mutable actualAllCmdArgs = []
+    let mutable actualRemainingArgs = []
+
+    pipeline "demo" {
+        cmdArgs [ "-p"; "demo"; "test1"; "v1" ]
+        stage "shows arguments" {
+            run (fun ctx ->
+                actualAllCmdArgs <- ctx.GetAllCmdArgs()
+                actualRemainingArgs <- ctx.GetRemainingCmdArgs()
+            )
+        }
+        runImmediate
+    }
+
+    Assert.Equal<string list>([ "-p"; "demo"; "test1"; "v1" ], actualAllCmdArgs)
+    Assert.Equal<string list>([], actualRemainingArgs)

Fun.Build/PipelineBuilder.fs

@@ -177,7 +177,13 @@ type PipelineBuilder(name: string) =
     member inline _.cmdArgs([<InlineIfLambda>] build: BuildPipeline, args: string list) =
         BuildPipeline(fun ctx ->
             let ctx = build.Invoke ctx
-            { ctx with CmdArgs = args }
+
+            let argsInfo = resolveCmdArgsAndRemainings args
+
+            { ctx with
+                CmdArgs = argsInfo.CmdArgs
+                RemainingCmdArgs = argsInfo.RemainingArgs
+            }
         )
 
     /// Set working dir for all steps under the stage.

Fun.Build/PipelineContextExtensions.fs

@@ -22,12 +22,15 @@ module PipelineContextExtensionsInternal =
                 with _ ->
                     envVars.Add(key, "")
 
+            let argsInfo = Environment.GetCommandLineArgs() |> Array.toList |> resolveCmdArgsAndRemainings
+
             {
                 Name = name
                 Description = ValueNone
                 Mode = Mode.Execution
                 Verify = fun _ -> true
-                CmdArgs = Seq.toList (Environment.GetCommandLineArgs())
+                CmdArgs = argsInfo.CmdArgs
+                RemainingCmdArgs = argsInfo.RemainingArgs
                 EnvVars = envVars |> Seq.map (fun (KeyValue(k, v)) -> k, v) |> Map.ofSeq
                 AcceptableExitCodes = set [| 0 |]
                 Timeout = ValueNone

Fun.Build/StageContextExtensions.fs

@@ -493,12 +493,40 @@ module StageContextExtensions =
         // If not find then return ""
         member inline ctx.GetEnvVar(key: string) = ctx.TryGetEnvVar key |> ValueOption.defaultValue ""
 
+        /// <summary>
+        /// Get the command arguments from the command line without the remaining arguments that are placed after <c>--</c>.
+        ///
+        /// For example, if you run the following arguments:
+        ///
+        /// <c> -p demo test1 v1 -- test2 v2</c>
+        ///
+        /// will return
+        ///
+        /// <c>[ "-p"; "demo"; "test1"; "v1" ]</c>
+        /// </summary>
         member ctx.GetAllCmdArgs() =
             match ctx.ParentContext with
             | ValueSome(StageParent.Pipeline p) -> p.CmdArgs
             | ValueSome(StageParent.Stage s) -> s.GetAllCmdArgs()
             | ValueNone -> []
 
+        /// <summary>
+        /// Return the remaining command arguments they are the arguments placed after <c>--</c> in the command line.
+        ///
+        /// For example, if you run the following arguments:
+        ///
+        /// <c> -p demo test1 v1 -- test2 v2</c>
+        ///
+        /// will return
+        ///
+        /// <c>[ "test2"; "v2" ]</c>
+        /// </summary>
+        member ctx.GetRemainingCmdArgs() =
+            match ctx.ParentContext with
+            | ValueSome(StageParent.Pipeline p) -> p.RemainingCmdArgs
+            | ValueSome(StageParent.Stage s) -> s.GetRemainingCmdArgs()
+            | ValueNone -> []
+
         member ctx.TryGetCmdArg(key: string) =
             let cmdArgs = ctx.GetAllCmdArgs()
             match cmdArgs |> List.tryFindIndex ((=) key) with

Fun.Build/Types.Internal.fs

@@ -76,6 +76,7 @@ type PipelineContext = {
     /// Verify before run pipeline, will throw PipelineFailedException if return false
     Verify: PipelineContext -> bool
     CmdArgs: string list
+    RemainingCmdArgs: string list
     EnvVars: Map<string, string>
     AcceptableExitCodes: Set<int>
     Timeout: TimeSpan voption

Fun.Build/Utils.fs

@@ -74,6 +74,19 @@ let getFsiFileName () =
     else
         "your_script.fsx"
 
+let resolveCmdArgsAndRemainings (args: string list) =
+
+    let cmdArgs = args |> List.takeWhile (fun x -> x <> "--")
+
+    let remainingArgs =
+        let remainingArgsStartIndex = cmdArgs.Length + 1
+
+        if remainingArgsStartIndex < args.Length then
+            args.[remainingArgsStartIndex..]
+        else
+            []
+
+    {| CmdArgs = cmdArgs; RemainingArgs = remainingArgs |}
 
 module ValueOption =