[Cake] 0. C#Make自動化構建-簡介

0. Cake是什么？

Cake是C# Make的縮寫，是一個基於C# DSL的自動化構建系統。它可以用來編譯代碼，復制文件以及文件夾，運行單元測試，壓縮文件以及構建Nuget包等等。

熟悉大名鼎鼎的Make的小伙伴，應該已經知道Cake大致是個什么樣的工具了，Cake具有以下幾個特點：

1. 方便編寫：使用基於C#的DSL，非常易於編寫自動化的腳本。
2. 跨平台: 基於Roslyn和Mono來編譯我們寫的自動化腳本，使得它可以運行在windows，linux，mac上。
3. 可靠的：可以建立在自己的機器上，也可以建立在像AppVeyor，TeamCity，TFS，VSTS或Jenkins這樣的CI系統上，都可以以相同的方式運行。
4. 豐富的工具集：支持MSBuild，MSTest，xUnit，NUnit，Nuget，ILMerge，Wix和SignTool等等，以及支持豐富的插件（Cake Addins）。
5. 開源：基於MIT開放源代碼（Cake on Github），並且是.NET 基金會支持的一個項目（Cake on dotnet foundation）。

1. 一個簡單的DEMO

筆者在Github上創建了一個簡單的DEMO（cake.demo），下面簡單的介紹，項目非常簡單，一個類庫項目，一個測試項目，如下：

1.1 下載引導腳本

首先第一步下載一個基於Powershell的引導腳本文件build.ps1，這個文件並不是必須的,你可以直接用調用cake腳本文件），在項目所在的目錄下運行： Invoke-WebRequest http://cakebuild.net/download/bootstrapper/windows -OutFile build.ps1 

備注：當前筆者是基於windows平台，開發環境是vs 2017 community：

linux : curl -Lsfo build.sh http://cakebuild.net/download/bootstrapper/linux

mac  : curl -Lsfo build.sh http://cakebuild.net/download/bootstrapper/osx

1.2 創建Cake腳本

添加一個文本文件build.cake(文件名隨意，筆者懶調整build.ps1中指定的cake腳本文件而已。完整文件：https://github.com/linianhui/cake.demo/blob/master/build.cake)

這一步我們用Cake來build以下我們上面的cake.demo這個項目。文件內容如下：

 1 /// args  2 var target = Argument("target", "default");  3  4  5 /// build task  6 Task("build")  7 .Does(() =>  8 {  9 MSBuild("./cake.demo.sln", new MSBuildSettings{ 10 Verbosity = Verbosity.Minimal 11  }); 12 }); 13 14 15 Task("default") 16 .IsDependentOn("build"); 17 18 19 /// run task 20 RunTarget(target);

腳本可以說是非常簡單易懂，相信有C#基礎的應該非常容易理解。

1. 首先，創建了一個參數target（名字和build.ps1中指定的參數名一致），默認值是“default”。
2. 其次，創建了一個名為build的Task，這個task調用MSBuild來build我們的項目。
3. 然后，創建了一個名為default的task，它什么都沒干，只是標識說我依賴一個為build的task，含義就是在運行default的task之前，會先運行build的task。
4. 最后，用RunTarget來運行指定名字的task。

OK，我們來運行一下build.ps1（初次運行它會下載cake所需的一些文件，這些文件會存放於build.ps1中指定的文件夾，默認是tools文件夾，感興趣的可以看一看build.ps1里面干了什么）。咦，運行出錯了！

原因是我的一個Demo.Tests這個項目引用了xUnit的包，MSBuild沒能正確的還原nuget包，這不知道算不算一個bug，筆者之前用 Cake的MSBuild來build vs2015的項目的時候是沒有問題的，當前環境只安裝了VS2017。不過也正好，我們再用Cake來寫一個還原nuget包的task。

1 /// nuget task 2 Task("restore-nuget-packages") 3 .Does(() => 4 { 5 NuGetRestore("./cake.demo.sln"); 6 });

再運行一次：

這次可以了。

然后我們再依次的添加幾個task，清理build的文件：

Task("clean")
    .Does(() =>
{
    CleanDirectories("./src/*/bin");
    CleanDirectories("./test/*/bin");
});

運行單元測試：

/// unit-test task
Task("unit-test")
    .IsDependentOn("build")
    .Does(() =>
{
    XUnit2("./test/*/bin/*/*.Tests.dll");
});

然后運行一下：

1.3 build.ps1

在前面我們提到這個文件並不是必須的文件，而是用它來下載Cake所需要的相關文件，以及設置默認的Cake配置。再者，我們可以通過它來簡化對Cake的調用，比如上面列出來的幾個task，我們可以通過傳遞參數給build.ps1，來運行我們指定的task(默認運行了default嘛)。比如:

僅清理項目的build生成的文件。

2. 總結

得益於Cake基於C#DSL來編寫腳本，相比寫Powershell或者其他的腳本來完成自動化構建，使得C#開發人員非常容易上手。

其次Cake基於Roslyn和Mono，使得它可以提供跨平台的自動化構建，也可以運行在各種常用的CI系統之上。

再者Cake提供了豐富的內建工具集以及插件（Cake Addins），可以滿足我們絕大部分的自動化構建需求，比如，編譯，測試，打包，部署等等。

例如前些日子我的一個web的demo項目（https://github.com/linianhui/Ids3.demo）使用cake來部署iis站點。

3. 參考資料

Make

C# Make

Cake Addins

Cake on Github

Cake on dotnet foundation

cake.demo

http://cakebuild.net/docs/tutorials/getting-started

http://cakebuild.net/docs/resources/videos

https://github.com/cake-build/example