https://github.com/codeofnode/allrounder
It validate everything. From rest call to dbvalidation to system commands to unit tests. Just almost everything.
https://github.com/codeofnode/allrounder
command db mocha-tests rest-api testing unit-testing
Last synced: 5 months ago
JSON representation
It validate everything. From rest call to dbvalidation to system commands to unit tests. Just almost everything.
- Host: GitHub
- URL: https://github.com/codeofnode/allrounder
- Owner: codeofnode
- License: mit
- Created: 2017-10-24T02:55:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-15T18:30:58.000Z (over 3 years ago)
- Last Synced: 2025-03-01T19:19:44.122Z (12 months ago)
- Topics: command, db, mocha-tests, rest-api, testing, unit-testing
- Language: JavaScript
- Size: 102 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# allrounder
> It validate everything. From rest call to dbvalidation to system commands to unit tests. Just almost everything.
## Why Allrounder ?
#### Act as simple REST Client
> Just defined the request, with all entries eg url, method, body, headers then after execution, debug the response.
#### You can pipe the sesion from one execution to another
> Yes, can pipe the sessions. So that you can pass the session variables to another execution.
```
allrounder -p pipeFile.json myfile.json
```
#### Re-usable components
> You can re-use a component (set of test cases) in a number of test suites. So you don't have to write same test case everywhere. Plus when its to modify, its a single place change.
#### Can use variables also for objects and at any depth
> It uses [templist](https://github.com/codeofnode/templist) engine to resolve the variables at run time.
#### Extractors
> You can chain a set of variables from one test case to another and even on other test suite
#### Assertions
> You can setup the various assertions with easy to use jsonpath syntax, as all the results are always available as json format.
#### Purely data driven
> As you provide json file for your test cases and all sort of configurations, allrounder supports purely data driven approach.
#### Remote json
> You can fetch the json file from remote server as well.
```
allrounder -f http://myrestserver.com/allrounder-test-file.json
```
#### Looping
> You can loop through a set of array or number for single or batch of test cases
#### Act as curl for windows users and also as a "simplified" curl
> Execute a request right on command line, with the simplest format
```
allrounder -e [method] https://myrestcallurl?withquery=parametersifany [] []
```
#### Can do database validation
> Set `type` as `db` in test and provide a `dbname` eg mongodb, `dbconfig`, and payload in request entry.
#### Can call system commands
> Set `type` as `command` in test and provide a payload as string of complete command in request entry.
#### Suitable for unit testing as well
> Provide the `require` as which file to require, `method` as which method to test, `payload` as the arguments to pass, `async` to instruct if the call is async or not, `constructor` to tell if we are creating a new instance and so on.
#### All in one tool
> Say you want to do REST validation, db validation, also want to do unit testing, and also want to execute system commands, you don't need to hunt for various different tools, just go for `allrounder`. Its an all in one tool.
#### Granular level debugging
> You can provide jsonpath syntax to debug very specifically what you want to debug
#### Support of javascript APIs
> You can customize the request, jsonquery etc as per your requirement with javascript APIs
#### Pre and Post hooks
> You can defined pre and post hook function handlers which initializing the options. That comes when you use javascript APIs.
#### Conditon based execution
> You can setup condition based execution for any test case, with the property `condition` which is evaluated dynamically.
#### Beautifull reporting
> Internally it uses mocha to display the results and diff beautifully on command line.
#### Easy to understand
> Its easy to understand a json file rather lines of code. So keeping data in jsonfile is always a smart choice. Yes, when it comes to utility functions in rare advance cases, it requires a little learning. But anyways the positive side is the freedome of customization.
#### Langauge independent
> Don't you think that being programming language independent is good move.
## Install
```
$ npm install [-g] allrounder
```
## Usage
> A very general usage is below. There are many more other options available.
```
$ allrounder my-json-file.json
$ allrounder my-json-dir
```
## Docs
> Sorry folks. Haven't got much time as of now. If you want to initiate, please feel free to contact me or raise a PR.