chef-flavor-pan 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Pan Example Cookbook Generator
+
+## Release 2.0.0 2015/06/03
+
+* Massive overhaul. Now uses [chef-gen-flavors](https://rubygems.org/gems/chef-gen-flavors) and provides several different flavors of cookbook generators for you to consume.
+
+## Release 1.1.1 2015/04/30
+
+* Fix readme.
+
+## Release 1.1.0 2015/04/28
+
+* Support for ChefDK 0.5.0.
+* Updates to example kitchen.yml to mirror idiomatic Windows configuration.
+* Added default rubocop.yml.
+
+## Release 1.0.1
+
+* Small updates to support ChefDK 0.3.6. Will no longer work on ChefDK 0.3.5 and below.
+
+## Release 1.0.0
+
+* Provide cookbook example generator

data/LICENSE

@@ -0,0 +1,15 @@
+# THE APACHE LICENSE, v2
+
+Copyright 2015 David Echols
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy
+of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.

data/README.md

@@ -0,0 +1,133 @@
+# pan cookbook generator
+
+Pan is a Chef cookbook generator using [chef-gen-flavors](https://rubygems.org/gems/chef-gen-flavors). You can use it out of the box as an opinionated way of creating new cookbooks, or modify it to meet your organization needs.
+
+## Install
+
+- To get started, you'll need to install chef-gen-flavors, a gem that allows you to have multiple types of generators.
+
+`chef gem install chef-gen-flavors`
+
+- Then you can install the pan flavor:
+
+`chef gem install chef-flavor-pan`
+
+- Now add this to your knife.rb:
+
+```
+# only load ChefGen::Flavors if we're being called from the ChefDK CLI
+if defined?(ChefDK::CLI)
+  require 'chef_gen/flavors'
+  chefdk.generator_cookbook = ChefGen::Flavors.path
+end
+```
+
+- You're done! Let's get cooking.
+
+## Usage
+
+`chef generate cookbook my_cookbook_name`
+
+```
+echohack:desktop echohack$ chef generate cookbook my_cookbook_name
+Compiling Cookbooks...
+Recipe: new::cookbook
+  * directory[/Users/echohack/Desktop/my_cookbook_name/attributes] action create
+    - create new directory /Users/echohack/Desktop/my_cookbook_name/attributes
+  * directory[/Users/echohack/Desktop/my_cookbook_name/recipes] action create
+    - create new directory /Users/echohack/Desktop/my_cookbook_name/recipes
+  * directory[/Users/echohack/Desktop/my_cookbook_name/templates/default] action create
+    - create new directory /Users/echohack/Desktop/my_cookbook_name/templates/default
+  * directory[/Users/echohack/Desktop/my_cookbook_name/files/default] action create
+    - create new directory /Users/echohack/Desktop/my_cookbook_name/files/default
+  * directory[/Users/echohack/Desktop/my_cookbook_name/test/integration/default] action create
+    - create new directory /Users/echohack/Desktop/my_cookbook_name/test/integration/default
+  * cookbook_file[/Users/echohack/Desktop/my_cookbook_name/.rubocop.yml] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/.rubocop.yml
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/.rubocop.yml from none to fb555e
+    (diff output suppressed by config)
+  * cookbook_file[/Users/echohack/Desktop/my_cookbook_name/Berksfile] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/Berksfile
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/Berksfile from none to 5ec92e
+    (diff output suppressed by config)
+  * cookbook_file[/Users/echohack/Desktop/my_cookbook_name/chefignore] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/chefignore
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/chefignore from none to 9727b1
+    (diff output suppressed by config)
+  * cookbook_file[/Users/echohack/Desktop/my_cookbook_name/Gemfile] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/Gemfile
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/Gemfile from none to a3b439
+    (diff output suppressed by config)
+  * cookbook_file[/Users/echohack/Desktop/my_cookbook_name/LICENSE] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/LICENSE
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/LICENSE from none to 693e85
+    (diff output suppressed by config)
+  * cookbook_file[/Users/echohack/Desktop/my_cookbook_name/Thorfile] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/Thorfile
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/Thorfile from none to bab8d2
+    (diff output suppressed by config)
+  * template[/Users/echohack/Desktop/my_cookbook_name/metadata.rb] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/metadata.rb
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/metadata.rb from none to 95b0c0
+    (diff output suppressed by config)
+  * template[/Users/echohack/Desktop/my_cookbook_name/README.md] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/README.md
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/README.md from none to 5b81bf
+    (diff output suppressed by config)
+  * template[/Users/echohack/Desktop/my_cookbook_name/CHANGELOG.md] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/CHANGELOG.md
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/CHANGELOG.md from none to 0404f5
+    (diff output suppressed by config)
+  * template[/Users/echohack/Desktop/my_cookbook_name/.kitchen.yml] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/.kitchen.yml
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/.kitchen.yml from none to 1338ed
+    (diff output suppressed by config)
+  * template[/Users/echohack/Desktop/my_cookbook_name/attributes/default.rb] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/attributes/default.rb
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/attributes/default.rb from none to cdc111
+    (diff output suppressed by config)
+  * template[/Users/echohack/Desktop/my_cookbook_name/recipes/default.rb] action create_if_missing
+    - create new file /Users/echohack/Desktop/my_cookbook_name/recipes/default.rb
+    - update content in file /Users/echohack/Desktop/my_cookbook_name/recipes/default.rb from none to e3b0c4
+    (diff output suppressed by config)
+```
+
+## Examples
+
+* Create a cookbook named my_cookbook_name in the same subdirectory where pan resides.
+
+(Mac & Windows): `chef generate cookbook my_cookbook_name`
+
+* Create a cookbook named my_cookbook_name in the root of your primary drive with pan residing in your home directory
+
+(Mac): `chef generate cookbook /mycookbook`
+
+(Windows): `chef generate cookbook C:\mycookbook`
+
+## Supported Platforms
+
+### Tested And Validated On
+* Mac OSX 10.10 with ChefDK 0.6.0
+* Windows 7 with ChefDK 0.6.0
+
+ChefDK 0.3.6 and higher all likely work, but previous versions were not tested and validated.
+
+## Stuff This Custom Generator Does
+
+Take a look at the flavors and generate a few cookbooks to see what they do. But I'll mention some best practices here:
+
+### In default_attributes.rb
+
+1. default['<%= @attribute_context %>']['file_cache_path']
+
+  * I like to do this so that I can create a "workspace" for the cookbook to drop any files in so I avoid cookbook download collisions. If your cookbook doesn't download anything, than you can trash this.
+  * It also provides a good example of how to do an attribute.
+
+### In .kitchen.yml
+
+1. chef_zero provisioner
+
+  * It's probably stronger to provision with chef_zero than chef_solo since it behaves more like the server does. (That is to say, if you use chef server, then test with chef zero. If you're using solo, then test with solo.)
+
+2. Windows 2012 R2 with automagical WinRM transport
+  * Ideally this is how you would set up the transport for WinRM with Kitchen. This is a new feature as of Test Kitchen 1.4.0 / ChefDK 0.5.0.

data/base/code_generator/files/default/Berksfile

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

data/base/code_generator/files/default/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'berkshelf'
+gem 'test-kitchen'
+gem 'kitchen-vagrant'

data/base/code_generator/files/default/LICENSE

@@ -0,0 +1,3 @@
+Copyright (C) 2014 Your Organization, Inc.
+
+All rights reserved - Do Not Redistribute

data/base/code_generator/files/default/Thorfile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/setup'
+require 'berkshelf/thor'
+
+begin
+  require 'kitchen/thor_tasks'
+  Kitchen::ThorTasks.new
+rescue LoadError
+  puts '>>>>> Kitchen gem not loaded, omitting tasks' unless ENV['CI']
+end

data/base/code_generator/files/default/_chef_client.rb

@@ -0,0 +1,14 @@
+# Your organization's chef-client settings
+interval = 600
+splay = 300
+node.set['chef_client']['interval'] = interval
+node.set['chef_client']['splay'] = splay
+
+# Requires Chef 12 client or a new version of Chef 11 client
+# Always explicitly set security settings: validate SSL
+node.set['chef_client']['config']['verify_api_cert'] = true
+node.set['chef_client']['config']['ssl_verify_mode'] = ':verify_peer'
+
+include_recipe 'chef-client::config'
+include_recipe 'chef-client::service'
+include_recipe 'chef-client::delete_validation'

data/base/code_generator/files/default/_defaults_linux.rb

@@ -0,0 +1,16 @@
+if platform_family?('debian', 'rhel')
+  node.set['omnibus_updater']['version'] = '12.3.0'
+  node.set['omnibus_updater']['restart_chef_service'] = true
+  include_recipe 'omnibus_updater'
+
+  # Install CA certificate
+  directory '/etc/chef/trusted_certs' do
+    recursive true
+    action :create
+  end
+
+  # If you are running your own CA
+  # bundle your public certificate with the cookbook
+  # and use a cookbook_file resource to drop it on the machine
+  # in /etc/chef/trusted_certs
+end

data/base/code_generator/files/default/_defaults_windows.rb

@@ -0,0 +1,41 @@
+if platform_family? 'windows'
+  # Install CA certificate
+  directory 'C:/chef/trusted_certs' do
+    recursive true
+    action :create
+  end
+  # If you are running your own CA
+  # bundle your public certificate with the cookbook
+  # and use a cookbook_file resource to drop it on the machine
+  # in C:/chef/trusted_certs
+
+  # install chocolatey so we have package management
+  include_recipe 'chocolatey'
+
+  # If you like optimizations like the one below, check out Boxstarter
+  # http://www.boxstarter.org/
+  # always display all items in the tray
+  registry_key 'HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Explorer' do
+    values [{ name: 'EnableAutoTray', type: :dword, data: 00000000 }]
+    recursive true
+    action :create
+  end
+
+  # Eliminate DSC collisions with Chef by disabling LCM.
+  powershell_script 'apply_lcm' do
+    code <<-EOH
+    configuration LCM
+    {
+      LocalConfigurationManager
+      {
+        ConfigurationMode = "ApplyOnly"
+      }
+    }
+    LCM -OutputPath #{Chef::Config[:file_cache_path]}
+    Set-DscLocalConfigurationManager -Path #{Chef::Config[:file_cache_path]}
+    EOH
+    not_if '(Get-DscLocalConfigurationManager).ConfigurationMode -eq "ApplyOnly"'
+  end
+
+  # If you are using DSC you will need to remote_file and install any DSC extensions you are using.
+end

data/base/code_generator/files/default/chefignore

@@ -0,0 +1,95 @@
+# Put files/directories that should be ignored in this file when uploading
+# or sharing to the community site.
+# Lines that start with '# ' are comments.
+
+# OS generated files #
+######################
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+
+# SASS #
+########
+.sass-cache
+
+# EDITORS #
+###########
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED ##
+##############
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+
+# Testing #
+###########
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+Guardfile
+Procfile
+
+# SCM #
+#######
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+
+# Berkshelf #
+#############
+Berksfile
+Berksfile.lock
+cookbooks/*
+tmp
+
+# Cookbooks #
+#############
+CONTRIBUTING
+
+# Strainer #
+############
+Colanderfile
+Strainerfile
+.colander
+.strainer
+
+# Vagrant #
+###########
+.vagrant
+Vagrantfile
+
+# Travis #
+##########
+.travis.yml

data/base/code_generator/files/default/gitignore

@@ -0,0 +1,16 @@
+.vagrant
+Berksfile.lock
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+
+# Bundler
+Gemfile.lock
+bin/*
+.bundle/*
+
+.kitchen/
+.kitchen.local.yml

data/base/code_generator/recipes/cookbook.rb

@@ -0,0 +1,86 @@
+context = ChefDK::Generator.context
+cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
+attribute_context = context.cookbook_name.gsub(/-/, '_')
+
+# Create cookbook directories
+cookbook_directories = [
+  'attributes',
+  'recipes',
+  'templates/default',
+  'files/default',
+  'test/integration/default'
+]
+cookbook_directories.each do |dir|
+  directory File.join(cookbook_dir, dir) do
+    recursive true
+  end
+end
+
+# Create basic files
+files_basic = %w(
+  Berksfile
+  chefignore
+  Gemfile
+  LICENSE
+  Thorfile
+)
+files_basic.each do |file|
+  cookbook_file File.join(cookbook_dir, file) do
+    action :create_if_missing
+  end
+end
+
+# Create basic files from template
+files_template = %w(
+  metadata.rb
+  README.md
+  CHANGELOG.md
+  .kitchen.yml
+)
+files_template.each do |file|
+  template File.join(cookbook_dir, file) do
+    helpers(ChefDK::Generator::TemplateHelper)
+    action :create_if_missing
+  end
+end
+
+# Create recipes
+files_recipes = %w(
+  _chef_client.rb
+  _defaults_linux.rb
+  _defaults_windows.rb
+)
+files_recipes.each do |file|
+  cookbook_file File.join(cookbook_dir, 'recipes', file) do
+    action :create_if_missing
+  end
+end
+
+# Create more complex files from templates
+template "#{cookbook_dir}/attributes/default.rb" do
+  source 'default_attributes.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+  variables(
+    attribute_context: attribute_context)
+end
+template "#{cookbook_dir}/recipes/default.rb" do
+  source 'default_recipe.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# git
+if context.have_git
+  unless context.skip_git_init
+
+    execute('initialize-git') do
+      command('git init .')
+      cwd cookbook_dir
+    end
+  end
+
+  cookbook_file "#{cookbook_dir}/.gitignore" do
+    source 'gitignore'
+  end
+end