brine-dsl 0.8.1 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/.ruby-gemset +1 -0
  3. data/Gemfile.lock +24 -75
  4. data/Rakefile +5 -29
  5. data/brine-dsl.gemspec +3 -5
  6. data/feature_setup.rb +17 -0
  7. data/lib/brine/requester.rb +27 -2
  8. data/lib/brine/step_definitions/request_construction.rb +5 -0
  9. data/lib/brine/test_steps.rb +8 -2
  10. data/lib/brine/type_checks.rb +2 -1
  11. data/lib/brine/util.rb +13 -3
  12. metadata +6 -145
  13. data/.gitignore +0 -3
  14. data/.travis.yml +0 -11
  15. data/CHANGELOG.md +0 -170
  16. data/Guardfile +0 -12
  17. data/LICENSE +0 -21
  18. data/README.adoc +0 -29
  19. data/config/cucumber.yml +0 -2
  20. data/docs/build.gradle +0 -19
  21. data/docs/cookbook.html +0 -643
  22. data/docs/gradle/wrapper/gradle-wrapper.jar +0 -0
  23. data/docs/gradle/wrapper/gradle-wrapper.properties +0 -6
  24. data/docs/gradlew +0 -172
  25. data/docs/gradlew.bat +0 -84
  26. data/docs/guide.html +0 -1220
  27. data/docs/index.html +0 -486
  28. data/docs/specs.html +0 -2066
  29. data/docs/src/cookbook.adoc +0 -160
  30. data/docs/src/guide.adoc +0 -524
  31. data/docs/src/index.adoc +0 -28
  32. data/docs/src/spec.erb +0 -121
  33. data/docs/src/specs.adoc +0 -37
  34. data/features/argument_transforms/boolean.feature +0 -37
  35. data/features/argument_transforms/datetime.feature +0 -45
  36. data/features/argument_transforms/integer.feature +0 -41
  37. data/features/argument_transforms/list.feature +0 -46
  38. data/features/argument_transforms/object.feature +0 -66
  39. data/features/argument_transforms/quoted.feature +0 -41
  40. data/features/argument_transforms/regex.feature +0 -40
  41. data/features/argument_transforms/template.feature +0 -46
  42. data/features/argument_transforms/whitespace.feature +0 -51
  43. data/features/assertions/is_a_valid.feature +0 -184
  44. data/features/assertions/is_empty.feature +0 -67
  45. data/features/assertions/is_equal_to.feature +0 -60
  46. data/features/assertions/is_including.feature +0 -34
  47. data/features/assertions/is_matching.feature +0 -35
  48. data/features/assertions/is_of_length.feature +0 -43
  49. data/features/assignment/parameter.feature +0 -20
  50. data/features/assignment/random.feature +0 -25
  51. data/features/assignment/response_attribute.feature +0 -33
  52. data/features/assignment/timestamp.feature +0 -33
  53. data/features/deprecations/replaced_with.feature +0 -53
  54. data/features/request_construction/basic.feature +0 -29
  55. data/features/request_construction/body.feature +0 -26
  56. data/features/request_construction/clearing.feature +0 -46
  57. data/features/request_construction/headers.feature +0 -94
  58. data/features/request_construction/params.feature +0 -60
  59. data/features/resource_cleanup/cleanup.feature +0 -86
  60. data/features/selectors/all.feature +0 -55
  61. data/features/selectors/any.feature +0 -48
  62. data/features/step_definitions/test_steps.rb +0 -5
  63. data/features/support/env.rb +0 -10
  64. data/tutorial/missing.feature +0 -5
  65. data/tutorial/post_matching.feature +0 -12
  66. data/tutorial/post_status.feature +0 -10
  67. data/tutorial/support/env.rb +0 -2
