如何用更多的"期望“;功能

How to extend frisby.js with more "expect" functions?

本文关键字:期望 功能 quot 何用更      更新时间:2023-09-26

有没有办法用自定义expect方法扩展Frisby.js模块?我不想修改源代码,这些扩展是特定于我的REST API的。我的目标是通过将它们组合成一个方法来避免重复常见的测试。

问题是Frisby.js模块导出其方法时使用以下代码:

exports.create = function(msg) {
  return new Frisby(msg);
};

我该如何向Frisby添加新方法?这更像是一个Javascript继承问题,因为它适用于Node.js模块。

例如,用于测试StackExchange API的脚本会有很多重复的.expect子句,如.expectHeader().expectJSONTypes()。我想把这些组合成一个.expectSEwrapper()方法。此方法是StackExchange API独有的,因此它不属于Frisby.js。脚本如下:

var frisby = require('frisby');
frisby.create('StackOverflow Info')
  .get('https://api.stackexchange.com/2.2/info?site=stackoverflow', {gzip: true})
  .expectStatus(200)
  .expectHeader('content-type', 'application/json; charset=utf-8')
  .expectHeader('content-encoding', 'gzip')
  .expectJSONTypes('', {
    items: Array,
    has_more: Boolean,
    quota_max: Number,
    quota_remaining: Number
  })
  .toss();
frisby.create('StackOverflow Badges')
  .get('https://api.stackexchange.com/2.2/badges?order=desc&sort=rank&site=stackoverflow', {gzip: true})
  .expectStatus(200)
  .expectHeader('content-type', 'application/json; charset=utf-8')
  .expectHeader('content-encoding', 'gzip')
  .expectJSONTypes('', {
    items: Array,
    has_more: Boolean,
    quota_max: Number,
    quota_remaining: Number
  })
  .expectJSONTypes('items.0', {
     badge_type: String,
     award_count: Number,
     rank: String,
     badge_id: Number,
     link: String,
     name: String
  })
  .toss();

我想让脚本看起来更像这样:

frisby.create('StackOverflow Info')
  .get('https://api.stackexchange.com/2.2/info?site=stackoverflow', {gzip: true})
  .expectSEwrapper()
  .toss();
frisby.create('StackOverflow Badges')
  .get('https://api.stackexchange.com/2.2/badges?order=desc&sort=rank&site=stackoverflow', {gzip: true})
  .expectSEwrapper()
  .expectJSONTypes('items.0', {
     badge_type: String,
     award_count: Number,
     rank: String,
     badge_id: Number,
     link: String,
     name: String
  })
  .toss();

这意味着要添加一种新的方法,看起来像这样:

frisby.expectSEwrapper = function() {
    return this.expectStatus(200)
               .expectHeader('content-type', 'application/json; charset=utf-8')
               .expectHeader('content-encoding', 'gzip')
               .expectJSONTypes('', {
                 items: Array,
                 has_more: Boolean,
                 quota_max: Number,
                 quota_remaining: Number
               });

但我该如何从脚本内部将其添加到Frisby原型中呢?

我提出了一个基本上是Frisby.js包装器的解决方案。在一个新的Node模块(我称之为config.js)中,它扩展了create()函数:

var frisby = require('frisby');
// Customize Frisby.js for the StackExchange REST API
exports.frisby = {
    create: function(describe) {
        var _frisby = frisby.create(describe);
        _frisby.expectSEwrapper = function() {
            return this.expectStatus(200)
                       .expectHeader('content-type', 'application/json; charset=utf-8')
                       .expectHeader('content-encoding', 'gzip')
                       .expectJSONTypes('', {
                           items: Array,
                           has_more: Boolean,
                           quota_max: Number,
                           quota_remaining: Number
                       });
        }
        return _frisby;
    }
}

然后,在我的Frisby.js规范文件中,我require这个模块:

var config = require('./config.js');
var frisby = config.frisby;

在这之后,我可以写:

frisby.create('StackOverflow Info')
  .get('https://api.stackexchange.com/2.2/info?site=stackoverflow', {gzip: true})
  .expectSEwrapper()
  .toss();