souschef 0.4.0

data/data/serverspec/serverspec.erb

@@ -0,0 +1,2 @@
+# Serverspec testing for <%= @recipe %> recipe
+require 'spec_helper'

data/data/serverspec/serverspec_helper.rb

@@ -0,0 +1,10 @@
+require 'serverspec'
+require 'pathname'
+include Serverspec::Helper::Exec
+include Serverspec::Helper::DetectOS
+
+RSpec.configure do |c|
+  c.before :all do
+    c.os = backend(Serverspec::Commands::Base).check_os
+  end
+end

data/data/testkitchen/kitchen.default.erb

@@ -0,0 +1,22 @@
+---
+driver:
+  name: vagrant
+  customize:
+    memory: 1024
+
+provisioner:
+  name: chef_zero
+  require_chef_omnibus: latest
+
+platforms:
+  - name: centos-5.10
+    driver_config:
+      box: centos-5.10-min-x86_64
+  - name: centos-6.4
+    driver_config:
+      box: centos-6.5-x86_64
+suites:
+  - name: default
+    run_list:
+      - recipe[<%= @cookbook %>::default]
+    attributes:

data/lib/souschef.rb

@@ -0,0 +1,16 @@
+require 'erb'
+require 'yaml'
+require 'open3'
+require 'trollop'
+require 'colorize'
+require 'ruth'
+require 'souschef/runner'
+require 'souschef/configure/file'
+require 'souschef/config'
+require 'souschef/berkshelf'
+require 'souschef/scaffold'
+require 'souschef/gemfile'
+require 'souschef/testkitchen'
+require 'souschef/template'
+require 'souschef/print'
+require 'souschef/version'

data/lib/souschef/berkshelf.rb

@@ -0,0 +1,93 @@
+module Souschef
+  # Includes slave functions that do all the work
+  class Berkshelf
+    attr_accessor :opts, :cookbook_dir
+
+    def initialize(opts)
+      @opts = opts
+    end
+
+    # Public - Tell Berkshelf to create a cookbook
+    #
+    # Returns nil
+    def berks_create
+      remove_old_readme
+      Souschef::Print.info 'Creating cookbook structure' if @opts[:verbose]
+
+      i, o, e, w = Open3.popen3(berks_cmd)
+      print_open3_stdout(o) if @opts[:verbose]
+      remove_vagrantfile
+      print_open3_stdout(e)
+      i.close
+      fail 'Berks failed' unless w.value == 0
+    end
+
+    private
+
+    # Private - Returns berkshelf command depending on the path
+    #
+    # Returns String
+    def berks_cmd
+      if @opts[:path] == Dir.pwd
+        "#{which_berks} cookbook #{@opts[:cookbook]} ."
+      else
+        path = @opts[:path].gsub("#{Dir.pwd}/", '')
+        "#{which_berks} cookbook #{@opts[:cookbook]} #{path}"
+      end
+    end
+
+    # Private - Remove README from cookbook dir
+    #
+    # Returns nil
+    def remove_old_readme
+      readme = File.join(@opts[:path], 'README.md')
+      File.delete(readme) if File.exist?(readme)
+    end
+
+    # Private - Remove README from cookbook dir
+    #
+    # Returns nil
+    def remove_vagrantfile
+      vagrantfile = File.join(@opts[:path], 'Vagrantfile')
+      File.delete(vagrantfile) if File.exist?(vagrantfile)
+    end
+
+    # Private - Obtain berks executable full path
+    #
+    # Returns String
+    def which_berks
+      i, o, e, w = Open3.popen3('which berks')
+      fail 'berks executable not found on system' if w.value.to_i > 0
+      i.close
+      e.close
+      o.read.chomp
+    end
+
+    # Private - Print out Open3 STDOUT stream
+    #
+    # stdout - Open3 stdout stream
+    #
+    # Return nil
+    def print_open3_stdout(stdout)
+      stdout.read.split("\n").each { |msg| puts msg.colorize(:green) }
+    end
+
+    # Private - Print out a colorized message
+    #
+    # msg - String message
+    #
+    # Returns nil
+    def colour(msg)
+      puts msg.colorize(:red)
+    end
+
+    # Private - Print out info message
+    #
+    # msg - String message
+    #
+    # Returns nil
+    def info_msg(msg)
+      puts msg.colorize(:yellow)
+    end
+  end
+end

