.net持续集成cake篇之cake介绍及简单示例

系列目录

cake介绍

Cake 是.net平台下的一款自动化构建工具,可以完成对.net项目的编译,打包,运行单元测试,集成测试甚至发布项目等等.如果有些特征Cake没有实现,我们还可以很容易地通过扩展Cake来实现我们想要的功能.

Cake有以下特点

使用c#语言编写,可以在Cake脚本里使用C#语言来实现我们想要达到的功能.
跨平台,可以运行在windows,linux 和macos上.

3)易于扩展,c#开发者很容易使用已有的c#语言知识对Cake进行扩展,甚至可以让Cake支持Java,Python等语言的构建

易于和常见CI/CD平台结合,Cake很容易和常见的CI/CD平台,例如 Jenkins,AppVeyor, TeamCity, TFS, VSTS,Azure PipeLine等结合
插件丰富,Cake官网和第三方开发者提供了丰富的Cake扩展工具,方便开箱即用.

新建一个Cake HelloWorld示例

本节我们通过一个HelloWorld示例讲解如何制作Cake文件,下载启动脚本以及如何安装Cake visualstudio插件

一.新建一个Cake文件

我们新建一个.net项目(可以是类库,控制台或者web项目),这里我们创建一个控制台项目,然后在项目sln所在目录下新建一个名为build.cake的文件.

读者可以新建一个文本文件,然后的后缀改为cake,把文件名改为build,这样也能完成一个build.cake的创建.当然也可以通过执行Powershell命令New-Item build.cake来创建一个build.cake文件,使用powershell创建时一定要注意在当前项目所在目录下打开powershell,不然以上命令合建的文件可能路径并不是我们期待的.

有些读者可能有疑问是不是这个文件一定要命名为build.cake呢,答案是否定的,其实这个文件可以随意命令,但是作为初体验,强烈建议读者不要随便命令,而是跟着讲解做,以免造成不必要的麻烦

二.编辑`build.cake`文件

我们新建build.cake后,用词本(或者其它自己熟悉的编辑器打开它),添加以下代码

var target = Argument("target", "Default");

var configuration = Argument("configuration", "Release");

Setup(ctx =>

{

	// Executed BEFORE the first task.

	Information("Running tasks...");

});

Teardown(ctx =>

{

	// Executed AFTER the last task.

	Information("Finished running tasks.");

});

Task("Default")

.Does(() => {

	Information("Hello World!");

});

RunTarget(target);

三.下载启动脚本

Cake在windows下启动脚本为build.ps1(当然也可以是其它名字),在linux和macos下为build.sh

需要注意的是虽然Cake在macos和linux下启动脚本都是build.sh但是并不是一模一样的,不同平台要下载针对本平台的启动脚本.

由于我是在windows下运行的,因此下载windows平台对应的启动脚本build.ps1

在项目build.cake所在目录下,我们打开powershell,然后执行以下命令Invoke-WebRequest http://cakebuild.net/download/bootstrapper/windows -OutFile build.ps1 即可下载启动脚本

linux平台下载方式:curl -Lsfo build.sh http://cakebuild.net/download/bootstrapper/linux

mac平台下载方式 curl -Lsfo build.sh http://cakebuild.net/download/bootstrapper/osx

需要注意的是,一定要在当前目录(sln所在目录或者自已指定的其它目录),如果是从开始菜单中启动的powershell,一定要通过cd命令进入到目标目录.

windows 10可以在文件夹左上角点击文件在弹出菜单中找到powershell,这样启动的powershell目录就是在当前文件夹所在目录

四.执行构建

我们在当前目录打开powershell,通过powershell,在powershell命令窗口里输入.\build.ps1执行刚下载的ps1脚本,过一分后我们可以看到输出的构建信息

五.build.cake文件解析

初接触build.cake我们可能对它很陌生,不过不要害怕,它完全是用c#语言写的,只是方法是自定义的.

build.cake里共有三个任务,Setup,TearDown和Default,其中Setup任务会在所有任务执行之前执行,TearDown任务会在所有任务执行后执行,非常类似于Nunit里的Setup和TearDown方法.有些时候我们想在所有方法执行之前执行一些初始化工作,在所有任务执行完之后执行一些收尾工具,我们可以把相应代码写在Setup和TearDown里

Setup,TearDown和Default里接收的都是一个委托,我们可在在委托里写自己的代码,委托里的参数由于目前我们没有使用到,这里不再讲解.大家只要知道它的格式就行了.

Setup,TearDown是两个特殊的任务,由cake自动调用,而Default任务需要显地调用才能执行,我们编写其它任务时,可以模仿Default任务.

在这里,有些童鞋可能会有疑问,以上任务通过脚本也能完成,为什么还要这么麻烦来使用工具呢,其实使用脚本有很多弊端,我们前面介绍了一个完整的.net web项目在测试环境的持续集成方案,其中使用到了数十个脚本和工具,如果我们的脚本编写不够严谨往往会造成生产环境的损失.并且从实践上来看,脚本数量过多时往往容易失控.部署在服务器中脚本很多时候成为烫手山芋,不熟悉的人既不想看,也不想改,更重要的是不敢轻易改.也不敢轻易把它移除或者删除掉.另外一个不可忽视的问题是脚本往往背后调用的是工具,工具又对运行环境有依赖.我们在精心配置的一台服务器上可能运行良好,但是换更换到其它的服务器上往往会因为各种条件不满足造成各种问题,在人手不足的情况下这么问题尤为凸显.开发和运维都苦不堪言,开发脚本的初衷往往是为了提高效率,结果由于维护问题加深开发和运维之间的矛盾.而cake则由自身管理各种依赖,很大程度上解决了以上问题.