cotton

README

Cotton

Markdown Test Specification Runner. This project is originally inspired by silk test.

• Executable RESTful API Markdown-based Document Specification.

Installation

Homebrew/Linuxbrew

brew tap chonla/universe
brew install cotton

From source

go get github.com/chonla/cotton

Upgrade

brew upgrade

Usage

cotton [-u <base-api-url>] [-i] [-d] <directory or file>

$ cotton

Usage of cotton:

  cotton [-u <base-url>] [-i] [-d] [-w] [-p name1=value1] [-p name2=value2] ... <test-cases>

  test-cases can be a markdown file or a directory contain markdowns.

  -d	detail mode -- to dump test detail
  -h	show this help
  -i	insecure mode -- to disable certificate verification
  -p value
    	to inject predefined variable in variable-name=variable-value format
  -u string
    	set base url (default "http://localhost:8080")
  -v	show cotton version
  -w	watch mode -- to auto-rerun when files are changed

Executable markdown specification

See Guide for more information.

Contributing

1. Fork it (https://github.com/chonla/cotton/fork).
2. Create your feature branch (git checkout -b feature/fooBar).
3. Commit your changes (git commit -am 'Add some fooBar').
4. Push to the branch (git push origin feature/fooBar).
5. Create a new Pull Request.

Testing

go test ./...

License

MIT