3loc 中文文档教程

Question

3loc

一个简单但可定制的集成测试工具：

0. Choose/write a test scenrio for your integration tests
1. Writes our test fixtures into one or several CSV/YAML files
2. Run the command and enjoy the results !

Principles

3loc 针对现有系统运行测试，发送输入和预期结果。 如果收到的结果不是预期的，它会抱怨。

它专注于 Http 服务、SOAP 和 REST。

测试场景基本上是 JavaScript 文件，包含一系列操作和期望。 您肯定需要多次运行相同的场景，测试数据略有变化：发送到测试 WebService 的主体，或预期的状态代码。

我们称它们为夹具，您可以将它们外部化到专用文件中（支持多种格式）。 事实上，fixture 文件是使用 3loc 的入口点，因为它定义了使用的场景文件。

Installation

3loc 建立在 Node.js 4+ 之上。 您需要将其安装在计算机上才能使用。

由于 3loc 使用 libXML.js，这需要一些 C++ 编译，因此您还需要一个 C++ 编译器 （例如 gcc 或 Visual Studio Community Edition）。

安装 Node 和 C++ 编译器后，运行以下命令进行安装

npm install --global 3loc

（然后喝杯咖啡）

Execution

从命令行或终端运行

run path/to/fixture.yml

CLI 选项已记录：

run

Providing test fixtures

测试装置用于为场景文件添加一些动态性. 这是一个示例：

return () =>
    run(request({
      url: 'http://api.wolframalpha.com/v2/query?input=<$ input $>&appid=<$ appId $>&includepodid=Result'
    })).
    then(expectStatusCode(<$ status $>)).
    then(expectXPathToEqual('//pod[id="Result"]//plaintext', '<$ sum $>'));

它对 Wolfram API 进行 Http 调用，获取并解析 XML内容， 检查接收到的状态代码并使用 XPath 表达式检查结果。

看到那些 <$ $> 占位符（input、sum…）了吗？ 它们被提供的测试数据所取代。

With YAML

YAML 可能是编写固定装置的最佳选择。 这是上述场景的 YAML 文件：

scenario: ./path_to/my-scenario.scn
appId: HLJL66-4W3HPXYYP8
tests:
  - name: nominal case
    input: 3%2B4
    sum: 7
    status: 200
  - name: handling nulls
    input: 3%2Bnull
    sum: 3
    status: 200

scenario 是场景文件的路径（必需）。

tests 是一个对象数组，每个对象都被视为给定测试的特定装置。 如果 3loc 在 tests 中找到两个对象，它将使用给定的对象运行场景两次。

在 tests 和根级别中，您可以放置​​任何内容，从简单的字符串/布尔值到复杂的数组/映射结构。

内容将在场景文件中使用：

• input, sum and status are defined at test levels
• appId is common to all tests (but can be overloaded per test)

如果您在测试级别指定一个名称，它将在最终报告中使用。 否则，将生成一个带有测试编号的名称。

您不能为每个测试使用不同的场景。 如果您愿意，可以编写不同的灯具文件。

最后但同样重要的是，YAML 文件可以包含其他 YAML 文件，使用以下宏：

config: !!inc/file configuration.yaml

!!inc/file 执行同步读取给定路径（相对于包含文件）并被其内容替换。

With CSV

不如 YAML 灵活，它适用于一些数据基本平坦、不共享大量数据以及需要不同场景的情况。 上述场景的 CSV fixture 是：

scenario;name;appId;input;sum;status
./path_to/my-scenario.scn;HLJL66-4W3HPXYYP8;"nominal case";3%2B4;7;200
./path_to/my-scenario.scn;HLJL66-4W3HPXYYP8;"handling nulls";3%2Bnull;3;200

每一行将执行不同的测试。 scenario 列包含场景文件的路径（必需）。

任何其他列包含测试内部使用的数据。 如果您在列名中加上点，则数据替换将是树状的。 例如，对于名为 host.url 的列，替换将是 request({host: '<$ host.url $>'}) 数据是包含 url 属性的 host 对象。

如果您指定一个 name 列，它将在最终报告中使用。 否则，将生成一个带有测试编号的名称。

您不能在不同的测试之间共享数据。 为此，请使用 YAML fixture 文件。

Common considerations

无论使用何种格式，以下注意事项始终适用：

• scenario path is always relative to the fixture location (you can provide absolute path as well)
• scenario can directly contains the JavaScript code (only suit really tiny scenarii)
• Tests are executed serially: the program bails at first error
• Test execution folder is always the folder containing the scenario file. Data used as path (load action for example) are relative to that folder
• When providing scenario content directly, the execution folder is the one containing the fixture file

Logging

默认情况下，3loc 并不是很冗长。 但如果您配置日志记录，它可能会更繁琐：只需将 logging.properties 文件放在执行文件夹中。

