unit-testing - 如何为 Kanso 编写单元测试

Question

我编写了很多 django 应用程序，并习惯于扩展unittest.TestCase和运行python manage.py test app_name. 是否有类似的简单方法来对Kanso应用程序进行单元测试？请提供一个最小的例子。

谢谢。

score 10 · Accepted Answer

Kanso 应用程序是 CouchDB 应用程序。然而，最好的选择是暂时忽略 CouchDB。重要的是：Kanso 应用程序是 Node.js 应用程序。以与测试 Node.js 应用程序相同的方式测试它们。测试他们是否遵守记录在案的 CouchDB API，你会没事的。

理想情况下，我们可能希望在 CouchDB 中实际运行测试。JavaScript 引擎不同（V8 与 SpiderMonkey）；环境不同。然而在实践中，测试 Node.js 代码要容易得多。（此外，两个平台上都没有一整类 JavaScript 错误：第三方代码设置全局变量、更改内置类型、更改原型——这些都是浏览器问题。Node.js 和 CouchDB 都是原始且可预测的。）

例子

让我们制作一个简单的 Couch 应用程序，在_show 函数中输出“Hello world” 。

kanso.json文件：

{ "name"   : "hello_world"
, "version": "0.1.0"
, "description": "A simple hello-world Couch app"
, "dependencies": { "node-couchapp": "~0.8.3" }
, "app": "app"
}

下一次运行kanso install将引入“node-couchapp”依赖项。（注意使用该kanso命令与使用该命令的方式相似npm。）

让我们制作一个非常简单的 Couch 应用程序，在./app.js：

// A Couch app that just says hello in a _show function.
module.exports = {
  'shows': {
    'hello': function(doc, req) {
      var who = req.query.who || "world"
      return "Hello, " + who
    }
  }
}

我跑了kanso push http://example.iriscouch.com/so_hello，我可以在这里看到我的应用程序：

添加测试

我喜欢node-tap，所以让我们使用它。但重点是，这只是一些 Node.js 代码。使用您喜欢的任何方法对其进行测试。

首先，一个快速package.json文件：

{ "name"   : "hello_world"
, "description": "A simple hello-world Couch app"
, "version": "0.1.0"
, "private": true
, "devDependencies": { "tap": "~0.2.3" }
}

运行npm install以获取 node-tap 包。（当我在 Node.js 上工作时，我总是有./node_modules/.bin。$PATH我喜欢在项目中拥有我需要的一切，而不是全局安装。

接下来，也许是一个test/show_function.js文件：

var tap = require('tap')

tap.test('The Couch app loads', function(t) {
  t.doesNotThrow(load_app, 'No problem loading the app.js file')
  t.end()

  function load_app() {
    var app = require('../app')
  }
})

tap.test('The show function', function(t) {
  var app = require('../app')
    , hello = app.shows.hello

  t.type(hello, 'function', 'Show function "hello" in the couch app')

  var doc = {}
    , null_req = {'query':{}}
    , john_req = {'query':{'who':'John Doe'}}

  t.equal(hello(doc, null_req), 'Hello, world', '"Hello world" by default')
  t.equal(hello(doc, john_req), 'Hello, John Doe', 'Supports ?who query string')
  t.end()
})

通过运行测试它tap test：

$ tap test
ok test/show_function.js ................................ 5/5
total ................................................... 5/5

ok

我将更改代码以返回硬编码的“Hello, world”（即忽略该req.query.who参数）。注意失败的测试：