data/lib/souschef/config.rb

@@ -0,0 +1,20 @@
+module Souschef
+  # Loads Souschef configuration YAML
+  class Config
+    # Public - Reads the configuration file
+    #
+    # Returns Hash
+    def self.read
+      verify_file
+      YAML.load_file(File.expand_path('~/.souschef.yml'))
+    end
+
+    # Private - Checks if we have a configuraiton file
+    #
+    # Returns nil
+    def self.verify_file
+      conf = File.expand_path('~/.souschef.yml')
+      fail "'~/.souschef.yml' missing!" unless File.exist?(conf)
+    end
+  end
+end

data/lib/souschef/configure/file.rb

@@ -0,0 +1,46 @@
+module Souschef
+  class Configure
+    # Create Configuration file
+    class Yaml
+      attr_accessor :opts, :data
+
+      def initialize(opts)
+        @opts = opts
+        @souschef = File.expand_path('~/.souschef.yml')
+        read_configuration
+        add_values
+        write_configuration
+      end
+
+      private
+
+      # Private - Add CLI passed data into the configuration
+      #
+      # Return nil
+      def add_values
+        @data[@opts[:profile]] = { maintainer: @opts[:maintainer],
+                                   maintainer_email: @opts[:maintainer_email],
+                                   license: @opts[:license] }
+      end
+
+      # Private - Read configuration file, if it exists, otherwise define @data
+      # as a empty Hash
+      #
+      # Returns Hash
+      def read_configuration
+        if File.exist?(@souschef)
+          @data ||= YAML.load_file(@souschef)
+        else
+          @data = {}
+        end
+      end
+
+      # Private - Write down configuration file
+      #
+      # Returns nil
+      def write_configuration
+        File.open(@souschef, 'w+') { |fd| fd.write(@data.to_yaml) }
+      end
+    end
+  end
+end

data/lib/souschef/gemfile.rb

@@ -0,0 +1,42 @@
+module Souschef
+  # Gemfile generator
+  class Gemfile < Ruth::Gemfile::Yaml
+    attr_accessor :opts
+
+    def initialize(opts)
+      @opts = opts
+      super(yaml_file_location)
+    end
+
+    # Public - Writes down the Gemfile location
+    #
+    # Returns nil
+    def write
+      Souschef::Print.info 'Populating Gemfile' if @opts[:verbose]
+      write_gemfile
+    end
+
+    private
+
+    # Private - Return location of YAML file
+    #
+    # Returns String
+    def yaml_file_location
+      File.expand_path('../../../data/gemfile.yml', __FILE__)
+    end
+
+    # Private - Return location of Gemfile
+    #
+    # Returns string
+    def gemfile_location
+      File.join(@opts[:path], 'Gemfile')
+    end
+
+    # Private - Write Gemfile data
+    #
+    # Returns nil
+    def write_gemfile
+      File.open(gemfile_location, 'w') { |file| file.write(output) }
+    end
+  end
+end

data/lib/souschef/print.rb

@@ -0,0 +1,40 @@
+module Souschef
+  # Prit out colorized information
+  class Print
+    # Public - Print info messate
+    #
+    # msg - String message
+    #
+    # Returns nil
+    def self.info(msg)
+      puts "~> #{msg}".colorize(:green)
+    end
+
+    # Public - Print header message
+    #
+    # msg - String message
+    #
+    # Returns nil
+    def self.header(msg)
+      puts "[*] #{msg}".colorize(:cyan)
+    end
+
+    # Public - Print error messate
+    #
+    # msg - String message
+    #
+    # Returns nil
+    def self.error(msg)
+      puts "#{msg}".colorize(:red)
+    end
+
+    # Public - Print warning  messate
+    #
+    # msg - String message
+    #
+    # Returns nil
+    def self.warning(msg)
+      puts "#{msg}".colorize(:orange)
+    end
+  end
+end

