dia

Dia

Check your provider API implementation for a Modulus add-on quickly and easily.

Usage

Run $ dia -h for a complete list of commands and options.

Usage: dia [options] [command]

Commands:

  config set <key> <value>        set a configuration value
  config get <key>                get a configuration value
  init                            initialize a skeleton manifest
  test                            run all add-on tests
  test manifest                   test a manifest (run before each test)
  test provision [params]         simulate a provision call
  test deprovision <id>           simulate a deprovision call
  test planchange <id> [new_plan] simulate a plan change
  test sso <id>                   simulate single sign on authentication for the add-on with the specified ID
  create                          create an add-on

Options:

  -h, --help             output usage information
  -V, --version          output the version number
  -f, --filename <path>  path to manifest.json file - defaults to the current working directory
  -p, --plan <plan>      provision the specified plan instead of "test"

Testing an add-on

Implement your add-on provider API following the instructions found in the Modulus codex or start with the example add-on project here. Once your API is implemented, start your server up at the base test URL configured in your manifest and run $ dia test with your manifest (either from the working directory that contains the manifest or use the -f option).

Run all tests for your add-on by running $ dia test or test individual endpoints (see below). Use the -f option to specify the location of the manifest for your add-on; otherwise, the current working directory will be used.

Note: the provided manifest will be validated for each check

Failed checks will provide a description of what is missing or incorrect. Once all checks pass, submit your add-on to Modulus.

License

The MIT License (MIT)

Copyright (c) 2014 Modulus

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.