curl-runnings: A framework for declaratively writing curl based API tests
Please see the README on Github at https://github.com/aviaviavi/curl-runnings#readme
[Skip to Readme]
Downloads
- curl-runnings-0.3.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.1.0, 0.2.0, 0.3.0, 0.6.0, 0.9.2, 0.10.0, 0.11.0, 0.11.1, 0.12.0, 0.14.0, 0.15.0, 0.16.0, 0.16.4, 0.17.0 |
|---|---|
| Dependencies | aeson (>=1.2.4.0), aeson-pretty (>=0.8.5), base (>=4.7 && <5), bytestring (>=0.10.8.2), case-insensitive (>=0.2.1), cmdargs (>=0.10.20), curl-runnings, directory (>=1.3.0.2), hspec (>=2.4.4), hspec-expectations (>=0.8.2), http-conduit (>=2.2.4), http-types (>=0.9.1), text (>=1.2.2.2), unordered-containers (>=0.2.8.0), vector (>=0.12.0), yaml (>=0.8.28) [details] |
| License | MIT |
| Copyright | 2018 Avi Press |
| Author | Avi Press |
| Maintainer | mail@avi.press |
| Category | Testing |
| Home page | https://github.com/aviaviavi/curl-runnings#readme |
| Bug tracker | https://github.com/aviaviavi/curl-runnings/issues |
| Source repo | head: git clone https://github.com/aviaviavi/curl-runnings |
| Uploaded | by aviaviavi at 2018-03-12T06:04:06Z |
| Distributions | |
| Executables | curl-runnings |
| Downloads | 5415 total (24 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2018-03-12 [all 1 reports] |
Readme for curl-runnings-0.3.0
[back to package description]curl-runnings
Feel the rhythm! Feel the rhyme! Get on up, it's testing time! curl-runnings!
curl-runnings is a framework for writing declarative, curl based tests for your APIs.
Write your tests quickly and correctly with a straight-forward specification in yaml or json. A DSL for writing your tests is on the way! Alternatively, you can use the curl-runnings library to write your tests directly in Haskell.
Why?
When writing curl based smoke/integration tests for APIs using bash and curl
is very convenient, but quickly becomes hard to maintain. Writing matchers for
json output quickly becomes unweildy and error prone. Writing these sorts of
tests in a more traditional programming language is fine, but certainly more
time consuming to write than some simple curl requests. curl-runnings aims to
make it very simple to write tests that curl some endpoints and verify the
output looks sane.
With curl-runnings, you can write your tests just as data in a yaml or json file, curl runnings will take care of the rest!
While yaml/json is the current way to write curl-runnings tests, this project is being built in a way that should lend itself well to an embedded domain specific language, which is a future goal for the project
Installing
There are few options to install:
- download the releases from the github releases page
stack install curl-runningscabal install curl-runnings- build from source with
stack
Writing a test specification
For now, you write your tests specs in a yaml or json file. See /examples to get started. A test spec is a top level array of test cases, each item represents a single curl and set of assertions about the response.
Running
Once you've written a spec, simply run it with:
$ curl-runnings -f path/to/your/spec.yaml
If all your tests pass, curl-runnings will cleanly exit with a 0 code. A code of 1 will be returned if any tests failed.
For more info:
$ curl-runnings --help
Roadmap
Contributions in any form are welcome and encouraged. Don't be shy! :D
- Json specifications for tests
- Yaml specifications for tests
- Embedded dsl for specifications for tests. As the specification gets more complex.
- Spec out dsl that can compile down into a yaml/json spec
- Implement dsl
- More specification features
- timeouts
- retry logic
- ability to configure alerts