chef-gen-flavors 0.3.0

data/lib/chef_gen/snippet/attributes.rb

@@ -0,0 +1,22 @@
+module ChefGen
+  module Snippet
+    # a cookbook that has attributes
+    module Attributes
+      # declares directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_attributes_dirs(recipe)
+        @directories << 'attributes'
+      end
+
+      # declares files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_attributes_files(recipe)
+        @templates_if_missing << File.join('attributes', 'default.rb')
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/chef_spec.rb

@@ -0,0 +1,41 @@
+module ChefGen
+  module Snippet
+    # creates a framework for ChefSpec unit testing
+    module ChefSpec
+      # declares the .rspec file
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_chefspec_dotrspec(recipe)
+        @templates << '.rspec'
+      end
+
+      # declares the ChefSpec directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_chefspec_dirs(recipe)
+        @directories << 'spec'
+        @directories << File.join('spec', 'recipes')
+      end
+
+      # declares the ChefSpec spec_helper
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_chefspec_spechelper(recipe)
+        @templates_if_missing << File.join('spec', 'spec_helper.rb')
+      end
+
+      # declares the default recipe spec
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_chefspec_defaultrecipespec(recipe)
+        @templates_if_missing << File.join(
+          'spec', 'recipes', 'default_spec.rb'
+        )
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/cookbook_base.rb

@@ -0,0 +1,64 @@
+module ChefGen
+  module Snippet
+    # creates the basic files that every cookbook should have
+    # each file is managed through a separate method to allow for
+    # people to mix this in but turn off just one file
+    module CookbookBase
+      # declares the Gemfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_gemfile(recipe)
+        @templates << 'Gemfile'
+      end
+
+      # declares the Berksfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_berksfile(recipe)
+        @templates << 'Berksfile'
+      end
+
+      # declares the Rakefile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_rakefile(recipe)
+        @templates << 'Rakefile'
+      end
+
+      # declares the Guardfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_guardfile(recipe)
+        @templates << 'Guardfile'
+      end
+
+      # declares the metadata.rb file
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_metadata(recipe)
+        @templates_if_missing << 'metadata.rb'
+      end
+
+      # declares the README file
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_readme(recipe)
+        @templates_if_missing << 'README.md'
+      end
+
+      # declares the CHANGELOG
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_cookbookbase_changelog(recipe)
+        @templates_if_missing << 'CHANGELOG.md'
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/example_file.rb

@@ -0,0 +1,23 @@
+module ChefGen
+  module Snippet
+    # a sample cookbook_file source
+    module ExampleFile
+      # declares directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_examplefile_dirs(recipe)
+        @directories << 'files'
+        @directories << File.join('files', 'default')
+      end
+
+      # declares files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_examplefile_files(recipe)
+        @files_if_missing << File.join('files', 'default', 'example.conf')
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/example_template.rb

@@ -0,0 +1,25 @@
+module ChefGen
+  module Snippet
+    # a sample template source
+    module ExampleTemplate
+      # declares directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_exampletemplate_dirs(recipe)
+        @directories << 'templates'
+        @directories << File.join('templates', 'default')
+      end
+
+      # declares files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_exampletemplate_files(recipe)
+        @files_if_missing << File.join(
+          'templates', 'default', 'example.conf.erb'
+        )
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/recipes.rb

@@ -0,0 +1,22 @@
+module ChefGen
+  module Snippet
+    # a cookbook that has recipes
+    module Recipes
+      # declares directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_recipes_dirs(recipe)
+        @directories << 'recipes'
+      end
+
+      # declares files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_recipes_files(recipe)
+        @templates_if_missing << File.join('recipes', 'default.rb')
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/resource_provider.rb

@@ -0,0 +1,24 @@
+module ChefGen
+  module Snippet
+    # a cookbook that has provides resources and providers
+    module ResourceProvider
+      # declares directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_resourceprovider_dirs(recipe)
+        @directories << 'resources'
+        @directories << 'providers'
+      end
+
+      # declares files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_resourceprovider_files(recipe)
+        @templates_if_missing << File.join('resources', 'default.rb')
+        @templates_if_missing << File.join('providers', 'default.rb')
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/standard_ignore.rb

