souschef 0.4.0

data/lib/souschef/template.rb

@@ -0,0 +1,26 @@
+require 'souschef/template/base'
+require 'souschef/template/metadata'
+require 'souschef/template/license'
+require 'souschef/template/readme'
+require 'souschef/template/rubocop'
+require 'souschef/template/chefspec'
+require 'souschef/template/serverspec'
+require 'souschef/template/rakefile'
+
+module Souschef
+  # Creates various files from predefined templates
+  class Template
+    # Public - Create needed standardised files
+    #
+    # Returns nil
+    def self.run(opts)
+      Souschef::Template::Rubocop.new(opts).create
+      Souschef::Template::Chefspec.new(opts).create
+      Souschef::Template::Serverspec.new(opts).create
+      Souschef::Template::Metadata.new(opts).create
+      Souschef::Template::License.new(opts).create
+      Souschef::Template::Readme.new(opts).create
+      Souschef::Template::Rakefile.new(opts).create
+    end
+  end
+end

data/lib/souschef/template/base.rb

@@ -0,0 +1,69 @@
+module Souschef
+  class Template
+    # Base class containing reusable functions
+    class Base
+      attr_accessor :path, :ots
+
+      def initialize(opts)
+        @opts = opts
+        @path = opts[:path]
+      end
+
+      private
+
+      # Private - Return location of a custom template file if it exists, or
+      # return the default version
+      #
+      # Return String
+      def datafile_path(file)
+        local_profile = "~/.souschef/#{@opts[:profile]}/#{file}"
+        profile = File.expand_path(local_profile, __FILE__)
+
+        if File.exist?(profile)
+          profile
+        else
+          p = "../../../../data/#{file}"
+          File.expand_path(p, __FILE__)
+        end
+      end
+
+      # Private - Print out message if verbose option is selected
+      #
+      # Return nil
+      def info(msg)
+        Souschef::Print.info(msg) if @opts[:verbose]
+      end
+
+      # Private - Return path to the file inside cookbook directory
+      #
+      # Return String
+      def cookbook_file_path(file)
+        File.join(@path, file)
+      end
+
+      # Private - Write data to the desired file
+      #
+      # Returns nil
+      def write_file(file, data)
+        File.open(file, 'w') { |fd| fd.write(data) }
+      end
+
+      # Private - Load ERB template
+      #
+      # file - String file name
+      #
+      # Returns String
+      def load_erb_file(file)
+        File.read(datafile_path(file))
+      end
+
+      # Private - Creates spec/ directory if missing
+      #
+      # Return nil
+      def create_spec_dir(spec_dir)
+        info "Create #{spec_dir} directory"
+        Dir.mkdir(spec_dir)
+      end
+    end
+  end
+end

data/lib/souschef/template/chefspec.rb

@@ -0,0 +1,26 @@
+module Souschef
+  class Template
+    # Create spechelper for Chefspec
+    class Chefspec < Souschef::Template::Base
+      def initialize(opts)
+        super(opts)
+      end
+      # Public - Create spec/spec_helper.rb file
+      #
+      # cookbook - String Cookbook name
+      #
+      # Returns nil
+      def create
+        spec_dir = File.join(@path, 'spec')
+
+        tmpl = ERB.new(load_erb_file('chefspec/spec_helper.rb'))
+        data = tmpl.result(binding)
+
+        create_spec_dir(spec_dir) unless File.directory?(spec_dir)
+
+        info 'Creating Chefspec helper'
+        write_file(cookbook_file_path('spec/spec_helper.rb'), data)
+      end
+    end
+  end
+end

data/lib/souschef/template/license.rb

@@ -0,0 +1,25 @@
+module Souschef
+  class Template
+    # Create standard LICENSE
+    class License < Souschef::Template::Base
+      def initialize(opts)
+        super(opts)
+      end
+
+      # Public - Create a valid License file
+      #
+      # cookbook - String Cookbook name
+      #
+      # Returns nil
+      def create
+        tmpl = ERB.new(load_erb_file('license.erb'))
+        @year = Time.now.year
+        @maintainer = @opts[:souschef][:maintainer]
+        data = tmpl.result(binding)
+
+        info 'Updating LICENSE file'
+        write_file(cookbook_file_path('LICENSE'), data)
+      end
+    end
+  end
+end

data/lib/souschef/template/metadata.rb

@@ -0,0 +1,30 @@
+# Souschef
+module Souschef
+  class Template
+    # Creates a well defined maetadata.rb
+    class Metadata < Souschef::Template::Base
+      attr_accessor :cookbook
+
+      def initialize(opts)
+        super(opts)
+      end
+
+      # Public - Create file start
+      #
+      # cookbook - String cookbook name
+      #
+      # Returns nil
+      def create
+        tmpl = ERB.new(load_erb_file('metadata.erb'))
+        @cookbook = @opts[:cookbook]
+        @maintainer = @opts[:souschef][:maintainer]
+        @maintainer_email = @opts[:souschef][:maintainer_email]
+        @license = @opts[:souschef][:license]
+        data = tmpl.result(binding)
+
+        info 'Updating metadata.rb'
+        write_file(cookbook_file_path('metadata.rb'), data)
+      end
+    end
+  end
+end

