chef-umami 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 016bd54f66198e533440c6eff8d3cc9d9a02a4dc
+  data.tar.gz: 1df201ee4d54ebfb32e4741ef08607562884af78
+SHA512:
+  metadata.gz: 4e405c663e1d1a0a7281540651555a715e57703de31fbec5097054bd8ea50806ea821d22868feaa6ebcdb0e953e8df8b1ac87ab14bc74c8a297893a09441998d
+  data.tar.gz: ea9b841efacd7aeff6b373e5c0757382e2a990cb225eb1e19115b571ecbbbc16889c27ebcb58435315e4f0321df0366fb470151699e525fb164e503fcdbd4aa5

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## [0.0.1] - 2017-08-07
+- Initial release.

data/CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# How to contribute
+
+If you'd like to help us improve and extend `chef-umami`, then we welcome your
+contributions!
+
+Below you will find some basic steps required to be able to contribute to `chef-umami`. If
+you have any questions about this process or any other aspect of contributing to a Bloomberg open
+source project, feel free to send an email to open-source@bloomberg.net and we'll get your questions
+answered as quickly as we can.
+
+
+## Contribution Licensing
+
+Since `chef-umami` is distributed under the terms of the [Apache License, Version
+2.0](http://www.apache.org/licenses/LICENSE-2.0.html), contributions that you make to `chef-umami`
+are licensed under the same terms. In order for us to be able to accept your contributions,
+we will need explicit confirmation from you that you are able and willing to provide them under
+these terms, and the mechanism we use to do this is called a Developer's Certificate of Origin
+[DCO](DCO.md).  This is very similar to the process used by the Linux(R) kernel, Samba, and many
+other major open source projects.
+
+To participate under these terms, all that you must do is include a line like the following as the
+last line of the commit message for each commit in your contribution:
+
+    Signed-Off-By: Random J. Developer <random@developer.example.org>
+
+You must use your real name (sorry, no pseudonyms, and no anonymous contributions).
+
+## The Mechanics of Contributing to `chef-umami`
+
+1. Fork the repo.
+2. Checkout a new branch.
+3. Open a pull request.
+
+To ensure consistency, all code needs to contain the license header. For
+convenience, the header can be found at [.vim/skeleton/license.skel](/.vim/skeleton/license.skel).
+For even more convenience, and if one uses `vim`, use the code in
+[.vimrc](/.vimrc) at the root of this project. It will ensure that any new
+files (with the extension `.rb`) will receive the license header.
+
+To use the `.vimrc` file in this repo, specify the following in `~/.vimrc`:
+
+```
+  set exrc
+  set secure
+```
+
+`set exrc` will enable support for per-project `.vimrc` meaning `vim` will find
+and use the `.vimrc` in this repo.
+
+`set secure` will ensure `vim` doesn't execute autocmd, shell, or write commands
+ unless owned by you.
+
+ Alternatively, be diligent about copying the license header into new files.

data/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,163 @@
+# `umami`
+
+A tool that attempts to write unit and integration tests for Chef cookbooks and
+policies, making it easier to do the right thing and test code.
+
+## How does it Work?
+
+`umami` loads up one or more cookbooks in a `chef-zero` instance, executes the
+compile phase of a `chef-client` run, and reads the run context to get a list
+of the resources that will be managed.
+
+**NOTE**: `umami` does not perform convergence.
+
+### Unit Tests
+
+With the set of resources enumerated, `umami` will write out a set of ChefSpec
+unit tests for the cookbook in which it's running. It determines the tests to
+write by matching the current directory to resources derived from that cookbook.
+
+### Integration Tests
+
+Using either Serverspec or Inspec (coming soon), `umami` writes integration
+tests for all the resources it has found.
+
+### Spec Files
+
+All test files are written to `spec/umami/`. If my cookbook is named `wutang`
+and I have the following recipes:
+
+```
+├── recipes/
+│   ├── bonds.rb
+│   ├── default.rb
+│   ├── financial.rb
+│   └── stocks.rb
+```
+
+`umami` will write tests as follows:
+
+```
+├── spec/
+│   └── umami/
+│       ├── integration/
+│       │   ├── wutang_bonds_spec.rb
+│       │   ├── wutang_default_spec.rb
+│       │   ├── wutang_financial_spec.rb
+│       │   └── wutang_stocks_spec.rb
+│       └── unit/
+│           └── recipes/
+│               ├── bonds_spec.rb
+│               ├── default_spec.rb
+│               ├── financial_spec.rb
+│               └── stocks_spec.rb
+```
+
+## How do I get it?
+
+Install `chef-umami` from your favorite `gem` source via:
+
+`chef exec gem install chef-umami`
+
+## How do I use it?
+
+From the top level of your cookbook, run `umami`:
+
+`chef exec umami`
+
+When it is finished, it will display the paths to the test files it has
+written:
+
+```
+Generating a set of unit tests...
+Running Rubocop over 'spec/umami/unit/recipes' to enforce styling...
+Wrote the following unit test files:
+    spec/umami/unit/recipes/bonds_spec.rb
+    spec/umami/unit/recipes/default_spec.rb
+    spec/umami/unit/recipes/financial_spec.rb
+    spec/umami/unit/recipes/stocks_spec.rb
+
+Generating a set of integration tests...
+Running Rubocop over 'spec/umami/integration' to enforce styling...
+Wrote the following integration tests:
+    spec/umami/integration/wutang_bonds_spec.rb
+    spec/umami/integration/wutang_default_spec.rb
+    spec/umami/integration/wutang_financial_spec.rb
+    spec/umami/integration/wutang_stocks_spec.rb
+```
+
+### Running Unit Tests
+
+Running one or more unit tests should be as easy as calling `rspec` on a given
+test file, like so:
+
+`chef exec rspec spec/umami/unit/recipes/default_spec.rb`
+
+### Running Integration Tests
+
+It's preferred to use `kitchen verify` to execute all integration tests.
+Teach `kitchen` to run `umami`'s tests by updating `.kitchen.yml`. Specify
+the appropriate `verifier` (`inspec` should mostly support Serverspec tests)
+and, if needed, direct `kitchen` where the tests are located:
+
+```
+verifier:
+  name: inspec
+
+suites:
+  - name: default
+    provisioner:
+      policyfile: Policyfile.rb
+    ...
+    verifier:
+      inspec_tests:
+        - path: spec/umami/integration
+```
+
+## Features
+
+### OS Detection
+
+ChefSpec may need to mock up ohai data (via Fauxhai). To facilitate this,
+ChefSpec needs to be told what operating system to pretend to be. `umami`
+does its best to detect the OS it's being called on.
+
+### Styling
+
+`umami` calls on Rubocop to perform some basic styling on test files after
+they've been written. This makes it very easy to add testing methods to `umami`
+without worrying about what the resulting indentation will be.
+
+## Dependencies and Assumptions
+
+`umami` depends on ChefDK to do the bulk of the work resolving cookbooks and
+their dependencies. Further, `umami` assumes you're using Policyfile to manage
+your nodes' run list.
+
+## Caveats
+
+`umami` is still in early and rapid development. Expect to see lots of activity.
+
+`umami` is not aware of any context. For example, if a recipe includes another
+recipe based on some condition (i.e. operating system), `umami` won't know about
+it and therefore won't write a relevant test. `umami` knows about the resources
+it finds during the compile phase of a `chef-client` run only. One can choose
+to use one, many, all, or none of the tests. It's up to you to decide what, if
+anything, you want to use.
+
+`umami`'s goal is to help get you started writing and using tests in your
+development cycle. It tries its best to provide a useful set of tests that you
+can build on.
+
+## Inspiration and Thanks
+
+This project came to be largely out of fear of having to write a lot of test
+code from scratch where none had previously existed. The idea of starting from
+nothing seemed so daunting that it's likely no on would ever get started. I
+wanted to give Chef developers a means to expedite writing tests. After all,
+it's much easier to modify code than it is to write it in the first place.
+
+`umami` is the product of reearch into various projects' code, such as
+Chef, ChefDK, and Test Kitchen. I am grateful to everyone that has contributed
+to those projects. `umami` borrows some patterns from those projects and, in
+some cases, bits of code.

data/bin/umami

@@ -0,0 +1,7 @@
+#!/opt/chefdk/embedded/bin/ruby
+
+chef_umami_lib = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+$:.unshift(chef_umami_lib)
+require "chef-umami/runner"
+
+Umami::Runner.new.run

data/lib/chef-umami.rb

@@ -0,0 +1,16 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+module Umami
+end