@@ -0,0 +1,97 @@
+# rubocop:disable Metrics/MethodLength
+module ChefGen
+  module Snippet
+    # populates the list of ignore patterns for chefignore and .gitignore
+    module StandardIgnore
+      # adds ignore patterns for chefignore
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_standardignore_chefignore(recipe)
+        @chefignore_files << <<END.split("\n")
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+.sass-cache
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+Guardfile
+Procfile
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+Berksfile
+Berksfile.lock
+cookbooks/*
+tmp
+CONTRIBUTING
+Colanderfile
+Strainerfile
+.colander
+.strainer
+.vagrant
+Vagrantfile
+.travis.yml
+END
+      end
+
+      # adds ignore patterns for .gitignore
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_standardignore_gitignore(recipe)
+        @gitignore_files << <<END.split("\n")
+.vagrant
+Berksfile.lock
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+Gemfile.lock
+bin/*
+.bundle/*
+.kitchen/
+.kitchen.local.yml
+END
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/style_rubocop.rb

@@ -0,0 +1,14 @@
+module ChefGen
+  module Snippet
+    # sets up style testing using Rubocop
+    module StyleRubocop
+      # declares the rubocop config file
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_stylerubocop_config(recipe)
+        @templates_if_missing << '.rubocop.yml'
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/test_kitchen.rb

@@ -0,0 +1,51 @@
+module ChefGen
+  module Snippet
+    # creates a framework for Test Kitchen integration testing
+    module TestKitchen
+      # declares the Test Kitchen config
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_testkitchen_config(recipe)
+        @templates_if_missing << '.kitchen.yml'
+      end
+
+      # declares directories
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_testkitchen_dirs(recipe)
+        @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
+
+      # declares the Test Kitchen spec helper
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_testkitchen_spechelper(recipe)
+        @templates_if_missing << File.join(
+          'test', 'integration', 'default', 'serverspec', 'spec_helper.rb'
+        )
+      end
+
+      # declares the Test Kitchen default recipe spec
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_testkitchen_defaultrecipespec(recipe)
+        @templates_if_missing << File.join(
+          'test', 'integration', 'default', 'serverspec',
+          'recipes', 'default_spec.rb'
+        )
+      end
+    end
+  end
+end

data/lib/chef_gen/snippets.rb

@@ -0,0 +1,15 @@
+module ChefGen
+  # template snippets that flavors can compose to do common things
+  module Snippet
+    autoload :Attributes, 'chef_gen/snippet/attributes'
+    autoload :ChefSpec, 'chef_gen/snippet/chef_spec'
+    autoload :CookbookBase, 'chef_gen/snippet/cookbook_base'
+    autoload :ExampleFile, 'chef_gen/snippet/example_file'
+    autoload :ExampleTemplate, 'chef_gen/snippet/example_template'
+    autoload :Recipes, 'chef_gen/snippet/recipes'
+    autoload :ResourceProvider, 'chef_gen/snippet/resource_provider'
+    autoload :StandardIgnore, 'chef_gen/snippet/standard_ignore'
+    autoload :StyleRubocop, 'chef_gen/snippet/style_rubocop'
+    autoload :TestKitchen, 'chef_gen/snippet/test_kitchen'
+  end
+end

data/spec/lib/chef_gen/flavor_base_spec.rb

@@ -0,0 +1,164 @@
+require 'chef_gen/flavor_base'
+
+# :nocov:
+module ChefGen
+  module Flavor
+    class Amazing < FlavorBase
+      class << self
+        def description
+          'an amazing cookbook template'
+        end
+      end
+    end
+  end
+  module Snippet
+    module Bar
+      def snippet_bar(_)
+        @directories << 'bar'
+      end
+    end
+  end
+end
+# :nocov:
+
+RSpec.describe ChefGen::FlavorBase do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+    @orig_stdout = $stdout
+    $stdout = File.open(File::NULL, 'w')
+  end
+
+  after do
+    $stdout = @orig_stdout
+  end
+
+  it 'can be constructed' do
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    expect(template).to be_a ChefGen::FlavorBase
+  end
+
+  it 'creates files unconditionally' do
+    expect(@recipe).to receive(:directory).once
+    expect(@recipe).to receive(:cookbook_file).once
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.files << 'README.md'
+    template.generate
+  end
+
+  it 'creates files conditionally with the clobber check enabled' do
+    expect(@recipe).to receive(:directory).once
+    expect(@recipe).not_to receive(:cookbook_file)
+    expect(File).to receive(:exist?)
+      .with('/nonexistent/foo/README.md')
+      .and_return(true)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.fail_on_clobber = true
+    template.files << 'README.md'
+    expect { template.generate }
+      .to output(/tried to overwrite file.+README\.md/).to_stderr
+      .and raise_error
+  end
+
+  it 'creates files conditionally with the clobber check disabled' do
+    expect(@recipe).to receive(:directory).once
+    expect(@recipe).to receive(:cookbook_file).once
+    expect(@ctx).to receive(:respond_to?).with(:clobber).and_return(true)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.files << 'README.md'
+    template.generate
+  end
+
+  it 'creates templates unconditionally' do
+    expect(@recipe).to receive(:directory).once
+    expect(@recipe).to receive(:template).once
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.templates << 'README.md'
+    template.generate
+  end
+
+  it 'creates templates conditionally with the clobber check enabled' do
+    expect(@recipe).to receive(:directory).once
+    expect(@recipe).not_to receive(:template)
+    expect(File).to receive(:exist?)
+      .with('/nonexistent/foo/README.md')
+      .and_return(true)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.fail_on_clobber = true
+    template.templates << 'README.md'
+    expect { template.generate }
+      .to output(/tried to overwrite file.+README\.md/).to_stderr
+      .and raise_error
+  end
+
+  it 'creates templates conditionally with the clobber check disabled' do
+    expect(@recipe).to receive(:directory).once
+    expect(@recipe).to receive(:template).once
+    expect(@ctx).to receive(:respond_to?).with(:clobber).and_return(true)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.templates << 'README.md'
+    template.generate
+  end
+
+  it 'accumulates .gitignore entries' do
+    expect(@recipe).to receive(:file).with(/.gitignore$/)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.gitignore_files << 'foo'
+    template.gitignore_files << 'bar'
+    template.generate
+  end
+
+  it 'does not write a .gitignore if there are no entries' do
+    expect(@recipe).not_to receive(:cookbook_file).with(/.gitignore$/)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.generate
+  end
+
+  it 'accumulates chefignore entries' do
+    expect(@recipe).to receive(:file).with(/chefignore$/)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.chefignore_files << 'foo'
+    template.chefignore_files << 'bar'
+    template.generate
+  end
+
+  it 'does not write a chefignore if there are no entries' do
+    expect(@recipe).not_to receive(:cookbook_file).with(/chefignore$/)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.generate
+  end
+
+  it 'calls mixin methods' do
+    expect(@recipe).to receive(:directory).with(%r{foo/$})
+    expect(@recipe).to receive(:directory).with(%r{foo/bar$})
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.extend ChefGen::Snippet::Bar
+    template.generate
+  end
+
+  it 'reports on actions by default' do
+    expect(@recipe).to receive(:ruby_block).with('report_actions_taken')
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.files << 'README.md'
+    template.generate
+  end
+
+  it 'does not report actions if disabled' do
+    expect(@recipe).not_to receive(:ruby_block)
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.report_actions = false
+    template.files << 'README.md'
+    template.generate
+  end
+
+  it 'displays the next steps if populated' do
+    expect(@recipe).to receive(:ruby_block).with('display_next_steps')
+    template = ChefGen::Flavor::Amazing.new(@recipe)
+    template.report_actions = false
+    template.next_steps = 'do something amazing'
+    template.generate
+  end
+end