chef-gen-flavor-example 0.2.0

data/Rakefile

@@ -0,0 +1,84 @@
+require 'chef_gen/flavor/example'
+
+begin
+  require 'hoe'
+  Hoe.plugin :gemspec
+  Hoe.plugins.delete :test
+  Hoe.spec 'chef-gen-flavor-example' do |s|
+    s.version = ChefGen::Flavor::Example::VERSION
+    developer 'James FitzGibbon', 'james.i.fitzgibbon@nordstrom.com'
+    license 'apache2'
+    extra_deps << ['chef-gen-flavors', '~> 0.3']
+    extra_dev_deps << ['chef-dk', '~> 0.5']
+    extra_dev_deps << ['hoe', '~> 3.13']
+    extra_dev_deps << ['hoe-gemspec', '~> 1.0']
+    extra_dev_deps << ['rake', '~> 10.3']
+    extra_dev_deps << ['rspec', '~> 3.1']
+    extra_dev_deps << ['guard', '~> 2.12']
+    extra_dev_deps << ['guard-rspec', '~> 4.2']
+    extra_dev_deps << ['guard-rake', '~> 0.0']
+    extra_dev_deps << ['guard-rubocop', '~> 1.2']
+    extra_dev_deps << ['simplecov', '~> 0.9']
+    extra_dev_deps << ['simplecov-console', '~> 0.2']
+    extra_dev_deps << ['yard', '~> 0.8']
+  end
+  # re-generate our gemspec before packaging
+  task package: 'gem:spec'
+rescue LoadError
+  puts 'hoe not available; disabling tasks'
+end
+
+# Style Tests
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new do |t|
+    t.formatters = ['progress']
+    t.options = ['-D']
+    t.patterns = %w(
+      lib/**/*.rb
+      spec/**/*.rb
+      ./Rakefile
+    )
+  end
+  desc 'Run Style Tests'
+  task style: [:rubocop]
+rescue LoadError
+  puts 'rubocop not available; disabling tasks'
+end
+
+# Unit Tests
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+
+  # Coverage
+  desc 'Generate unit test coverage report'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task[:test].invoke
+  end
+rescue LoadError
+  puts 'rspec not available; disabling tasks'
+  # create a no-op task so that :default works
+  task :test
+end
+
+# Documentation
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.options = ['-m', 'markdown', '--private']
+    t.stats_options = ['--list-undoc']
+  end
+rescue LoadError
+  puts 'yard not available; disabling tasks'
+end
+
+# test is an alias for spec
+desc 'runs unit tests'
+task test: [:spec]
+
+# default is to test everything
+desc 'runs all tests'
+task default: :test

data/chef-gen-flavor-example.gemspec

