chef-umami 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016bd54f66198e533440c6eff8d3cc9d9a02a4dc
-  data.tar.gz: 1df201ee4d54ebfb32e4741ef08607562884af78
+  metadata.gz: 332bd1c06e4c1ef37879026cb156036d17c0ab9f
+  data.tar.gz: 0af958230fbe4ba6ee6ad8bc548a4cd724b6b23f
 SHA512:
-  metadata.gz: 4e405c663e1d1a0a7281540651555a715e57703de31fbec5097054bd8ea50806ea821d22868feaa6ebcdb0e953e8df8b1ac87ab14bc74c8a297893a09441998d
-  data.tar.gz: ea9b841efacd7aeff6b373e5c0757382e2a990cb225eb1e19115b571ecbbbc16889c27ebcb58435315e4f0321df0366fb470151699e525fb164e503fcdbd4aa5
+  metadata.gz: 9bb516181d9d2fc958e79827fe1cf9fc60c8b122aacaa03404239d6b4bd2e97a1f6cd3a22f9f7cc175297ae815d0428a42bcdd56b2636b3014c8155b43860fa1
+  data.tar.gz: 38ef2f48e5172497dd44c76dbab69fe437dc6dc54db8420e16fed2ca1b497ae1aa14157371d38533d90549f03d7499d81a9482db1e1f8efd93b474fcac798eba

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Changelog
 
+## [0.0.4]
+- Fixes a bug where two methods have the same name. Thanks @HarryYC.
+- Adds `spec_helper.rb` for unit tests, cutting down on boilerplate in each unit test.
+ - Includes test coverage report.
+
+## [0.0.3]
+- I have no recollection.
+
+## [0.0.2]
+- My dog ate my homework.
+
 ## [0.0.1] - 2017-08-07
 - Initial release.

data/README.md

@@ -3,6 +3,10 @@
 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.
 
+Let's see it in action!
+
+[![asciicast](https://asciinema.org/a/138816.png)](https://asciinema.org/a/138816)
+
 ## How does it Work?
 
 `umami` loads up one or more cookbooks in a `chef-zero` instance, executes the
@@ -19,8 +23,7 @@ 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.
+`umami` writes Inspec-type integration tests for all the resources it has found.
 
 ### Spec Files
 
@@ -35,7 +38,7 @@ and I have the following recipes:
 │   └── stocks.rb
 ```
 
-`umami` will write tests as follows:
+`umami` will write tests as follows (assuming the recipes are defined in the run list):
 
 ```
 ├── spec/
@@ -97,8 +100,8 @@ test file, like so:
 
 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:
+the appropriate `verifier` (`inspec`) and, if needed, direct `kitchen` where
+the tests are located:
 
 ```
 verifier:
@@ -132,12 +135,16 @@ without worrying about what the resulting indentation will be.
 
 `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.
+the run list.
 
 ## Caveats
 
 `umami` is still in early and rapid development. Expect to see lots of activity.
 
+`umami` **always overwrites the contents of `spec/umami` on each run.** This may
+change in the future. Until then, you may want to move the generated tests
+into a different subdirectory (i.e. `test/`).
+
 `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
@@ -147,7 +154,7 @@ 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.
+can build on. **Do NOT depend solely on `umami` to provide test coverage!**
 
 ## Inspiration and Thanks
 

data/lib/chef-umami/test/integration.rb

@@ -35,12 +35,12 @@ module Umami
         "inspec"
       end
 
-      def test_file(cookbook = '', recipe = '')
+      def test_file_path(cookbook = '', recipe = '')
         "#{test_root}/#{cookbook}_#{recipe}_spec.rb"
       end
 
       def preamble(cookbook = '', recipe = '')
-        "# #{test_file(cookbook, recipe)} - Originally written by Umami!"
+        "# #{test_file_path(cookbook, recipe)} - Originally written by Umami!"
       end
 
       # Call on the apprpriate method from the Umami::Helper::InSpec
@@ -73,7 +73,7 @@ module Umami
           resources.each do |resource|
             content << write_test(resource)
           end
-          test_file_name = test_file(cookbook, recipe)
+          test_file_name = test_file_path(cookbook, recipe)
           test_file_content = content.join("\n") + "\n"
           write_file(test_file_name, test_file_content)
           test_files_written << test_file_name

data/lib/chef-umami/test/unit.rb

@@ -39,16 +39,26 @@ module Umami
         "#{test_root}/#{recipe}_spec.rb"
       end
 
+      def spec_helper_path
+        File.join(test_root, '..', 'spec_helper.rb')
+      end
+
       def preamble(cookbook = '', recipe = '')
         "# #{test_file(recipe)} - Originally written by Umami!\n" \
         "\n" \
-        "require '#{framework}'\n" \
-        "require '#{framework}/policyfile'\n" \
+        "require_relative '../spec_helper'\n" \
         "\n" \
         "describe '#{cookbook}::#{recipe}' do\n" \
         "let(:chef_run) { ChefSpec::ServerRunner.new(platform: '#{os[:platform]}', version: '#{os[:version]}').converge(described_recipe) }"
       end
 
+      def write_spec_helper
+        content = ["require '#{framework}'"]
+        content << "require '#{framework}/policyfile'"
+        content << "at_exit { ChefSpec::Coverage.report! }\n"
+        write_file(spec_helper_path, content.join("\n"))
+      end
+
       def write_test(resource = nil)
         state_attrs = [] # Attribute hash to be used with #with()
         resource.state.each do |attr, value|
@@ -93,6 +103,8 @@ module Umami
         end
 
         enforce_styling(test_root)
+        write_spec_helper
+        test_files_written << spec_helper_path
 
         unless test_files_written.empty?
           puts "Wrote the following unit test files:"

data/lib/chef-umami/version.rb

@@ -13,5 +13,5 @@
 #   limitations under the License.
 
 module Umami
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-umami
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryan Frantz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef