chef-gen-flavor-base 0.9.0

data/lib/chef_gen/snippet/style_tailor.rb

@@ -0,0 +1,64 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # sets up style testing using Tailor
+    class StyleTailor < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'style_tailor'
+
+      private
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        declare_cookbook_gems
+        declare_rake_tasks
+      end
+
+      # declares cookbook_gems if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_cookbook_gems
+        @flavor.class.do_declare_resources do
+          break unless snippet?('cookbook_base')
+          cookbook_gems['tailor'] = '~> 1.4'
+          cookbook_gems['guard-rake'] = '~> 0.0'
+        end
+      end
+
+      # declares rake tasks if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_rake_tasks
+        @flavor.class.do_declare_resources do
+          break unless snippet?('cookbook_base')
+          rake_tasks['tailor'] = <<'END'
+require 'tailor/rake_task'
+Tailor::RakeTask.new do |t|
+  {
+    spec:        'spec/recipes/*_spec.rb',
+    spec_helper: 'spec/spec_helper.rb',
+    attributes:  'attributes/*.rb',
+    resources:   'resources/*.rb',
+    providers:   'providers/*.rb',
+    libraries:   'libraries/**/*.rb',
+    recipes:     'recipes/*.rb',
+    metadata:    'metadata.rb'
+  }.each do |name, glob|
+    t.file_set glob, name do |s|
+      s.max_line_length 1000
+      s.max_code_lines_in_method 1000
+      s.max_code_lines_in_class 1000
+    end
+  end
+end
+task style: :tailor
+END
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/test_kitchen.rb

