chef-gen-flavors 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 562095360336aa05b9852c336b8ed4039cfda565
-  data.tar.gz: 08a2839dad35a4e412c74905f9e9b6a192dafb47
+  metadata.gz: f72906ef7e1128c8a165ff27e2552452e9dff66d
+  data.tar.gz: 52ff5b57d993cd32c412f05f74ad8f407b308d64
 SHA512:
-  metadata.gz: 929b6174ccab2ec30537d317e6a9f9cb1279c738bb926521f1c5400f4428497fda54a773e0ee7e842afd32d0cddfb447aa70be36ef744e761bb4340fbb4b567f
-  data.tar.gz: 28e725b716c9241b46eb68a01195183f42512adc10da09585e363d2169ed09aabd7b87476293910d2dd89eb115fb11a06cd5604161dc1bcf12af95085bf3cbf5
+  metadata.gz: 44a3d2d8706036b51de5769e26e8746e9a404949d6735563ddc7c23989aeac9dd13041f01fa09fc1a98fe5c1e73e73bed1a1282c381eeccd5227c3ffa4aa938c
+  data.tar.gz: 9350287247b69bcf12a3a80b7099c9cf965b2ca9cff1956958c80b08ce0cba13133d318a7cb8872a9ce22b80ba7f322c6bbff88d6d82c4b9f2b21a1560cd7ad4

data/.rubocop.yml

