feat(test-utils): built-in chai extension (#98)

packages/adapter-cqhttp/tests/mock.ts

@@ -1,7 +1,6 @@
 import { snakeCase } from 'koishi-utils'
 import { CQResponse } from 'koishi-adapter-cqhttp'
 import { expect } from 'chai'
-import '@shigma/chai-extended'
 
 export type RequestParams = Record<string, any>
 export type RequestData = readonly [string, RequestParams]

packages/koishi-core/src/database.ts

@@ -65,7 +65,7 @@ export namespace Group {
 
   export type Field = keyof Group
   export const fields: Field[] = []
-  export type Observed<K extends Field = Field> = utils.Observed<Pick<Group, K>>
+  export type Observed<K extends Field = Field> = utils.Observed<Pick<Group, K>, Promise<void>>
   type Getter = (id: number, authority: number) => Partial<Group>
   const getters: Getter[] = []
 

packages/koishi-core/tests/command.spec.ts

@@ -4,7 +4,6 @@ import { Logger, noop } from 'koishi-utils'
 import { Session } from 'koishi-core'
 import { inspect } from 'util'
 import { expect } from 'chai'
-import '@shigma/chai-extended'
 
 describe('Command API', () => {
   describe('Register Commands', () => {

packages/koishi-core/tests/context.spec.ts

@@ -3,7 +3,6 @@ import { Session } from 'koishi-core'
 import { noop } from 'koishi-utils'
 import { expect } from 'chai'
 import { fn } from 'jest-mock'
-import '@shigma/chai-extended'
 
 const app = new App()
 const groupSession = new Session(app, { userId: 123, groupId: 456, messageType: 'group' })

packages/koishi-core/tests/parser.spec.ts

@@ -1,7 +1,6 @@
 import { Command } from 'koishi-core'
 import { App } from 'koishi-test-utils'
 import { expect } from 'chai'
-import '@shigma/chai-extended'
 
 const app = new App()
 

packages/koishi-test-utils/chai/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "chai-extended",
+  "private": true,
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "author": "Shigma <1700011071@pku.edu.cn>",
+  "license": "MIT",
+  "files": [
+    "index.d.ts",
+    "dist"
+  ]
+}

packages/koishi-test-utils/chai/src/index.ts

@@ -0,0 +1,45 @@
+import { use } from 'chai'
+import { inspect } from 'util'
+
+use(({ Assertion }) => {
+  function checkShape(expect, actual, path) {
+    if (actual === expect || Number.isNaN(expect) && Number.isNaN(actual)) return
+
+    function formatError(expect, actual) {
+      return `expected to have ${expect} but got ${actual} at path ${path}`
+    }
+
+    if (!expect || ['string', 'number', 'boolean', 'bigint'].includes(typeof expect)) {
+      return formatError(inspect(expect), inspect(actual))
+    }
+
+    // dates
+    if (expect instanceof Date) {
+      if (!(actual instanceof Date) || +expect !== +actual) {
+        return formatError(inspect(expect), inspect(actual))
+      }
+      return
+    }
+
+    if (actual === null) {
+      const type = Object.prototype.toString.call(expect).slice(8, -1).toLowerCase()
+      return formatError(`a ${type}`, 'null')
+    }
+
+    // array / object
+    for (const prop in expect) {
+      if (typeof actual[prop] === 'undefined' && typeof expect[prop] !== 'undefined') {
+        return `expected "${prop}" field to be defined at path ${path}`
+      }
+      const message = checkShape(expect[prop], actual[prop], `${path}${prop}/`)
+      if (message) return message
+    }
+  }
+
+  Assertion.addMethod('shape', function (expect) {
+    const message = checkShape(expect, this._obj, '/')
+    if (message) this.assert(false, message, undefined, expect, this._obj)
+  })
+})
+
+use(require('chai-as-promised'))

packages/chai-extended/tsconfig.json → packages/koishi-test-utils/chai/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.base",
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "outDir": "dist",
     "rootDir": "src",

packages/koishi-test-utils/package.json

@@ -8,7 +8,9 @@
     "node": ">=12.0.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "chai/index.d.ts",
+    "chai/package.json"
   ],
   "author": "Shigma <1700011071@pku.edu.cn>",
   "license": "MIT",
@@ -36,9 +38,13 @@
     "utilities"
   ],
   "dependencies": {
-    "@shigma/chai-extended": "^0.1.4",
     "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "koishi-core": "^2.0.1",
     "koishi-utils": "^3.1.1"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.12",
+    "@types/chai-as-promised": "^7.1.3"
   }
 }

packages/koishi-test-utils/src/database.ts

@@ -1,9 +1,9 @@
 import { App, User, Group } from 'koishi-core'
 import { BASE_SELF_ID } from './app'
 import { expect } from 'chai'
-import '@shigma/chai-extended'
+import '../chai'
 
-export function createArray <T>(length: number, create: (index: number) => T) {
+export function createArray<T>(length: number, create: (index: number) => T) {
   return Array(length).fill(undefined).map((_, index) => create(index))
 }
 

packages/koishi-test-utils/src/index.ts

@@ -1,15 +1,7 @@
-import * as utils from './koishi'
-import * as memory from './memory'
-import { mockModule, actualModule } from './module'
+import memory from './memory'
 
-export { utils, memory }
+export { memory }
 
 export * from './app'
 export * from './database'
 export * from './memory'
-
-mockModule('koishi-utils', () => {
-  const utils1 = actualModule('koishi-utils')
-  const utils2 = actualModule('./koishi')
-  return { ...utils1, ...utils2 }
-})

packages/koishi-test-utils/src/memory.ts

@@ -93,6 +93,6 @@ extendDatabase(MemoryDatabase, {
   },
 })
 
-export function apply(app: App, config: MemoryConfig = {}) {
+export default function apply(app: App, config: MemoryConfig = {}) {
   app.database = new MemoryDatabase(app, config) as any
 }

packages/koishi-test-utils/tests/chai.spec.ts

@@ -0,0 +1,30 @@
+import 'koishi-test-utils'
+import { expect } from 'chai'
+import { Random } from 'koishi-utils'
+
+describe('Chai Extensions', () => {
+  it('shape', () => {
+    expect(1).to.have.shape(1)
+    expect(NaN).to.have.shape(NaN)
+    expect(true).to.have.shape(true)
+    expect('foo').to.have.shape('foo')
+
+    const random = Random.int(1 << 20)
+    expect(new Date(random)).to.have.shape(new Date(random))
+    expect({ a: 1, b: 2 }).to.have.shape({ a: 1 })
+    expect([1, 2]).to.have.shape([1])
+
+    expect(() => expect(1).to.have.shape(2))
+      .to.throw('expected to have 2 but got 1 at path /')
+    expect(() => expect(null).to.have.shape(/(?:)/))
+      .to.throw('expected to have a regexp but got null at path /')
+    expect(() => expect(new Date(0)).to.have.shape(new Date(1000)))
+      .to.throw('expected to have 1970-01-01T00:00:01.000Z but got 1970-01-01T00:00:00.000Z at path /')
+    expect(() => expect({ a: 1 }).to.have.shape({ a: 1, b: 2 }))
+      .to.throw('expected "b" field to be defined at path /')
+    expect(() => expect([1]).to.have.shape([1, 2]))
+      .to.throw('expected "1" field to be defined at path /')
+    expect(() => expect([[1, 2], { a: 3, b: 4 }]).to.have.shape([[1], { a: 4 }]))
+      .to.throw('expected to have 4 but got 3 at path /1/a/')
+  })
+})