文件语法是经典的 INI 文件，其中类别是记录器名称，值允许自定义其参数

[my-logger-1]
level=error

[my-logger-2]
level=debug

： conf 被定期监视，因此您可以在 3loc 运行时更改您的文件。

按照惯例，每个动作/期望都使用自己的记录器，因此您可以进行细粒度的调整。

Scenario authoring

场景文件是 JavaScript 文件，使用 Nunjucks 模板语言进行模板化。

显然，它们必须是格式良好的 JavaScript 在模板编译之后。

Templating

为了提高可读性，默认的 Nunjucks 分隔符已被更改：

• blockStart: '<%'
• blockEnd: '%>'
• variableStart: '<$'
• variableEnd: '$>'
• commentStart: '<#'
• commentEnd: '#>'

请注意，占位符是类型感知的（这是对 Nunjuck 行为的改进）。 例如这个场景：

load(<$ file $>)

只有当你在夹具文件中提供一个字符串值时它才会编译。

布尔和数字类型保存在模板中， 字符串固定装置自动用双引号引起来， 数组和对象被序列化为 JSON。

lodash v4.0.1 中的所有方法也可用作 Nunjuck 过滤器：

run(request(<$ endpoint | pick('url', 'headers') $>)).
  then(expectContentToInclude(<$ filename | camelCase $>))

第一个方法参数始终是过滤后的值，您可以添加额外的参数. 它严格等同于写： var _ = require('lodash');

run(request(_.pick(<$ endpoint $>, 'url', 'headers'))).
  then(expectContentToInclude(_.camelCase(<$ filename $>)))

您还可以对所有内容进行硬编码，在这种情况下，fixtures 文件只需要为每个测试指定场景路径和名称。

Returning the proper thing

您的场景文件必须以返回结束：

• A Promise. ex: return Promise.resolve(18);
• A synchronous function. ex return function() { return 18; };
• An asynchronous function. ex return function(done) { require('fs').readFile('myfile.txt', done); }; (asynchronous functions differs from synchronous function because they declare a single argument)

最好的办法是返回 run() 或 runSerial()< 的结果/a> 行动。

It's just JavaScript

它是在 Node.js 上执行的。 这意味着 Node 的 API 可用（通过使用 require() 函数）， 以及 3loc 自己的依赖项（lodash、moment、< a href="http://chaijs.com/">chai, joi ...)

当你的测试运行时在 Node.js 上，您可以使用 4.2 版支持的 ES6 功能 （箭头函数、promises、字符串插值、类……）。

Available actions

所有操作都是脚本文件中自动可用的 JavaScript 函数（不需要任何其他要求）。 它们可以在 Promises 中组合，并且旨在以这种方式使用。

不要不处理 promise 拒绝，除非您的场景需要在错误发生后继续测试内容。 名义上的情况是让错误冒泡并停止当前执行的测试。

listen

启动 HTTP 服务器以侦听给定的 url。 可以配置可接受的方法，具有响应主体和标头。

如果传递的是 JSON 主体，则将默认响应内容类型设置为 application/json。 如果传递 libXML.js 文档主体，请将默认响应内容类型设置为 application/xml。 如果需要，您仍然可以覆盖响应内容类型。

如果 body 作为函数给出，它必须返回一个已实现的承诺 使用包含 content 属性的对象。

请求体将被自动解析（使用请求内容类型）为 libXML.js 文件或 JSON 对象以供进一步处理。 否则，请求正文作为字符串传递。

listen({
  port: 4000,
  url: '/my-api',
  method: 'POST',
  body: '{"msg": "response sent"}',
  headers: {
    'content-type': 'application/json',
    'x-custom': 'custom'
  },
  code: 200
}).then(...)

• opt.port {Number} - absolute or relative path to read file
• opt.url {String} - acceptable url to listen to
• opt.method = GET {String} - acceptable Http method
• opt.body = '' {String|Object|Document|Function} - response sent to incoming request
• opt.headers = {} {Object} - response headers sent to incoming request
• opt.code = 200 {Number} - status code sent to incoming request
• returns {Function} function usable in promises chain. Takes as first parameter an object. Returns a promise fulfilled with the same object, containing
• content {String} - response body received (might be parsed in JSON/XML)
• headers {Object} - response headers

记录器名称：act:listen

load

将文件内容作为字符串加载。 通常用于读取请求/响应主体、XSD 文件……

load('./path_to/file.txt', 'ascii').then(...)

• path {String} - absolute or relative path to read file
• encoding = utf8 {String} - encoding used to read the file
• returns {Function} function that loads the file when invoked. Takes as first parameter an object. Returns a promise fulfilled with the same object, containing
• content {String} - response body received (might be parsed in JSON/XML)
• path {Object} - absolute or relative path to read file

记录器名称：act:load

render

使用给定数据呈现 Nunjucks 模板。 请参阅 Nunjucks 模板语言， 带有特定的分隔符（为了场景文件的可读性）

• blockStart: '<%',
• blockEnd: '%>',
• variableStart: '<$',
• variableEnd: '$>',
• commentStart: '<#',
• commentEnd: '#>'

render('Hello <$ name $> !', {name: 'James'}).then(...)

如果内容作为函数给出，它必须返回一个已实现的承诺 对象包含 content 和 path 属性。

• content {String|Function} - template rendered
• data = {} {Object} - data used for rendering
• returns {Function} function usable in promises chain. Takes as first parameter an object Returns a promise fulfilled with the same object, containing
• content {String} - the rendered template

记录器名称：act:render

request

在给定的 url 上发出 HTTP(s) 请求。 HTTP 方法、标头和跟随重定向的能力是可配置的。

如果传递的是 JSON 正文，请将默认请求内容类型设置为“application/json”。 如果传递 libXML.js 文档正文，请将默认请求内容类型设置为“application/xml”。 如果需要，您仍然可以覆盖请求内容类型。

请求体将被自动解析（使用请求内容类型）为 libXML.js 文件或 JSON 对象以供进一步处理。 否则，请求正文作为字符串传递。

request({
  url: 'http://localhost:8080/my-api',
  method: 'PUT',
  body: '{"msg": "request sent"}',
  headers: {
    'content-type': 'application/json',
    'x-custom': 'custom'
  },
  followRedirect: true
}).then(...)

如果您需要传递查询参数，请使用url对其进行编码。

如果 body 作为函数给出，它必须返回一个已实现的承诺 使用包含 content 属性的对象。

• opt.url {String} - full url (protocol, host, port, path) requested
• opt.method = GET {String} - method used
• opt.body = '' {String|Object|Document} - body sent (only when doing POST and PUT)
• opt.headers = {} {Object} - request headers
• opt.followRedirect = false {Boolean} - automatically follows redirection
• returns {Function} function usable in promises chain. Takes as first parameter an object. Returns a promise fulfilled with the same object, containing
• content {String} - response body received (might be parsed in JSON/XML)
• headers {Object} - response headers
• code {Number} - http status code

记录器名称：act:request

run

使用提供的数据同步运行给定函数，并包装到 承诺下一步行动和期望。 开始新场景时的必备品。

run(request({url: 'http://somewhere.com/'}))

• fs {Function} - 执行的函数

• data = {} {Object} - 作为函数参数给出的可选数据

• < strong>返回 {Promise} 用函数结果实现

记录器名称：act:run

runSerial

连续运行函数数组， 将任务 N 的结果作为任务 N+1 的参数传递。

请注意，您必须传递数组函数。 不要给出承诺，否则它们将一次性全部启动。

runSerial([
  () => Promise.resolve(1),
  p => Promise.resolve(p + 1)
].then(result => ...) // result === 2

• tasks {Array}- tasks to be executed
• returns {Function} that when invoked, will return promise fulfilled with the latest task's result

记录器名称：act:serial

Expectations

所有操作都是在场景文件中自动可用的 JavaScript 函数（无需任何其他要求）。 它们可以在 Promises 中组合，并且旨在以这种方式使用。

不要不处理 promise 拒绝，除非您的场景需要在错误发生后继续测试内容。 名义上的情况是让错误冒泡并停止当前执行的测试。

expectContentToInclude

检查接收到的内容是否包含给定元素， 或匹配给定的模式。

run(load('my-file.txt')).
then(expectcontentToInclude('Hi !'))

• element {String|Regex} - expected element or matching pattern
• returns {Function} function usable in promises chain Takes as first parameter an object containing
• content {Object} - checked content
• returns {Promise} fulfilled with the same object

记录器名称：expect:content

expectStatusCode

检查是否已收到给定的状态代码。

run(request({'http://somewhere.com/api'})).
then(expectStatusCode(404))

• code {Number} - expected value
• returns {Function} function usable in promises chain Takes as first parameter an object containing
• code {Object} - checked code value
• returns {Promise} fulfilled with the same object

记录器名称：expect:status

expectToMatchXsd

根据给定的 XSD 内容验证传入的内容。 在内部使用 libXML.js。 XSD 和 XML 内容可以作为纯字符串或作为 libXML.js 的文档对象传递

如果 xsd 作为函数给出，它必须返回一个已实现的承诺 使用包含 content 属性的对象。

run(request({'http://somewhere.com/api'})).
then(expectToMatchXsd(load('schema.xsd')))

• xsd {String|Object|Function} - xsd content used for validation
• returns {Function} function usable in promises chain. Takes as first parameter an object containing
• content {String|Object} - xml content validated
• returns {Promise} fulfilled with the same object, where content has been enriched as a libXML.js's Document

记录器名称：expect:xsd