You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/commands-and-arguments/arguments.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ You can get the full list of arguments by running `cats -h`. Below is a short de
10
10
-`--server=URL` supplies the URL of the service implementing the contract.
11
11
-`--basicauth=USR:PWD` supplies a `username:password` pair, in case the service uses basic auth.
12
12
-`--authRefreshInterval=value_in_seconds` Amount of time in seconds after which to get new auth credentials
13
-
-`--authRefreshScript=script` Script to get executed after `--authRefreshInterval` in order to get new auth credentials. The script will replace any headers that have aut_script as value. If you don't supply a --authRefreshInterval, but you supply a script, the script will be used to get the initial auth credentials.
13
+
-`--authRefreshScript=script` Script to get executed after `--authRefreshInterval` in order to get new auth credentials. The script will replace any headers that have `auth_script` as value. If you don't supply a `--authRefreshInterval`, but you supply a script, the script will be used to get the initial auth credentials.
14
14
-`--fuzzers=LIST_OF_FUZZERS` supplies a comma separated list of fuzzers. The supplied list of Fuzzers can be partial names, not full Fuzzer names. CATS which check for all Fuzzers containing the supplied strings. If the argument is not supplied, all fuzzers will be run.
15
15
-`--log=PACKAGE:LEVEL` can configure custom log level for a given package. You can provide a comma separated list of packages and levels or a level to apply to everything. This is helpful when you want to see full HTTP traffic: `--log=org.apache.http.wire:debug` or suppress CATS logging: `--log=com.endava.cats:warn`
16
16
-`--skipLog=LEVELS` A list of log levels to skip. For example, you can skip only note and info levels, but leave the rest
@@ -76,7 +76,7 @@ You can get the full list of arguments by running `cats -h`. Below is a short de
76
76
-`--[no-]-color` If true enables ANSI codes and coloured console output. Default: true
77
77
-`--onlyLog=star,note` A list of log levels to include; allows more granular control of the log levels
78
78
-`--userAgent=USER_AGENT` The user agent to be set in the User-Agent HTTP header. Default: cats/version
79
-
-`--verbosity=DEETAILED|SUMMARY` Sets the verbosity of the console logging. If set to summary CATS will only output a simple progress screen per path. Default: `SUMMARY`
79
+
-`--verbosity=DETAILED|SUMMARY` Sets the verbosity of the console logging. If set to summary CATS will only output a simple progress screen per path. Default: `SUMMARY`
80
80
-`--oneOfSelection "field1=value1"`, `--anyOfSelection` A `name=value` list of discriminator names and values that can be use to filter request payloads when objects use oneOf or anyOf definitions which result in multiple payloads for a single endpoint and http method
81
81
-`--randomHeadersNumber=NUMBER` The number of random headers that will be sent by the `LargeNumberOfRandomAlphanumericHeadersFuzzer` and `LargeNumberOfRandomHeadersFuzzer`. Default: `10000`
82
82
-`--skipFieldTypes=string,integer,etc.` A comma separated list of OpenAPI data types to skip. It only supports standard types: https://swagger.io/docs/specification/data-models/data-types
@@ -96,7 +96,10 @@ You can get the full list of arguments by running `cats -h`. Below is a short de
96
96
-`--selfReferenceDepth=<selfReferenceDepth>` Max depth for objects having cyclic dependencies
97
97
-`--limitXxxOfCombinations=<limitXxxOfCombinations>` Max number of anyOf/oneOf combinations
98
98
-`--[no-]useDefaults` If set to true, it will use the default values when generating examples
99
-
-`--simpleReplace` If set to true, it will simply do a replacement between the targetFields names provided and the fuzz values
99
+
-`--nameReplace` If set to true, it will simply do a replacement between the targetFields names provided and the fuzz values
100
+
-`--stopAfterErrors=<stopAfterErrors>` Number of errors after which the continuous fuzzing will stop running. Errors are defined as conditions matching the given match arguments. Only available in `cats random` sub-command.
101
+
-`--stopAfterMutations=<stopAfterMutations>` Number of mutations (test cases) after which the continuous fuzzing will stop running. Only available in `cats random` sub-command.
102
+
-`--stopAfterTimeInSec=<stopAfterTimeInSec>` Amount of time in seconds for how long the continuous fuzzing will run before stopping. Only available in `cats random` sub-command.
100
103
101
104
:::tip
102
105
When you want to skip fuzzing entirely for a specific JSON object or specific fields you must prefix the field name from the `--skipFields` argument with `!`.
@@ -53,5 +53,14 @@ HTTP methods without bodies will be fuzzed at path and query parameters and head
53
53
This is an example for a `GET` request:
54
54
55
55
```shell
56
-
cats fuzz -X GET -t "path1,query1" -i "2XX,4XX" http://service-url/paths1?query1=test&query2
57
-
```
56
+
cats template -X GET -t "path1,query1" -i "2XX,4XX" http://service-url/paths1?query1=test&query2
57
+
```
58
+
59
+
# TemplateFuzzer with continuous fuzzing
60
+
You can also run the `TemplateFuzzer` in continuous mode using the `--random` argument.
61
+
It will run similarly to the [Continuous Fuzzing Mode](/docs/getting-started/running-cats#continuous-fuzzing-mode) based on the registered mutators.
62
+
You must either provide a match condition using the `--matchXXX` arguments, a ignore condition using the `--ignoreXXX` arguments or a filtering condition using the `--filterXXX` arguments.
63
+
64
+
```shell
65
+
cats template -X GET -t "path1,query1" -i "2XX,4XX" http://service-url/paths1?query1=test&query2 --random
0 commit comments