Permalink
Browse files

Edits to README and extensions docs

  • Loading branch information...
1 parent e0e4d9b commit fa5962b0984a3a8bcdff3a031b3ac12563851774 @svanoort committed Oct 10, 2015
Showing with 10 additions and 8 deletions.
  1. +2 −2 README.md
  2. +8 −6 extensions.md
View
@@ -12,7 +12,7 @@ pyresttest
# License
Apache License, Version 2.0
-![Status Badge](http://52.4.228.82:8080/jenkins/buildStatus/icon?job=set-main-build-status)
+![Status Badge](http://52.4.228.82:8080/jenkins/buildStatus/icon?job=set-main-build-status) [![PyPI version](https://badge.fury.io/py/pyresttest.svg)](https://badge.fury.io/py/pyresttest) and [Changelog](CHANGELOG.md)
# Sample Test
**This will check that APIs accept operations, and will smoketest an application**
@@ -606,4 +606,4 @@ For pull requests to get easily merged, please:
- Include documentation as appropriate
- Attempt to adhere to PEP8 style guidelines and project style
-Bear in mind that this is largely a one-man, outside-of-working-hours effort at the moment, so response times will vary.
+Bear in mind that this is largely a one-man, outside-of-working-hours effort at the moment, so response times will vary. That said: every feature request gets heard, and even if it takes a while, all the reasonable features will get incorporated. **If you fork the main repo, check back periodically... you may discover that the next release includes something to meet your needs and then some.**
View
@@ -2,9 +2,11 @@
PyRestTest provides hooks for extending built-in components with your own Python code.
# What Can An Extension Do?
+
+- In general: use more advanced dependencies while not making them required for installation
- Generators: generate data for templating URL/request body/tests/etc
-- Extractors: get data from HTTP response body/headers
-- Validators: write custom tests of headers & request bodies
+- Extractors: get data from HTTP response body/headers and use it in future tests
+- Validators: write custom tests using headers & response bodies
- Test Functions: for the ExtractTest validator, validate a single condition
- Comparator function:s for the ComparatorValidator, compare expected and actual values
@@ -49,8 +51,8 @@ It shows an extension for all extensible functions.
# What Doe An Extension Need To Work?
-1. Function to run
-2. Registry Entries
+1. Function(s) to run
+2. Registry Entries: these are special ALLCAPS variables binding extension names
## Functions (different for each type)
@@ -128,7 +130,7 @@ class HeaderExtractor(AbstractExtractor):
### Validators
Validators should extend AbstractValidator.
-The parse function below will be registered in the registry.
+The parse function below will be registered in the registry VALIDATORS.
```python
class ExtractTestValidator(AbstractValidator):
@@ -187,7 +189,7 @@ Each one maps to the same registry in pyresttest.validators.
# Use Case Suggestions
- **Need to generate complex, formatted data?**
- - Write a generator extension, multiple generators may be used together to yield pieces of a result.
+ - Write a generator extension, or multiple generators may be used together to create a complex result
- **Want to test whether API results fit a business rule?**
- Write a validator extension, your logic can be as complex as you like
- **Want to apply a business rule to the output and use the result?**

0 comments on commit fa5962b

Please sign in to comment.