souschef 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8346f12ba0184f1d32193a4f9fe4fddb1b4d8048
+  data.tar.gz: 93f8a98bd81ede8f3638f81f19db3fa283e73ae4
+SHA512:
+  metadata.gz: 20e084327520acbc3f39404a85c47a55dc438a36dcb94396ed67357a508606ce1928fdb97b9ff04cae0d441c3669fab07f1f5a4f9b4100f1bc27bdcc5a49b66c
+  data.tar.gz: eabede258978b53326a716ffbd93b01d6db9a32a5bbc4b36161d171bfe208473ed4bb66ffffdcd48cbd7cc4a2f5a219e09f34ba6576c4354e6e8f62079afb15b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in souschef.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Antun Krasic
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,177 @@
+# Souschef
+
+Souschef is a helper script to aid with starting a developing Chef cookbook by automating the creation of cookbook per standards.
+
+Cookbook creation uses following steps:
+- Using Berkshelf to create the cookbook structure
+- Populates the `Gemfile`, `.kitchen.yml`, `.rubocop.yml`
+- Adjusts the `metadata.rb`, `README` and `LICENSE`
+- Configured directorie and places `spec_helper.rb` for Chefspec and Serverspec
+- Adds `Rakefile` which runs Foodcritic, Rubocop, RSpec and TestKitchecn tests 
+
+Souschef also can create new recipe and spec test files for you:
+- file under `recipes/` directory
+- file under `spec/unit/` directory
+- file under `test/integration/default/serverspec/localhost/` directory
+
+
+## Installation
+Clone this repository and do:
+`gem build souschef.gemspec`
+`gem install souschef-*.gem`
+
+
+# Getting started
+First off you'd need to generate your configuration file that will hold data 
+about your profile - `maintainer`, `maintainer_email` and `license` which are
+written to the `~/.souschef.yml` file.
+Additionally, you can have several profiles specified by the `--profile` argument.
+
+**Creating default configuration**
+
+`souschef --configure --maintainer 'John Doe' --maintainer-email 'john@doe.com' --license 'MIT'`
+
+or 
+
+`souschef  --profile 'default' --configure --maintainer 'John Doe' --maintainer-email 'john@doe.com' --license 'MIT'`
+## Usage
+
+Currently available options:
+
+```
+Options:
+          --cookbook <s>:   Name of your cookbook
+              --path <s>:   Define cookbook directory path (relative)
+       --testkitchen <s>:   Pick your additional configuration to create
+                            .kitchen.local.yml file
+              --scaffold:   Create recipe, chefspec and serverspec files for
+                            recipe
+            --recipe <s>:   Recipe name, used along with --scaffold
+           --profile <s>:   Pick your configuration profile (default: default)
+                 --force:   Force create action
+             --configure:   Create configuration file
+               --verbose:   Print out detailed information
+        --maintainer <s>:   Maintainer name
+  --maintainer-email <s>:   Maintainer email
+           --license <s>:   Licese you want to use, be explicit
+
+```
+
+# Example usage
+**Create cookbook in current directory**
+
+`souschef --cookbook mycb --verbose`
+
+**Create cookbook using alternate profile from your configuration file**
+
+`souschef --cookbook mycb --profile other --verbose`
+
+**Create cookbook in a subfolder of current directory**
+
+`souschef --cookbook mycb --path subdir --verbose`
+
+**Use scaffold to get you started writing a new recipe and tests**
+
+`souschef --scaffold --recipe install`
+
+# Profile support
+Souschef lets you one or several profiles/configurations under one roof, to get
+started simply configure it via:
+
+```
+souschef --configure --maintainer "YOUR NAME" \
+--maintainer-email "YOUR EMAIL" \
+--license "Restricted license, do not touch"
+```
+
+Profile configuration is written inside `~/.souschef.yml` file and can be easily
+edited by hand if needed.
+
+# Note on TestKitchen
+Souschef uses a default template for TestKitchen `.kitchen.yaml`. If this
+doesn't fit your needs, please check the section on custimization and create
+your own `.kitchen.default.erb` template.
+
+If you are sporting Docker, DigitalOcean or any other TestKitchen driver please
+follow these steps to make it into your newly generated cookbook:
+
+**Create testkitchen directory for your profile**
+
+Assuming that your will be using this for the "default" profile, but adjust
+accordingly:
+
+`mkdir -p ~/.souschef/default/testkitchen/`
+
+**Create your new ERB driver configuration**
+
+To differentiate between drivers, TestKitchen template filename has the
+following format: kitchen.DRIVER.yml
+If you want to use your own Docker TestKitchen configuration please create
+following file and populate it with a valid YAML syntax.
+
+`vim ~/.souschef/default/testkitchen/kitchen.docker.erb`
+
+**Create your new cookbook using TestKitchen Docker tempalte**
+
+`souschef --cookbook mycb --testkitchen docker`
+
+Souschef will create following  standard `.kitchen.yml` file and
+`.kitchen.local.yml` holding your Docker configuration. If you have a custom
+`kitchen.default.erb` Souschef will use that to generate `.kitchen.yml` over the
+bundled template.
+
+# Customization
+
+When creating a cookbook, Souschef will look first if a custom directory for the
+chosen profile exists - `~/.souschef/$PROFILE` and search if the template it is
+currently creating exists there - if so, it will be used instead of the bundled
+one.
+
+
+You can customize the default configuration that comes with few easy steps,
+below is an example for a custom recipe file
+
+**Create ~/.souschef/ directory for chosen profile**
+
+`mkdir -p ~/souschef/default/recipe`
+
+**Create your own rubocop.yml file**
+
+`vim ~/.shouschef/default/recipe/recipe.erb`
+
+**Run souschef command and you will see following in the output**
+
+```
+~> Create default[recipe] from /home/user/.souschef/default/recipe/recipe.erb
+```
+
+**Full directory structure of custom files**
+
+```
+├── chefspec                                                                                                                                                           
+│   ├── chefspec.erb                                                                                                                                                   
+│   └── spec_helper.rb                                                                                                                                                 
+├── gemfile.yml                                                                                                                                                        
+├── license.erb                                                                                                                                                        
+├── metadata.erb                                                                                                                                                       
+├── rakefile.erb                                                                                                                                                       
+├── readme.erb                                                                                                                                                         
+├── recipe                                                                                                                                                             
+│   └── recipe.erb                                                                                                                                                     
+├── rubocop                                                                                                                                                            
+│   └── rubocop.yml                                                                                                                                                    
+├── serverspec                                                                                                                                                         
+│   ├── serverspec.erb                                                                                                                                                 
+│   └── serverspec_helper.rb                                                                                                                                           
+└── testkitchen                                                                                                                                                        
+    └── kitchen.default.erb  
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/souschef/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/souschef

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby
+#	souschef - Chef developemnt helper
+$LOAD_PATH << File.join(File.dirname(__FILE__), '../lib')
+require 'souschef'
+
+options = Trollop::Parser.new do
+  version "SousChef #{Souschef::VERSION}"
+
+  opt :cookbook, 'Name of your cookbook', type: :string
+  opt :path, 'Define cookbook directory path (relative)', type: :string
+  opt :testkitchen, "Pick your additional configuration to create \
+.kitchen.local.yml file", type: :string
+  opt :scaffold, 'Create recipe, chefspec and serverspec files for recipe'
+  opt :recipe, 'Recipe name, used along with --scaffold', type: :string
+  opt :profile, 'Pick your configuration profile', default: 'default'
+  opt :force, 'Force create action'
+  opt :configure, 'Create configuration file'
+  opt :verbose, 'Print out detailed information'
+  opt :maintainer, 'Maintainer name', type: :string
+  opt :maintainer_email, 'Maintainer email', type: :string
+  opt :license, 'Licese you want to use, be explicit', type: :string
+end
+
+opts = Trollop.with_standard_exception_handling options do
+  fail Trollop::HelpNeeded if ARGV.empty?
+  options.parse ARGV
+end
+
+begin
+  Souschef::Runner.new(opts).run
+rescue RuntimeError => e
+  Souschef::Print.error e
+end

data/data/chefspec/chefspec.erb

@@ -0,0 +1,6 @@
+# Chefspec testing for <%= @recipe %> recipe
+require 'spec_helper'
+# Start description
+describe '<%= @cookbook %>::<%= @recipe %>' do
+	let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+end

data/data/chefspec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'chefspec'
+require 'chefspec/berkshelf'
+
+RSpec.configure do |config|
+  config.color = true
+end
+
+at_exit { ChefSpec::Coverage.report! }

data/data/gemfile.yml

@@ -0,0 +1,23 @@
+---
+:source:
+- https://rubygems.org
+:general:
+- :name: chefspec
+  :version: "~> 4"
+- :name: berkshelf
+  :version: "~> 3"
+- rake
+- rubocop
+- foodcritic
+:group:
+- :group_name: development
+  :gems:
+  - :name: vagrant-berkshelf
+    :github: berkshelf/vagrant-berkshelf
+  - :name: vagrant-omnibus
+    :github: schisamo/vagrant-omnibus
+- :group_name: integration
+  :gems:
+  - test-kitchen
+  - kitchen-vagrant
+  - kitchen-docker

data/data/license.erb

@@ -0,0 +1,3 @@
+Copyright (C) <%= @year %> <%= @maintainer %>
+
+All rights reserved - Do Not Redistribute

data/data/metadata.erb

@@ -0,0 +1,7 @@
+name '<%= @cookbook %>'
+maintainer '<%= @maintainer %>'
+maintainer_email '<%= @maintainer_email %>'
+license '<%= @license %>'
+description 'Installs/Configures <%= @cookbook %>'
+long_description 'Installs/Configures <%= @cookbook %>'
+version '0.1.0'

data/data/rakefile.erb

@@ -0,0 +1,39 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'foodcritic'
+require 'kitchen'
+
+# Style tests. Rubocop and Foodcritic
+namespace :style do
+  desc 'Run Ruby style checks'
+  RuboCop::RakeTask.new(:ruby)
+
+  desc 'Run Chef style checks'
+  FoodCritic::Rake::LintTask.new(:chef) do |t|
+    t.options = {
+      fail_tags: ['any'],
+      tags: ['~FC005']
+    }
+  end
+end
+
+desc 'Run all style checks'
+task style: ['style:chef', 'style:ruby']
+
+# Rspec and ChefSpec
+desc "Run ChefSpec examples"
+RSpec::Core::RakeTask.new(:spec)
+
+# Integration tests. Kitchen.ci
+namespace :integration do
+  desc 'Run Test Kitchen with Vagrant'
+  task :vagrant do
+    Kitchen.logger = Kitchen.default_file_logger
+    Kitchen::Config.new.instances.each do |instance|
+      instance.test(:always)
+    end
+  end
+end
+
+# Default
+task default: ['style', 'spec', 'integration:vagrant']

data/data/readme.erb

@@ -0,0 +1,47 @@
+## <%= @cookbook %>
+
+## Description
+
+INSERT DESCRIPTION FOR <%= @cookbook %> HERE
+
+---
+
+## Supported Platforms
+
+The following platforms and versions are tested and supported using
+[test-kitchen](http://kitchen.ci/).
+
+* CentOS 5.10, 6.5
+
+
+---
+
+## Cookbook Dependencies
+
+* None
+
+---
+
+## Attributes
+
+* None
+
+---
+
+## Recipes
+
+* default
+    + None
+
+---
+
+## Tests
+
+* default
+    + None
+
+---
+
+## Author
+
+Author: <%= @maintainer %> (<%= @maintainer_email %>)

data/data/recipe/recipe.erb

@@ -0,0 +1,6 @@
+# Cookbook Name:: <%= @cookbook %>
+# Recipe:: <%= @recipe %>
+#
+# Copyright (C) <%= @year %> <%= @maintainer %>
+#
+# <%= @license %>

data/data/rubocop/rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Include:
+    - Berksfile
+    - Gemfile
+    - Rakefile
+  Exclude:
+    - vendor/**/*
+AlignParameters:
+  Enabled: false
+Encoding:
+  Enabled: false
+HashSyntax:
+  Enabled: false
+LineLength:
+  Enabled: false
+MethodLength:
+  Max: 30
+StringLiterals:
+  Enabled: false