data/lib/souschef/template/rakefile.rb

@@ -0,0 +1,23 @@
+module Souschef
+  class Template
+    # Add Rakefile for testing support
+    class Rakefile < Souschef::Template::Base
+      def initialize(opts)
+        super(opts)
+      end
+
+      # Public - Create a Rakefile from our Template
+      #
+      # cookbook - String Cookbook name
+      #
+      # Returns nil
+      def create
+        tmpl = ERB.new(load_erb_file('rakefile.erb'))
+        data = tmpl.result(binding)
+
+        info 'Setting up Rakefile'
+        write_file(cookbook_file_path('Rakefile'), data)
+      end
+    end
+  end
+end

data/lib/souschef/template/readme.rb

@@ -0,0 +1,24 @@
+module Souschef
+  class Template
+    # Updates README.md inside cookbook folder
+    class Readme < Souschef::Template::Base
+      def initialize(opts)
+        super(opts)
+      end
+
+      # Public - Create standardised README
+      #
+      # Return nil
+      def create
+        tmpl = ERB.new(load_erb_file('readme.erb'))
+        @cookbook = @opts[:cookbook]
+        @maintainer = @opts[:souschef][:maintainer]
+        @maintainer_email = @opts[:souschef][:maintainer_email]
+        data = tmpl.result(binding)
+
+        info 'Updating README file'
+        write_file(cookbook_file_path('README.md'), data)
+      end
+    end
+  end
+end

data/lib/souschef/template/rubocop.rb

@@ -0,0 +1,22 @@
+module Souschef
+  class Template
+    # Configure Rubocop configuratiopn
+    class Rubocop < Souschef::Template::Base
+      def initialize(opts)
+        super(opts)
+      end
+      # Public - Create a .rubocop file
+      #
+      # cookbook - String Cookbook name
+      #
+      # Returns nil
+      def create
+        tmpl = ERB.new(load_erb_file('rubocop/rubocop.yml'))
+        data = tmpl.result(binding)
+
+        info 'Setting up Rubocop configuration'
+        write_file(cookbook_file_path('.rubocop.yml'), data)
+      end
+    end
+  end
+end

data/lib/souschef/template/serverspec.rb

@@ -0,0 +1,27 @@
+module Souschef
+  class Template
+    # Serverspec configurator
+    class Serverspec < Souschef::Template::Base
+      def initialize(opts)
+        super(opts)
+      end
+      # Public - Create serverspec helper
+      #
+      # cookbook - String Cookbook name
+      #
+      # Returns nil
+      def create
+        spec_dir = File.join(@path, 'test', 'integration', 'default',
+                             'serverspec')
+        spec_helper = File.join(spec_dir, 'spec_helper.rb')
+
+        tmpl = ERB.new(load_erb_file('serverspec/serverspec_helper.rb'))
+        data = tmpl.result(binding)
+
+        create_spec_dir(spec_dir) unless File.directory?(spec_dir)
+        info 'Creating Serverspec helper'
+        write_file(spec_helper, data)
+      end
+    end
+  end
+end

data/lib/souschef/testkitchen.rb