data/lib/souschef/runner.rb

@@ -0,0 +1,104 @@
+module Souschef
+  # Runner library that does all the hard work
+  class Runner
+    attr_accessor :opts
+
+    def initialize(opts)
+      @opts = opts
+      adjust_cb_path
+      load_configuration unless @opts[:configure]
+    end
+
+    # Public - Run Souschef
+    #
+    # Returns nil
+    def run
+      Souschef::Print.header "Using Souschef profile: #{opts[:profile]}"
+
+      if @opts[:scaffold]
+        Souschef::Scaffold.new(@opts).start
+      elsif @opts[:configure]
+        verify_configure_input
+        Souschef::Configure::Yaml.new(@opts)
+      else
+        Souschef::Print.header "Starting cookbook creation...\n"
+        cookbook_runlist
+      end
+    end
+
+    private
+
+    # Private - Create cookbook run list
+    #
+    # Returns nil
+    def cookbook_runlist
+      verify_cookbook_creation
+
+      Souschef::Print.header 'Berkshelf configuration'
+      Souschef::Berkshelf.new(@opts).berks_create
+      Souschef::Print.header 'Configure gemfile'
+      Souschef::Gemfile.new(@opts).write
+      Souschef::Print.header 'Create essential template files'
+      Souschef::Template.run(@opts)
+      # Mock Scaffold to generate default recipe and tests
+
+      Souschef::Print.header 'Create default recipe and tests'
+      Souschef::Scaffold.new(path: @opts[:path],
+                             recipe: 'default',
+                             profile: @opts[:profile],
+                             force: true,
+                             verbose: @opts[:verbose]).start
+
+      Souschef::Print.header 'Testkitchen configuration'
+      Souschef::Testkitchen.new(@opts).setup
+
+      Souschef::Print.header "Don't forget to run bundle install!"
+    end
+
+    # Private - Verify @opts values
+    #
+    # Return nil
+    def verify_configure_input
+      if @opts[:maintainer_given] || @opts[:maintainer_email_given] ||
+        @opts[:license_given]
+        unless @opts[:configure]
+          fail 'Please check Souschef options, you are missing --configure'
+        end
+      else
+        fail 'Please check if you have all options for configuration selected'
+      end
+    end
+
+    # Private - Verify cookbook creation options
+    #
+    # Return nil
+    def verify_cookbook_creation
+      fail 'You need to specify the cookbook name' if @opts[:cookbook].nil?
+    end
+
+    # Private - Verify Scaffold input
+    #
+    # Return nil
+    def verify_scaffold_input
+      fail 'Recipe name is missing for scaffold creation' if @opts[:recipe].nil?
+    end
+
+    # Private - Adjust cookbook path
+    #
+    # Return nil
+    def adjust_cb_path
+      if @opts[:path]
+        @opts[path] = File.join(Dir.pwd, @opts[:path])
+      else
+        @opts[:path] = Dir.pwd
+      end
+    end
+
+    # Private - Load contents of .souschef.yml configuration
+    #
+    # Returns nil
+    def load_configuration
+      @opts[:souschef] = Souschef::Config.read[@opts[:profile]]
+    end
+  end
+end

data/lib/souschef/scaffold.rb

