chef-umami 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 016bd54f66198e533440c6eff8d3cc9d9a02a4dc
4
+ data.tar.gz: 1df201ee4d54ebfb32e4741ef08607562884af78
5
+ SHA512:
6
+ metadata.gz: 4e405c663e1d1a0a7281540651555a715e57703de31fbec5097054bd8ea50806ea821d22868feaa6ebcdb0e953e8df8b1ac87ab14bc74c8a297893a09441998d
7
+ data.tar.gz: ea9b841efacd7aeff6b373e5c0757382e2a990cb225eb1e19115b571ecbbbc16889c27ebcb58435315e4f0321df0366fb470151699e525fb164e503fcdbd4aa5
data/CHANGELOG.md ADDED
@@ -0,0 +1,4 @@
1
+ # Changelog
2
+
3
+ ## [0.0.1] - 2017-08-07
4
+ - Initial release.
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,54 @@
1
+ # How to contribute
2
+
3
+ If you'd like to help us improve and extend `chef-umami`, then we welcome your
4
+ contributions!
5
+
6
+ Below you will find some basic steps required to be able to contribute to `chef-umami`. If
7
+ you have any questions about this process or any other aspect of contributing to a Bloomberg open
8
+ source project, feel free to send an email to open-source@bloomberg.net and we'll get your questions
9
+ answered as quickly as we can.
10
+
11
+
12
+ ## Contribution Licensing
13
+
14
+ Since `chef-umami` is distributed under the terms of the [Apache License, Version
15
+ 2.0](http://www.apache.org/licenses/LICENSE-2.0.html), contributions that you make to `chef-umami`
16
+ are licensed under the same terms. In order for us to be able to accept your contributions,
17
+ we will need explicit confirmation from you that you are able and willing to provide them under
18
+ these terms, and the mechanism we use to do this is called a Developer's Certificate of Origin
19
+ [DCO](DCO.md). This is very similar to the process used by the Linux(R) kernel, Samba, and many
20
+ other major open source projects.
21
+
22
+ To participate under these terms, all that you must do is include a line like the following as the
23
+ last line of the commit message for each commit in your contribution:
24
+
25
+ Signed-Off-By: Random J. Developer <random@developer.example.org>
26
+
27
+ You must use your real name (sorry, no pseudonyms, and no anonymous contributions).
28
+
29
+ ## The Mechanics of Contributing to `chef-umami`
30
+
31
+ 1. Fork the repo.
32
+ 2. Checkout a new branch.
33
+ 3. Open a pull request.
34
+
35
+ To ensure consistency, all code needs to contain the license header. For
36
+ convenience, the header can be found at [.vim/skeleton/license.skel](/.vim/skeleton/license.skel).
37
+ For even more convenience, and if one uses `vim`, use the code in
38
+ [.vimrc](/.vimrc) at the root of this project. It will ensure that any new
39
+ files (with the extension `.rb`) will receive the license header.
40
+
41
+ To use the `.vimrc` file in this repo, specify the following in `~/.vimrc`:
42
+
43
+ ```
44
+ set exrc
45
+ set secure
46
+ ```
47
+
48
+ `set exrc` will enable support for per-project `.vimrc` meaning `vim` will find
49
+ and use the `.vimrc` in this repo.
50
+
51
+ `set secure` will ensure `vim` doesn't execute autocmd, shell, or write commands
52
+ unless owned by you.
53
+
54
+ Alternatively, be diligent about copying the license header into new files.
data/LICENSE.md ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,163 @@
1
+ # `umami`
2
+
3
+ A tool that attempts to write unit and integration tests for Chef cookbooks and
4
+ policies, making it easier to do the right thing and test code.
5
+
6
+ ## How does it Work?
7
+
8
+ `umami` loads up one or more cookbooks in a `chef-zero` instance, executes the
9
+ compile phase of a `chef-client` run, and reads the run context to get a list
10
+ of the resources that will be managed.
11
+
12
+ **NOTE**: `umami` does not perform convergence.
13
+
14
+ ### Unit Tests
15
+
16
+ With the set of resources enumerated, `umami` will write out a set of ChefSpec
17
+ unit tests for the cookbook in which it's running. It determines the tests to
18
+ write by matching the current directory to resources derived from that cookbook.
19
+
20
+ ### Integration Tests
21
+
22
+ Using either Serverspec or Inspec (coming soon), `umami` writes integration
23
+ tests for all the resources it has found.
24
+
25
+ ### Spec Files
26
+
27
+ All test files are written to `spec/umami/`. If my cookbook is named `wutang`
28
+ and I have the following recipes:
29
+
30
+ ```
31
+ ├── recipes/
32
+ │   ├── bonds.rb
33
+ │   ├── default.rb
34
+ │   ├── financial.rb
35
+ │   └── stocks.rb
36
+ ```
37
+
38
+ `umami` will write tests as follows:
39
+
40
+ ```
41
+ ├── spec/
42
+ │   └── umami/
43
+ │   ├── integration/
44
+ │   │   ├── wutang_bonds_spec.rb
45
+ │   │   ├── wutang_default_spec.rb
46
+ │   │   ├── wutang_financial_spec.rb
47
+ │   │   └── wutang_stocks_spec.rb
48
+ │   └── unit/
49
+ │   └── recipes/
50
+ │   ├── bonds_spec.rb
51
+ │   ├── default_spec.rb
52
+ │   ├── financial_spec.rb
53
+ │   └── stocks_spec.rb
54
+ ```
55
+
56
+ ## How do I get it?
57
+
58
+ Install `chef-umami` from your favorite `gem` source via:
59
+
60
+ `chef exec gem install chef-umami`
61
+
62
+ ## How do I use it?
63
+
64
+ From the top level of your cookbook, run `umami`:
65
+
66
+ `chef exec umami`
67
+
68
+ When it is finished, it will display the paths to the test files it has
69
+ written:
70
+
71
+ ```
72
+ Generating a set of unit tests...
73
+ Running Rubocop over 'spec/umami/unit/recipes' to enforce styling...
74
+ Wrote the following unit test files:
75
+ spec/umami/unit/recipes/bonds_spec.rb
76
+ spec/umami/unit/recipes/default_spec.rb
77
+ spec/umami/unit/recipes/financial_spec.rb
78
+ spec/umami/unit/recipes/stocks_spec.rb
79
+
80
+ Generating a set of integration tests...
81
+ Running Rubocop over 'spec/umami/integration' to enforce styling...
82
+ Wrote the following integration tests:
83
+ spec/umami/integration/wutang_bonds_spec.rb
84
+ spec/umami/integration/wutang_default_spec.rb
85
+ spec/umami/integration/wutang_financial_spec.rb
86
+ spec/umami/integration/wutang_stocks_spec.rb
87
+ ```
88
+
89
+ ### Running Unit Tests
90
+
91
+ Running one or more unit tests should be as easy as calling `rspec` on a given
92
+ test file, like so:
93
+
94
+ `chef exec rspec spec/umami/unit/recipes/default_spec.rb`
95
+
96
+ ### Running Integration Tests
97
+
98
+ It's preferred to use `kitchen verify` to execute all integration tests.
99
+ Teach `kitchen` to run `umami`'s tests by updating `.kitchen.yml`. Specify
100
+ the appropriate `verifier` (`inspec` should mostly support Serverspec tests)
101
+ and, if needed, direct `kitchen` where the tests are located:
102
+
103
+ ```
104
+ verifier:
105
+ name: inspec
106
+
107
+ suites:
108
+ - name: default
109
+ provisioner:
110
+ policyfile: Policyfile.rb
111
+ ...
112
+ verifier:
113
+ inspec_tests:
114
+ - path: spec/umami/integration
115
+ ```
116
+
117
+ ## Features
118
+
119
+ ### OS Detection
120
+
121
+ ChefSpec may need to mock up ohai data (via Fauxhai). To facilitate this,
122
+ ChefSpec needs to be told what operating system to pretend to be. `umami`
123
+ does its best to detect the OS it's being called on.
124
+
125
+ ### Styling
126
+
127
+ `umami` calls on Rubocop to perform some basic styling on test files after
128
+ they've been written. This makes it very easy to add testing methods to `umami`
129
+ without worrying about what the resulting indentation will be.
130
+
131
+ ## Dependencies and Assumptions
132
+
133
+ `umami` depends on ChefDK to do the bulk of the work resolving cookbooks and
134
+ their dependencies. Further, `umami` assumes you're using Policyfile to manage
135
+ your nodes' run list.
136
+
137
+ ## Caveats
138
+
139
+ `umami` is still in early and rapid development. Expect to see lots of activity.
140
+
141
+ `umami` is not aware of any context. For example, if a recipe includes another
142
+ recipe based on some condition (i.e. operating system), `umami` won't know about
143
+ it and therefore won't write a relevant test. `umami` knows about the resources
144
+ it finds during the compile phase of a `chef-client` run only. One can choose
145
+ to use one, many, all, or none of the tests. It's up to you to decide what, if
146
+ anything, you want to use.
147
+
148
+ `umami`'s goal is to help get you started writing and using tests in your
149
+ development cycle. It tries its best to provide a useful set of tests that you
150
+ can build on.
151
+
152
+ ## Inspiration and Thanks
153
+
154
+ This project came to be largely out of fear of having to write a lot of test
155
+ code from scratch where none had previously existed. The idea of starting from
156
+ nothing seemed so daunting that it's likely no on would ever get started. I
157
+ wanted to give Chef developers a means to expedite writing tests. After all,
158
+ it's much easier to modify code than it is to write it in the first place.
159
+
160
+ `umami` is the product of reearch into various projects' code, such as
161
+ Chef, ChefDK, and Test Kitchen. I am grateful to everyone that has contributed
162
+ to those projects. `umami` borrows some patterns from those projects and, in
163
+ some cases, bits of code.
data/bin/umami ADDED
@@ -0,0 +1,7 @@
1
+ #!/opt/chefdk/embedded/bin/ruby
2
+
3
+ chef_umami_lib = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
4
+ $:.unshift(chef_umami_lib)
5
+ require "chef-umami/runner"
6
+
7
+ Umami::Runner.new.run
data/lib/chef-umami.rb ADDED
@@ -0,0 +1,16 @@
1
+ # Copyright 2017 Bloomberg Finance, L.P.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Umami
16
+ end