天天看點

[Cake] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

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

),下面簡單的介紹,項目非常簡單,一個類庫項目,一個測試項目,如下:

[Cake] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

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] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

這一步我們用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裡面幹了什麼)。咦,運作出錯了!

[Cake] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

原因是我的一個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 });      

再運作一次:

[Cake] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

這次可以了。

然後我們再依次的添加幾個task,清理build的檔案:

1 Task("clean")
2     .Does(() =>
3 {
4     CleanDirectories("./src/*/bin");
5     CleanDirectories("./test/*/bin");
6 });      

運作單元測試:

1 /// unit-test task
2 Task("unit-test")
3     .IsDependentOn("build")
4     .Does(() =>
5 {
6     XUnit2("./test/*/bin/*/*.Tests.dll");
7 });      

然後運作一下:

[Cake] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

1.3 build.ps1

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

[Cake] 0.C#Make自動化建構-簡介0. Cake是什麼?1. 一個簡單的DEMO2. 總結3. 參考資料

僅清理項目的build生成的檔案。

2. 總結

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

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

再者Cake提供了豐富的内建工具集以及插件(

),可以滿足我們絕大部分的自動化建構需求,比如,編譯,測試,打包,部署等等。

例如前些日子我的一個web的demo項目(

https://github.com/linianhui/Ids3.demo

)使用cake來部署iis站點。

3. 參考資料

http://cakebuild.net/docs/tutorials/getting-started http://cakebuild.net/docs/resources/videos https://github.com/cake-build/example

作者:

Blackheart

出處:

http://linianhui.cnblogs.com

本文版權歸作者和部落格園共有,歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連接配接,否則保留追究法律責任的權利。

繼續閱讀