使用rebar构建工程、执行单元测试、自动生成项目文档
来源:互联网 发布:2014网络流行体 编辑:程序博客网 时间:2024/06/18 16:33
原文转自:http://blog.linezing.com/2011/04/rebar%EF%BC%9Aerlang%E6%9E%84%E5%BB%BA%E5%B7%A5%E5%85%B7
Rebar是一款Erlang的构建工具,使用它可以方便的编译、测试erlang程序、内联驱动和打包Erlang发行版本。
Rebar是一个独立的erlang脚本,所以使用Rebar发布程序非常简单,甚至可以直接集成在项目文件夹中。默认的情况下,Rebar会按照Erlang/OTP来组织项目的结构,这样一来,构建时的配置工作量就会大大减少。Rebar同时提供了依赖库(包)管理机制,方便程序员重用已存在的模块。Rebar的以来管理机制支持的方式非常多,甚至包括Git, Hg等少见的方式。
这里有一个例子演示怎样将一个已经存在的项目转化为使用rebar来构建。
- 准备开始
- Rebar的命令参数
- 构建Rebar
- Rebar和OTP约定
- 模板支持
- 处理发行版本
- 扩展Rebar
1.准备开始
第一步:
学习使用Rebar的最好的方法是使用一个简单的例子来演示如何用Rebar构建Erlang项目。首先,我们为这个例子项目创建一个文件夹:
$ mkdir myapp; cd myapp然后,下载rebar的二进制文件到这个项目的文件夹。注意:如果在你的PATH中间有已经有rebar了,不会对我们这个例子有影响。
$cd .. ;$git clone git://github.com/basho/rebar.git;$cd rebar;
$./bootstrap;
$cd ../myapp;
$mv ../rebar/rebar ./
接下来我们使用rebar的模板系统来构建我们程序的“骨架”。
$ ./rebar create-app appid=myapp这条指令的结果会产生一个子文件夹“src”,src包含三个文件夹:
- myapp.app.src:OTP应用程序的资源文件
- myapp_app.erl:一个OTP应用程序的Application behaviour
- myapp_sup.erl: 一个OTP应用程序的Supervisor behaviour
现在我们可以使用rebar来编译这个应用程序:
$ ./rebar compile执行完成后,会出现一个新的文件夹ebin,在ebin文件夹下,会出现与src文件夹下源文件一一对应的beam文件。同时,rebar会根据myapp.app.src动态生成一个合适OTP项目资源文件。
在这里我发现,执行./rebar compile 或者是执行./rebar compile eunit 之后,都会自动重新将src下面的模块名字全都更新到 ebin 目录下 的 .app文件module一栏里面
{application,server,
[{description,[]},
{vsn,"1"},
{registered,[]},
{applications,[kernel,stdlib]},
{mod,{server_app,[]}},
{env,[]},
{modules,[ben,client,listen_work,main,room_manager,room_sup,
room_work,server_app,server_sup,tcp_protocol,
user_manager]}]}.
上面这些都是自动写入的。
注意,如果用到rebar工具的话,ebin目录下面的.app文件是自动写入的,我们在之前项目中有rebar,但是因为人员流动大,到后来ebin目录下的.app文件改成了手动写入,这样就存在被覆盖回去的危险。因此在使用rebar之前,特别强调必须摸清楚它的功能
编译完成后,如果想清除文件也非常简单:
$ ./rebar clean测试:
Rebar为eunit和common_test两个测试框架都提供了支持,在下面这个例子中,我们使用eunit来为我们的应用程序写一个测试用例。
打开文件src/myapp_app.erl,在-export()指令之后添加如下代码:
注意:这里我在测试的时候,发现对于 application 的behavior ,-ifdef(TEST) 还不能放到 start 函数的定义之前,那样会报错,因此我放到了start函数之后,来-include_lib
-endif.
在这个文件的最后添加:
-ifdef(TEST).simple_test() ->ok = application:start(myapp),
?assertNot(undefined == whereis(myapp_sup)).
-endif.
注意:这里的 ?assertNot() 函数的使用好像有点问题,我在用的时候是报错了,我最后用的是?assert()函数,参数需要自己去研究研究.....
通过使用ifdef保护我们的测试代码,我们可以保证最后的测试代码不会随着编译生成的代码进入ebin文件夹。下面我们来运行这个单元测试用例:
$ ./rebar compile eunit你应该收到类似的输出:
==> myapp (compile)Compiled src/myapp_app.erlCompiled src/myapp_sup.erl
==> myapp (eunit)
Compiled src/myapp_sup.erl
Compiled src/myapp_app.erl
Test passed.
注意:rebar这次会编译myapp_app.erl文件两遍,第二遍编译会将输出放到一个特殊的文件夹下(.eunit)下,生成的文件会包含调试信息和其他有用的测试标记。
如果你想检查我们单元测试的覆盖率,可以非常简单的通过在myapp/rebar.config添加一行:
{cover_enabled, true}.然后重新运行我们的测试用例:
$ ./rebar compile eunit==> myapp (compile)==> myapp (eunit)
Test passed.
Cover analysis: /Users/dizzyd/tmp/myapp/.eunit/index.html
详细的覆盖分析会被保存在.eunit/index.html文件里。
2.Rebar的命令参数
Rebar提供了开发中最常用的一些操作,包括:
- 编译
- 单元测试和覆盖分析
- 静态分析(通过Dialyzer和Xref)
- 生成文档
- 依赖管理
另外,rebar和reltool提供模板机制以方便OTP嵌入式系统利用。
最经常使用的命令:
命令 描述 compile编译项目中所有可用的源文件eunit使用Eunit执行单元测试doc使用Edoc生成文档clean去掉所有生成的文件。包括编译,单元测试等过程生成的文件较少用的命令(按照字母序):
命令 描述 analyze使用Dialyzer执行静态分析build_plt构建Dialyzer PLT; 具体描述请看:Dialyzer documentationcheck_plt检查Dialyzer PLT是否是最新,需要的话重新构建create根据模板创建一个典型的项目create-app根据模板文件priv/templates/simpleapp.template ,创建一个典型的OTP应用create-nodeCreate a prototypical OTP embedded system (described by the priv/templates/simplenode.reltool.config template)delete-deps删除rebar.config 设置的依赖库(包)源文件Dgenerate使用 Reltool 构建一个embedded systemget-deps检索rebar.config 文件中配置的依赖的代码xref使用Xref 分析依赖支持的源文件的格式:
Rebar可以通过compile指令编译多种格式的源文件。
源文件 目标文件 描述 src/*.erlebin/*.beamERlang的源文件src/*.app.srcebin/*.appErlang应用程序的资源文件c_src/*.cpriv/<app>.soport driver的c语言源代码或者NIF共享链接库mibs/*.mibpriv/mibs/*.binSNMP 的mib 文件src/*.xrlsrc/*.erlLeex 生成的文件src/*.yrlsrc/*.erlYecc 生成的文件asn1/*.asn1src/*.erlASN-1文件templates/*.dtlebin/*_dtl.beamErlyDTL模板文件 (需要额外安装 ErlyDTL)src/*.lfeebin/*.beamLFE 源文件 (需要额外安装LFE)src/*.pegebin/*.beamNeotoma PEG 语法源文件 (需要额外安装Neotoma)src/*.protoebin/*_pb.beam, include/*_pb.hrlProtocol Buffers 参数(需要额外安装protobuffs)选项:
下面列出可以在在rebar.config文件中配置的各种选项。
命令 选项参数 描述 compileerl_first_files需要提前编译的erlang源文件(例如behavior模块)compileerl_opts编译器支持的其他选项,详情请见 herecompilemib_first_files需要提前编译的mib文件列表 (例如, mib 文件中import部分的引用的RFC文件compilesrc_dirs列出其他包含erlang源文件的目录compileerlydtl_opts更多的支持的选项查阅 ErlyDTL Templatescleanclean_files需要在clean步骤删除的文件列表,列出那些需要clean指令删除的其他模块的文件docedoc_optsedoc 支持的指令,详见:hereeuniteunit_optsEunit支持的指令,详见 hereeunitcover_enabled开启erlang的覆盖率分析euniteunit_compile_optsEunit编译时用到的其他的选项analyzedialyzer_opts指定Dialyzer PLT 文件build_pltdialyzer_opts指定Dialyzer PLT 文件check_pltdialyzer_opts指定 Dialyzer PLT 文件get-deps, delete-depsbase_dir为deps_dir 指定一个候选的目录get-deps, delete-depsdeps_dir制定一个文件夹存储依赖get-deps, delete-depsdeps依赖的列表generatetarget_dir目标文件夹generateoverlay_varsOverlay variables filexrefxref_warnings打开xref的警告xrefxref_checksXref模块中analyze/3支持的选项,具体可以参考: here3.构建Rebar
构建rebar
$git clone git://github.com/basho/rebar.git;$cd rebar;$./bootstrap;
Recompile: src/rebar_core
==> rebar (compile)
Congratulations! You now have a self-contained script called “rebar” in your current working directory. Place this script anywhere in your path and you can use rebar to build OTP-compliant apps.
就像终端提示的一样,我们现在有一个rebar的脚本,现在拷贝这个脚本到项目目录,开始rebar之旅。
4.Rebar和OTP约定
Rebar按照OTP的约定组织项目,OTP约定可以参考OTP设计原则。应用程序的目录需要下列子文件夹:
- src
- ebin
- priv
- include
应用程序的资源文件(*.app)应该放到ebin文件夹下。除了上面文件夹,rebar还还支持下列的原则:
- test:包含EUnit测试脚本的文件夹
- c_src:包含c语言写的port drivers
5.模板支持
我可以使用我的模板吗?—-是的,只要吧把模板文件(mytemplate.template)放到.rebar/templates下,然后通过下列命令使用:
$ rebar create template=mytemplate6.管理发行版本
reltool.config简介:
erlang通过配置文件reltool.config来帮助创建节点,配置文件中包含rebar和reltool(Erlang R13B引入的发布管理工具)创建节点需要的信息。
创建应用如下:
$ ./rebar create-app appid=exemplar注意:create-app和create-node选项能够在rebar_templater.erl中找到,其他的支持的参数都能在simpleapp.template和simplenode.template中找到。
要创建一个节点,需要手动创建一个rel文件:
$ mkdir rel$ cd rel创建节点:
$ ../rebar create-node nodeid=exemplar$ ls -lR.:
total 8
drwxr-xr-x 2 haoze.zpx users 4096 Apr 11 11:08 files
-rw-r–r– 1 haoze.zpx users 806 Apr 11 11:08 reltool.config
./files:
total 28
-rw-r–r– 1 haoze.zpx users 334 Apr 11 11:08 app.config
-rwxr–r– 1 haoze.zpx users 1120 Apr 11 11:08 erl
-rwxr–r– 1 haoze.zpx users 4370 Apr 11 11:08 exemplar
-rwxr–r– 1 haoze.zpx users 4819 Apr 11 11:08 nodetool
-rw-r–r– 1 haoze.zpx users 423 Apr 11 11:08 vm.args
需要在rebar.config中添加:
{sub_dirs, ["rel"]}.执行:
$ ./rebar generate==> rel (generate)在rel目录中就会生成examplar系统:
$ ls -l rel/exemplar/total 24drwxr-xr-x 2 haoze.zpx users 4096 Apr 11 11:09 bin
drwxr-xr-x 8 haoze.zpx users 4096 Apr 11 11:09 erts-5.8
drwxr-xr-x 2 haoze.zpx users 4096 Apr 11 11:09 etc
drwxr-xr-x 18 haoze.zpx users 4096 Apr 11 11:09 lib
drwxr-xr-x 3 haoze.zpx users 4096 Apr 11 11:09 log
drwxr-xr-x 3 haoze.zpx users 4096 Apr 11 11:09 releases
7.扩展Rebar
(Tips:这章我没有实验过)
在标准发布版本中,rebar能够支持大部分erlang开发者的需要。当你碰到需要扩展rebar的需求时,rebar提供一种简单的方法帮助加入新功能。
Contexts:
想要知道如何扩展rebar,一个关键的因素就是理解rebar的核心机制—–contexts。Contexts决定在项目目录结构中选择那些命令选项执行。
对于哪个目录能够执行哪个选项,contexts没有限制,通过配置资源文件rebar.app,例如想要在项目的任何一个目录都执行any_dir_modules,需要在rebar.app中添加:
{application, rebar,[{description, "Rebar: Erlang Build Tool"},%% ...
{env, [
%% ...
%% any_dir processing modules
{any_dir_modules, [
%% ...
rebar_exemplar
]},
%% …
]}
]}.
Module context:
Module context允许rebar的选项与项目中的文件夹和发布文件夹都关联。
你可以通过查看rebar.app了解这些,从中学习如何用modules配置参数来使用app_dir和rel_dir。
Example: EDoc command修改rebar.app:
{application, rebar,[{description, "Rebar: Erlang Build Tool"},{vsn, "2"},
{modules, [ rebar,
%% ...
rebar_edoc,
%% ...
mustache ]},
{registered, []},
{applications, [kernel,
stdlib,
sasl]},
{env, [
%% ...
%% Dir specific processing modules
{modules, [
{app_dir, [
%% ...
rebar_edoc,
%% ...
]},
{rel_dir, [
rebar_reltool
]}
]}
]}
]}.
引入rebar_edoc模块:
-module(rebar_edoc).-export([doc/2, clean/2]).
-include(“rebar.hrl”).
%% @doc Generate Erlang program documentation.
%% @spec doc(#config{}, string()) -> ok
-spec(doc(Config::#config{}, File::string()) -> ok).
doc(Config, File) ->
{ok, AppName, _AppData} = rebar_app_utils:load_app_file(File),
EDocOpts = rebar_config:get(Config, edoc_opts, []),
ok = edoc:application(AppName, “.”, EDocOpts),
ok.
%% @doc Remove the generated Erlang program documentation.
%% @spec clean(#config{}, string()) -> ok
-spec(clean(Config::#config{}, File::string()) -> ok).
clean(Config, _File) ->
EDocOpts = rebar_config:get(Config, edoc_opts, []),
DocDir = proplists:get_value(dir, EDocOpts, “doc”),
rebar_file_utils:rm_rf(DocDir).
- 使用rebar构建工程、执行单元测试、自动生成项目文档
- rebar 构建erlang项目
- 使用rebar构建erlang工程,手把手入门版
- 使用rebar构建erlang工程,手把手入门版
- 使用cmake自动构建工程
- 使用cmake自动构建工程
- 使用cmake自动构建工程
- 使用cmake自动构建工程
- Xcode自动生成项目文档
- 使用GhostDoc为.Net项目自动生成帮助文档
- 使用rebar创建一个otp项目
- erlang 使用rebar创建项目实例
- 使用Swagger自动生成文档
- 使用automake工具自动构建工程
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- SSM项目中自动生成反向工程
- 使用mvn插件执行工程单元测试OOM的解决办法
- 使用Teamcity自构建之-自动运行单元测试
- 在Ubuntu上为Android系统编写Linux内核驱动程序
- ArcGIS.Server.9.2.DotNet在ElementGraphicsLayer画点、线、折线、面、圆、矩形的代码
- JobTracker任务调度器之JobQueueTaskScheduler
- 在Ubuntu上为Android系统内置C可执行程序测试Linux内核驱动程序
- Android root权限获取大揭秘
- 使用rebar构建工程、执行单元测试、自动生成项目文档
- [php] Call to undefined function bccomp
- 三极管工作原理分析,精辟、透彻,看后你就懂
- android 为支持多语言,常用的iso country code
- bcb mac地址
- AndroidUI之开关效果的设计
- 在Ubuntu上为Android增加硬件抽象层(HAL)模块访问Linux内核驱动程序
- 在Ubuntu为Android硬件抽象层(HAL)模块编写JNI方法提供Java访问硬件服务接口
- Ubuntu12.04编译安装insight-6.8