Chai-Kekka

一个用于 Kekka 的 Chai 插件

安装和使用

Node: npm install --save-dev chai-kekka 开始使用。

const chai = require("chai")
const chaiKekka = require("chai-kekka")
 
chai.use(chaiKekka)

文档

测试值是一个类型结果

可以使用 result 属性来检查测试值是否是 Result 类的一个实例。

expect(Success('Some String')).to.be.a.result
expect(Failure(new Error('Failure...'))).to.be.a.result

测试值是一个结果成功

可以使用 success 属性来检查测试值是否是类型为 Success 的 Result 类的一个实例。

// Positive
expect(Success('Success String')).to.be.a.success // OK
expect(Failure(new Error('Failure...'))).to.be.a.success // FAIL
expect('Not a result').to.be.a.success // FAIL

// Negative
expect(Success('Success String')).not.to.be.a.success // FAIL
expect(Failure(new Error('Failure...'))).not.to.be.a.success // OK
expect('Not a result').not.to.be.a.success // FAIL with 'expected 'Not a result' to be an instance of Result'

测试值是一个结果失败

可以使用 failure 属性来检查测试值是否是类型为 Failure 的 Result 类的一个实例。

// Positive
expect(Success('Success String')).to.be.a.failure // FAIL
expect(Failure(new Error('Failure...'))).to.be.a.failure // OK
expect('Not a result').to.be.a.failure // FAIL

// Negative
expect(Success('Success String')).not.to.be.a.failure // OK
expect(Failure(new Error('Failure...'))).not.to.be.a.failure // FAIL
expect('Not a result').not.to.be.a.failure // FAIL with 'expected 'Not a result' to be an instance of Result'

测试结果对象的关联值

有两种方法可以测试结果对象的关联值

方法 successWrapping 和 failureWrapping
属性 associatedValue

`successWrapping` 和 `failureWrapping`

const error = new Error('Failure message')
expect(Failure(error)).to.be.a.failureWrapping(error) // OK
expect(Failure(error)).to.be.a.successWrapping(error) // FAIL - not a Success
expect(Failure(error)).to.be.a.failureWrapping('some other value') // FAIL

expect(Success('Success String')).to.be.a.successWrapping('Success String') // OK
expect(Success('Success String')).to.be.a.failureWrapping('Success String') // Fail - not a Failure

// equality modifiers can be used, such as deep, on successWrapping and failureWrapping
expect(Success({ a: '423' })).to.be.a.deep.successWrapping({ a: '423' }) 

`associatedValue`

在使用 result、success 或 failure 属性后，可以使用 associatedValue 属性。它将链中任何后续断言的目标更改为结果关联值。

expect(Success('Success String')).to.be.a.success
  .with.associatedValue.that.equals('Success String') // OK
expect(Success({ a: '423' })).to.be.a.success
  .with.associatedValue.that.deep.equals({ a: '423' }) // OK - equality modifiers accepted
expect(Success({ a: '423' })).to.be.a.failure
  .with.associatedValue.that.deep.equals({ a: '423' }) // FAIL - not a failure
expect(Success({ a: '423' })).to.be.a.result
  .with.associatedValue.that.deep.equals({ a: '423' }) // OK
expect(Success('Success String')).to.have.associatedValue.that.equals('Success String') // FAILS 
// associatedValue must be after either a result, success or failure assertion property