@@ -0,0 +1,129 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # creates a framework for Test Kitchen integration testing
+    class TestKitchen < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'test_kitchen'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      def initialize_generate
+        super
+        declare_directories
+        declare_files_templates
+        declare_chefignore_patterns
+        declare_gitignore_patterns
+        declare_cookbook_gems
+        declare_rake_tasks
+      end
+
+      # declares directories
+      # @return [void]
+      # @api private
+      def declare_directories
+        @flavor.class.do_declare_resources do
+          directories << 'test'
+          directories << File.join('test', 'integration')
+          directories << File.join('test', 'integration', 'default')
+          directories << File.join(
+            'test', 'integration', 'default', 'serverspec'
+          )
+          directories << File.join(
+            'test', 'integration', 'default', 'serverspec', 'recipes'
+          )
+        end
+      end
+
+      # declares files and templates
+      # @return [void]
+      # @api private
+      def declare_files_templates
+        @flavor.class.do_declare_resources do
+          templates_if_missing << '.kitchen.yml'
+          templates_if_missing << File.join(
+            'test', 'integration', 'default', 'serverspec', 'spec_helper.rb'
+          )
+          templates_if_missing << File.join(
+            'test', 'integration', 'default', 'serverspec',
+            'recipes', 'default_spec.rb'
+          )
+        end
+      end
+
+      # declares chefignore patterns if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_chefignore_patterns
+        @flavor.class.do_declare_resources do
+          break unless snippet?('standard_ignore')
+          %w(
+            .vagrant .kitchen/* .kitchen.local.yml
+          ).each do |e|
+            chefignore_patterns << e
+          end
+        end
+      end
+
+      # declares .gitignore patterns if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_gitignore_patterns
+        @flavor.class.do_declare_resources do
+          break unless snippet?('standard_ignore')
+          %w(
+            .vagrant .kitchen/* .kitchen.local.yml
+          ).each do |e|
+            gitignore_patterns << e
+          end
+        end
+      end
+
+      # declares cookbook_gems if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_cookbook_gems
+        @flavor.class.do_declare_resources do
+          break unless snippet?('cookbook_base')
+          cookbook_gems['test-kitchen'] = '~> 1.4'
+          cookbook_gems['kitchen-vagrant'] = '~> 0.16'
+        end
+      end
+
+      # declares rake tasks if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_rake_tasks
+        @flavor.class.do_declare_resources do
+          break unless snippet?('cookbook_base')
+          rake_tasks['testkitchen'] = <<'END'
+begin
+  require 'kitchen/rake_tasks'
+  Kitchen::RakeTasks.new
+rescue
+  desc 'placeholder Test Kitchen task when plugins are missing'
+  task 'kitchen:all' do
+    puts 'test-kitchen plugins not installed; this is a placeholder task'
+  end
+end
+task integration: 'kitchen:all'
+END
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet_base.rb

@@ -0,0 +1,46 @@
+module ChefGen
+  # a base for ChefDK Template Flavor Snippets
+  class SnippetBase
+    # @overload initialize(flavor)
+    #   initializes the snippet in setup mode
+    #   @param [ChefGen::FlavorBase] flavor the flavor object
+    #   @return [self]
+    # @overload initialize(flavor, recipe)
+    #   initializes the snippet in generate mode
+    #   @param [ChefGen::FlavorBase] flavor the flavor object
+    #   @param [Chef::Recipe] recipe the recipe object
+    #   @return [self]
+    def initialize(flavor: nil, recipe: nil)
+      @recipe = recipe
+      @flavor = flavor
+      initialize_setup if flavor.setup_mode?
+      initialize_generate if flavor.generate_mode?
+    end
+
+    private
+
+    # @abstract declare {#initialize_setup} to add setup behaviour
+    # @return [void]
+    # @api private
+    def initialize_setup
+    end
+
+    # @abstract declare {#initialize_generate} to add setup behaviour
+    # @return [void]
+    # @api private
+    def initialize_generate
+    end
+
+    # returns the path to static content distributed with a snippet
+    # @param file [String] the file to generate the path from
+    # @return [String] the path the static content relative to the file
+    # @api private
+    def static_content_path(file)
+      File.expand_path(
+        File.join(
+          File.dirname(file), '..', '..', '..', 'shared', 'snippet', self.class::NAME
+        )
+      )
+    end
+  end
+end

data/lib/chef_gen/snippets.rb

@@ -0,0 +1,24 @@
+# Chef Cookbook Generation tools
+module ChefGen
+  # template snippets that flavors can compose to do common things
+  module Snippet
+    autoload :Attributes, 'chef_gen/snippet/attributes'
+    autoload :ActionsTaken, 'chef_gen/snippet/actions_taken'
+    autoload :ChefSpec, 'chef_gen/snippet/chef_spec'
+    autoload :CookbookBase, 'chef_gen/snippet/cookbook_base'
+    autoload :Debugging, 'chef_gen/snippet/debugging'
+    autoload :ExampleFile, 'chef_gen/snippet/example_file'
+    autoload :ExampleTemplate, 'chef_gen/snippet/example_template'
+    autoload :GitInit, 'chef_gen/snippet/git_init'
+    autoload :Guard, 'chef_gen/snippet/guard'
+    autoload :NextSteps, 'chef_gen/snippet/next_steps'
+    autoload :NoClobber, 'chef_gen/snippet/no_clobber'
+    autoload :Recipes, 'chef_gen/snippet/recipes'
+    autoload :ResourceProvider, 'chef_gen/snippet/resource_provider'
+    autoload :StandardIgnore, 'chef_gen/snippet/standard_ignore'
+    autoload :StyleFoodcritic, 'chef_gen/snippet/style_foodcritic'
+    autoload :StyleRubocop, 'chef_gen/snippet/style_rubocop'
+    autoload :StyleTailor, 'chef_gen/snippet/style_tailor'
+    autoload :TestKitchen, 'chef_gen/snippet/test_kitchen'
+  end
+end

data/shared/snippet/attributes/templates/default/attributes_default_rb.erb

@@ -0,0 +1,8 @@
+#
+# Cookbook <%= cookbook_name %>
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+# replace these with something real
+default['<%= cookbook_name %>']['attribute_1'] = 'foo'
+default['<%= cookbook_name %>']['attribute_2'] = 'bar'

data/shared/snippet/chef_spec/templates/default/_rspec.erb

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/shared/snippet/chef_spec/templates/default/spec_chef_runner_context_rb.erb

@@ -0,0 +1,36 @@
+require 'rspec/core/shared_context'
+
+# this is a 'standard' chef run, with no overrides
+module ChefRun
+  extend RSpec::Core::SharedContext
+
+  let(:chef_run) do
+    ChefSpec::ServerRunner.new.converge(described_recipe)
+  end
+end
+
+# the following are commented out to save memory
+# they show how you can set up alternate Chef Runners that
+# override the node's chef environment or other attributes
+# module ChefRunTestEnv
+#   extend RSpec::Core::SharedContext
+#
+#   let(:chef_run) do
+#     ChefSpec::ServerRunner.new do |node, server|
+#       server.create_environment('<%= cookbook_name %>-test')
+#       node.chef_environment = '<%= cookbook_name %>-test'
+#       server.create_node(node)
+#     end.converge(described_recipe)
+#   end
+# end
+#
+# # a chef run where node attributes are overriden
+# module ChefRunOverrideAttrs
+#   extend RSpec::Core::SharedContext
+#
+#   let(:chef_run) do
+#     ChefSpec::ServerRunner.new do |node|
+#       node.set['<%= cookbook_name %>']['foobar'] = true
+#     end.converge(described_recipe)
+#   end
+# end

data/shared/snippet/chef_spec/templates/default/spec_recipes_default_spec_rb.erb

@@ -0,0 +1,7 @@
+RSpec.describe '<%= cookbook_name %>::default' do
+  include ChefRun
+
+  it 'converges successfully' do
+    expect(chef_run).to include_recipe(described_recipe)
+  end
+end

data/shared/snippet/chef_spec/templates/default/spec_spec_helper_rb.erb

@@ -0,0 +1,95 @@
+require 'chefspec'
+require 'chefspec/berkshelf'
+require 'chef_runner_context'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will
+# cause this file to always be loaded, without a need to explicitly require
+# it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for
+# an individual file that may not need all of that loaded. Instead, consider
+# making a separate helper file that requires the additional dependencies
+# and performs the additional setup, and require it from the spec files that
+# actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
+ChefSpec::Coverage.start! if ENV['COVERAGE']

data/shared/snippet/cookbook_base/templates/default/Berksfile.erb

@@ -0,0 +1,12 @@
+<% @sources.each do |source| -%>
+source '<%= source %>'
+<% end -%>
+
+metadata
+
+# load local overrides
+berksfile_dir = File.absolute_path(File.join('.', 'lib', 'berksfile'))
+Dir.glob(File.join(berksfile_dir, '*.berks')).each do |snippet|
+  # rubocop:disable Lint/Eval
+  eval File.read(snippet), nil, snippet
+end

data/shared/snippet/cookbook_base/templates/default/CHANGELOG_md.erb

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