@@ -0,0 +1,135 @@
+require 'souschef/testkitchen/docker'
+require 'souschef/testkitchen/solusvm'
+require 'souschef/testkitchen/virtualbox'
+
+module Souschef
+  # TestKitchen generator
+  class Testkitchen
+    attr_accessor :files, :cookbook, :opts, :metadata
+
+    def initialize(opts)
+      @opts = opts
+      @cookbook = opts[:cookbook]
+      @file = kitchen_driver_file
+      metadata_info
+    end
+
+    # Public - Write down TestKitchen configuration
+    #
+    # Returns nil
+    def configure
+      if @opts[:docker]
+        Souschef::Print.info 'Creating Docker configuration .kitchen.local.yml'
+        write(:docker, Souschef::Testkitchen::Docker.new(@cookbook).yaml)
+      end
+      if @opts[:solusvm]
+        Souschef::Print.info 'Creating SolusVM configuraton .kitchen.local.yml'
+        write(:solusvm, Souschef::Testkitchen::Solusvm.new(@cookbook).yaml)
+      end
+
+      Souschef::Print.info 'Creating Vagrant configuration in .kitchen.yml'
+      write(:virtualbox, Souschef::Testkitchen::Virtualbox.new(@cookbook).yaml)
+    end
+
+    # Public - Copy the already generated files from the data/ directory
+    #
+    # Returns nil
+    def setup
+      templates = ['default']
+      templates << @opts[:testkitchen] if @opts[:testkitchen]
+
+      templates.each { |type| create_file(type) }
+    end
+
+    private
+
+    # Private - Read metadata file
+    #
+    # Return Hash
+    def metadata_info
+      @metadata = Chef::Cookbook::Metadata.new
+      @metadata.from_file(File.join(@opts[:path], 'metadata.rb'))
+    end
+
+    # Private - Creates the TestKitchen YML file based on the provided template
+    #
+    # Returns nil
+    def create_file(type)
+      cb_file, source_file = get_locations(type)
+
+      File.open(cb_file, 'w') { |f| f.write(process_template(source_file)) }
+
+      if @opts[:verbose]
+        Souschef::Print.info "Creating Testkitchen #{type} configuration"
+      end
+    rescue TypeError
+      Souschef::Print.error 'SKipping'
+    end
+
+    # Private - Return location of cookbook file and source template file
+    #
+    # Return Array
+    def get_locations(type)
+      case type
+      when 'default'
+        cb_file = File.join(@opts[:path], '.kitchen.yml')
+        source_file = template_location(type)
+      else
+        cb_file = File.join(@opts[:path], '.kitchen.local.yml')
+        source_file = template_location(type)
+      end
+
+      [cb_file, source_file]
+    end
+
+    # Private - Generate the .kitchen.yml file based on our cookbook
+    #
+    # Returns String
+    def process_template(source_file)
+      rfile = ERB.new(File.read(source_file))
+      @cookbook = @metadata.name
+
+      rfile.result(binding)
+    end
+
+    # Private - Return location of the preconfigured .kitchen*.yml files
+    #
+    # Returns String
+    def template_location(type)
+      local = File.expand_path(
+        "~/.souschef/#{@opts[:profile]}/testkitchen/kitchen.#{type}.erb",
+        __FILE__)
+
+      bundled = File.expand_path(
+        "../../../data/testkitchen/kitchen.#{type}.erb", __FILE__)
+
+      if !File.exist?(local) && !File.exist?(bundled)
+        if @opts[:verbose]
+          Souschef::Print.error "Missing custom configuration for TestKitchen \
+#{@opts[:testkitchen]} configuration"
+        end
+      else
+        File.exist?(local) ? local : bundled
+      end
+    end
+
+    # Private - Return full locations for files
+    #
+    # Returns Hash
+    def kitchen_driver_file
+      { virtualbox: File.join(@opts[:path], '.kitchen.yml'),
+        docker: File.join(@opts[:path], '.kitchen.local.yml'),
+        solusvm: File.join(@opts[:path], '.kitchen.local.yml')
+      }
+    end
+
+    # Private - Write down the configuration file
+    #
+    # Returns nile
+    def write(driver, data)
+      fd = File.open(kitchen_driver_file[driver], 'w')
+      fd.write(data)
+      fd.close unless fd.nil?
+    end
+  end
+end

data/lib/souschef/testkitchen/docker.rb

@@ -0,0 +1,97 @@
+module Souschef
+  class Testkitchen
+    # Testkitchen Docker configuration
+    class Docker
+      attr_accessor :config, :cookbook
+
+      def initialize(cookbook)
+        @cookbook = cookbook
+        populate_configuration
+      end
+
+      # Public - Return YAML formatted data
+      #
+      # Returns String
+      def yaml
+        @config.to_yaml
+      end
+
+      private
+
+      # Private - Populate @config
+      #
+      # Returns nil
+      def populate_configuration
+        @config = { 'driver' => define_driver,
+                    'provisioner' => define_provisioner,
+                    'platforms' => define_platforms,
+                    'suits' => define_suits }
+      end
+
+      # Private - Define driver section
+      #
+      # Returns Hash
+      def define_driver
+        { 'name' => 'docker',
+          'privileged' => true
+        }
+      end
+
+      # Private - Define provisioner
+      #
+      # Returns Hash
+      def define_provisioner
+        { 'name' => 'chef_zero',
+          'require_chef_omnibus' => 'latest' }
+      end
+
+      # Private - Define platforms configuration
+      #
+      # Returns Array
+      def define_platforms
+        if define_run_list['run_list'].empty?
+          [define_centos_5, define_centos_6]
+        else
+          [define_centos_5, define_centos_6, define_run_list]
+        end
+      end
+
+      # Private - Define CentOS 5.10 platforms
+      #
+      # Returns Hash
+      def define_centos_5
+        { 'name' => 'centos-5.10',
+          'driver_config' => { 'image' => 'akrasic/centos5',
+                               'platform' => 'centos',
+                               'use_sudo' => false,
+                               'privileged' => true } }
+      end
+
+      # Private - Define CentOS 6.4 platform
+      #
+      # Returns Hash
+      def define_centos_6
+        { 'name' => 'centos-6.4',
+          'driver_config' => { 'image' => 'centos:6.4',
+                               'platform' => 'centos',
+                               'use_sudo' => false,
+                               'privileged' => true } }
+      end
+
+      # Private - Define Runlist for platforms
+      #
+      # Returs Hash
+      def define_run_list
+        { 'run_list' => '' }
+      end
+
+      # Private - Define suits
+      #
+      # Returns Hash
+      def define_suits
+        [{ 'name' => 'default',
+           'run_list' => ["recipe[#{@cookbook}::default]"] }]
+      end
+    end
+  end
+end