@@ -0,0 +1,145 @@
+require 'chef/cookbook/metadata'
+require 'fileutils'
+
+module Souschef
+  # Automagically create needed files
+  class Scaffold
+    attr_accessor :opts, :dir, :recipe, :recipe_file, :cookbook, :metadata
+
+    def initialize(opts)
+      @opts = opts
+      @dir = Dir.pwd
+      metadata_info
+    end
+
+    def start
+      check_cookbook_name
+      check_for_metadata unless @opts[:force]
+      process_templates
+    end
+
+    private
+
+    # Private - Chef if cookbook name is set
+    #
+    # Returns nil
+    def check_cookbook_name
+      fail 'Please specify the recipe name' if @opts[:recipe].nil?
+    end
+
+    # Private - Read Chef metadata
+    #
+    # Returns String
+    def metadata_info
+      meta = File.join(@opts[:path], 'metadata.rb')
+      @metadata = Chef::Cookbook::Metadata.new
+      @metadata.from_file(meta)
+    end
+
+    # Private - Process tempaltes
+    #
+    # Return inl
+    def process_templates
+      %w( recipe serverspec chefspec ).each { |type| create_recipe_file(type) }
+    end
+
+    # Private - Creates recipe file based on the input
+    #
+    # Retunrns nil
+    def create_recipe_file(type)
+      source = template_location(type)
+      Souschef::Print.info("Create #{@opts[:recipe]}[#{type}] from #{source}"
+                          ) if @opts[:verbose]
+      check_for_directories(type)
+      write_file(return_file_location(type), generate_template(source))
+    end
+
+    # Private - Generate the template
+    #
+    # Return String
+    def generate_template(source)
+      rfile = ERB.new(File.read(source))
+      @recipe = @opts[:recipe]
+      @cookbook = @metadata.name
+      @maintainer = @metadata.maintainer
+      @license = @metadata.license
+      @year = Time.now.year
+
+      rfile.result(binding)
+    end
+
+    # Private - Return location of the template file, depending if custom
+    # configuration is set under ~/.souschef/%profile%/ or use the default
+    # template provided by Souschef gem.
+    #
+    # Returns String
+    def template_location(type)
+      local = File.expand_path(
+        "~/.souschef/#{@opts[:profile]}/#{type}/#{type}.erb", __FILE__)
+      bundled = File.expand_path("../../../data/#{type}/#{type}.erb", __FILE__)
+      File.exist?(local) ? local : bundled
+    end
+
+    # Private - Return location of directories
+    #
+    # Returns Hash
+    def return_directories
+      { recipe: File.join(@opts[:path], 'recipes'),
+        serverspec: File.join(@opts[:path], 'test', 'integration', 'default',
+                              'serverspec', 'localhost'),
+        chefspec: File.join(@opts[:path], 'spec', 'unit') }
+    end
+
+    # Private - Get path to the recipes file
+    #
+    # Return String
+    def return_file_location(type)
+      case type
+      when 'recipe'
+        File.join(return_directories[:recipe], "#{@opts[:recipe]}.rb")
+      when 'serverspec'
+        File.join(return_directories[:serverspec], "#{opts[:recipe]}_spec.rb")
+      when 'chefspec'
+        File.join(return_directories[:chefspec], "#{@opts[:recipe]}_spec.rb")
+      end
+    end
+
+    # Private - Check if directories exist
+    #
+    # Return nil
+    def check_for_directories(type)
+      dir = return_directories[type.to_sym]
+
+      if @opts[:versbose]
+        unless File.directory?(dir)
+          Souschef::Print.info "Creating missing directory #{dir}"
+        end
+      end
+      FileUtils.mkdir_p dir unless File.directory?(dir)
+    end
+
+    # Private - Locate metadata.rb
+    #
+    # Return nil
+    def check_for_metadata
+      meta = File.join(@opts[:path], 'metadata.rb')
+      fail 'Please return to the root of your cookbook' unless File.exist?(meta)
+    end
+
+    # Private - Write file
+    #
+    # Returns nil
+    def write_file(file, data)
+      check_for_file(file) unless @opts[:force]
+      fd = File.open(file, 'w')
+      fd.write(data)
+    end
+
+    # Private - Exit if file exists
+    #
+    # Returns nil
+    def check_for_file(file)
+      fail "#{file} already exists. Frozen in fear!" if File.exist?(file)
+    end
+  end
+end