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
data/.gitignore DELETED
@@ -1,3 +0,0 @@
1
- pkg/
2
- tmp
3
- .gradle
@@ -1,11 +0,0 @@
1
- language: ruby
2
- rvm:
3
- - 2.3
4
- - 2.4
5
- deploy:
6
- provider: rubygems
7
- gem: brine-dsl
8
- api_key:
9
- secure: QrX84AYqIs2Mz/5SaziW528tWzhx6pBZg93rwGWk8FyCjTZd2yILm+1O2BE/52JQclk/9lbJqzjJYsEirCC+5CmvddojiQCpX/ABeIbBq/DhNjomKf0L+tVglcZMbC/n3Xl6Xaa2kWv00mXxn71Ndj+uqCBq7oPXEZ6Z9Bf2x+Fz4+Mb0yN7tylCsQJ7WUR+EuMccXJ/eRIeVLlBqDtu7Ki534kKwOKWarkGvmvJMaXDRUSVm4dYkLDE+byoZTqu2LhcRcchCQauatDjMIv+NEhoVF9nvJPaFfSBnV64i+RwVIDemNgtSAGfZxmw6Jlf8ZWnlNDCvkXqN4dypqrlIiIZpeJpAZg0zj48sV6PNNNqr5xPgepTbNw8ShUHIQr9E8m9ePnyf1kg6FtkbnP0HYuabNw3XMIa7ZTzeCfKH6hwHFpBfNntZO9Ph6mhBsx3VkBq1RzjM3JKGOQqILsq3EZJdwRL5r+WWp8J6FtHWMfsHxQ5Fj4bAZPBYHKyamLEl14l/grnl+PussGT09DYkDInnmihprHw/5Pl/lOJk7OtmrNB2OrRlDt9spsua4P+sZdiQwqnG/p2UXQSeShQoYbm4pgqrbfKUF3Bye3uYhujXfCu2/vEN9ddv2UBKCCZA/iqZohmZbGZadeayBLLVvB/CTFzEI5z9ya0f8TDTzo=
10
- on:
11
- tags: true
@@ -1,170 +0,0 @@
1
- # Change Log
2
-
3
- ## [v0.6.0](https://github.com/brightcove/brine/tree/v0.6.0) (2018-02-08)
4
- [Full Changelog](https://github.com/brightcove/brine/compare/v0.5.0...v0.6.0)
5
-
6
- **Closed issues:**
7
-
8
- - Assertion for empty values [\#99](https://github.com/brightcove/brine/issues/99)
9
-
10
- **Merged pull requests:**
11
-
12
- - Expose Faraday middleware extensibility [\#102](https://github.com/brightcove/brine/pull/102) ([mwhipple](https://github.com/mwhipple))
13
- - Add is\_empty assertion \(Fix \#99\) [\#100](https://github.com/brightcove/brine/pull/100) ([mwhipple](https://github.com/mwhipple))
14
-
15
- ## [v0.5.0](https://github.com/brightcove/brine/tree/v0.5.0) (2017-12-05)
16
- [Full Changelog](https://github.com/brightcove/brine/compare/0.5.0...v0.5.0)
17
-
18
- **Closed issues:**
19
-
20
- - Publish first Gem [\#83](https://github.com/brightcove/brine/issues/83)
21
-
22
- **Merged pull requests:**
23
-
24
- - Add travis config; rename gem \(Fix \#83\) [\#94](https://github.com/brightcove/brine/pull/94) ([mwhipple](https://github.com/mwhipple))
25
-
26
- ## [0.5.0](https://github.com/brightcove/brine/tree/0.5.0) (2017-12-05)
27
- [Full Changelog](https://github.com/brightcove/brine/compare/0.4.0...0.5.0)
28
-
29
- **Fixed bugs:**
30
-
31
- - Pin cucumber version [\#85](https://github.com/brightcove/brine/issues/85)
32
-
33
- **Closed issues:**
34
-
35
- - Assess custom testing "store" vs. Faraday doubles [\#89](https://github.com/brightcove/brine/issues/89)
36
- - Integer type matching [\#82](https://github.com/brightcove/brine/issues/82)
37
- - Publish/Open Source [\#78](https://github.com/brightcove/brine/issues/78)
38
- - GitHub access for Brightcove [\#76](https://github.com/brightcove/brine/issues/76)
39
- - RFC: Object Traversal Syntax [\#62](https://github.com/brightcove/brine/issues/62)
40
- - make cleanup delete retries more intentional [\#31](https://github.com/brightcove/brine/issues/31)
41
-
42
- **Merged pull requests:**
43
-
44
- - Pin cucumber version \(Fix \#85\) [\#93](https://github.com/brightcove/brine/pull/93) ([mwhipple](https://github.com/mwhipple))
45
- - Slightly less optimistic cleanup calls \(Fix \#31\) [\#92](https://github.com/brightcove/brine/pull/92) ([mwhipple](https://github.com/mwhipple))
46
- - tests: Replace `store` with Faraday doubles [\#90](https://github.com/brightcove/brine/pull/90) ([mwhipple](https://github.com/mwhipple))
47
- - Add type checking for Integers \(Fix \#82\) [\#88](https://github.com/brightcove/brine/pull/88) ([mwhipple](https://github.com/mwhipple))
48
- - Support specifying request header values [\#80](https://github.com/brightcove/brine/pull/80) ([mwhipple](https://github.com/mwhipple))
49
- - Add LICENSE [\#79](https://github.com/brightcove/brine/pull/79) ([mwhipple](https://github.com/mwhipple))
50
- - Update docs; Cleanup [\#74](https://github.com/brightcove/brine/pull/74) ([mwhipple](https://github.com/mwhipple))
51
-
52
- ## [0.4.0](https://github.com/brightcove/brine/tree/0.4.0) (2017-09-20)
53
- [Full Changelog](https://github.com/brightcove/brine/compare/0.3.3...0.4.0)
54
-
55
- **Closed issues:**
56
-
57
- - RFC: New Documentation solution [\#70](https://github.com/brightcove/brine/issues/70)
58
- - Replace docs [\#68](https://github.com/brightcove/brine/issues/68)
59
- - Enforce ruby version [\#38](https://github.com/brightcove/brine/issues/38)
60
- - Type tests [\#63](https://github.com/brightcove/brine/issues/63)
61
-
62
- **Merged pull requests:**
63
-
64
- - Support request query parameters [\#72](https://github.com/brightcove/brine/pull/72) ([mwhipple](https://github.com/mwhipple))
65
- - Initial User Guide \(Fixes \#70, \#68\) [\#71](https://github.com/brightcove/brine/pull/71) ([mwhipple](https://github.com/mwhipple))
66
-
67
- ## [0.3.3](https://github.com/brightcove/brine/tree/0.3.3) (2017-09-19)
68
- [Full Changelog](https://github.com/brightcove/brine/compare/0.3.2...0.3.3)
69
-
70
- **Closed issues:**
71
-
72
- - RFC: Switch back to jsonpath [\#59](https://github.com/brightcove/brine/issues/59)
73
-
74
- **Merged pull requests:**
75
-
76
- - JSONPath for Traversal \(POC for \#62\) [\#65](https://github.com/brightcove/brine/pull/65) ([mwhipple](https://github.com/mwhipple))
77
- - Add assertions for JSON types \(Fix \#63\) [\#64](https://github.com/brightcove/brine/pull/64) ([mwhipple](https://github.com/mwhipple))
78
-
79
- ## [0.3.2](https://github.com/brightcove/brine/tree/0.3.2) (2017-08-10)
80
- [Full Changelog](https://github.com/brightcove/brine/compare/0.3.1...0.3.2)
81
-
82
- **Merged pull requests:**
83
-
84
- - adding options and head request methods [\#61](https://github.com/brightcove/brine/pull/61) ([tnc5484](https://github.com/tnc5484))
85
-
86
- ## [0.3.1](https://github.com/brightcove/brine/tree/0.3.1) (2017-08-03)
87
- [Full Changelog](https://github.com/brightcove/brine/compare/0.3.0...0.3.1)
88
-
89
- **Closed issues:**
90
-
91
- - improve HTTP logging [\#49](https://github.com/brightcove/brine/issues/49)
92
-
93
- **Merged pull requests:**
94
-
95
- - Log HTTP bodies with DEBUG \(Fix \#49\) [\#55](https://github.com/brightcove/brine/pull/55) ([mwhipple](https://github.com/mwhipple))
96
-
97
- ## [0.3.0](https://github.com/brightcove/brine/tree/0.3.0) (2017-07-28)
98
- [Full Changelog](https://github.com/brightcove/brine/compare/0.2.0...0.3.0)
99
-
100
- **Implemented enhancements:**
101
-
102
- - Define step for binding a timestamp [\#14](https://github.com/brightcove/brine/issues/14)
103
-
104
- **Fixed bugs:**
105
-
106
- - Deprecation code is not requoting values, leading to undefined steps. [\#39](https://github.com/brightcove/brine/issues/39)
107
-
108
- **Closed issues:**
109
-
110
- - RFC: Temple expansions everywhere [\#19](https://github.com/brightcove/brine/issues/19)
111
- - Selectors for list membership [\#37](https://github.com/brightcove/brine/issues/37)
112
- - replace jsonpath with object traversal [\#5](https://github.com/brightcove/brine/issues/5)
113
- - support regex in including [\#3](https://github.com/brightcove/brine/issues/3)
114
-
115
- **Merged pull requests:**
116
-
117
- - Add all selector [\#53](https://github.com/brightcove/brine/pull/53) ([mwhipple](https://github.com/mwhipple))
118
- - Improved path traversal and any selector \(Fix \#37\) [\#52](https://github.com/brightcove/brine/pull/52) ([mwhipple](https://github.com/mwhipple))
119
- - Support for regexp and is\_matching assertion \(Fix \#3\) [\#51](https://github.com/brightcove/brine/pull/51) ([mwhipple](https://github.com/mwhipple))
120
-
121
- ## [0.2.0](https://github.com/brightcove/brine/tree/0.2.0) (2017-06-29)
122
- [Full Changelog](https://github.com/brightcove/brine/compare/0.1.0...0.2.0)
123
-
124
- **Closed issues:**
125
-
126
- - Support calling multiple services [\#28](https://github.com/brightcove/brine/issues/28)
127
-
128
- **Merged pull requests:**
129
-
130
- - Support multiple clients [\#47](https://github.com/brightcove/brine/pull/47) ([mwhipple](https://github.com/mwhipple))
131
-
132
- ## [0.1.0](https://github.com/brightcove/brine/tree/0.1.0) (2017-06-26)
133
- **Fixed bugs:**
134
-
135
- - replaced\_with fights with step transformation [\#30](https://github.com/brightcove/brine/issues/30)
136
- - Whitespace transform can overflow the stack [\#23](https://github.com/brightcove/brine/issues/23)
137
-
138
- **Closed issues:**
139
-
140
- - RFC: Subject selection in assertions [\#26](https://github.com/brightcove/brine/issues/26)
141
- - Define deprecation policy [\#25](https://github.com/brightcove/brine/issues/25)
142
- - Add Guard to Rake [\#20](https://github.com/brightcove/brine/issues/20)
143
- - RFC: Flipped data comparison [\#18](https://github.com/brightcove/brine/issues/18)
144
- - RFC: Prefer JSON deserialization over tables [\#17](https://github.com/brightcove/brine/issues/17)
145
- - construction of deeper request values. [\#16](https://github.com/brightcove/brine/issues/16)
146
- - README [\#11](https://github.com/brightcove/brine/issues/11)
147
- - parallelized execution [\#9](https://github.com/brightcove/brine/issues/9)
148
- - add support for randomization [\#8](https://github.com/brightcove/brine/issues/8)
149
- - tests [\#7](https://github.com/brightcove/brine/issues/7)
150
- - replace oauth2 with faraday middleware [\#6](https://github.com/brightcove/brine/issues/6)
151
- - merge child with non child body matchers [\#4](https://github.com/brightcove/brine/issues/4)
152
- - register cleanup hook [\#2](https://github.com/brightcove/brine/issues/2)
153
-
154
- **Merged pull requests:**
155
-
156
- - Some fixes [\#44](https://github.com/brightcove/brine/pull/44) ([mwhipple](https://github.com/mwhipple))
157
- - Minor patches [\#41](https://github.com/brightcove/brine/pull/41) ([mwhipple](https://github.com/mwhipple))
158
- - Add multiline child selector [\#40](https://github.com/brightcove/brine/pull/40) ([mwhipple](https://github.com/mwhipple))
159
- - Switch DateTime to Time for more flexibility [\#36](https://github.com/brightcove/brine/pull/36) ([mwhipple](https://github.com/mwhipple))
160
- - `include` assertion; multiline structure transforms [\#35](https://github.com/brightcove/brine/pull/35) ([mwhipple](https://github.com/mwhipple))
161
- - \[WIP\] Support for dates; deprecation; selector and assertion split [\#29](https://github.com/brightcove/brine/pull/29) ([mwhipple](https://github.com/mwhipple))
162
- - Adjust regex for multiline string; bind response directly [\#24](https://github.com/brightcove/brine/pull/24) ([mwhipple](https://github.com/mwhipple))
163
- - initial request construction extraction and clearing of state [\#22](https://github.com/brightcove/brine/pull/22) ([mwhipple](https://github.com/mwhipple))
164
- - Add Guard \(Fix \#20\) [\#21](https://github.com/brightcove/brine/pull/21) ([mwhipple](https://github.com/mwhipple))
165
- - Add README [\#12](https://github.com/brightcove/brine/pull/12) ([mwhipple](https://github.com/mwhipple))
166
- - Initial extraction; Fix \#6 [\#1](https://github.com/brightcove/brine/pull/1) ([mwhipple](https://github.com/mwhipple))
167
-
168
-
169
-
170
- \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
data/Guardfile DELETED
@@ -1,12 +0,0 @@
1
- guard 'cucumber',
2
- all_after_pass: true,
3
- all_on_start: true,
4
- cmd_additional_args: '--profile guard',
5
- keep_failed: true do
6
-
7
- clearing = true
8
- watch(%r{^features/.+\.feature$})
9
- watch(%r{^lib/.+$}) { "features" }
10
- watch(%r{^features/step_definitions/.+$}) { "features" }
11
- watch(%r{^features/support/.+$}) { "features" }
12
- end
data/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2018 Brightcove
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,29 +0,0 @@
1
- = Brine
2
-
3
- > Cucumber DSL for testing REST APIs
4
-
5
- == Metadata
6
-
7
- Documentation::
8
- https://brightcove.github.io/brine/
9
-
10
- Status::
11
- Active
12
-
13
- Type::
14
- Library
15
-
16
- Versioning::
17
- Semantic Versioning
18
-
19
- Contributing::
20
- _To be cleaned up_
21
- Contributions are welcome. Guides on developing and contributing
22
- are planned, in the short term opening an issue is always a safe
23
- choice to avoid any wasted work.
24
-
25
- If you want to contribute or are otherwise interested in the concepts of Brine
26
- but may not be fond of the underlying technologies...also feel free to open a
27
- ticket. All of the current choices were driven by practicality rather than
28
- preference or being considered the best long term solution for the problem, so
29
- there's still a strong chance for collaboration and convergence.
@@ -1,2 +0,0 @@
1
- debug: --format pretty --strict --backtrace
2
- guard: --format pretty --strict --backtrace
@@ -1,19 +0,0 @@
1
- plugins {
2
- id 'org.asciidoctor.gradle.asciidoctor' version '1.5.1'
3
- }
4
-
5
- dependencies {
6
- asciidoctor 'com.github.domgold.doctools.asciidoctor:asciidoctor-gherkin-extension:1.0.1'
7
- }
8
-
9
- asciidoctor {
10
- separateOutputDirs = false
11
- sourceDir 'src'
12
- outputDir projectDir
13
- attributes 'toc' : 'right',
14
- 'source-highlighter' : 'highlightjs',
15
- 'icons' : 'font',
16
- 'page-layout': 'docs',
17
- 'page-description': '{description}',
18
- 'page-keywords': '{keywords}'
19
- }
@@ -1,643 +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="Cookbook for the Brine REST Testing DSL">
9
- <meta name="keywords" content="Brine, Cucumber, REST, DSL">
10
- <meta name="author" content="Matt Whipple">
11
- <title>Brine Cookbook</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-cutlery"></i></span> Brine Cookbook</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="#_overview">Overview</a></li>
430
- <li><a href="#_intercepting_of_http_calls">Intercepting of HTTP Calls</a>
431
- <ul class="sectlevel2">
432
- <li><a href="#_context">Context</a></li>
433
- <li><a href="#_solution">Solution</a></li>
434
- <li><a href="#_recipe">Recipe</a></li>
435
- </ul>
436
- </li>
437
- <li><a href="#__assurances">"Assurances"</a>
438
- <ul class="sectlevel2">
439
- <li><a href="#_context_2">Context</a></li>
440
- <li><a href="#_solution_2">Solution</a></li>
441
- <li><a href="#_recipe_2">Recipe</a></li>
442
- </ul>
443
- </li>
444
- </ul>
445
- </div>
446
- </div>
447
- <div id="content">
448
- <div class="sect1">
449
- <h2 id="_overview">Overview</h2>
450
- <div class="sectionbody">
451
- <div class="paragraph">
452
- <p>The following are some recipes to address issues which may arise while using
453
- Brine but are not considered part of Brine&#8217;s (current) responsibility.
454
- Many of these are focused on simplicity and ease rather than robustness or
455
- elegance, and modification to address specific cases should be expected.</p>
456
- </div>
457
- <div class="paragraph">
458
- <p>Many of these will also be platform specific and be subject to further
459
- organization once platforms beyond ruby are supported.</p>
460
- </div>
461
- </div>
462
- </div>
463
- <div class="sect1">
464
- <h2 id="_intercepting_of_http_calls">Intercepting of HTTP Calls</h2>
465
- <div class="sectionbody">
466
- <div class="sect2">
467
- <h3 id="_context">Context</h3>
468
- <div class="paragraph">
469
- <p>There may be cases where the request or reponse may need to be modified
470
- in some way before or after transmission, for example to add a custom header
471
- which is somehow specific to the testing configuration and therefore outside
472
- of anything that belongs in the specification.</p>
473
- </div>
474
- </div>
475
- <div class="sect2">
476
- <h3 id="_solution">Solution</h3>
477
- <div class="paragraph">
478
- <p>This can be done through the registration of custom Faraday middleware on
479
- the Brine client. All of the registered middleware attaches
480
- to the generated connection through an array of functions in
481
- <a href="https://github.com/brightcove/brine/blob/master/lib/brine/requester.rb">requester.rb</a>.
482
- Each function accepts the connection object as its single parameter.
483
- The array of functions is exposed as <code>connection_handlers</code> and can be modified
484
- through getting that property from either the default <code>World</code>
485
- (for the default client) or from an appropriate <code>ClientBuilder</code>
486
- if creating custom clients and mutating it accordingly (setting the reference
487
- is not suported).
488
- You could just build your own client without the facilities provided by Brine.</p>
489
- </div>
490
- </div>
491
- <div class="sect2">
492
- <h3 id="_recipe">Recipe</h3>
493
- <div class="paragraph">
494
- <p>An example to add a custom header could be implemented as follows:</p>
495
- </div>
496
- <div class="listingblock">
497
- <div class="content">
498
- <pre class="highlightjs highlight"><code class="language-ruby" data-lang="ruby">require 'faraday'
499
- class CustomHeaderAdder &lt; Faraday::Middleware
500
- def initialize(app, key, val)
501
- super(app)
502
- @key = key
503
- @val = val
504
- end
505
-
506
- def call(env)
507
- env[:request_headers].merge!({@key =&gt; @val})
508
- @app.call(env)
509
- end
510
- end
511
-
512
- ...
513
-
514
- connection_handlers.unshift(proc do |conn|
515
- conn.use CustomHeaderAdder, 'x-header', 'I am a test'
516
- end)</code></pre>
517
- </div>
518
- </div>
519
- </div>
520
- </div>
521
- </div>
522
- <div class="sect1">
523
- <h2 id="__assurances">"Assurances"</h2>
524
- <div class="sectionbody">
525
- <div class="sect2">
526
- <h3 id="_context_2">Context</h3>
527
- <div class="paragraph">
528
- <p>Ideally all tests should be as self-contained and isolated as possible;
529
- when writing functional tests, however, there are cases where this isn&#8217;t
530
- feasible or possible. In some cases a system depends on another external
531
- system which is not a system that is under test and which (for whatever reason)
532
- cannot be easily worked with. In white box testing such a system would likely be
533
- represented by some form of test double, but this may be unfeasible and/or
534
- undesirable when testing a deployed system.</p>
535
- </div>
536
- <div class="paragraph">
537
- <p>An example of such a system is user/account management which often incurs
538
- additional overhead to provision a new account. When testing a secured
539
- system valid accounts are needed for representative testing, but provisioning
540
- a new account may be difficult or outside the scope of the system that is being
541
- actively tested. If tested functionality involves enacting account-wide changes
542
- and the number of accounts is limited, then that is likely to unfortunately
543
- prevent complete test isolation.</p>
544
- </div>
545
- </div>
546
- <div class="sect2">
547
- <h3 id="_solution_2">Solution</h3>
548
- <div class="paragraph">
549
- <p>In such cases a standard solution is to designate certain resources to be
550
- reused for certain tests. These are analogous to the concept of "fixtures" in
551
- some test suites though there may be slight differences in implementation and
552
- reliance on them. Here the term "assurances" is used&#8230;&#8203;primarily because it
553
- starts with <code>a</code> which lends itself to relevant files being listed towards the
554
- beginning alphabetically in a given directory.</p>
555
- </div>
556
- <div class="paragraph">
557
- <p>The goal of assurances is to specify conditions which are expected before other
558
- tests are to be run. Preferably the dependent tests should also explicitly
559
- declare the dependency but a significant solution for that is not established.
560
- Assurances therefore validate that preconditions are met; ideally if such
561
- preconditions can be established idempotently then the assurances can do so
562
- before the validation.</p>
563
- </div>
564
- <div class="sect3">
565
- <h4 id="_assurances_are_not_tests">Assurances are NOT Tests</h4>
566
- <div class="paragraph">
567
- <p><strong>Assurances validate a state which is desired to be consistently retained
568
- within the system rather than being changed</strong>. This means that they should <em>not</em>
569
- be used for tests as that would require state changes, nor should they clean up
570
- after themselves (as that would also imply a state change). If assurances are
571
- configured for a system which should also be tested, then appropriate tests
572
- should exist (including those that may validate any behavior relied upon by
573
- the assurance).</p>
574
- </div>
575
- </div>
576
- <div class="sect3">
577
- <h4 id="_consequences">Consequences</h4>
578
- <div class="paragraph">
579
- <p>As mentioned previously assertions help in cases where tests cannot be fully
580
- isolated, and therefore some known state must be established and reused across
581
- tests (and such state should <strong>not</strong> change). A practical reason for this is to
582
- allow for overlapping test executions.
583
- If tests are not fully isolated, state is being changed, and test runs overlap,
584
- then tests may fail non-deterministically due to one test run pulling the state
585
- out from another. This in the simplest form can be a nuisance but it also
586
- effectively precludes the ability to speed up test runs through the use of
587
- parallelism/asynchronicity.</p>
588
- </div>
589
- <div class="paragraph">
590
- <p><em>TODO: Enumerate drawbacks</em></p>
591
- </div>
592
- </div>
593
- </div>
594
- <div class="sect2">
595
- <h3 id="_recipe_2">Recipe</h3>
596
- <div class="paragraph">
597
- <p>This can be done using standard cucumber tags. Assurances can be defined in
598
- designated <code>assure_*.feature</code> files where each Feature is appropriately tagged:</p>
599
- </div>
600
- <div class="listingblock">
601
- <div class="content">
602
- <pre class="highlightjs highlight"><code class="language-gherkin" data-lang="gherkin">@assure
603
- Feature: Some preconditions are verified...</code></pre>
604
- </div>
605
- </div>
606
- <div class="paragraph">
607
- <p>And then a Rake task is added to run those tagged features:</p>
608
- </div>
609
- <div class="listingblock">
610
- <div class="content">
611
- <pre class="highlightjs highlight"><code class="language-ruby" data-lang="ruby">Cucumber::Rake::Task.new(:assure) do |t|
612
- t.cucumber_opts = "#{ENV['CUCUMBER_OPTS']} --tags @assure"
613
- end</code></pre>
614
- </div>
615
- </div>
616
- <div class="paragraph">
617
- <p>The Rake task that runs the other tests then depends on that task:</p>
618
- </div>
619
- <div class="listingblock">
620
- <div class="content">
621
- <pre class="highlightjs highlight"><code class="language-ruby" data-lang="ruby">task :invoke_cuke =&gt; [:assure] do
622
- #Run cucumber, potentially in parallel and likely with --tags `@assure`
623
- end</code></pre>
624
- </div>
625
- </div>
626
- <div class="paragraph">
627
- <p>This approach tests preconditions and will avoid running the rest of the tests
628
- if they are not (relying on standard Rake behavior). The assurances can also be
629
- run with different Cucumber behavior so that the full test suite can be more
630
- stochastic (randomized/non-serialized) while the assurances can be more
631
- controlled.</p>
632
- </div>
633
- </div>
634
- </div>
635
- </div>
636
- </div>
637
- <div id="footer">
638
- <div id="footer-text">
639
- Last updated 2018-06-17 15:55:45 EDT
640
- </div>
641
- </div>
642
- </body>
643
- </html>