@@ -0,0 +1,72 @@
+# -*- encoding: utf-8 -*-
+# stub: chef-gen-flavor-example 0.2.0.20150514061744 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "chef-gen-flavor-example"
+  s.version = "0.2.0.20150514061744"
+
+  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-14"
+  s.description = "An example plugin for [chef-gen-flavors](https://rubygems.org/gems/chef-gen-flavors).\n\nThis plugin makes use of most of the snippets available, and is meant as a\nreference implementation than for actual use. It demonstrates how to create\na template plugin with tests and serve as a good example of how to get\nstarted writing your own templates for distribution."
+  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", "Gemfile.lock", "Guardfile", "History.md", "LICENSE", "Manifest.txt", "README.md", "Rakefile", "chef-gen-flavor-example.gemspec", "code_generator/files/default/files_default_example_conf", "code_generator/files/default/templates_default_example_conf_erb", "code_generator/libraries/kitchen_helper.rb", "code_generator/metadata.rb", "code_generator/recipes/cookbook.rb", "code_generator/templates/default/Berksfile.erb", "code_generator/templates/default/CHANGELOG_md.erb", "code_generator/templates/default/Gemfile.erb", "code_generator/templates/default/Guardfile.erb", "code_generator/templates/default/README_md.erb", "code_generator/templates/default/Rakefile.erb", "code_generator/templates/default/_kitchen_yml.erb", "code_generator/templates/default/_rspec.erb", "code_generator/templates/default/_rubocop_yml.erb", "code_generator/templates/default/attributes_default_rb.erb", "code_generator/templates/default/metadata_rb.erb", "code_generator/templates/default/recipes_default_rb.erb", "code_generator/templates/default/spec_recipes_default_spec_rb.erb", "code_generator/templates/default/spec_spec_helper_rb.erb", "code_generator/templates/default/test_integration_default_serverspec_recipes_default_spec_rb.erb", "code_generator/templates/default/test_integration_default_serverspec_spec_helper_rb.erb", "lib/chef_gen/flavor/example.rb", "spec/lib/chef_gen/flavor/example_spec.rb", "spec/spec_helper.rb"]
+  s.homepage = "https://github.com/Nordstrom/chef-gen-flavor-example"
+  s.licenses = ["apache2"]
+  s.rdoc_options = ["--main", "README.md"]
+  s.rubygems_version = "2.4.4"
+  s.summary = "An example plugin for [chef-gen-flavors](https://rubygems.org/gems/chef-gen-flavors)"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<chef-gen-flavors>, ["~> 0.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<chef-dk>, ["~> 0.5"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.13"])
+      s.add_development_dependency(%q<hoe-gemspec>, ["~> 1.0"])
+      s.add_development_dependency(%q<rake>, ["~> 10.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_development_dependency(%q<guard>, ["~> 2.12"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 4.2"])
+      s.add_development_dependency(%q<guard-rake>, ["~> 0.0"])
+      s.add_development_dependency(%q<guard-rubocop>, ["~> 1.2"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_development_dependency(%q<simplecov-console>, ["~> 0.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+    else
+      s.add_dependency(%q<chef-gen-flavors>, ["~> 0.3"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<chef-dk>, ["~> 0.5"])
+      s.add_dependency(%q<hoe>, ["~> 3.13"])
+      s.add_dependency(%q<hoe-gemspec>, ["~> 1.0"])
+      s.add_dependency(%q<rake>, ["~> 10.3"])
+      s.add_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_dependency(%q<guard>, ["~> 2.12"])
+      s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
+      s.add_dependency(%q<guard-rake>, ["~> 0.0"])
+      s.add_dependency(%q<guard-rubocop>, ["~> 1.2"])
+      s.add_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_dependency(%q<simplecov-console>, ["~> 0.2"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+    end
+  else
+    s.add_dependency(%q<chef-gen-flavors>, ["~> 0.3"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<chef-dk>, ["~> 0.5"])
+    s.add_dependency(%q<hoe>, ["~> 3.13"])
+    s.add_dependency(%q<hoe-gemspec>, ["~> 1.0"])
+    s.add_dependency(%q<rake>, ["~> 10.3"])
+    s.add_dependency(%q<rspec>, ["~> 3.1"])
+    s.add_dependency(%q<guard>, ["~> 2.12"])
+    s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
+    s.add_dependency(%q<guard-rake>, ["~> 0.0"])
+    s.add_dependency(%q<guard-rubocop>, ["~> 1.2"])
+    s.add_dependency(%q<simplecov>, ["~> 0.9"])
+    s.add_dependency(%q<simplecov-console>, ["~> 0.2"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+  end
+end

data/code_generator/files/default/files_default_example_conf

@@ -0,0 +1,34 @@
+# this is an example of a Chef cookbook file.  It is
+# copied intact when referenced by the cookbook_file
+# resource.
+
+[today_2014_09_17]
+variable = value
+
+[section_two]
+variable_1=value_1
+variable_2=value_2
+variable_3=value_3
+variable_4=value_4
+variable_5=value_5
+
+[section_three]
+variable_1=value_1
+variable_2=value_2
+variable_3=value_3
+variable_4=value_4
+variable_5=value_5
+
+[section_four]
+variable_1=value_1
+variable_2=value_2
+variable_3=value_3
+variable_4=value_4
+variable_5=value_5
+
+[section_five]
+variable_1=value_1
+variable_2=value_2
+variable_3=value_3
+variable_4=value_4
+variable_5=value_5

data/code_generator/files/default/templates_default_example_conf_erb

@@ -0,0 +1,22 @@
+# this is an example of a Chef template.  It is a simple
+# INI-style file.  The first section name is dynamically
+# generated to be the current date in YYYY_MM_DD format
+# and the second through fifth sections are generated in
+# an 'each' loop.
+#
+# note that ending an ERB tag with -% instead of just %,
+# that line doesn't produce an empty line in the output.
+# Use this syntax on lines that are pure logic (like the
+# require line and start and end of the loop) and contain
+# no actual output
+
+<% require 'date' -%>
+[today_<%= DateTime.now.strftime('%Y_%M_%D') %>]
+variable = value
+
+<% %w(two three four five).each do |section_name| -%>
+[<%= section_name %>]
+<% 5.times do |i| -%>
+variable_<%= i %>=value_<%= i %>
+<% end -%>
+<% end -%>

data/code_generator/libraries/kitchen_helper.rb

@@ -0,0 +1,13 @@
+# produces ERB to conditionally set proxy vars in kitchen at
+# runtime.  This can't go directly in the template because if
+# it does it gets evaluated at generation time in the context
+# of ChefDK
+def kitchen_proxy_vars(indentspaces)
+  <<END
+<% %w(http_proxy https_proxy no_proxy).each do |envvar| %>
+<% if ENV.key?(envvar) %>
+#{' ' * indentspaces}<%= envvar %>: '<%= ENV[envvar] %>'
+<% end %>
+<% end %>
+END
+end

data/code_generator/metadata.rb

@@ -0,0 +1,2 @@
+name 'code_generator'
+version '0.0.0'

data/code_generator/recipes/cookbook.rb

@@ -0,0 +1,11 @@
+template = ChefGen::Flavor::Example.new(self)
+template.next_steps = <<END
+
+
+Now cd into the generated cookbook directory and run
+  'bundle' to install Ruby gems needed for local testing and
+  'bundle exec rake -T' to see which testing tasks you can run.
+
+  You are now ready to begin writing your first recipe.
+END
+template.generate

data/code_generator/templates/default/Berksfile.erb

@@ -0,0 +1,3 @@
+source 'https://supermarket.chef.io'
+
+metadata

data/code_generator/templates/default/CHANGELOG_md.erb

@@ -0,0 +1,5 @@
+# Revision History for <%= cookbook_name %>
+
+## 0.1.0
+
+* initial version

data/code_generator/templates/default/Gemfile.erb

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rake', '~> 10.3'
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-rescue', '~> 1.3'
+  gem 'pry-stack_explorer', '~> 0.4'
+end
+
+group :test do
+  gem 'foodcritic', '~> 4.0'
+  gem 'chefspec', '~> 4.1'
+  gem 'ci_reporter_rspec', '~> 1.0'
+  gem 'test-kitchen', '~> 1.4'
+  gem 'kitchen-vagrant', '~> 0.16'
+  gem 'berkshelf', '~> 3.2'
+  # pin to 2.8 series until guard-foodcritic has been updated for v2 API
+  gem 'guard', '~> 2.8.2'
+  # pin to 4.3 series until guard-foodcritic has been updated for v2 API
+  gem 'guard-rspec', '~> 4.3.1'
+  gem 'guard-foodcritic', '~> 1.0'
+  gem 'rubocop', '~> 0.30.0'
+  gem 'guard-rubocop', '~> 1.1'
+end

data/code_generator/templates/default/Guardfile.erb

@@ -0,0 +1,41 @@
+notification :terminal_title
+
+# prevent dropping into pry when nothing is happening
+interactor :off
+
+# automatically runs Foodcritic
+guard :foodcritic, cookbook_paths: '.', cli: '-f any -X spec -X test -X features' do
+  watch(%r{^attributes/.+\.rb$})
+  watch(%r{^resources/.+\.rb$})
+  watch(%r{^providers/.+\.rb$})
+  watch(%r{^libraries/.+\.rb$})
+  watch(%r{^recipes/.+\.rb$})
+  watch(%r{^metadata\.rb$})
+end
+
+# automatically runs Rubocop
+guard :rubocop, all_on_start: true, cli: ['-f', 'p', '-D'] do
+  watch(%r{^attributes/.+\.rb$})
+  watch(%r{^recipes/.+\.rb$})
+  watch(%r{^libraries/.+\.rb$})
+  watch(%r{^resources/.+\.rb$})
+  watch(%r{^providers/.+\.rb$})
+  watch(%r{^spec/.+\.rb$})
+  watch(%r{^test/.+\.rb$})
+  watch(%r{^metadata\.rb$})
+  watch(%r{^Berksfile$})
+  watch(%r{^Gemfile$})
+  watch(%r{^Rakefile$})
+end
+
+# automatically runs ChefSpec tests
+rspec_command = ENV.key?('DISABLE_PRY_RESCUE') ? 'rspec' : 'rescue rspec'
+guard :rspec, all_on_start: true, cmd: "bundle exec #{rspec_command}" do
+  watch(%r{^spec/recipes/.+_spec\.rb$})
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  watch(%r{^attributes/.+\.rb$})    { 'spec' }
+  watch(%r{^resources/.+\.rb$})     { 'spec' }
+  watch(%r{^providers/.+\.rb$})     { 'spec' }
+  watch(%r{^libraries/.+\.rb$})     { 'spec' }
+  watch(%r{^recipes/(.+)\.rb$})     { |m| "spec/recipes/#{m[1]}_spec.rb" }
+end

data/code_generator/templates/default/README_md.erb

@@ -0,0 +1,92 @@
+# <%= cookbook_name %>
+
+## Description
+
+...
+
+## Usage
+
+Add 'recipe[<%= cookbook_name %>::default]' to your node's run-list.
+
+## Recipes
+
+### default
+
+The default recipe ...
+
+## Attributes
+
+The attributes defined by this recipe are organized under the
+`node['<%= cookbook_name %>']` namespace.
+
+Attribute | Description | Type   | Default
+----------|-------------|--------|--------
+...       | ...         | String | ...
+
+## Development
+
+The first time you check out this cookbook, run
+
+    bundle --binstubs
+
+to download and install the development tools.
+
+## Testing
+
+Three forms of cookbook testing are available:
+
+### Style Checks
+
+    bin/rake style
+
+Will run foodcritic (cookbook style) and tailor (ruby style/syntax)
+checks. These tests must pass before the cookbook can progress
+through the CI pipeline.
+
+### Unit Tests
+
+    bin/rake spec
+
+Will run ChefSpec tests.  It is a good idea to ensure that these
+tests pass before committing changes to git.
+
+#### Unit Test Coverage
+
+    bin/rake coverage
+
+Will run the ChefSpec tests and report on test coverage.  It is a
+good idea to make sure that every Chef resource you declare is covered
+by a unit test.
+
+#### Automated Testing with Guard
+
+    bin/guard
+
+Will run foodcritic, tailor, rubocop (if enabled) and chefspec tests
+automatically when the associated files change.  If a chefspec test
+fails, it will drop you into a pry session in the context of the
+failure to explore the state of the run.
+
+To disable the pry-rescue behavior, define the environment variable
+DISABLE_PRY_RESCUE before running guard:
+
+    DISABLE_PRY_RESCUE=1 bin/guard
+
+### Integration Tests
+
+    bin/rake kitchen:all
+
+Will run the test kitchen integration tests.  These tests use Vagrant
+and Virtualbox, which must be installed for the tests to execute.
+
+After converging in a virtual machine, ServerSpec tests are executed.
+This skeleton comes with a very basic ServerSpec test; refer to
+http://serverspec.org for detail on how to create tests.
+
+## Author
+
+<%= copyright_holder %>
+
+## License
+
+<%= license_description %>

data/code_generator/templates/default/Rakefile.erb

@@ -0,0 +1,45 @@
+require 'foodcritic'
+require 'foodcritic/rake_task'
+require 'tailor/rake_task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'kitchen/rake_tasks'
+
+# Style tests (Foodcritic / Rubocop)
+FoodCritic::Rake::LintTask.new
+RuboCop::RakeTask.new do |t|
+  t.formatters = ['progress']
+  t.options = ['-D']
+  t.patterns = %w(
+    attributes/*.rb
+    recipes/*.rb
+    libraries/**/*.rb
+    resources/*.rb
+    providers/*.rb
+    spec/**/*.rb
+    test/**/*.rb
+    ./metadata.rb
+    ./Berksfile
+    ./Gemfile
+    ./Rakefile
+  )
+end
+
+desc 'Run Style Tests'
+task style: [:foodcritic, :rubocop]
+
+# ChefSpec (RSpec)
+RSpec::Core::RakeTask.new
+
+desc 'Generate ChefSpec coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task[:spec].invoke
+end
+
+# Test Kitchen
+begin
+  Kitchen::RakeTasks.new
+rescue LoadError
+  puts 'test-kitchen initialization failed; disabling kitchen tasks'
+end