skip to navigation
skip to content

smolder 0.6.0.0

Json wrapper around requests for simple smoke testing.

Smolder
=======

"[Requests](https://github.com/kennethreitz/requests) for humans." :)
[![Build Status](https://travis-ci.org/sky-shiny/smolder.svg?branch=master)](https://travis-ci.org/sky-shiny/smolder)

The prevalence of SOA, microservices and dev/stage/live environment build processes precipitated the development of smolder.
The challenges these technologies pose requires the use of restful api tests which are simple and repeatable on
different endpoints without modifying the tests or the endpoints. A lot of these environments require agents running the
tests to be inside the network boundary and running inside internal build pipelines.

Smolder aims to solve these problems by providing features such as:

- Smoke test your rest API.
- Validate response times.
- Validate redirects.
- Validate ssl certificates.
- Validate headers.
- Validate json object types using [validictory](https://github.com/jamesturk/validictory)
- Write plugins using [Yapsy](https://github.com/tibonihoo/yapsy)
- More

Example
=======

Copy/paste the following into your shell:
```
echo "---
tests:
-
name: "Github Status"
outcomes:
expect_status_code: 301
response_redirect: "https://status.github.com/api/status.json"
inputs:
headers:
User-Agent: "Smolder smoke test library"
uri: /api/status.json
-
inputs:
headers:
User-Agent: "Smolder smoke test library"
name: "Github Status ssl"
outcomes:
response_json_contains:
status: good
response_max_time_ms: 200
port: 443
protocol: https
uri: /api/status.json
" | docker run -i mcameron/smolder status.github.com
```

Expected Output:
![Output](https://raw.githubusercontent.com/sky-shiny/smolder/master/docs/output.png)

Installation
============

```
pip install git+https://github.com/sky-shiny/smolder.git
```

Documentation
=============

[readthedocs](http://smolder.readthedocs.io)

1. [tests](docs/tests.md)
- [inputs](docs/inputs.md)
- [outcomes](docs/outcomes.md)
2. [plugins](docs/plugins.md)
3. [examples](docs/examples.md)
4. [contributing](docs/contributing.md)
5. [history](./HISTORY)

Similar Projects
================

1. [Runscope](https://www.runscope.com/)
2. [vrest.io](http://vrest.io)
3. [Stackoverflow](http://stackoverflow.com/questions/12135309/automated-testing-for-rest-api)

Thanks
======

https://github.com/njsaunders

https://github.com/nielsdraaisma

https://github.com/lotia

https://github.com/casibbald
 
File Type Py Version Uploaded on Size
smolder-0.6.0.0.tar.gz (md5) Source 2017-11-19 19KB
  • Author: Max Cameron
  • Home Page: http://sky-shiny.github.io/smolder/
  • License: BSD License
  • Requires ldap3, httpretty, nose, validictory, Yapsy, PyYAML, jsonpickle, six, retrying, retry, requests, MarkupSafe, Jinja2, ecdsa, dpath, decorator, argh, jsonpickle, nose, httpretty, requests
  • Package Index Owner: sky-shiny
  • DOAP record: smolder-0.6.0.0.xml