Git Product home page Git Product logo

cotton's Introduction

Cotton

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

  • Executable RESTful API Markdown-based Document Specification.

Latest stable version

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

cotton's People

Contributors

chonla avatar up1 avatar anuchitop avatar

Watchers

Twin Panichsombat avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.