meambobbo/busybee

busybee

• Requirements
• Quickstart
• About
  • What it is
  • What it isn't
• Todo

Requirements

• Node.js 8 or higher

Quickstart

npm install -g busybee
busybee init
busybee --help

See The Configuration Docs for detailed information on config file properties.

About

What it is

Busybee will coordinate the steps necessary to run your Functional Tests. It is unopinionated when it comes to deciding how your environments are started, when they're ready, what technologies are used, etc. Busybee is only concerned with the following:

1. Figure out how many Test Suites we're dealing with.
2. Figure out how many Environments are required for each Test Suite
3. Figure out how many Test Sets to run against each Environment.
4. Spin up each Environment
5. Run the Test Sets
6. Spin down each Environment.
7. Report results.

What it isn't

It is not a magic bullet. You still have to write tests. You still have to provide 'start' and 'stop' scripts detailing how start/stop your environments. If your Test Suite is not a REST Test Suite then you will also need to provide a 'run' script that actually runs your tests once the environment as been provisioned.

Todo

Check out the Github Issues Page for a list of future bugfixes and enhancements

• test adapters
  • support https://github.com/postmanlabs/newman#using-newman-as-a-nodejs-module ?
    • may just want a commandline opt for running postman tests and another for converting them to Busybee formay since Busybee supports additional features like sets and indexes.
• support healthcheck script
• transpile to support older versions of node
• Mock Server
  • support testSets with state
  • support a .spec file for documenting endpoints?
• remove placeholder 'null' entries after building testSets with skipped indexes

License

MIT © stowns