JSPM

  • Created
  • Published
  • Downloads 206
  • Score
    100M100P100Q101620F
  • License Apache-2.0

Puppet Mocker for Wechaty

Package Exports

  • wechaty-puppet-mock

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wechaty-puppet-mock) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

PUPPET-MOCK

NPM Version npm (tag) NPM

chatie puppet

Picture Credit: https://softwareautotools.com/2017/03/01/mocking-explained-in-python/

Powered by Wechaty TypeScript

Puppet Mocker & Starter Template for Wechaty, it is very useful when you:

  1. Want to test the Wechaty framework with a mock puppet, or
  2. You want to write your own Puppet implenmentation.

Then PuppetMock will helps you a lot.

USAGE

import { MemoryCard } from 'wechaty-puppet'
import { PuppetMock } from 'wechaty-puppet-mock'

const puppet  = new PuppetMock({ memory: new MemoryCard() })
const wechaty = new Wechaty({ puppet })

API Reference

Mocker

import { Wechaty }  from 'wechaty'
import { Mocker, PuppetMock }   from 'wechaty-puppet-mock'

const mocker = new Mocker()
const puppet = new PuppetMock({ mocker })
const bot = new Wechaty({ puppet })

await bot.start()

mocker.scan('https://github.com/wechaty', 1)

const user = mocker.createContact()
mocker.login(user)

const contact = mocker.createContact()
const room = mocker.createRoom()

user.say('Hello').to(contact)
contact.say('World').to(user)

HELPER UTILITIES

StateSwitch

this.state.on('pending')
this.state.on(true)
this.state.off('pending')
this.state.off(true)

await this.state.ready('on')
await this.state.ready('off')

Watchdog

MemoryCard

await memory.set('config', { id: 1, key: 'xxx' })
const config = await memory.get('config')
console.log(config)
// Output: { id: 1, key: 'xxx' }

HISTORY

master

v0.22 (Jun 4, 2020)

Mocker Realeased. Mocker is a manager for controlling the behavior of the Puppet activities.

v0.0.1 (Jun 27, 2018)

Initial version.

PuppetMock is a skelton Puppet without do anything, it will make testing easy when developing Wechaty

AUTHOR

Huan LI <zixia@zixia.net>

profile for zixia on Stack Exchange, a network of free, community-driven Q&A sites
  • Code & Docs © 2018 Huan LI <zixia@zixia.net>
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons