Parameters for tasks?

[Kralizek]

I have the same task that needs to be run using two values of the same parameter.

dotnet test --framework netcoreapp3.1
dotnet test --framework net5.0

It would be cool if I could define a parameter for the task, something like

Task("Test")
    .IsDependentOn("RunTest", "net5.0")
    .IsDependentOn("RunTest", "netcoreapp3.1");

Not sure how the RunTest task could be defined. Probably an overload of the Does method?

Task("RunTest")
     .Does<BuildData, string>((data, targetFramework) => { ... });

Or maybe there is another way to achieve the same but I am not aware of it and I couldn't find it by simply searching through the documentation.

[devlead]

With 1.0 you could do something like this utilizing Arguments(string) alias and DoesForEach.

targetframework.cake

public record BuildData(ICollection<string> targetFrameworks);

Setup(
    context => {
        var targetFrameworks = context.Arguments<string>("framework");

        return new BuildData(targetFrameworks);
    }
);

Task("Test")
    .DoesForEach<BuildData, string>(
        (data, context) => data.targetFrameworks,
        (data, targetFramework, context) => context.Information("Framework: {0}", targetFramework)
    );

RunTarget("Test");

no args specified

dotnet cake targetframework.cake

 ----------------------------------------
 Setup
 ----------------------------------------
- Error: One or more errors occurred. (Argument 'framework' was not set.)
-         Argument 'framework' was not set.

If you don't want it to throw on missing framework change to Arguments(string name, T default) i.e.

var targetFrameworks = context.Arguments<string>("framework", "net5.0");

framework="net5.0"

dotnet cake targetframework.cake --framework="net5.0"

----------------------------------------
Setup
----------------------------------------

========================================
Test
========================================
Framework: net5.0

Task                          Duration
--------------------------------------------------
Setup                         00:00:00.0105753    
Test                          00:00:00.0156912    
--------------------------------------------------
Total:                        00:00:00.0262665

framework="netcoreapp3.1"

dotnet cake targetframework.cake --framework="netcoreapp3.1"

----------------------------------------
Setup
----------------------------------------

========================================
Test
========================================
Framework: netcoreapp3.1

Task                          Duration
--------------------------------------------------
Setup                         00:00:00.0107609    
Test                          00:00:00.0112082    
--------------------------------------------------
Total:                        00:00:00.0219691   

framework="net5.0" and framework="netcoreapp3.1"

dotnet cake targetframework.cake --framework="net5.0" --framework="netcoreapp3.1"

----------------------------------------
Setup
----------------------------------------

========================================
Test
========================================
Framework: net5.0
Framework: netcoreapp3.1

Task                          Duration
--------------------------------------------------
Setup                         00:00:00.0106643    
Test                          00:00:00.0129854    
--------------------------------------------------
Total:                        00:00:00.0236497

[Kralizek]

Oh, that's nice.

Very close to my final intended result. I see that Arguments doesn't accept multiple default values (something like Arguments<T>(string, T[])).

To have a deeper explanation.

Right now I am building my library in CircleCI and I want to test it both with .NET Core 3.1 and .NET 5.0.

CircleCI uses build containers so I can either run .NET Core 3.1 or .NET 5.0 during the CI build, but I want devs being able to do "dotnet cake" and run tests on both platforms.

so the idea is to have a file that allows:

// CI commands
dotnet cake --target=RunTest --targetFramework=net5.0 // runs tests for net5.0
dotnet cake --target=RunTest --targetFramework=netcoreapp3.1 // runs tests for netcoreapp3.1
dotnet cake --target=Pack // packs the library

// Dev commands
dotnet cake // full pipeline, includes tests for both net5.0 and netcoreapp3.1

[devlead]

There's the HasArgument alias so you can use it to check if the argument is specified or not, ISetupContext has an TargetTask property you could use to decide too.

So an evolution of the above script could look something like below.

• dotnet cake targetframework.cake
  • net5.0
  • netcoreapp3.1
• dotnet cake targetframework.cake --target=Pack
  • net5.0
  • netcoreapp3.1
  • netstandard2.0
• dotnet cake targetframework.cake --target=Pack --framework=net461
  • net461
• dotnet cake targetframework.cake --target=Build
  • net5.0
• dotnet cake targetframework.cake --framework="net5.0" --framework="netcoreapp3.1"
  • net5.0
  • netcoreapp3.1

public record BuildData(ICollection<string> targetFrameworks);

Setup(
    context => {
        var targetFrameworks = context.HasArgument("framework")
            ? context.Arguments<string>("framework")
            : context.TargetTask.Name switch {
                        "Pack"      => new [] { "net5.0", "netcoreapp3.1",  "netstandard2.0" },
                        "Default"   => new [] { "net5.0", "netcoreapp3.1" },
                        _           => new [] { "net5.0" }
                    };

        return new BuildData(targetFrameworks);
    }
);

Task("Build")
    .Does<BuildData>(
        (context, data)=> context.Information(
            "TargetFrameworks: {0}",
            string.Join(
                ";",
                data.targetFrameworks
            )
        )
    );

Task("Test")
    .IsDependentOn("Build")
    .DoesForEach<BuildData, string>(
        (data, context)=>data.targetFrameworks,
        (data, targetFramework, context) => context.Information("Framework: {0}", targetFramework)
    );

Task("Pack")
    .IsDependentOn("Test")
    .Does<BuildData>(
        (context, data)=> context.Information(
            "TargetFrameworks: {0}",
            string.Join(
                ";",
                data.targetFrameworks
            )
        )
    );

Task("Default")
    .IsDependentOn("Build")
    .IsDependentOn("Test");

RunTarget(Argument("Target", "Default"));

[Kralizek]

cool tack!! later I'll try to "ingest" the script to fully interiorize it :)