chef-gen-flavors 0.6.2 → 0.7.0

data/lib/chef_gen/snippets.rb

@@ -10,6 +10,8 @@ module ChefGen
     autoload :ResourceProvider, 'chef_gen/snippet/resource_provider'
     autoload :StandardIgnore, 'chef_gen/snippet/standard_ignore'
     autoload :StyleRubocop, 'chef_gen/snippet/style_rubocop'
+    autoload :StyleTailor, 'chef_gen/snippet/style_tailor'
+    autoload :StyleFoodcritic, 'chef_gen/snippet/style_foodcritic'
     autoload :TestKitchen, 'chef_gen/snippet/test_kitchen'
     autoload :GitInit, 'chef_gen/snippet/git_init'
   end

data/shared/snippet/attributes/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/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/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/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/cookbookbase/Berksfile.erb

@@ -0,0 +1,5 @@
+<% @sources.each do |source| -%>
+source '<%= source %>'
+<% end -%>
+
+metadata

data/shared/snippet/cookbookbase/CHANGELOG_md.erb

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

data/shared/snippet/cookbookbase/Gemfile.erb

@@ -0,0 +1,7 @@
+<% @sources.each do |source| -%>
+source '<%= source %>'
+<% end -%>
+
+<% @gems.each do |gem, constraint| -%>
+gem '<%= gem %>', '<%= constraint %>'
+<% end -%>

data/shared/snippet/cookbookbase/Guardfile.erb

@@ -0,0 +1,10 @@
+notification :terminal_title
+
+# prevent dropping into pry when nothing is happening
+interactor :off
+
+<% @guards.each do |name, guard| -%>
+# <%= name %>
+<%= guard %>
+
+<% end -%>

data/shared/snippet/cookbookbase/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/shared/snippet/cookbookbase/Rakefile.erb

@@ -0,0 +1,20 @@
+desc 'runs style tests'
+task style: []
+
+desc 'runs unit tests'
+task spec: []
+
+desc 'runs integration tests'
+task integration: []
+
+desc 'runs style and unit tests'
+task test: [:style, :spec]
+
+desc 'runs all tests'
+task default: :test
+
+<% @tasks.each do |name, task| -%>
+# <%= name %>
+<%= task %>
+
+<% end -%>

data/shared/snippet/cookbookbase/metadata_rb.erb

@@ -0,0 +1,10 @@
+#
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+name             '<%= cookbook_name %>'
+maintainer       '<%= copyright_holder %>'
+maintainer_email '<%= email %>'
+license          '<%= license %>'
+description      'Installs/Configures <%= cookbook_name %>'
+version          '0.1.0'

data/shared/snippet/examplefile/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/shared/snippet/exampletemplate/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/shared/snippet/recipes/recipes_default_rb.erb

@@ -0,0 +1,9 @@
+#
+# Recipe: <%= cookbook_name %>::default
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+# a common pattern is to seperate the cookbook into distinct
+# recipes and pull them all in via the default recipe
+# include_recipe '<%= cookbook_name %>::recipe_a'
+# include_recipe '<%= cookbook_name %>::recipe_b'

data/shared/snippet/resourceprovider/providers_default_rb.erb

@@ -0,0 +1,20 @@
+#
+# Resource: <%= cookbook_name %>
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+use_inline_resources
+
+def whyrun_supported?
+  true
+end
+
+action :create do
+  converge_by 'create a <%= cookbook_name %>' do
+  end
+end
+
+action :delete do
+  converge_by 'delete a <%= cookbook_name %>' do
+  end
+end

data/shared/snippet/resourceprovider/resources_default_rb.erb

@@ -0,0 +1,9 @@
+#
+# Provider: <%= cookbook_name %>
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+actions :create, :delete
+default_action :create
+
+attribute :name, kind_of: String, name_attribute: true

data/shared/snippet/stylerubocop/_rubocop_yml.erb

@@ -0,0 +1,27 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+
+Style/SingleSpaceBeforeFirstArg:
+  Exclude:
+    - '**/Berksfile'
+    - '**/metadata.rb'
+
+Style/FileName:
+  Exclude:
+    - '**/Gemfile'
+    - '**/Berksfile'
+
+Style/RegexpLiteral:
+  Exclude:
+    - '**/Guardfile'
+
+Style/EmptyLines:
+  Exclude:
+    - '**/Guardfile'
+    - '**/Rakefile'
+
+Style/TrailingBlankLines:
+  Exclude:
+    - '**/Guardfile'
+    - '**/Rakefile'