<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="Asciidoctor 1.5.0"> <meta name="description" content="Specifications for Brine"> <meta name="keywords" content="Brine, Cucumber, RESt, DSL"> <meta name="author" content="Matt Whipple"> <title>Brine Specifications</title> <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"> <style> /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ /* Remove the comments around the @import statement below when using this as a custom stylesheet */ /*@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";*/ article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} audio,canvas,video{display:inline-block} audio:not([controls]){display:none;height:0} [hidden],template{display:none} script{display:none!important} html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} body{margin:0} a{background:transparent} a:focus{outline:thin dotted} a:active,a:hover{outline:0} h1{font-size:2em;margin:.67em 0} abbr[title]{border-bottom:1px dotted} b,strong{font-weight:bold} dfn{font-style:italic} hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} mark{background:#ff0;color:#000} code,kbd,pre,samp{font-family:monospace;font-size:1em} pre{white-space:pre-wrap} q{quotes:"\201C" "\201D" "\2018" "\2019"} small{font-size:80%} sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} sup{top:-.5em} sub{bottom:-.25em} img{border:0} svg:not(:root){overflow:hidden} figure{margin:0} fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} legend{border:0;padding:0} button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} button,input{line-height:normal} button,select{text-transform:none} button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} button[disabled],html input[disabled]{cursor:default} input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} textarea{overflow:auto;vertical-align:top} table{border-collapse:collapse;border-spacing:0} *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} html,body{font-size:100%} 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} a:hover{cursor:pointer} img,object,embed{max-width:100%;height:auto} object,embed{height:100%} img{-ms-interpolation-mode:bicubic} #map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} .left{float:left!important} .right{float:right!important} .text-left{text-align:left!important} .text-right{text-align:right!important} .text-center{text-align:center!important} .text-justify{text-align:justify!important} .hide{display:none} .antialiased,body{-webkit-font-smoothing:antialiased} img{display:inline-block;vertical-align:middle} textarea{height:auto;min-height:50px} select{width:100%} p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} .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} 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} a{color:#2156a5;text-decoration:underline;line-height:inherit} a:hover,a:focus{color:#1d4b8f} a img{border:none} p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} p aside{font-size:.875em;line-height:1.35;font-style:italic} 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} 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} h1{font-size:2.125em} h2{font-size:1.6875em} h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} h4,h5{font-size:1.125em} h6{font-size:1em} hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} em,i{font-style:italic;line-height:inherit} strong,b{font-weight:bold;line-height:inherit} small{font-size:60%;line-height:inherit} code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} ul.square{list-style-type:square} ul.circle{list-style-type:circle} ul.disc{list-style-type:disc} ul.no-bullet{list-style:none} ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} dl dt{margin-bottom:.3125em;font-weight:bold} dl dd{margin-bottom:1.25em} abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} abbr{text-transform:none} blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} blockquote cite:before{content:"\2014 \0020"} blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} h1{font-size:2.75em} h2{font-size:2.3125em} h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} table thead,table tfoot{background:#f7f8f7;font-weight:bold} 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} table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} 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} h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} .clearfix:after,.float-group:after{clear:both} *: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} 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} .keyseq{color:rgba(51,51,51,.8)} 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} .keyseq kbd:first-child{margin-left:0} .keyseq kbd:last-child{margin-right:0} .menuseq,.menu{color:rgba(0,0,0,.8)} b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} b.button:before{content:"[";padding:0 3px 0 2px} b.button:after{content:"]";padding:0 2px 0 3px} p a>code:hover{color:rgba(0,0,0,.9)} #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} #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} #header:after,#content:after,#footnotes:after,#footer:after{clear:both} #content{margin-top:1.25em} #content:before{content:none} #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} #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} #header .details span:first-child{margin-left:-.125em} #header .details span.email a{color:rgba(0,0,0,.85)} #header .details br{display:none} #header .details br+span:before{content:"\00a0\2013\00a0"} #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} #header .details br+span#revremark:before{content:"\00a0|\00a0"} #header #revnumber{text-transform:capitalize} #header #revnumber:after{content:"\00a0"} #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} #toc{border-bottom:1px solid #efefed;padding-bottom:.5em} #toc>ul{margin-left:.125em} #toc ul.sectlevel0>li>a{font-style:italic} #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} #toc a{text-decoration:none} #toc a:active{text-decoration:underline} #toctitle{color:#7a2518;font-size:1.2em} @media only screen and (min-width:768px){#toctitle{font-size:1.375em} body.toc2{padding-left:15em;padding-right:0} #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} #toc.toc2 #toctitle{margin-top:0;font-size:1.2em} #toc.toc2>ul{font-size:.9em;margin-bottom:0} #toc.toc2 ul ul{margin-left:0;padding-left:1em} #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} body.toc2.toc-right{padding-left:0;padding-right:15em} 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} #toc.toc2{width:20em} #toc.toc2 #toctitle{font-size:1.375em} #toc.toc2>ul{font-size:.95em} #toc.toc2 ul ul{padding-left:1.25em} 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} #content #toc>:first-child{margin-top:0} #content #toc>:last-child{margin-bottom:0} #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} #footer-text{color:rgba(255,255,255,.8);line-height:1.44} .sect1{padding-bottom:.625em} @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} #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} #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} #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} #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} #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} .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} .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} table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} .admonitionblock>table td.icon{text-align:center;width:80px} .admonitionblock>table td.icon img{max-width:none} .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} .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} .exampleblock>.content>:first-child{margin-top:0} .exampleblock>.content>:last-child{margin-bottom:0} .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} .sidebarblock>:first-child{margin-top:0} .sidebarblock>:last-child{margin-bottom:0} .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} .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} .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} .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} .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} .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} @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)} .listingblock pre.highlightjs{padding:0} .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} .listingblock pre.prettyprint{border-width:0} .listingblock>.content{position:relative} .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} .listingblock:hover code[data-lang]:before{display:block} .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} table.pyhltable td.code{padding-left:.75em;padding-right:0} pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} pre.pygments .lineno{display:inline-block;margin-right:.25em} table.pyhltable .linenodiv{background:none!important;padding-right:0!important} .quoteblock{margin:0 1em 1.25em 1.5em;display:table} .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} .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} .quoteblock blockquote{margin:0;padding:0;border:0} .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)} .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} .quoteblock .quoteblock blockquote{padding:0 0 0 .75em} .quoteblock .quoteblock blockquote:before{display:none} .verseblock{margin:0 1em 1.25em 1em} .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} .verseblock pre strong{font-weight:400} .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} .quoteblock .attribution br,.verseblock .attribution br{display:none} .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} .quoteblock.abstract{margin:0 0 1.25em 0;display:block} .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} table.tableblock{max-width:100%;border-collapse:separate} 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} table.spread{width:100%} table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} 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} table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} table.frame-all{border-width:1px} table.frame-sides{border-width:0 1px} table.frame-topbot{border-width:1px 0} th.halign-left,td.halign-left{text-align:left} th.halign-right,td.halign-right{text-align:right} th.halign-center,td.halign-center{text-align:center} th.valign-top,td.valign-top{vertical-align:top} th.valign-bottom,td.valign-bottom{vertical-align:bottom} th.valign-middle,td.valign-middle{vertical-align:middle} table thead th,table tfoot th{font-weight:bold} tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} p.tableblock>code:only-child{background:none;padding:0} p.tableblock{font-size:1em} td>div.verse{white-space:pre} ol{margin-left:1.75em} ul li ol{margin-left:1.5em} dl dd{margin-left:1.125em} dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} 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} ul.checklist li>p:first-child>input[type="checkbox"]:first-child{position:relative;top:1px} ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} ul.inline>li>*{display:block} .unstyled dl dt{font-weight:400;font-style:normal} ol.arabic{list-style-type:decimal} ol.decimal{list-style-type:decimal-leading-zero} ol.loweralpha{list-style-type:lower-alpha} ol.upperalpha{list-style-type:upper-alpha} ol.lowerroman{list-style-type:lower-roman} ol.upperroman{list-style-type:upper-roman} ol.lowergreek{list-style-type:lower-greek} .hdlist>table,.colist>table{border:0;background:none} .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} td.hdlist1{padding-right:.75em;font-weight:bold} td.hdlist1,td.hdlist2{vertical-align:top} .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} .colist>table tr>td:last-of-type{padding:.25em 0} .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} .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} .imageblock>.title{margin-bottom:0} .imageblock.thumb,.imageblock.th{border-width:6px} .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} .image.left{margin-right:.625em} .image.right{margin-left:.625em} a.image{text-decoration:none} span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} span.footnote a,span.footnoteref a{text-decoration:none} span.footnote a:active,span.footnoteref a:active{text-decoration:underline} #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} #footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} #footnotes .footnote:last-of-type{margin-bottom:0} #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} .gist .file-data>table td.line-data{width:99%} div.unbreakable{page-break-inside:avoid} .big{font-size:larger} .small{font-size:smaller} .underline{text-decoration:underline} .overline{text-decoration:overline} .line-through{text-decoration:line-through} .aqua{color:#00bfbf} .aqua-background{background-color:#00fafa} .black{color:#000} .black-background{background-color:#000} .blue{color:#0000bf} .blue-background{background-color:#0000fa} .fuchsia{color:#bf00bf} .fuchsia-background{background-color:#fa00fa} .gray{color:#606060} .gray-background{background-color:#7d7d7d} .green{color:#006000} .green-background{background-color:#007d00} .lime{color:#00bf00} .lime-background{background-color:#00fa00} .maroon{color:#600000} .maroon-background{background-color:#7d0000} .navy{color:#000060} .navy-background{background-color:#00007d} .olive{color:#606000} .olive-background{background-color:#7d7d00} .purple{color:#600060} .purple-background{background-color:#7d007d} .red{color:#bf0000} .red-background{background-color:#fa0000} .silver{color:#909090} .silver-background{background-color:#bcbcbc} .teal{color:#006060} .teal-background{background-color:#007d7d} .white{color:#bfbfbf} .white-background{background-color:#fafafa} .yellow{color:#bfbf00} .yellow-background{background-color:#fafa00} span.icon>.fa{cursor:default} .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} .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} .conum[data-value] *{color:#fff!important} .conum[data-value]+b{display:none} .conum[data-value]:after{content:attr(data-value)} pre .conum[data-value]{position:relative;top:-.125em} b.conum *{color:inherit!important} .conum:not([data-value]):empty{display:none} h1,h2{letter-spacing:-.01em} dt,th.tableblock,td.content{text-rendering:optimizeLegibility} p,td.content{letter-spacing:-.01em} p strong,td.content strong{letter-spacing:-.005em} p,blockquote,dt,td.content{font-size:1.0625rem} p{margin-bottom:1.25rem} .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} .print-only{display:none!important} @media print{@page{margin:1.25cm .75cm} *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} a{color:inherit!important;text-decoration:underline!important} a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} 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} abbr[title]:after{content:" (" attr(title) ")"} pre,blockquote,tr,img{page-break-inside:avoid} thead{display:table-header-group} img{max-width:100%!important} p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} #toc,.sidebarblock,.exampleblock>.content{background:none!important} #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} .sect1{padding-bottom:0!important} .sect1+.sect1{border:0!important} #header>h1:first-child{margin-top:1.25rem} body.book #header{text-align:center} body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} body.book #header .details{border:0!important;display:block;padding:0!important} body.book #header .details span:first-child{margin-left:0!important} body.book #header .details br{display:block} body.book #header .details br+span:before{content:none!important} body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} .listingblock code[data-lang]:before{display:block} #footer{background:none!important;padding:0 .9375em} #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} .hide-on-print{display:none!important} .print-only{display:block!important} .hide-for-print{display:none!important} .show-for-print{display:inherit!important}} </style> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.1.0/css/font-awesome.min.css"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/github.min.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script> <script>hljs.initHighlightingOnLoad()</script> </head> <body class="article toc2 toc-right"> <div id="header"> <h1><span class="icon"><i class="fa fa-cogs"></i></span> Brine Specifications</h1> <div class="details"> <span id="author" class="author">Matt Whipple</span><br> <span id="email" class="email"><a href="http://github.com/mwhipple">@mwhipple</a></span><br> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of Contents</div> <ul class="sectlevel1"> <li><a href="#_request_construction">Request Construction</a> <ul class="sectlevel2"> <li><a href="#__span_class_feature_name_basic_request_construction_span"><span class="feature name">Basic Request Construction</span></a></li> <li><a href="#__span_class_feature_name_assigning_a_request_body_span"><span class="feature name">Assigning a Request Body</span></a></li> <li><a href="#__span_class_feature_name_adding_query_parameters_span"><span class="feature name">Adding Query Parameters</span></a></li> <li><a href="#__span_class_feature_name_adding_headers_span"><span class="feature name">Adding Headers</span></a></li> <li><a href="#__span_class_feature_name_cleared_after_sent_span"><span class="feature name">Cleared After Sent</span></a></li> </ul> </li> <li><a href="#_resource_cleanup">Resource Cleanup</a> <ul class="sectlevel2"> <li><a href="#__span_class_feature_name_resource_cleanup_span"><span class="feature name">Resource Cleanup</span></a></li> </ul> </li> <li><a href="#_selection">Selection</a> <ul class="sectlevel2"> <li><a href="#__span_class_feature_name_any_element_span"><span class="feature name">Any Element</span></a></li> <li><a href="#__span_class_feature_name_all_elements_span"><span class="feature name">All Elements</span></a></li> </ul> </li> <li><a href="#_assertion">Assertion</a> <ul class="sectlevel2"> <li><a href="#__span_class_feature_name_equal_to_span"><span class="feature name">Equal to</span></a></li> <li><a href="#__span_class_feature_name_matching_span"><span class="feature name">Matching</span></a></li> <li><a href="#__span_class_feature_name_including_span"><span class="feature name">Including</span></a></li> <li><a href="#__span_class_feature_name_empty_span"><span class="feature name">Empty</span></a></li> <li><a href="#__span_class_feature_name_of_length_span"><span class="feature name">Of Length</span></a></li> <li><a href="#__span_class_feature_name_a_valid_span"><span class="feature name">A valid …​</span></a></li> </ul> </li> </ul> </div> </div> <div id="content"> <div class="sect1"> <h2 id="_request_construction">Request Construction</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="__span_class_feature_name_basic_request_construction_span"><span class="feature name">Basic Request Construction</span></h3> <div class="paragraph"> <p>A simple request with a specified method and path can be sent.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_varying_methods_span"><span class="scenario name">Varying Methods</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/basic_requests.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Sending a method Scenario: Basic URL Given expected <method> sent to `/profile` When a <method> is sent to `/profile` Then expected calls are verified</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/basic_requests.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">1 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> <div class="sect4"> <h5 id="__example_name_examples">[example name]#Examples #</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 100%;"> </colgroup> <tbody> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">method</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">POST</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">PATCH</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">DELETE</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">PUT</p></td> </tr> </tbody> </table> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_assigning_a_request_body_span"><span class="feature name">Assigning a Request Body</span></h3> <div class="sect3"> <h4 id="__span_class_scenario_name_request_with_body_span"><span class="scenario name">Request With Body</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/request_body.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Passing a body Scenario: Basic URL Given expected request body: """ {"request":1} """ And expected PUT sent to `/store` When the request body is assigned: """ {"request":1} """ When a PUT is sent to `/store` Then expected calls are verified</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/request_body.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">5 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_adding_query_parameters_span"><span class="feature name">Adding Query Parameters</span></h3> <div class="sect3"> <h4 id="__span_class_scenario_name_query_parameters_are_added_to_requests_span"><span class="scenario name">Query parameters are added to requests.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/params.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Request query parameters can be specified. Scenario: A single parameter is appended to the URL. Given expected GET sent to `/query?foo=bar` When the request query parameter `foo` is assigned `bar` And a GET is sent to `/query` Then expected calls are verified Scenario: Multiple parameters are appended to the URL with proper formatting. Given expected GET sent to `/query?foo=bar&baz=1` When the request query parameter `foo` is assigned `bar` And the request query parameter `baz` is assigned `1` And a GET is sent to `/query` Then expected calls are verified Scenario Outline: Values are encoded appropriately. Given expected GET sent to `/query?foo=<encoded>` When the request query parameter `foo` is assigned `<input>` And a GET is sent to `/query` Then expected calls are verified Examples: | input | encoded | | bar & grill | bar+%26+grill | | + + | %2B+%2B | | (imbalance)) | %28imbalance%29%29 | Scenario Outline: Parametes are added regardless of HTTP method. Given expected <method> sent to `/query?foo=bar` When the request query parameter `foo` is assigned `bar` And a <method> is sent to `/query` Then expected calls are verified Examples: | method | | POST | | PUT | | DELETE | | HEAD | | OPTIONS |</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/params.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">10 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_adding_headers_span"><span class="feature name">Adding Headers</span></h3> <div class="sect3"> <h4 id="__span_class_scenario_name_headers_are_added_to_requests_span"><span class="scenario name">Headers are added to requests.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/headers.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Request headers can be specified. Scenario: A new header with a single value is added to request. Given expected request headers: """ {"foo":"bar"} """ And expected GET sent to `/query` When the request header `foo` is assigned `bar` And a GET is sent to `/query` Then expected calls are verified Scenario: Default headers are present in requests. Given expected request headers: """ {"Content-Type": "application/json"} """ And expected GET sent to `/query` When a GET is sent to `/query` Then expected calls are verified Scenario: Default headers can be overridden. Given expected request headers: """ {"Content-Type": "text/plain"} """ And expected GET sent to `/query` When the request header `Content-Type` is assigned `text/plain` And a GET is sent to `/query` Then expected calls are verified Scenario: Array header values are added to requests. Given expected request headers: """ {"X-Array": "1, 2, 3"} """ And expected GET sent to `/query` When the request header `X-Array` is assigned `[1, 2, 3]` And a GET is sent to `/query` Then expected calls are verified Scenario: The last set value for a given header wins. Given expected request headers: """ {"foo":"baz"} """ And expected GET sent to `/query` When the request header `foo` is assigned `bar` And the request header `foo` is assigned `baz` And a GET is sent to `/query` Then expected calls are verified Scenario Outline: Header is added regardless of HTTP method. Given expected request headers: """ {"foo":"bar"} """ And expected <method> sent to `/query` When the request header `foo` is assigned `bar` And a <method> is sent to `/query` Then expected calls are verified Examples: | method | | POST | | PUT | | DELETE | | HEAD | | OPTIONS |</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/headers.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">10 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_cleared_after_sent_span"><span class="feature name">Cleared After Sent</span></h3> <div class="paragraph"> <p>After a request is sent, any values that were added to that request are cleared and will not be present in subsequent requests.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_request_is_cleared_before_second_send_span"><span class="scenario name">Request is Cleared Before Second Send</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/request_clearing.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Clearing the request. Scenario: Request body is cleared. Given expected request body: """ {"request":1} """ And expected PUT sent to `/profile` Given expected request body: """ """ And expected PUT sent to `/store` When the request body is assigned: """ {"request":1} """ And a PUT is sent to `/profile` And a PUT is sent to `/store` Then expected calls are verified Scenario: Request parameter Given expected GET sent to `/query?foo=bar` And expected GET sent to `/resource` Given the request query parameter `foo` is assigned `bar` And a GET is sent to `/query` When a GET is sent to `/resource` Then expected calls are verified</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/request_clearing.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">2 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> </div> </div> <div class="sect1"> <h2 id="_resource_cleanup">Resource Cleanup</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="__span_class_feature_name_resource_cleanup_span"><span class="feature name">Resource Cleanup</span></h3> <div class="paragraph"> <p>Resources created during testing can be marked for deletion.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_initial_success_span"><span class="scenario name">Initial Success</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/cleanup.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Resource Cleanup Scenario: Successful Basic Deletion Given expected DELETE sent to `/some/path` When a resource is created at `/some/path`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/cleanup.feature</code></p> </li> <li> <p><strong>Then</strong> the output should match %r<delete <a href="http://www.example.com/some/path>" class="bare">http://www.example.com/some/path></a>;</p> </li> <li> <p><strong>And</strong> the output should not contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">ERROR</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_returned_4xx_span"><span class="scenario name">Returned 4xx</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/cleanup_failure.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Resource Cleanup Scenario: Failed Deletion Given expected response status of `409` And expected DELETE sent to `/some/path` When a resource is created at `/some/path`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/cleanup_failure.feature</code></p> </li> <li> <p><strong>Then</strong> the output should match %r<(?:.<strong>delete <a href="http://www.example.com/some/path" class="bare">http://www.example.com/some/path</a>.</strong>){3}></p> </li> <li> <p><strong>And</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">ERROR</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_success_upon_retry_span"><span class="scenario name">Success Upon Retry</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/cleanup_retried.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Resource Cleanup Scenario: Success Upon Retry Given expected response status sequence of `[504, 200]` And expected DELETE sent to `/some/path` When a resource is created at `/some/path`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict -o ../../out.log features/cleanup_retried.feature</code></p> </li> <li> <p><strong>Then</strong> the output should match %r<(?:.<strong>delete <a href="http://www.example.com/some/path" class="bare">http://www.example.com/some/path</a>.</strong>){2}></p> </li> <li> <p><strong>And</strong> the output should not contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">ERROR</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_unreached_success_span"><span class="scenario name">Unreached Success</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/cleanup_unreached.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Resource Cleanup Scenario: Unreached Success Given expected response status sequence of `[504, 504, 504, 200]` And expected DELETE sent to `/some/path` When a resource is created at `/some/path`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict -o ../../out.log features/cleanup_unreached.feature</code></p> </li> <li> <p><strong>Then</strong> the output should match %r<(?:.<strong>delete <a href="http://www.example.com/some/path" class="bare">http://www.example.com/some/path</a>.</strong>){3}></p> </li> <li> <p><strong>And</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">ERROR</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> </div> </div> <div class="sect1"> <h2 id="_selection">Selection</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="__span_class_feature_name_any_element_span"><span class="feature name">Any Element</span></h3> <div class="paragraph"> <p>Assertions can be done against any element of a structure.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_assorted_positive_and_negative_assertions_span"><span class="scenario name">Assorted positive and negative assertions.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/any.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Allow selection of any structure element Scenario: List in response body When the response body is assigned: """ ["a", "b", "c"] """ Then the value of the response body does have any element that is equal to `a` And the value of the response body does not have any element that is equal to `d` Scenario: Nested list in response body When the response body is assigned: """ {"letters": ["a", "b", "c"]} """ Then the value of the response body child `letters` does have any element that is equal to `a` And the value of the response body child `letters` does not have any element that is equal to `d` Scenario: Map matches entries When the response body is assigned: """ {"a": 1, "b": 2} """ #Equality will match keys Then the value of the response body does have any element that is equal to `a` And the value of the response body does not have any element that is equal to `d` Scenario: Spread nested lists When the response body is assigned: """ [{"val":"foo"},{"val":"bar"}] """ Then the value of the response body children `..val` does have any element that is equal to `foo` And the value of the response body children `..val` does not have any element that is equal to `other`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/any.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">4 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_all_elements_span"><span class="feature name">All Elements</span></h3> <div class="paragraph"> <p>Assertions can be done against all elements of a structure.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_assorted_positive_and_negative_assertions_span_2"><span class="scenario name">Assorted positive and negative assertions.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/all.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Allow selection of all structure elements Scenario: List in response body When the response body is assigned: """ ["a", "bb", "ccc"] """ Then the value of the response body has elements which are all matching `/\w+/` Scenario: Spread nested lists When the response body is assigned: """ [{"val": "foo"},{"val": "foo"}] """ Then the value of the response body children `..val` has elements which are all equal to `foo`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/all.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">4 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_failing_tests_since_negation_isn_t_available_yet_span"><span class="scenario name">Failing tests since negation isn’t available yet.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/all.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Allow selection of all structure elements Scenario: List in response body When the response body is assigned: """ ["a", "bb", "ccc"] """ Then the value of the response body has elements which are all matching `/^\w$/` Scenario: Spread nested lists When the response body is assigned: """ [{"val": "foo"},{"val": "fob"}] """ Then the value of the response body children `..val` has elements which are all equal to `foo`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/all.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">2 failed</code></pre> </div> </div> </div> </div> </div> </div> <div class="sect1"> <h2 id="_assertion">Assertion</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="__span_class_feature_name_equal_to_span"><span class="feature name">Equal to</span></h3> <div class="paragraph"> <p>It can be asserted that a value is equal to another value.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_assorted_positive_and_negative_assertions_pass_span"><span class="scenario name">Assorted positive and negative assertions pass.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/is_equal_to.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Assert value equality Scenario: String in response body When the response body is assigned: """ foo """ Then the value of the response body is equal to `foo` And the value of the response body is not equal to `foot` Scenario: Response Status When the response status is assigned `404` Then the value of the response status is equal to `404` And the value of the response status is not equal to `200` Scenario: Object in response body When the response body is assigned: """ { "foo": "bar" } """ Then the value of the response body is equal to: """ {"foo":"bar"} """ And the value of the response body is not equal to: """ {"foo": "baz"} """ Scenario: List in response body When the response body is assigned `[1, "foo", true]` Then the value of the response body is equal to `[1, "foo", true]` And the value of the response body is not equal to `[1, "bar", true]` Scenario Outline: Objects must match completely When the response body is assigned `{"foo": "bar", "baz": 1}` Then the value of the response body is not equal to `<comparison>` Examples: | comparison | | {} | | {"foo": "bar"} | | {"foo": "bar", "baz": 1, "extra": 2} | | {"foo": "bar", "baz": 2} |</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/is_equal_to.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">8 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_matching_span"><span class="feature name">Matching</span></h3> <div class="paragraph"> <p>It can be asserted that a value matches another string or regex.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_assorted_positive_and_negative_assertions_span_3"><span class="scenario name">Assorted positive and negative assertions.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/is_matching.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Assert value matchiness. Scenario: String in response body is matched against a regex. When the response body is assigned: """ http://www.github.com?var=val """ Then the value of the response body is matching `/github/` And the value of the response body is matching `/git.*\?.*=/` And the value of the response body is not matching `/gh/` And the value of the response body is not matching `/^github/` Scenario: Regex in response body matched against a string When the response body is assigned: """ /(.+)\1/ """ Then the value of the response body is matching `blahblah` And the value of the response body is matching `boo` And the value of the response body is not matching `blah blah` And the value of the response body is not matching `blah`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/is_matching.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">2 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_including_span"><span class="feature name">Including</span></h3> <div class="paragraph"> <p>It can be asserted that a value is a superset of another value.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_includes_span"><span class="scenario name">Includes</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/includes.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Includes Scenario: Basic object membership When the response body is assigned: """ {"foo":"bar", "baz": 1, "other": "blah"} """ Then the value of the response body is including: """ {"baz":1} """ And the value of the response body is not including: """ {"missing":"value"} """ And the value of the response body is including `other` And the value of the response body is not including `brother` And the value of the response body is not including `value`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/includes.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">1 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_empty_span"><span class="feature name">Empty</span></h3> <div class="paragraph"> <p>It can be asserted that a value is empty.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_assorted_positive_and_negative_assertions_pass_span_2"><span class="scenario name">Assorted positive and negative assertions pass.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/is_empty.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Assert emptiness for multiple types. Scenario: Empty body is empty. When the response body is assigned `` Then the value of the response body is empty Scenario: Whitespace-only body is empty. When the response body is assigned: """ """ Then the value of the response body is empty Scenario: Empty string is empty. When the response body is assigned `""` Then the value of the response body is empty Scenario: Non-empty string is not empty. When the response body is assigned `blah` Then the value of the response body is not empty Scenario: Quoted whitespace is not empty. When the response body is assigned `" "` Then the value of the response body is not empty Scenario: Empty arrays are empty. When the response body is assigned `[]` Then the value of the response body is empty Scenario: Non-empty arrays are not empty. When the response body is assigned `[[]]` Then the value of the response body is not empty Scenario: Empty objects are empty. When the response body is assigned `{}` Then the value of the response body is empty Scenario: Non-empty objects are not empty. When the response body is assigned `{"foo":{}}` Then the value of the response body is not empty Scenario: Null values are empty. When the response body is assigned `{"foo": null}` Then the value of the response body child `foo` is empty Scenario: False is not empty. When the response body is assigned `false` Then the value of the response body is not empty Scenario: 0 is not empty. When the response body is assigned `0` Then the value of the response body is not empty</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/is_empty.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">12 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_of_length_span"><span class="feature name">Of Length</span></h3> <div class="paragraph"> <p>It can be asserted that a value has a provided length.</p> </div> <div class="sect3"> <h4 id="__span_class_scenario_name_has_length_span"><span class="scenario name">Has Length</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/has_length.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Has Length Scenario: String When the response body is assigned: """ blah """ Then the value of the response body is of length `4` Scenario: Array When the response body is assigned: """ ["foo", "blah"] """ Then the value of the response body is of length `2` Scenario: Map When the response body is assigned: """ {"foo": "blah"} """ Then the value of the response body is of length `1` Scenario: Value without length attribute When the response body is assigned: """ true """ Then the value of the response body is not of length `1`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber features/has_length.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">4 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> <div class="sect2"> <h3 id="__span_class_feature_name_a_valid_span"><span class="feature name">A valid …​</span></h3> <div class="sect3"> <h4 id="__span_class_scenario_name_positive_and_negative_assertions_for_json_types_span"><span class="scenario name">Positive and negative assertions for JSON types.</span></h4> <div class="ulist step-list"> <ul> <li> <p><strong>Given</strong> a file named "features/is_a_valid.feature" with:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">Feature: Assert type validity Scenario: String in response body is only a valid String. When the response body is assigned: """ foo """ Then the value of the response body is a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Integer in response body is a valid Integer and Number. When the response body is assigned: """ 1 """ Then the value of the response body is not a valid `String` And the value of the response body is a valid `Number` And the value of the response body is a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Quoted Number in response body is only a valid String. When the response body is assigned: """ "1" """ Then the value of the response body is a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Empty Object in response body is only a valid Object. When the response body is assigned: """ {} """ Then the value of the response body is not a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Object in response body is only a valid Object. When the response body is assigned: """ {"foo": 1} """ Then the value of the response body is not a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Quoted Object in response body is only a valid String. When the response body is assigned: """ "{"foo": 1}" """ Then the value of the response body is a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Empty Array in response body is only a valid Array. When the response body is assigned: """ [] """ Then the value of the response body is not a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: Array in response body is only a valid Array. When the response body is assigned: """ [1, "foo"] """ Then the value of the response body is not a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is a valid `Array` And the value of the response body is not a valid `Boolean` Scenario: true in response body is only a valid Boolean. When the response body is assigned: """ true """ Then the value of the response body is not a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is a valid `Boolean` Scenario: false in response body is only a valid Boolean. When the response body is assigned: """ false """ Then the value of the response body is not a valid `String` And the value of the response body is not a valid `Number` And the value of the response body is not a valid `Integer` And the value of the response body is not a valid `Object` And the value of the response body is not a valid `Array` And the value of the response body is a valid `Boolean` Scenario: null in response body is not any valid type. When the response body is assigned: """ [null] """ Then the value of the response body child `[0]` is not a valid `String` And the value of the response body child `[0]` is not a valid `Number` And the value of the response body child `[0]` is not a valid `Integer` And the value of the response body child `[0]` is not a valid `Object` And the value of the response body child `[0]` is not a valid `Array` And the value of the response body child `[0]` is not a valid `Boolean` Scenario: Selected Array child is a valid Array. When the response body is assigned: """ {"val": [1, 2, 3]} """ Then the value of the response body child `val` is a valid `Array` Scenario: Selected Array child member is a valid String. When the response body is assigned: """ {"val": [1, 2, 3]} """ Then the value of the response body child `val[0]` is a valid `Number` Then the value of the response body child `val[0]` is a valid `Integer` Scenario: Selected nested children are a valid Array. When the response body is assigned: """ [{"val": 1},{"val": 2}] """ Then the value of the response body children `.val` is a valid `Array` Scenario: Selected nested children can be tested for type. When the response body is assigned: """ [{"val": 1},{"val": 2}] """ Then the value of the response body children `.val` has elements which are all a valid `Number` Then the value of the response body children `.val` has elements which are all a valid `Integer` Scenario: Selected nested children can be tested for type when Arrays. When the response body is assigned: """ [{"val": [1]},{"val": [2]}] """ Then the value of the response body children `.val` has elements which are all a valid `Array`</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>When</strong> I run <code>cucumber --strict features/is_a_valid.feature</code></p> </li> <li> <p><strong>Then</strong> the output should contain:</p> </li> </ul> </div> <div class="listingblock"> <div class="content"> <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">16 passed</code></pre> </div> </div> <div class="ulist"> <ul> <li> <p><strong>And</strong> it should pass</p> </li> </ul> </div> </div> </div> </div> </div> </div> <div id="footer"> <div id="footer-text"> Last updated 2018-05-30 13:07:46 EDT </div> </div> </body> </html>