@@ -21,3 +21,7 @@ Metrics/ClassLength:
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/chef_gen/snippet/*.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'lib/chef_gen/flavors/cucumber/*.rb'

data/History.md

@@ -1,5 +1,13 @@
 # Changelog for chef-gen-template
 
+## 0.5.0
+
+* provide some helpful Aruba step definitions for flavors to use in feature tests
+
+## 0.4.1
+
+* declare the target path 'directory' before running snippets, which fixes the GitInit snippet trying to run in a directory that hasn't been created yet
+
 ## 0.4.0
 
 * added a GitInit snippet that runs 'git init .'

data/Manifest.txt

@@ -10,12 +10,17 @@ README.md
 Rakefile
 chef-gen-flavors.gemspec
 features/generate.feature
-features/step_definitions/chef.rb
-features/step_definitions/knife.rb
 features/support/env.rb
 lib/chef_gen/flavor.rb
 lib/chef_gen/flavor_base.rb
 lib/chef_gen/flavors.rb
+lib/chef_gen/flavors/cucumber.rb
+lib/chef_gen/flavors/cucumber/bundle.rb
+lib/chef_gen/flavors/cucumber/chefdk.rb
+lib/chef_gen/flavors/cucumber/kitchen.rb
+lib/chef_gen/flavors/cucumber/knife.rb
+lib/chef_gen/flavors/cucumber/rake.rb
+lib/chef_gen/flavors/cucumber/regex.rb
 lib/chef_gen/snippet/attributes.rb
 lib/chef_gen/snippet/chef_spec.rb
 lib/chef_gen/snippet/cookbook_base.rb

data/README.md

@@ -291,6 +291,19 @@ like this:
       end
     end
 
+## FEATURE TESTING FLAVORS
+
+chef-gen-flavors provides a number of useful step definitions for Aruba (a CLI
+driver for Cucumber) to make it easier to test flavors.  To access these definitions,
+add the following line to your `features/support/env.rb` file:
+
+    require 'chef_gen/flavors/cucumber'
+
+For an example of how to use these steps in your features, refer to the reference
+implementation of a flavor: [chef-gen-flavor-example](https://github.com/Nordstrom/chef-gen-flavor-example).
+
+Documentation for the steps themselves is in the file `ARUBA_STEPS.md`
+
 ## AUTHOR
 
 James FitzGibbon - james.i.fitzgibbon@nordstrom.com - Nordstrom, Inc.

data/chef-gen-flavors.gemspec

@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
-# stub: chef-gen-flavors 0.4.0.20150515142632 ruby lib
+# stub: chef-gen-flavors 0.5.0.20150518085211 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "chef-gen-flavors"
-  s.version = "0.4.0.20150515142632"
+  s.version = "0.5.0.20150518085211"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["James FitzGibbon"]
-  s.date = "2015-05-15"
+  s.date = "2015-05-18"
   s.description = "chef-gen-flavors is a framework for creating custom templates for the\n'chef generate' command provided by ChefDK.\n\nThis gem simply provides a framework; templates are provided by separate\ngems, which you can host privately for use within your organization or\npublicly for the Chef community to use.\n\nAt present this is focused primarily on providing templates for generation of\ncookbooks, as this is where most organization-specific customization takes place.\nSupport for the other artifacts that ChefDK can generate may work, but is not\nthe focus of early releases."
   s.email = ["james.i.fitzgibbon@nordstrom.com"]
   s.extra_rdoc_files = ["History.md", "Manifest.txt", "README.md"]
-  s.files = [".rspec", ".rubocop.yml", ".travis.yml", "Gemfile", "Guardfile", "History.md", "LICENSE", "Manifest.txt", "README.md", "Rakefile", "chef-gen-flavors.gemspec", "features/generate.feature", "features/step_definitions/chef.rb", "features/step_definitions/knife.rb", "features/support/env.rb", "lib/chef_gen/flavor.rb", "lib/chef_gen/flavor_base.rb", "lib/chef_gen/flavors.rb", "lib/chef_gen/snippet/attributes.rb", "lib/chef_gen/snippet/chef_spec.rb", "lib/chef_gen/snippet/cookbook_base.rb", "lib/chef_gen/snippet/example_file.rb", "lib/chef_gen/snippet/example_template.rb", "lib/chef_gen/snippet/git_init.rb", "lib/chef_gen/snippet/recipes.rb", "lib/chef_gen/snippet/resource_provider.rb", "lib/chef_gen/snippet/standard_ignore.rb", "lib/chef_gen/snippet/style_rubocop.rb", "lib/chef_gen/snippet/test_kitchen.rb", "lib/chef_gen/snippets.rb", "spec/lib/chef_gen/flavor_base_spec.rb", "spec/lib/chef_gen/flavors_spec.rb", "spec/lib/chef_gen/snippet/attributes_spec.rb", "spec/lib/chef_gen/snippet/chef_spec_spec.rb", "spec/lib/chef_gen/snippet/cookbook_base_spec.rb", "spec/lib/chef_gen/snippet/example_file_spec.rb", "spec/lib/chef_gen/snippet/example_template_spec.rb", "spec/lib/chef_gen/snippet/git_init_spec.rb", "spec/lib/chef_gen/snippet/recipes_spec.rb", "spec/lib/chef_gen/snippet/resource_provider_spec.rb", "spec/lib/chef_gen/snippet/standard_ignore_spec.rb", "spec/lib/chef_gen/snippet/style_rubocop_spec.rb", "spec/lib/chef_gen/snippet/test_kitchen_spec.rb", "spec/spec_helper.rb", "spec/support/fixtures/code_generator/metadata.rb", "spec/support/fixtures/code_generator/recipes/cookbook.rb", "spec/support/fixtures/code_generator_2/metadata.rb", "spec/support/fixtures/code_generator_2/recipes/cookbook.rb", "spec/support/fixtures/code_generator_2/templates/default/README_md.erb", "spec/support/fixtures/lib/chef_gen/flavor/bar.rb", "spec/support/fixtures/lib/chef_gen/flavor/baz.rb", "spec/support/fixtures/lib/chef_gen/flavor/foo.rb"]
+  s.files = [".rspec", ".rubocop.yml", ".travis.yml", "Gemfile", "Guardfile", "History.md", "LICENSE", "Manifest.txt", "README.md", "Rakefile", "chef-gen-flavors.gemspec", "features/generate.feature", "features/support/env.rb", "lib/chef_gen/flavor.rb", "lib/chef_gen/flavor_base.rb", "lib/chef_gen/flavors.rb", "lib/chef_gen/flavors/cucumber.rb", "lib/chef_gen/flavors/cucumber/bundle.rb", "lib/chef_gen/flavors/cucumber/chefdk.rb", "lib/chef_gen/flavors/cucumber/kitchen.rb", "lib/chef_gen/flavors/cucumber/knife.rb", "lib/chef_gen/flavors/cucumber/rake.rb", "lib/chef_gen/flavors/cucumber/regex.rb", "lib/chef_gen/snippet/attributes.rb", "lib/chef_gen/snippet/chef_spec.rb", "lib/chef_gen/snippet/cookbook_base.rb", "lib/chef_gen/snippet/example_file.rb", "lib/chef_gen/snippet/example_template.rb", "lib/chef_gen/snippet/git_init.rb", "lib/chef_gen/snippet/recipes.rb", "lib/chef_gen/snippet/resource_provider.rb", "lib/chef_gen/snippet/standard_ignore.rb", "lib/chef_gen/snippet/style_rubocop.rb", "lib/chef_gen/snippet/test_kitchen.rb", "lib/chef_gen/snippets.rb", "spec/lib/chef_gen/flavor_base_spec.rb", "spec/lib/chef_gen/flavors_spec.rb", "spec/lib/chef_gen/snippet/attributes_spec.rb", "spec/lib/chef_gen/snippet/chef_spec_spec.rb", "spec/lib/chef_gen/snippet/cookbook_base_spec.rb", "spec/lib/chef_gen/snippet/example_file_spec.rb", "spec/lib/chef_gen/snippet/example_template_spec.rb", "spec/lib/chef_gen/snippet/git_init_spec.rb", "spec/lib/chef_gen/snippet/recipes_spec.rb", "spec/lib/chef_gen/snippet/resource_provider_spec.rb", "spec/lib/chef_gen/snippet/standard_ignore_spec.rb", "spec/lib/chef_gen/snippet/style_rubocop_spec.rb", "spec/lib/chef_gen/snippet/test_kitchen_spec.rb", "spec/spec_helper.rb", "spec/support/fixtures/code_generator/metadata.rb", "spec/support/fixtures/code_generator/recipes/cookbook.rb", "spec/support/fixtures/code_generator_2/metadata.rb", "spec/support/fixtures/code_generator_2/recipes/cookbook.rb", "spec/support/fixtures/code_generator_2/templates/default/README_md.erb", "spec/support/fixtures/lib/chef_gen/flavor/bar.rb", "spec/support/fixtures/lib/chef_gen/flavor/baz.rb", "spec/support/fixtures/lib/chef_gen/flavor/foo.rb"]
   s.homepage = "https://github.com/Nordstrom/chef-gen-flavors"
   s.licenses = ["apache2"]
   s.rdoc_options = ["--main", "README.md"]

data/features/generate.feature

@@ -10,7 +10,7 @@ Feature: chef generate
       |----------------|----------------------------------|
       | CHEFGEN_FLAVOR | bar                              |
       | RUBYLIB        | ../../spec/support/fixtures/lib |
-    When I generate a cookbook named 'foo'
+    When I generate a cookbook named "foo"
     Then the exit status should be 0
     And the output should match /using ChefGen flavor 'bar'/
     And the output should match /Recipe: code_generator_2::cookbook/

data/features/support/env.rb

@@ -3,6 +3,7 @@ if ENV['COVERAGE']
 end
 
 require 'aruba/cucumber'
+require 'chef_gen/flavors/cucumber'
 
 # Travis runs tests in a limited environment which takes a long time to invoke
 # the knife command.  Up the timeout when we're in a travis build based on the

data/lib/chef_gen/flavor_base.rb

@@ -64,7 +64,7 @@ module ChefGen
       # set defaults
       @report_actions = true
       @fail_on_clobber = !ctx.respond_to?(:clobber)
-      @directories = [''] # root directory
+      @directories = []
       %w(files files_if_missing templates templates_if_missing
          chefignore_files gitignore_files actions_taken failures)
         .each do |varname|
@@ -81,6 +81,7 @@ module ChefGen
     # generates the Chef resources that the plugin has declared
     # @return [void]
     def generate
+      add_target_path
       run_snippets
       add_directories
       add_files
@@ -108,6 +109,13 @@ module ChefGen
 
     private
 
+    # creates a directory resource for the target
+    # @return [void]
+    def add_target_path
+      @recipe.send(:directory, @target_path)
+      @actions_taken << "create directory #{@target_path}"
+    end
+
     # find all public methods of the plugin starting with snippet_
     # and calls them
     # @return [void]

data/lib/chef_gen/flavors.rb

@@ -7,7 +7,7 @@ module ChefGen
   # a plugin framework for creating ChefDK generator flavors
   class Flavors
     # the version of the gem
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
 
     extend LittlePlugger path: 'chef_gen/flavor',
                          module: ChefGen::Flavor

data/lib/chef_gen/flavors/cucumber.rb

@@ -0,0 +1,6 @@
+require 'chef_gen/flavors/cucumber/bundle'
+require 'chef_gen/flavors/cucumber/chefdk'
+require 'chef_gen/flavors/cucumber/kitchen'
+require 'chef_gen/flavors/cucumber/knife'
+require 'chef_gen/flavors/cucumber/rake'
+require 'chef_gen/flavors/cucumber/regex'

data/lib/chef_gen/flavors/cucumber/bundle.rb

@@ -0,0 +1,4 @@
+Given(/^I bundle gems$/) do
+  unset_bundler_env_vars
+  run_simple 'bundle', true, 60
+end

data/lib/chef_gen/flavors/cucumber/chefdk.rb

@@ -0,0 +1,3 @@
+Given(/I generate a cookbook named "(.+)"(?: with the "(.+)" options?)?/) do |cbname, opts|
+  run_simple "chef generate cookbook #{cbname} #{opts}"
+end

data/lib/chef_gen/flavors/cucumber/kitchen.rb

@@ -0,0 +1,4 @@
+Given(/^I list the kitchen suites$/) do
+  unset_bundler_env_vars
+  run_simple 'bundle exec kitchen list'
+end

data/{features/step_definitions → lib/chef_gen/flavors/cucumber}/knife.rb

@@ -1,5 +1,6 @@
 Given(/^a knife.rb that uses chef-gen-flavors$/) do
   write_file 'knife.rb', <<END
+cookbook_path '#{File.expand_path(current_dir)}'
 require 'chef_gen/flavors'
 chefdk.generator_cookbook = ChefGen::Flavors.path
 END

data/lib/chef_gen/flavors/cucumber/rake.rb

@@ -0,0 +1,14 @@
+Given(/^I run a style test$/) do
+  unset_bundler_env_vars
+  run_simple 'bundle exec rake style', true, 10
+end
+
+Given(/^I run a unit test$/) do
+  unset_bundler_env_vars
+  run_simple 'bundle exec rake spec', true, 10
+end
+
+Given(/^I list the rake tasks$/) do
+  unset_bundler_env_vars
+  run_simple 'bundle exec rake -T'
+end

data/lib/chef_gen/flavors/cucumber/regex.rb

@@ -0,0 +1,3 @@
+Given(/the output should match each of:/) do |regexes|
+  regexes.raw.map { |row| assert_matching_output(row[0], all_output) }
+end

data/lib/chef_gen/snippet/git_init.rb

@@ -8,9 +8,10 @@ module ChefGen
       # @return [void]
       def snippet_gitinit(recipe)
         c = generator_context
+        target_path = @target_path
         recipe.send(:execute, 'initialize git repo') do
           command('git init .')
-          cwd @target_path
+          cwd target_path
         end if c.have_git && !c.skip_git_init
       end
     end

data/spec/lib/chef_gen/flavor_base_spec.rb

@@ -130,7 +130,7 @@ RSpec.describe ChefGen::FlavorBase do
   end
 
   it 'calls mixin methods' do
-    expect(@recipe).to receive(:directory).with(%r{foo/$})
+    expect(@recipe).to receive(:directory).with(/foo$/)
     expect(@recipe).to receive(:directory).with(%r{foo/bar$})
     template = ChefGen::Flavor::Amazing.new(@recipe)
     template.extend ChefGen::Snippet::Bar

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-gen-flavors
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - James FitzGibbon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger
@@ -267,12 +267,17 @@ files:
 - Rakefile
 - chef-gen-flavors.gemspec
 - features/generate.feature
-- features/step_definitions/chef.rb
-- features/step_definitions/knife.rb
 - features/support/env.rb
 - lib/chef_gen/flavor.rb
 - lib/chef_gen/flavor_base.rb
 - lib/chef_gen/flavors.rb
+- lib/chef_gen/flavors/cucumber.rb
+- lib/chef_gen/flavors/cucumber/bundle.rb
+- lib/chef_gen/flavors/cucumber/chefdk.rb
+- lib/chef_gen/flavors/cucumber/kitchen.rb
+- lib/chef_gen/flavors/cucumber/knife.rb
+- lib/chef_gen/flavors/cucumber/rake.rb
+- lib/chef_gen/flavors/cucumber/regex.rb
 - lib/chef_gen/snippet/attributes.rb
 - lib/chef_gen/snippet/chef_spec.rb
 - lib/chef_gen/snippet/cookbook_base.rb

data/features/step_definitions/chef.rb

@@ -1,3 +0,0 @@
-Given(/I generate a cookbook named '(.+)'/) do |cbname|
-  run_simple "chef generate cookbook #{cbname}"
-end