$ tap test
not ok test/show_function.js ............................ 4/5
    Command: "node" "show_function.js"
    ok 1 No problem loading the app.js file
    ok 2 Show function "hello" in the couch app
    ok 3 "Hello world" by default
    not ok 4 Supports ?who query string
      ---
        file:   /private/tmp/j/test/show_function.js
        line:   23
        column: 5
        stack:  
          - getCaller (/private/tmp/j/node_modules/tap/lib/tap-assert.js:403:17)
          - assert (/private/tmp/j/node_modules/tap/lib/tap-assert.js:19:16)
          - Function.equal (/private/tmp/j/node_modules/tap/lib/tap-assert.js:160:10)
          - Test._testAssert [as equal] (/private/tmp/j/node_modules/tap/lib/tap-test.js:86:16)
          - Test.<anonymous> (/private/tmp/j/test/show_function.js:23:5)
          - Test.<anonymous> (native)
          - Test.<anonymous> (events.js:88:20)
          - Test.emit (/private/tmp/j/node_modules/tap/lib/tap-test.js:103:8)
          - GlobalHarness.<anonymous> (/private/tmp/j/node_modules/tap/lib/tap-harness.js:86:13)
          - Array.0 (native)
        found:  Hello, world
        wanted: Hello, John Doe
        diff:   |
          FOUND:  Hello, world
          WANTED: Hello, John Doe
                         ^ (at position = 7)
      ...
    ok 5 test/show_function.js

    1..5
    # tests 5
    # pass  4
    # fail  1

total ................................................... 4/5

not ok

score 6 · Accepted Answer

我有一些项目可以帮助展示测试 kanso 应用程序：

仪表板核心项目

https://github.com/ryanramage/dashboard-core

特征：

特拉维斯支持。
使用NodeUnit进行 PhantomJS无头测试
由于这是一个模块，我们有一个test 文件夹，这是一个使用该模块的单独的 kanso 应用程序。请注意，在packages 文件夹中有一个指向项目根目录的符号链接。

Node-Couchapp 项目

https://github.com/kanso/node-couchapp

特拉维斯支持
这次在 kanso 文件夹中有多个测试 kanso 项目。再次使用包目录中的符号链接技巧

score 6 · Accepted Answer

像 JasonSmith 一样，我也建议您尽可能使用 Node.js 进行测试。但是，由于 CouchApps 的性质，您通常最终不得不编写单元测试才能在浏览器中运行，因为它们与您不想模拟的浏览器 API 交互，或者因为您需要测试它在一系列浏览器中的工作情况.

在进行基于浏览器的单元测试时，我使用了一些小的 Kanso 包，我将它们组合在一起，以自动呈现运行 nodeunit 测试套件的界面。目前它的边缘有点粗糙，但可以完成工作。

kanso.json

将 nodeunit 和 nodeunit-testrunner 包添加到您的 kanso.json 文件并运行 kanso install 从存储库中获取它们。

{
    "name": "example",
    "version": "0.0.1",
    "description": "example app with unit tests",
    "modules": ["lib", "tests"],
    "load": "lib/app",
    "dependencies": {
        "modules": null,
        "properties": null,
        "nodeunit": null,
        "nodeunit-testrunner": null
    }
}

请注意，我已将“测试”目录作为模块路径包含在内。放入该目录的任何模块都将用作 nodeunit 测试套件并由 nodeunit-testrunner UI 显示。

重写

您需要手动将 nodeunit-testrunner 包的重写添加到您的应用程序中，在我的示例中，这意味着将 lib/app.js 编辑为如下所示：

exports.rewrites = [
    require('nodeunit-testrunner/rewrites')
];

添加一些测试

假设我们有一个如下所示的模块 lib/foo.js：

exports.hello = function (name) {
    return 'hello ' + name;
};

我们可以通过在tests/test-foo.js 中添加一个模块来添加一个测试（只要它在tests 目录中就可以命名任何东西）。

var foo = require('lib/foo');


exports['test for foo.hello'] = function (test) {
    test.equal(foo.hello('bar'), 'hello bar');
    test.done();
};

如果您随后推送您的应用程序并在浏览器中访问http://localhost:5984/example/_design/example/_rewrite/test，您将看到一个基本界面，用于在测试目录中单独或全部运行测试套件他们一个接一个。

希望有帮助。

unit-testing - 如何为 Kanso 编写单元测试

3 回答 3

例子

添加测试

仪表板核心项目

Node-Couchapp 项目

Related

Reference