@@ -1,6 +0,0 @@
1
- #Mon Sep 18 08:41:45 EDT 2017
2
- distributionBase=GRADLE_USER_HOME
3
- distributionPath=wrapper/dists
4
- zipStoreBase=GRADLE_USER_HOME
5
- zipStorePath=wrapper/dists
6
- distributionUrl=https\://services.gradle.org/distributions/gradle-4.0.1-bin.zip
@@ -1,172 +0,0 @@
1
- #!/usr/bin/env sh
2
-
3
- ##############################################################################
4
- ##
5
- ## Gradle start up script for UN*X
6
- ##
7
- ##############################################################################
8
-
9
- # Attempt to set APP_HOME
10
- # Resolve links: $0 may be a link
11
- PRG="$0"
12
- # Need this for relative symlinks.
13
- while [ -h "$PRG" ] ; do
14
- ls=`ls -ld "$PRG"`
15
- link=`expr "$ls" : '.*-> \(.*\)$'`
16
- if expr "$link" : '/.*' > /dev/null; then
17
- PRG="$link"
18
- else
19
- PRG=`dirname "$PRG"`"/$link"
20
- fi
21
- done
22
- SAVED="`pwd`"
23
- cd "`dirname \"$PRG\"`/" >/dev/null
24
- APP_HOME="`pwd -P`"
25
- cd "$SAVED" >/dev/null
26
-
27
- APP_NAME="Gradle"
28
- APP_BASE_NAME=`basename "$0"`
29
-
30
- # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31
- DEFAULT_JVM_OPTS=""
32
-
33
- # Use the maximum available, or set MAX_FD != -1 to use that value.
34
- MAX_FD="maximum"
35
-
36
- warn () {
37
- echo "$*"
38
- }
39
-
40
- die () {
41
- echo
42
- echo "$*"
43
- echo
44
- exit 1
45
- }
46
-
47
- # OS specific support (must be 'true' or 'false').
48
- cygwin=false
49
- msys=false
50
- darwin=false
51
- nonstop=false
52
- case "`uname`" in
53
- CYGWIN* )
54
- cygwin=true
55
- ;;
56
- Darwin* )
57
- darwin=true
58
- ;;
59
- MINGW* )
60
- msys=true
61
- ;;
62
- NONSTOP* )
63
- nonstop=true
64
- ;;
65
- esac
66
-
67
- CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68
-
69
- # Determine the Java command to use to start the JVM.
70
- if [ -n "$JAVA_HOME" ] ; then
71
- if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72
- # IBM's JDK on AIX uses strange locations for the executables
73
- JAVACMD="$JAVA_HOME/jre/sh/java"
74
- else
75
- JAVACMD="$JAVA_HOME/bin/java"
76
- fi
77
- if [ ! -x "$JAVACMD" ] ; then
78
- die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79
-
80
- Please set the JAVA_HOME variable in your environment to match the
81
- location of your Java installation."
82
- fi
83
- else
84
- JAVACMD="java"
85
- which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86
-
87
- Please set the JAVA_HOME variable in your environment to match the
88
- location of your Java installation."
89
- fi
90
-
91
- # Increase the maximum file descriptors if we can.
92
- if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93
- MAX_FD_LIMIT=`ulimit -H -n`
94
- if [ $? -eq 0 ] ; then
95
- if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96
- MAX_FD="$MAX_FD_LIMIT"
97
- fi
98
- ulimit -n $MAX_FD
99
- if [ $? -ne 0 ] ; then
100
- warn "Could not set maximum file descriptor limit: $MAX_FD"
101
- fi
102
- else
103
- warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104
- fi
105
- fi
106
-
107
- # For Darwin, add options to specify how the application appears in the dock
108
- if $darwin; then
109
- GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110
- fi
111
-
112
- # For Cygwin, switch paths to Windows format before running java
113
- if $cygwin ; then
114
- APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115
- CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116
- JAVACMD=`cygpath --unix "$JAVACMD"`
117
-
118
- # We build the pattern for arguments to be converted via cygpath
119
- ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120
- SEP=""
121
- for dir in $ROOTDIRSRAW ; do
122
- ROOTDIRS="$ROOTDIRS$SEP$dir"
123
- SEP="|"
124
- done
125
- OURCYGPATTERN="(^($ROOTDIRS))"
126
- # Add a user-defined pattern to the cygpath arguments
127
- if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128
- OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129
- fi
130
- # Now convert the arguments - kludge to limit ourselves to /bin/sh
131
- i=0
132
- for arg in "$@" ; do
133
- CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134
- CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135
-
136
- if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137
- eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138
- else
139
- eval `echo args$i`="\"$arg\""
140
- fi
141
- i=$((i+1))
142
- done
143
- case $i in
144
- (0) set -- ;;
145
- (1) set -- "$args0" ;;
146
- (2) set -- "$args0" "$args1" ;;
147
- (3) set -- "$args0" "$args1" "$args2" ;;
148
- (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149
- (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150
- (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151
- (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152
- (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153
- (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154
- esac
155
- fi
156
-
157
- # Escape application args
158
- save () {
159
- for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160
- echo " "
161
- }
162
- APP_ARGS=$(save "$@")
163
-
164
- # Collect all arguments for the java command, following the shell quoting and substitution rules
165
- eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166
-
167
- # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168
- if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169
- cd "$(dirname "$0")"
170
- fi
171
-
172
- exec "$JAVACMD" "$@"
@@ -1,84 +0,0 @@
1
- @if "%DEBUG%" == "" @echo off
2
- @rem ##########################################################################
3
- @rem
4
- @rem Gradle startup script for Windows
5
- @rem
6
- @rem ##########################################################################
7
-
8
- @rem Set local scope for the variables with windows NT shell
9
- if "%OS%"=="Windows_NT" setlocal
10
-
11
- set DIRNAME=%~dp0
12
- if "%DIRNAME%" == "" set DIRNAME=.
13
- set APP_BASE_NAME=%~n0
14
- set APP_HOME=%DIRNAME%
15
-
16
- @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17
- set DEFAULT_JVM_OPTS=
18
-
19
- @rem Find java.exe
20
- if defined JAVA_HOME goto findJavaFromJavaHome
21
-
22
- set JAVA_EXE=java.exe
23
- %JAVA_EXE% -version >NUL 2>&1
24
- if "%ERRORLEVEL%" == "0" goto init
25
-
26
- echo.
27
- echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28
- echo.
29
- echo Please set the JAVA_HOME variable in your environment to match the
30
- echo location of your Java installation.
31
-
32
- goto fail
33
-
34
- :findJavaFromJavaHome
35
- set JAVA_HOME=%JAVA_HOME:"=%
36
- set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37
-
38
- if exist "%JAVA_EXE%" goto init
39
-
40
- echo.
41
- echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42
- echo.
43
- echo Please set the JAVA_HOME variable in your environment to match the
44
- echo location of your Java installation.
45
-
46
- goto fail
47
-
48
- :init
49
- @rem Get command-line arguments, handling Windows variants
50
-
51
- if not "%OS%" == "Windows_NT" goto win9xME_args
52
-
53
- :win9xME_args
54
- @rem Slurp the command line arguments.
55
- set CMD_LINE_ARGS=
56
- set _SKIP=2
57
-
58
- :win9xME_args_slurp
59
- if "x%~1" == "x" goto execute
60
-
61
- set CMD_LINE_ARGS=%*
62
-
63
- :execute
64
- @rem Setup the command line
65
-
66
- set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67
-
68
- @rem Execute Gradle
69
- "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70
-
71
- :end
72
- @rem End local scope for the variables with windows NT shell
73
- if "%ERRORLEVEL%"=="0" goto mainEnd
74
-
75
- :fail
76
- rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77
- rem the _cmd.exe /c_ return code!
78
- if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79
- exit /b 1
80
-
81
- :mainEnd
82
- if "%OS%"=="Windows_NT" endlocal
83
-
84
- :omega
@@ -1,1220 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
6
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
- <meta name="generator" content="Asciidoctor 1.5.0">
8
- <meta name="description" content="The User Guide for using the Brine REST Testing DSL">
9
- <meta name="keywords" content="Brine, Cucumber, REST, DSL">
10
- <meta name="author" content="Matt Whipple">
11
- <title>Brine User Guide</title>
12
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic|Noto+Serif:400,400italic,700,700italic|Droid+Sans+Mono:400">
13
- <style>
14
- /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
15
- /* Remove the comments around the @import statement below when using this as a custom stylesheet */
16
- /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic|Noto+Serif:400,400italic,700,700italic|Droid+Sans+Mono:400";*/
17
- article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
18
- audio,canvas,video{display:inline-block}
19
- audio:not([controls]){display:none;height:0}
20
- [hidden],template{display:none}
21
- script{display:none!important}
22
- html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
23
- body{margin:0}
24
- a{background:transparent}
25
- a:focus{outline:thin dotted}
26
- a:active,a:hover{outline:0}
27
- h1{font-size:2em;margin:.67em 0}
28
- abbr[title]{border-bottom:1px dotted}
29
- b,strong{font-weight:bold}
30
- dfn{font-style:italic}
31
- hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
32
- mark{background:#ff0;color:#000}
33
- code,kbd,pre,samp{font-family:monospace;font-size:1em}
34
- pre{white-space:pre-wrap}
35
- q{quotes:"\201C" "\201D" "\2018" "\2019"}
36
- small{font-size:80%}
37
- sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
38
- sup{top:-.5em}
39
- sub{bottom:-.25em}
40
- img{border:0}
41
- svg:not(:root){overflow:hidden}
42
- figure{margin:0}
43
- fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
44
- legend{border:0;padding:0}
45
- button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
46
- button,input{line-height:normal}
47
- button,select{text-transform:none}
48
- button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
49
- button[disabled],html input[disabled]{cursor:default}
50
- input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
51
- input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
52
- input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
53
- button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
54
- textarea{overflow:auto;vertical-align:top}
55
- table{border-collapse:collapse;border-spacing:0}
56
- *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
57
- html,body{font-size:100%}
58
- body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto}
59
- a:hover{cursor:pointer}
60
- img,object,embed{max-width:100%;height:auto}
61
- object,embed{height:100%}
62
- img{-ms-interpolation-mode:bicubic}
63
- #map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important}
64
- .left{float:left!important}
65
- .right{float:right!important}
66
- .text-left{text-align:left!important}
67
- .text-right{text-align:right!important}
68
- .text-center{text-align:center!important}
69
- .text-justify{text-align:justify!important}
70
- .hide{display:none}
71
- .antialiased,body{-webkit-font-smoothing:antialiased}
72
- img{display:inline-block;vertical-align:middle}
73
- textarea{height:auto;min-height:50px}
74
- select{width:100%}
75
- p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
76
- .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
77
- div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
78
- a{color:#2156a5;text-decoration:underline;line-height:inherit}
79
- a:hover,a:focus{color:#1d4b8f}
80
- a img{border:none}
81
- p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
82
- p aside{font-size:.875em;line-height:1.35;font-style:italic}
83
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
84
- h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
85
- h1{font-size:2.125em}
86
- h2{font-size:1.6875em}
87
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
88
- h4,h5{font-size:1.125em}
89
- h6{font-size:1em}
90
- hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
91
- em,i{font-style:italic;line-height:inherit}
92
- strong,b{font-weight:bold;line-height:inherit}
93
- small{font-size:60%;line-height:inherit}
94
- code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
95
- ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
96
- ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
97
- ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
98
- ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
99
- ul.square{list-style-type:square}
100
- ul.circle{list-style-type:circle}
101
- ul.disc{list-style-type:disc}
102
- ul.no-bullet{list-style:none}
103
- ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
104
- dl dt{margin-bottom:.3125em;font-weight:bold}
105
- dl dd{margin-bottom:1.25em}
106
- abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
107
- abbr{text-transform:none}
108
- blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
109
- blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
110
- blockquote cite:before{content:"\2014 \0020"}
111
- blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
112
- blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
113
- @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
114
- h1{font-size:2.75em}
115
- h2{font-size:2.3125em}
116
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
117
- h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
118
- table thead,table tfoot{background:#f7f8f7;font-weight:bold}
119
- table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
120
- table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
121
- table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
122
- table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
123
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
124
- h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
125
- .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
126
- .clearfix:after,.float-group:after{clear:both}
127
- *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
128
- pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
129
- .keyseq{color:rgba(51,51,51,.8)}
130
- kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap}
131
- .keyseq kbd:first-child{margin-left:0}
132
- .keyseq kbd:last-child{margin-right:0}
133
- .menuseq,.menu{color:rgba(0,0,0,.8)}
134
- b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
135
- b.button:before{content:"[";padding:0 3px 0 2px}
136
- b.button:after{content:"]";padding:0 2px 0 3px}
137
- p a>code:hover{color:rgba(0,0,0,.9)}
138
- #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
139
- #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
140
- #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
141
- #content{margin-top:1.25em}
142
- #content:before{content:none}
143
- #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
144
- #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
145
- #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
146
- #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
147
- #header .details span:first-child{margin-left:-.125em}
148
- #header .details span.email a{color:rgba(0,0,0,.85)}
149
- #header .details br{display:none}
150
- #header .details br+span:before{content:"\00a0\2013\00a0"}
151
- #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
152
- #header .details br+span#revremark:before{content:"\00a0|\00a0"}
153
- #header #revnumber{text-transform:capitalize}
154
- #header #revnumber:after{content:"\00a0"}
155
- #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
156
- #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
157
- #toc>ul{margin-left:.125em}
158
- #toc ul.sectlevel0>li>a{font-style:italic}
159
- #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
160
- #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
161
- #toc a{text-decoration:none}
162
- #toc a:active{text-decoration:underline}
163
- #toctitle{color:#7a2518;font-size:1.2em}
164
- @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
165
- body.toc2{padding-left:15em;padding-right:0}
166
- #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
167
- #toc.toc2 #toctitle{margin-top:0;font-size:1.2em}
168
- #toc.toc2>ul{font-size:.9em;margin-bottom:0}
169
- #toc.toc2 ul ul{margin-left:0;padding-left:1em}
170
- #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171
- body.toc2.toc-right{padding-left:0;padding-right:15em}
172
- body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
173
- #toc.toc2{width:20em}
174
- #toc.toc2 #toctitle{font-size:1.375em}
175
- #toc.toc2>ul{font-size:.95em}
176
- #toc.toc2 ul ul{padding-left:1.25em}
177
- body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
178
- #content #toc>:first-child{margin-top:0}
179
- #content #toc>:last-child{margin-bottom:0}
180
- #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
181
- #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
182
- .sect1{padding-bottom:.625em}
183
- @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed}
184
- #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
185
- #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
186
- #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
187
- #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
188
- #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
189
- .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
190
- .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
191
- table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
192
- .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
193
- table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
194
- .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
195
- .admonitionblock>table td.icon{text-align:center;width:80px}
196
- .admonitionblock>table td.icon img{max-width:none}
197
- .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
198
- .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
199
- .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
200
- .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
201
- .exampleblock>.content>:first-child{margin-top:0}
202
- .exampleblock>.content>:last-child{margin-bottom:0}
203
- .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
204
- .sidebarblock>:first-child{margin-top:0}
205
- .sidebarblock>:last-child{margin-bottom:0}
206
- .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
207
- .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
208
- .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
209
- .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
210
- .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
211
- .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
212
- @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
213
- .listingblock pre.highlightjs{padding:0}
214
- .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
215
- .listingblock pre.prettyprint{border-width:0}
216
- .listingblock>.content{position:relative}
217
- .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
218
- .listingblock:hover code[data-lang]:before{display:block}
219
- .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
220
- .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
221
- table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
222
- table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0}
223
- table.pyhltable td.code{padding-left:.75em;padding-right:0}
224
- pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
225
- pre.pygments .lineno{display:inline-block;margin-right:.25em}
226
- table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
227
- .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
228
- .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
229
- .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
230
- .quoteblock blockquote{margin:0;padding:0;border:0}
231
- .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
232
- .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
233
- .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
234
- .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
235
- .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
236
- .quoteblock .quoteblock blockquote:before{display:none}
237
- .verseblock{margin:0 1em 1.25em 1em}
238
- .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
239
- .verseblock pre strong{font-weight:400}
240
- .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
241
- .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
242
- .quoteblock .attribution br,.verseblock .attribution br{display:none}
243
- .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)}
244
- .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
245
- .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
246
- .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
247
- table.tableblock{max-width:100%;border-collapse:separate}
248
- table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
249
- table.spread{width:100%}
250
- table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
251
- table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
252
- table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
253
- table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
254
- table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
255
- table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
256
- table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
257
- table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
258
- table.frame-all{border-width:1px}
259
- table.frame-sides{border-width:0 1px}
260
- table.frame-topbot{border-width:1px 0}
261
- th.halign-left,td.halign-left{text-align:left}
262
- th.halign-right,td.halign-right{text-align:right}
263
- th.halign-center,td.halign-center{text-align:center}
264
- th.valign-top,td.valign-top{vertical-align:top}
265
- th.valign-bottom,td.valign-bottom{vertical-align:bottom}
266
- th.valign-middle,td.valign-middle{vertical-align:middle}
267
- table thead th,table tfoot th{font-weight:bold}
268
- tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
269
- tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
270
- p.tableblock>code:only-child{background:none;padding:0}
271
- p.tableblock{font-size:1em}
272
- td>div.verse{white-space:pre}
273
- ol{margin-left:1.75em}
274
- ul li ol{margin-left:1.5em}
275
- dl dd{margin-left:1.125em}
276
- dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
277
- ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
278
- ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
279
- ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
280
- ul.checklist li>p:first-child>.fa-check-square-o:first-child,ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
281
- ul.checklist li>p:first-child>input[type="checkbox"]:first-child{position:relative;top:1px}
282
- ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
283
- ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
284
- ul.inline>li>*{display:block}
285
- .unstyled dl dt{font-weight:400;font-style:normal}
286
- ol.arabic{list-style-type:decimal}
287
- ol.decimal{list-style-type:decimal-leading-zero}
288
- ol.loweralpha{list-style-type:lower-alpha}
289
- ol.upperalpha{list-style-type:upper-alpha}
290
- ol.lowerroman{list-style-type:lower-roman}
291
- ol.upperroman{list-style-type:upper-roman}
292
- ol.lowergreek{list-style-type:lower-greek}
293
- .hdlist>table,.colist>table{border:0;background:none}
294
- .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
295
- td.hdlist1{padding-right:.75em;font-weight:bold}
296
- td.hdlist1,td.hdlist2{vertical-align:top}
297
- .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
298
- .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
299
- .colist>table tr>td:last-of-type{padding:.25em 0}
300
- .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
301
- .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
302
- .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
303
- .imageblock>.title{margin-bottom:0}
304
- .imageblock.thumb,.imageblock.th{border-width:6px}
305
- .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
306
- .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
307
- .image.left{margin-right:.625em}
308
- .image.right{margin-left:.625em}
309
- a.image{text-decoration:none}
310
- span.footnote,span.footnoteref{vertical-align:super;font-size:.875em}
311
- span.footnote a,span.footnoteref a{text-decoration:none}
312
- span.footnote a:active,span.footnoteref a:active{text-decoration:underline}
313
- #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
314
- #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
315
- #footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em}
316
- #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
317
- #footnotes .footnote:last-of-type{margin-bottom:0}
318
- #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
319
- .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
320
- .gist .file-data>table td.line-data{width:99%}
321
- div.unbreakable{page-break-inside:avoid}
322
- .big{font-size:larger}
323
- .small{font-size:smaller}
324
- .underline{text-decoration:underline}
325
- .overline{text-decoration:overline}
326
- .line-through{text-decoration:line-through}
327
- .aqua{color:#00bfbf}
328
- .aqua-background{background-color:#00fafa}
329
- .black{color:#000}
330
- .black-background{background-color:#000}
331
- .blue{color:#0000bf}
332
- .blue-background{background-color:#0000fa}
333
- .fuchsia{color:#bf00bf}
334
- .fuchsia-background{background-color:#fa00fa}
335
- .gray{color:#606060}
336
- .gray-background{background-color:#7d7d7d}
337
- .green{color:#006000}
338
- .green-background{background-color:#007d00}
339
- .lime{color:#00bf00}
340
- .lime-background{background-color:#00fa00}
341
- .maroon{color:#600000}
342
- .maroon-background{background-color:#7d0000}
343
- .navy{color:#000060}
344
- .navy-background{background-color:#00007d}
345
- .olive{color:#606000}
346
- .olive-background{background-color:#7d7d00}
347
- .purple{color:#600060}
348
- .purple-background{background-color:#7d007d}
349
- .red{color:#bf0000}
350
- .red-background{background-color:#fa0000}
351
- .silver{color:#909090}
352
- .silver-background{background-color:#bcbcbc}
353
- .teal{color:#006060}
354
- .teal-background{background-color:#007d7d}
355
- .white{color:#bfbfbf}
356
- .white-background{background-color:#fafafa}
357
- .yellow{color:#bfbf00}
358
- .yellow-background{background-color:#fafa00}
359
- span.icon>.fa{cursor:default}
360
- .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
361
- .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
362
- .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
363
- .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
364
- .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
365
- .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
366
- .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
367
- .conum[data-value] *{color:#fff!important}
368
- .conum[data-value]+b{display:none}
369
- .conum[data-value]:after{content:attr(data-value)}
370
- pre .conum[data-value]{position:relative;top:-.125em}
371
- b.conum *{color:inherit!important}
372
- .conum:not([data-value]):empty{display:none}
373
- h1,h2{letter-spacing:-.01em}
374
- dt,th.tableblock,td.content{text-rendering:optimizeLegibility}
375
- p,td.content{letter-spacing:-.01em}
376
- p strong,td.content strong{letter-spacing:-.005em}
377
- p,blockquote,dt,td.content{font-size:1.0625rem}
378
- p{margin-bottom:1.25rem}
379
- .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
380
- .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
381
- .print-only{display:none!important}
382
- @media print{@page{margin:1.25cm .75cm}
383
- *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
384
- a{color:inherit!important;text-decoration:underline!important}
385
- a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
386
- a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after,a[href^="mailto:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
387
- abbr[title]:after{content:" (" attr(title) ")"}
388
- pre,blockquote,tr,img{page-break-inside:avoid}
389
- thead{display:table-header-group}
390
- img{max-width:100%!important}
391
- p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
392
- h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
393
- #toc,.sidebarblock,.exampleblock>.content{background:none!important}
394
- #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
395
- .sect1{padding-bottom:0!important}
396
- .sect1+.sect1{border:0!important}
397
- #header>h1:first-child{margin-top:1.25rem}
398
- body.book #header{text-align:center}
399
- body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
400
- body.book #header .details{border:0!important;display:block;padding:0!important}
401
- body.book #header .details span:first-child{margin-left:0!important}
402
- body.book #header .details br{display:block}
403
- body.book #header .details br+span:before{content:none!important}
404
- body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
405
- body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
406
- .listingblock code[data-lang]:before{display:block}
407
- #footer{background:none!important;padding:0 .9375em}
408
- #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
409
- .hide-on-print{display:none!important}
410
- .print-only{display:block!important}
411
- .hide-for-print{display:none!important}
412
- .show-for-print{display:inherit!important}}
413
- </style>
414
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.1.0/css/font-awesome.min.css">
415
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/github.min.css">
416
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script>
417
- <script>hljs.initHighlightingOnLoad()</script>
418
- </head>
419
- <body class="article toc2 toc-right">
420
- <div id="header">
421
- <h1><span class="icon"><i class="fa fa-book"></i></span> Brine User Guide</h1>
422
- <div class="details">
423
- <span id="author" class="author">Matt Whipple</span><br>
424
- <span id="email" class="email"><a href="http://github.com/mwhipple">@mwhipple</a></span><br>
425
- </div>
426
- <div id="toc" class="toc2">
427
- <div id="toctitle">Table of Contents</div>
428
- <ul class="sectlevel1">
429
- <li><a href="#_introduction">Introduction</a>
430
- <ul class="sectlevel2">
431
- <li><a href="#_motivation">Motivation</a></li>
432
- <li><a href="#_sample_usage">Sample Usage</a></li>
433
- <li><a href="#_key_features">Key Features</a></li>
434
- </ul>
435
- </li>
436
- <li><a href="#_installation">Installation</a></li>
437
- <li><a href="#_tutorial">Tutorial</a>
438
- <ul class="sectlevel2">
439
- <li><a href="#_selecting_a_root_url">Selecting a ROOT_URL</a></li>
440
- <li><a href="#_a_basic_get">A Basic GET</a></li>
441
- <li><a href="#_a_write_request">A Write Request</a></li>
442
- <li><a href="#_test_response_properties">Test Response Properties</a></li>
443
- </ul>
444
- </li>
445
- <li><a href="#_environment_variables">Environment Variables</a></li>
446
- <li><a href="#_language_conventions">Language Conventions</a>
447
- <ul class="sectlevel2">
448
- <li><a href="#_the_use_of_code_code_s">The use of <code>`</code>s</a></li>
449
- </ul>
450
- </li>
451
- <li><a href="#_selection_and_assertion">Selection and Assertion</a>
452
- <ul class="sectlevel2">
453
- <li><a href="#_selection_modifiers">Selection Modifiers</a></li>
454
- <li><a href="#_chained_assertions">Chained Assertions</a></li>
455
- </ul>
456
- </li>
457
- <li><a href="#_traversal_2">Traversal</a>
458
- <ul class="sectlevel2">
459
- <li><a href="#_cardinality">Cardinality</a></li>
460
- <li><a href="#_expressions">Expressions</a></li>
461
- </ul>
462
- </li>
463
- <li><a href="#_resource_cleanup">Resource Cleanup</a>
464
- <ul class="sectlevel2">
465
- <li><a href="#_step_indicating_resource_to_delete">Step indicating resource to DELETE</a></li>
466
- </ul>
467
- </li>
468
- <li><a href="#_step_reference">Step Reference</a>
469
- <ul class="sectlevel2">
470
- <li><a href="#_request_construction">Request Construction</a></li>
471
- <li><a href="#_cleanup">Cleanup</a></li>
472
- <li><a href="#_assignment">Assignment</a></li>
473
- <li><a href="#_selection">Selection</a></li>
474
- <li><a href="#_assertion">Assertion</a></li>
475
- </ul>
476
- </li>
477
- </ul>
478
- </div>
479
- </div>
480
- <div id="content">
481
- <div id="preamble">
482
- <div class="sectionbody">
483
- <div class="paragraph">
484
- <p>Cucumber DSL for testing REST APIs</p>
485
- </div>
486
- </div>
487
- </div>
488
- <div class="sect1">
489
- <h2 id="_introduction">Introduction</h2>
490
- <div class="sectionbody">
491
- <div class="sect2">
492
- <h3 id="_motivation">Motivation</h3>
493
- <div class="paragraph">
494
- <p>REpresentational State Transfer APIs expose their functionality
495
- through combinations of fairly coarse primitives that generally
496
- revolve around the use of transferring data in a standard exchange
497
- format (such as JSON) using HTTP methods and other aspects of the very
498
- simple HTTP protocol. Tests for such an API can therefore be defined
499
- using a domain specific language (DSL) built around those higher level
500
- ideas rather than requiring a general purpose language (the equivalent
501
- of scripted <code>curl</code> commands with some glue code and assertions).
502
- This project provides such a DSL by using select libraries
503
- integrated into Cucumber, where Cucumber provides a test-oriented
504
- framework for DSL creation.</p>
505
- </div>
506
- </div>
507
- <div class="sect2">
508
- <h3 id="_sample_usage">Sample Usage</h3>
509
- <div class="paragraph">
510
- <p>The general usage pattern revolves around construction of a request
511
- and performing assertions against the received response.</p>
512
- </div>
513
- <div class="listingblock">
514
- <div class="content">
515
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">When the request body is assigned:
516
- """
517
- {"first_name": "John",
518
- "last_name": "Smith"}
519
- """
520
- And a POST is sent to `/users`
521
- Then the value of the response status is equal to `200`
522
- And the value of the response body is including:
523
- """
524
- {"first_name": "John",
525
- "last_name": "Smith"}
526
- """</code></pre>
527
- </div>
528
- </div>
529
- </div>
530
- <div class="sect2">
531
- <h3 id="_key_features">Key Features</h3>
532
- <div class="dlist">
533
- <dl>
534
- <dt class="hdlist1">Variable Binding/Expansion</dt>
535
- <dd>
536
- <p>In cases where dynamic data is in the response or is desired for the
537
- request, then values can be bound to identifiers which can then be
538
- expanded using <a href="http://mustache.github.io">Mustache</a> templates in your
539
- feature files.</p>
540
- </dd>
541
- <dt class="hdlist1">Type Transforms</dt>
542
- <dd>
543
- <p>Different types of data can be expressed directly in the feature files
544
- or expanded into variables by using the appropriate syntax for that
545
- type.</p>
546
- </dd>
547
- <dt class="hdlist1">Type Coercion</dt>
548
- <dd>
549
- <p>Related to transforms, a facility to coerce types is also provided. This
550
- allows more intelligent comparison of inputs which have been transformed to a
551
- richer data type with those that have not been transformed (normally strings).
552
- As an example comparing a date/time value with a string will attempt to parse
553
- the string to a date/time so that the values can be compared using the proper
554
- semantics.</p>
555
- </dd>
556
- <dt class="hdlist1"><a href="#_resource_cleanup">Resource Cleanup</a></dt>
557
- <dd>
558
- <p>Tests are likely to create resources which should then be cleaned up,
559
- restoring the pre-test state of the system: steps to facilitate this
560
- are provided.</p>
561
- </dd>
562
- <dt class="hdlist1">Authentication</dt>
563
- <dd>
564
- <p>Presently OAuth2 is supported to issue authenticated requests during a
565
- test (likely using a feature <code>Background</code>).</p>
566
- </dd>
567
- <dt class="hdlist1">Request Construction and Response Assertion Step Definitions</dt>
568
- <dd>
569
- <p>The previous features combined with the library of provide steps should
570
- cover all of the functionality needed to exercise and validate all of
571
- the functionality exposed by your REST API.</p>
572
- </dd>
573
- </dl>
574
- </div>
575
- </div>
576
- </div>
577
- </div>
578
- <div class="sect1">
579
- <h2 id="_installation">Installation</h2>
580
- <div class="sectionbody">
581
- <div class="paragraph">
582
- <p>Brine is published as <code>brine-dsl</code> on rubygems, the page for which is
583
- at <a href="https://rubygems.org/gems/brine-dsl" class="bare">https://rubygems.org/gems/brine-dsl</a>. The latest version and other
584
- gem metadata can be viewed on that page. Brine can be used by
585
- declaring that gem in your project Gemfile such as:</p>
586
- </div>
587
- <div class="listingblock">
588
- <div class="content">
589
- <pre class="highlightjs highlight"><code class="language-ruby" data-lang="ruby">gem 'brine-dsl', '~&gt; 1.0'</code></pre>
590
- </div>
591
- </div>
592
- <div class="paragraph">
593
- <p>(after version 1.0 is released).</p>
594
- </div>
595
- <div class="paragraph">
596
- <p>Brine can then be "mixed in" to your project (which adds assorted
597
- modules to the <code>World</code> and loads all the step definitions and other
598
- Cucumber magic) by adding the following to your <code>support/env.rb</code> or
599
- other ruby file:</p>
600
- </div>
601
- <div class="listingblock">
602
- <div class="content">
603
- <pre class="highlightjs highlight"><code class="language-ruby" data-lang="ruby">require 'brine'
604
-
605
- World(brine_mix)</code></pre>
606
- </div>
607
- </div>
608
- <div class="paragraph">
609
- <p>Select pieces can also be loaded (to be documented). With the above,
610
- feature files should be able to be written and executed without
611
- requiring any additional ruby code.</p>
612
- </div>
613
- </div>
614
- </div>
615
- <div class="sect1">
616
- <h2 id="_tutorial">Tutorial</h2>
617
- <div class="sectionbody">
618
- <div class="paragraph">
619
- <p>We&#8217;ll write some tests against <a href="http://myjson.com/api" class="bare">http://myjson.com/api</a>
620
- (selected fairly arbitrary from the list at
621
- <a href="https://github.com/toddmotto/public-apis" class="bare">https://github.com/toddmotto/public-apis</a>).
622
- The API is being explored for the sake of this tutorial,
623
- which also serves to bolster this library to support the effort.</p>
624
- </div>
625
- <div class="sect2">
626
- <h3 id="_selecting_a_root_url">Selecting a ROOT_URL</h3>
627
- <div class="paragraph">
628
- <p>Brine expects steps to use relative URLs. The feature files specify
629
- the behavior of an API (or multiple APIs), while the root of the
630
- URLs define where that API is, so this is a natural mapping.
631
- More practically, when developing an API it&#8217;s likely to
632
- be promoted across various environments such as
633
- local, qa, stage, and production so having a parameterized root for
634
- the URLs eases this while encouraging inter-environment consistency.</p>
635
- </div>
636
- <div class="paragraph">
637
- <p>For simple cases where all tests are to be run against the same root,
638
- the root url can be specified with the environment variable <code>ROOT_URL</code>,
639
- such as <code>ROOT_URL=https://api.myjson.com/ cucumber</code>, or letting <code>rake</code>
640
- take care of this for you such as:</p>
641
- </div>
642
- <div class="listingblock">
643
- <div class="content">
644
- <pre class="highlightjs highlight"><code class="language-ruby" data-lang="ruby">Cucumber::Rake::Task.new do
645
- ENV['ROOT_URL'] = 'https://api.myjson.com/'
646
- end</code></pre>
647
- </div>
648
- </div>
649
- <div class="paragraph">
650
- <p>which could then be called with <code>rake cucumber</code>. The rake approach
651
- can be extended for different tasks for each environment, each
652
- of which sets the appropriate environment variables allowing the
653
- test code itself to follow
654
- <a href="https://12factor.net/config">Twelve-Factor App guidelines</a>
655
- where Rake provides sugary convenience.</p>
656
- </div>
657
- </div>
658
- <div class="sect2">
659
- <h3 id="_a_basic_get">A Basic GET</h3>
660
- <div class="paragraph">
661
- <p>Most tests will involve some form of issuing requests and performing assertions
662
- on the responses. Let&#8217;s start with a simple version of that pattern,
663
- testing the response status from a GET request.</p>
664
- </div>
665
- <div class="listingblock">
666
- <div class="content">
667
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Absent resources return 404s.
668
-
669
- Scenario: A request for a known missing resource.
670
- When a GET is sent to `/bins/brine-absent`
671
- Then the value of the response status is equal to `404`</code></pre>
672
- </div>
673
- </div>
674
- </div>
675
- <div class="sect2">
676
- <h3 id="_a_write_request">A Write Request</h3>
677
- <div class="paragraph">
678
- <p>For POST, PATCH and PUT requests you&#8217;ll normally want to include a request body.
679
- To support this, additional data can be added to the requests before they are
680
- sent (see <a href="#_request_construction">Request Construction</a>).</p>
681
- </div>
682
- <div class="listingblock">
683
- <div class="content">
684
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: A POST returns a 201.
685
-
686
- Scenario: A valid post.
687
- When the request body is assigned:
688
- """
689
- {"name": "boolean-setting",
690
- "value": true}
691
- """
692
- And a POST is sent to `/bins`
693
- Then the value of the response status is equal to `201`</code></pre>
694
- </div>
695
- </div>
696
- </div>
697
- <div class="sect2">
698
- <h3 id="_test_response_properties">Test Response Properties</h3>
699
- <div class="paragraph">
700
- <p>The API that was chosen for testing returns the link to the created resource
701
- which is based off of a generated id. That means that the exact response cannot
702
- be verified, but instead property based testing can be done to verify that the
703
- data is sane and therefore likely trustworthy. In this case we
704
- can check that the <code>uri</code> response child matches the expected pattern.</p>
705
- </div>
706
- <div class="listingblock">
707
- <div class="content">
708
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: A POST returns a link to the created resource.
709
-
710
- Scenario: A valid post.
711
- When the request body is assigned:
712
- """
713
- {"name": "boolean-setting",
714
- "value": true}
715
- """
716
- And a POST is sent to `/bins`
717
-
718
- Then the value of the response status is equal to `201`
719
- And the value of the response body child `uri` is matching `/https://api.myjson.com/bins/\w+/`</code></pre>
720
- </div>
721
- </div>
722
- </div>
723
- </div>
724
- </div>
725
- <div class="sect1">
726
- <h2 id="_environment_variables">Environment Variables</h2>
727
- <div class="sectionbody">
728
- <div class="paragraph">
729
- <p>Some Brine behavior can be tuned by passing it appropriate environment
730
- variables, listed here.</p>
731
- </div>
732
- <div class="dlist">
733
- <dl>
734
- <dt class="hdlist1"><code>BRINE_LOG_HTTP</code></dt>
735
- <dd>
736
- <p>Output HTTP traffic to stdout. Any truthy value will result in request and
737
- response metadata being logged, a value of <code>DEBUG</code> (case insensitive) will
738
- also log the bodies.</p>
739
- </dd>
740
- <dt class="hdlist1"><code>BRINE_LOG_BINDING</code></dt>
741
- <dd>
742
- <p>Log values as they are assigned to variables in Brine steps.</p>
743
- </dd>
744
- </dl>
745
- </div>
746
- </div>
747
- </div>
748
- <div class="sect1">
749
- <h2 id="_language_conventions">Language Conventions</h2>
750
- <div class="sectionbody">
751
- <div class="sect2">
752
- <h3 id="_the_use_of_code_code_s">The use of <code>`</code>s</h3>
753
- <div class="paragraph">
754
- <p>Backticks/grave accents are used as <em>parameter delimiters</em>. It is perhaps
755
- most helpful to think of them in those explicit terms rather than thinking of
756
- them as an alternate <em>quote</em> construct. In particular quoting implies that the
757
- parameter value is a string value, while the step transforms allow for
758
- alternative data types.</p>
759
- </div>
760
- <div class="paragraph">
761
- <p><code>`</code>s were chosen as they are less common than many other syntactical
762
- elements and also allow for the use of logically significant
763
- quoting within paremeter values while hopefully avoiding the need for escape
764
- artistry (as used for argument transforms).</p>
765
- </div>
766
- </div>
767
- </div>
768
- </div>
769
- <div class="sect1">
770
- <h2 id="_selection_and_assertion">Selection and Assertion</h2>
771
- <div class="sectionbody">
772
- <div class="paragraph">
773
- <p>As tests are generally concerned with performing assertions, a testing DSL
774
- should be able to express the variety of assertions that may be needed. Because
775
- these are likely to be numerous, it could easily lead to duplicated logic or
776
- geometric growth of code due to the combinations of types of assertions and the
777
- means to select the inputs for the assertion.</p>
778
- </div>
779
- <div class="paragraph">
780
- <p>To avoid this issue the concepts of selection and assertion are considered
781
- separate operations in Brine. Internally this corresponds to two steps: the
782
- first assigns a selector;
783
- the second passes the assertion to that selector which is responsible for
784
- applying the assertion against the selected value(s). In standard step use this
785
- will still be expressed as a single step,
786
- and dynamic step definitions are used to split the work appropriately.</p>
787
- </div>
788
- <div class="paragraph">
789
- <p>For example the step:</p>
790
- </div>
791
- <div class="listingblock">
792
- <div class="content">
793
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Then the value of the response body is equal to `foo`</code></pre>
794
- </div>
795
- </div>
796
- <div class="paragraph">
797
- <p>Will be split where the subject of the step (<code>the value of the response body</code>)
798
- defines the selector and the predicate of the step
799
- <code>is equal to `foo`</code> defines the assertion (which is translated to a
800
- step such as <code>Then it is equal to `foo`</code>).</p>
801
- </div>
802
- <div class="paragraph">
803
- <p>The result of this is that the assertion steps will always follow a pattern
804
- where the subject resembles <code>the value of &#8230;&#8203;</code> and the predicate always
805
- resembles <code>is &#8230;&#8203;</code>. Learning the selection phrases and the assertion phrases
806
- and combining them should be a more efficient and flexible way to become
807
- familiar with the language instead of focusing on the resulting combined steps.</p>
808
- </div>
809
- <div class="paragraph">
810
- <p>The chosen approach sacrifices eloquence for the sake of consistency.
811
- The predicate will always start with <code>is</code> which can lead to awkward language
812
- such as <code>is including</code> rather than simply <code>includes</code>.
813
- The consistency provides additional benefits such as consistent modification:
814
- for instance <code>is not</code> can always be use for negation rather than working out the
815
- appropriate phrasing for a more natural sounding step (let alone the logic).</p>
816
- </div>
817
- <div class="paragraph">
818
- <p>One of the secondary goals of this is that assertion step definitions should
819
- be very simple to write and modifiers (such as negation) should be provided for
820
- free to those definitions.
821
- As assertion definitions are likely to be numerous and potentially customized,
822
- this should help optimize code economy.</p>
823
- </div>
824
- <div class="sect2">
825
- <h3 id="_selection_modifiers">Selection Modifiers</h3>
826
- <div class="paragraph">
827
- <p>To pursue economical flexibility Brine steps attempt to balance step definitions
828
- which accommodate variations while keeping the step logic and patterns fairly
829
- simple. Selection steps in particular generally accept some parameters that
830
- affect their behavior. This allows the relatively small number of selection
831
- steps to provide the flexibility to empower the more numerous assertion steps.</p>
832
- </div>
833
- <div class="sect3">
834
- <h4 id="_traversal">Traversal</h4>
835
- <div class="paragraph">
836
- <p>Selection steps can generally target the root of the object specified (such as
837
- the response body) or some nodes within the object if it is a non-scalar value
838
- (for instance a child of the response body). This is indicated in the
839
- <a href="#_selection">step reference selection steps</a> by the <code>[$TRAVERSAL]</code> placeholder.
840
- <code>child `$EXPRESSION`</code> or <code>children `$EXPRESSION`</code> can
841
- optionally be inserted at the placeholder to select nested nodes as described
842
- in <a href="#_traversal_2">Traversal</a>.</p>
843
- </div>
844
- </div>
845
- <div class="sect3">
846
- <h4 id="_negation">Negation</h4>
847
- <div class="paragraph">
848
- <p>The selectors also currently handle negation of the associated assertions.
849
- This is potentially counter-intuitive but as previously mentioned the intent is
850
- that this should ease the creation of assertions. If negation is added to a
851
- selector that it is expected that the assertion will <em>fail</em>.</p>
852
- </div>
853
- <div class="paragraph">
854
- <p>Negation will be normally indicated in the
855
- <a href="#_selection">step reference selection steps</a> by the presence
856
- of the <code>[not]</code> placeholder. A similar placeholder may be used that is more
857
- readable but leads to an equivalent inversion of the semantics of the statement.
858
- To negate the step, the text within the <code>[]</code>s should be inserted
859
- in the indicated position.</p>
860
- </div>
861
- <div class="admonitionblock note">
862
- <table>
863
- <tr>
864
- <td class="icon">
865
- <i class="fa icon-note" title="Future Versions"></i>
866
- </td>
867
- <td class="content">
868
- Handling this in the selectors is (as mentioned) counter-intuitive and
869
- unnecessarily couples the selector to the assertion. It is currently done for
870
- practical reasons but is likely to be replaced in a future version after (or as
871
- part of) the initial port of the library to another platform. When it is
872
- replaced, all existing steps will remain supported through at least one more
873
- major revision and most should (most should remain unchanged).
874
- </td>
875
- </tr>
876
- </table>
877
- </div>
878
- </div>
879
- </div>
880
- <div class="sect2">
881
- <h3 id="_chained_assertions">Chained Assertions</h3>
882
- <div class="admonitionblock warning">
883
- <table>
884
- <tr>
885
- <td class="icon">
886
- <i class="fa icon-warning" title="Unsupported Feature"></i>
887
- </td>
888
- <td class="content">
889
- Use at your own risk, this feature is <strong>not presently supported</strong>.
890
- </td>
891
- </tr>
892
- </table>
893
- </div>
894
- <div class="paragraph">
895
- <p>For anyone that likes to live on the (relative) edge or if this gathers notable
896
- interest&#8230;&#8203;the above also provides an implicit feature: after a value is
897
- selected multiple assertions could be performed against it.</p>
898
- </div>
899
- <div class="paragraph">
900
- <p>For instance:</p>
901
- </div>
902
- <div class="listingblock">
903
- <div class="content">
904
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Then the value of the response body is equal to `foo`
905
- And it is of the type `String`</code></pre>
906
- </div>
907
- </div>
908
- <div class="paragraph">
909
- <p>Though this may work in simple cases the present design is likely to produce
910
- surprising results since some aspects (such as negation) are handled by the
911
- selector so it would be inherited by the conjunctions even though it wouldn&#8217;t
912
- read that way.</p>
913
- </div>
914
- </div>
915
- </div>
916
- </div>
917
- <div class="sect1">
918
- <h2 id="_traversal_2">Traversal</h2>
919
- <div class="sectionbody">
920
- <div class="paragraph">
921
- <p>The language exposed by Brine is flat but the data returned by the server is
922
- likely to include deeper data structures such as objects and collections. To
923
- allow selection within such structures a <code>traversal</code> language is embedded within
924
- some steps which will be indicated by the use of the <code>TRAVERSAL</code> placeholder.</p>
925
- </div>
926
- <div class="paragraph">
927
- <p>The traversal language consists of a selected subset of
928
- <a href="http://goessner.net/articles/JsonPath/">JsonPath</a>.</p>
929
- </div>
930
- <div class="admonitionblock note">
931
- <table>
932
- <tr>
933
- <td class="icon">
934
- <i class="fa icon-note" title="The Selected Subset"></i>
935
- </td>
936
- <td class="content">
937
- The subset of JsonPath functionality has been chosen that is believed to support
938
- all needed test cases without requiring deep familiarity with JsonPath. This may
939
- lead to more numerous simple steps in place of fewer steps that use unsupported
940
- expressions. Additionally Brine is intended to be ported to a range of platforms
941
- and so only those steps outlined here will be supported across those platforms.
942
- JsonPath expressions <em>not</em> listed below will not be explicitly disallowed but
943
- are not officially supported (will not be tested and will not be ported to
944
- another platform if needed).
945
- </td>
946
- </tr>
947
- </table>
948
- </div>
949
- <div class="sect2">
950
- <h3 id="_cardinality">Cardinality</h3>
951
- <div class="paragraph">
952
- <p>Each traversal expression will select <em>all</em> matching nodes which is therefore
953
- represented as a collection. Often, however, only a single node is expected or
954
- desired. Therefore the traversal expression will also be accompanied by a phrase
955
- which defines the expected cardinality, normally <code>child</code> vs. <code>children</code>.
956
- <code>children</code> will <em>always</em> return an array while <code>child</code> will return what would be
957
- the first element in that array. <code>child</code> should be used when accessing a
958
- specific node within the tree, while <code>children</code> should be used for what amounts
959
- to a query across multiple nodes (such as testing the value of a field for every
960
- element in a collection).</p>
961
- </div>
962
- </div>
963
- <div class="sect2">
964
- <h3 id="_expressions">Expressions</h3>
965
- <div class="dlist">
966
- <dl>
967
- <dt class="hdlist1"><code>.$KEY</code></dt>
968
- <dd>
969
- <p>Access the <code>KEY</code> named child of the starting node. The leading <code>.</code> can be
970
- omitted if at the start of an expression.</p>
971
- </dd>
972
- <dt class="hdlist1"><code>.[$INDEX]</code></dt>
973
- <dd>
974
- <p>Access the element of the array at index <code>INDEX</code></p>
975
- </dd>
976
- <dt class="hdlist1"><code>.[$FROM:$TO]</code></dt>
977
- <dd>
978
- <p>Access a slice of the array containing the elements at index <code>FROM</code> through
979
- <code>TO</code> (including both limits).</p>
980
- </dd>
981
- </dl>
982
- </div>
983
- </div>
984
- </div>
985
- </div>
986
- <div class="sect1">
987
- <h2 id="_resource_cleanup">Resource Cleanup</h2>
988
- <div class="sectionbody">
989
- <div class="paragraph">
990
- <p>All test suites should clean up after themselves as a matter of hygiene and to
991
- help enforce test independence and reproducibility. This is particularly
992
- important for this library given that it is likely the systems under test
993
- are likely to remain running; accumulated uncleaned resources are at best a
994
- nuisance to have to weed through and at worst raise some costs or other due to
995
- heightened consumption of assorted resources (as opposed to more ephemeral test
996
- environments).</p>
997
- </div>
998
- <div class="paragraph">
999
- <p>Brine therefore provides mechanisms to assist in cleaning up those resources
1000
- which are created as part of a test run. A conceptual hurdle for this type of
1001
- functionality is that it is very unlikely to be part of the feature that is
1002
- being specified, and therefore should ideally not be part of the specification.
1003
- Depending on the functionality (and arguably the
1004
- <a href="https://www.martinfowler.com/articles/richardsonMaturityModel.html">maturity</a>)
1005
- of the API, most or all of the cleanup can be automagically done based on
1006
- convention. There are tentative plans to support multiple techniques for
1007
- cleaning up resources based on how much can be implicitly
1008
- ascertained&#8230;&#8203;though presently there exists only one.</p>
1009
- </div>
1010
- <div class="sect2">
1011
- <h3 id="_step_indicating_resource_to_delete">Step indicating resource to DELETE</h3>
1012
- <div class="paragraph">
1013
- <p>If the API supports DELETE requests to remove created resources but it is either
1014
- desirable or necessary to specify what those resource PATHS are, a step can be
1015
- used to indicate which resources should be DELETEd upon test completion.</p>
1016
- </div>
1017
- <div class="paragraph">
1018
- <p><em>see <a href="#_cleanup">Cleanup Step Definitions</a></em></p>
1019
- </div>
1020
- </div>
1021
- </div>
1022
- </div>
1023
- <div class="sect1">
1024
- <h2 id="_step_reference">Step Reference</h2>
1025
- <div class="sectionbody">
1026
- <div class="sect2">
1027
- <h3 id="_request_construction">Request Construction</h3>
1028
- <div class="paragraph">
1029
- <p><a href="specs.html#_request_construction"><span class="icon"><i class="fa fa-cogs"></i></span> Specification</a></p>
1030
- </div>
1031
- <div class="paragraph">
1032
- <p>The requests which are sent as part of a test are constructed using
1033
- a <a href="https://en.wikipedia.org/wiki/Builder_pattern">Builder</a>.</p>
1034
- </div>
1035
- <div class="dlist">
1036
- <dl>
1037
- <dt class="hdlist1"><code>When a $METHOD is sent to `$PATH`</code></dt>
1038
- <dd>
1039
- <p>As every request to a REST API is likely to have a significant
1040
- HTTP <code>METHOD</code> and <code>PATH</code>, this step is considered required and is therefore
1041
- used to send the built request. This should therefore be the <strong>last</strong> step for
1042
- any given request that is being built.</p>
1043
- </dd>
1044
- <dt class="hdlist1"><code>When the request body is assigned:</code></dt>
1045
- <dd>
1046
- <p>The multiline content provided will be assigned to the body of the request.
1047
- This will normally likely be the JSON representation of data.</p>
1048
- </dd>
1049
- </dl>
1050
- </div>
1051
- <div class="paragraph">
1052
- <p><code>When the request query parameter `$PARAMETER` is assigned
1053
- `$VALUE`</code>::
1054
- Assign <code>VALUE</code> to the request query <code>PARAMETER</code>.
1055
- The value will be URL encoded and the key/value pair appended to the URL using
1056
- the appropriate <code>?</code> or <code>&amp;</code> delimiter.
1057
- The order of the parameters in the resulting URL should be considered
1058
- undefined.</p>
1059
- </div>
1060
- <div class="dlist">
1061
- <dl>
1062
- <dt class="hdlist1"><code>When the request header `$HEADER` is assigned `$VALUE`</code></dt>
1063
- <dd>
1064
- <p>Assign <code>VALUE</code> to the request header <code>HEADER</code>.
1065
- Will overwrite any earlier value for the specified header, including earlier
1066
- steps or defaults.</p>
1067
- </dd>
1068
- </dl>
1069
- </div>
1070
- </div>
1071
- <div class="sect2">
1072
- <h3 id="_cleanup">Cleanup</h3>
1073
- <div class="dlist">
1074
- <dl>
1075
- <dt class="hdlist1"><code>When a resouce is created at `$PATH`</code></dt>
1076
- <dd>
1077
- <p>Mark <code>PATH</code> as a resource to DELETE after the test is run.
1078
- See <a href="#_resource_cleanup">Resource Cleanup</a></p>
1079
- </dd>
1080
- </dl>
1081
- </div>
1082
- </div>
1083
- <div class="sect2">
1084
- <h3 id="_assignment">Assignment</h3>
1085
- <div class="paragraph">
1086
- <p><a href="specs.html#_assignment"><span class="icon"><i class="fa fa-cogs"></i></span> Specification</a></p>
1087
- </div>
1088
- <div class="dlist">
1089
- <dl>
1090
- <dt class="hdlist1"><code>When `$IDENTIFIER` is assigned `$VALUE`</code></dt>
1091
- <dd>
1092
- <p>Assigns <code>VALUE</code> to <code>IDENTIFIER</code>.</p>
1093
- </dd>
1094
- <dt class="hdlist1"><code>When `$IDENTIFIER` is assigned a random string</code></dt>
1095
- <dd>
1096
- <p>Assigns a random string (UUID) to <code>IDENTIFIER</code>.
1097
- This is particularly useful to assist with test isolation.</p>
1098
- </dd>
1099
- <dt class="hdlist1"><code>When `$IDENTIFIER` is assigned a timestamp</code></dt>
1100
- <dd>
1101
- <p>Assigns to <code>IDENTIFIER</code> a timestamp value representing the instant at
1102
- which the step was evaluated.</p>
1103
- </dd>
1104
- <dt class="hdlist1"><code>When `$IDENTIFIER` is assigned the response (body|status|headers) [$TRAVERSAL]</code></dt>
1105
- <dd>
1106
- <p>Assigns to <code>IDENTIFIER</code> the value extracted from the specified response
1107
- attribtute (at the optional traversal path).</p>
1108
- </dd>
1109
- </dl>
1110
- </div>
1111
- </div>
1112
- <div class="sect2">
1113
- <h3 id="_selection">Selection</h3>
1114
- <div class="paragraph">
1115
- <p><a href="specs.html#_selection"><span class="icon"><i class="fa fa-cogs"></i></span> Specification</a></p>
1116
- </div>
1117
- <div class="paragraph">
1118
- <p><em>see <a href="#_selection_and_assertion">Selection and Assertion</a></em></p>
1119
- </div>
1120
- <div class="paragraph">
1121
- <p><em>TODO: Replace all the explicit attributes.</em></p>
1122
- </div>
1123
- <div class="dlist">
1124
- <dl>
1125
- <dt class="hdlist1"><code>Then the value of the response (body|status|headers) is</code></dt>
1126
- <dd>
1127
- <p>Select the sepecified attribute of the current HTTP response.</p>
1128
- </dd>
1129
- <dt class="hdlist1"><code>Then the value of the response body [$TRAVERSAL] is [not]</code></dt>
1130
- <dd>
1131
- <p>Select the value from the body of the response.</p>
1132
- </dd>
1133
- <dt class="hdlist1"><code>Then the value of the response body [$TRAVERSAL] does have any element that is [not]</code></dt>
1134
- <dd>
1135
- <p>Select any (at least one) element from the structure within the response body.</p>
1136
- </dd>
1137
- <dt class="hdlist1"><code>Then the value of the response body [$TRAVERSAL] has elements which are all</code></dt>
1138
- <dd>
1139
- <p>Select all elements from the structure within the response body.</p>
1140
- </dd>
1141
- </dl>
1142
- </div>
1143
- </div>
1144
- <div class="sect2">
1145
- <h3 id="_assertion">Assertion</h3>
1146
- <div class="paragraph">
1147
- <p><a href="specs.html#_assertion"><span class="icon"><i class="fa fa-cogs"></i></span> Specification</a></p>
1148
- </div>
1149
- <div class="paragraph">
1150
- <p><em>see <a href="#_selection_and_assertion">Selection and Assertion</a></em></p>
1151
- </div>
1152
- <div class="dlist">
1153
- <dl>
1154
- <dt class="hdlist1"><code>Then it is equal to `$VALUE`</code></dt>
1155
- <dd>
1156
- <p>Assert that the current selected value is equivalent to <code>VALUE</code></p>
1157
- </dd>
1158
- <dt class="hdlist1"><code>Then it is matching `$VALUE`</code></dt>
1159
- <dd>
1160
- <p>Assert that the current select value matches the regular expression <code>VALUE</code></p>
1161
- </dd>
1162
- <dt class="hdlist1"><code>Then it is including `$VALUE`</code></dt>
1163
- <dd>
1164
- <p>Assert that the current select value includes/is a superset of <code>VALUE</code>.</p>
1165
- </dd>
1166
- <dt class="hdlist1"><code>Then it is empty</code></dt>
1167
- <dd>
1168
- <p>Assert that value is empty or null. Any type which is not testable for
1169
- emptiness (such as booleans or numbers) will always return false. Null is
1170
- treated as an empty value so that it can be treated as such for endpoints that
1171
- return null in place of empty collections, and non-null empty values can
1172
- easily be tested for using conjunction.</p>
1173
- </dd>
1174
- <dt class="hdlist1"><code>Then it is of length `$VALUE`</code></dt>
1175
- <dd>
1176
- <p>Assert that the value exposes a length attribute and the value of that
1177
- attribute is <code>VALUE</code>.</p>
1178
- </dd>
1179
- <dt class="hdlist1"><code>Then it is a valid `$TYPE`</code></dt>
1180
- <dd>
1181
- <p> Assert that the selected value is a valid instance of a <code>TYPE</code>. Presently this
1182
- is focused on standard data types (intially based on those specified by JSON),
1183
- but it is designed to handle user specified domain types pending some minor
1184
- wiring and documentation. The current supported types are:</p>
1185
- <div class="ulist">
1186
- <ul>
1187
- <li>
1188
- <p><code>Object</code>: A JSON style object/associative array</p>
1189
- </li>
1190
- <li>
1191
- <p><code>String</code></p>
1192
- </li>
1193
- <li>
1194
- <p><code>Number</code></p>
1195
- </li>
1196
- <li>
1197
- <p><code>Integer</code></p>
1198
- </li>
1199
- <li>
1200
- <p><code>Array</code></p>
1201
- </li>
1202
- <li>
1203
- <p><code>Boolean</code></p>
1204
- </li>
1205
- </ul>
1206
- </div>
1207
- </dd>
1208
- </dl>
1209
- </div>
1210
- </div>
1211
- </div>
1212
- </div>
1213
- </div>
1214
- <div id="footer">
1215
- <div id="footer-text">
1216
- Last updated 2018-06-17 22:38:06 EDT
1217
- </div>
1218
- </div>
1219
- </body>
1220
- </html>