boxes 2.0.0

data/lib/boxes/config.rb

@@ -0,0 +1,73 @@
+module Boxes
+  # Stores the configuration for Boxes.
+  class Config
+    # The default settings for the configuration.
+    DEFAULTS = {
+      environment_vars: [
+        { 'PACKER_CACHE_DIR' => (
+            Pathname.new(ENV['BOXES_HOME_DIR'] || '~/.boxes'
+                        ).expand_path + 'packer_cache') }
+      ],
+      template_paths: [
+        # the gem install directory
+        File.expand_path('../../../templates', __FILE__)
+      ],
+      script_paths: [
+        # the gem install directory
+        File.expand_path('../../../scripts', __FILE__)
+      ]
+    }
+
+    # The directory which boxes works out of.
+    def home_dir
+      @home_dir ||= Pathname.new(
+        ENV['BOXES_HOME_DIR'] || '~/.boxes').expand_path
+    end
+
+    # The directory inside the `home_dir` which boxes runs builds inside of.
+    def working_dir
+      @working_dir ||= Pathname.new(
+        ENV['BOXES_WORKING_DIR'] || home_dir + 'tmp').expand_path
+    end
+
+    # Paths known to boxes for discovering templates.
+    attr_accessor :template_paths
+
+    # Paths known to boxes for discovering scripts.
+    attr_accessor :script_paths
+
+    # A Hash of environment variables Boxes sets in the run environment.
+    attr_accessor :environment_vars
+
+    def initialize
+      configure_with(DEFAULTS)
+
+      return unless user_settings_file.exist?
+
+      user_settings = YAML.load_file(user_settings_file)
+      configure_with(user_settings)
+    end
+
+    private
+
+    def user_settings_file
+      home_dir + 'config.yml'
+    end
+
+    def configure_with(opts = {}) # rubocop:disable Metrics/MethodLength
+      opts.each do |k, v|
+        next unless respond_to?("#{k}=")
+
+        if v.class == Array
+          v.each do |e|
+            set = Set.new(send("#{k}".to_sym))
+            set << e
+            send("#{k}=".to_sym, set.to_a)
+          end
+        else
+          send("#{k}=".to_sym, v)
+        end
+      end
+    end
+  end
+end

data/lib/boxes/environment.rb

@@ -0,0 +1,74 @@
+module Boxes
+  # For creating and managing the environment which boxes uses.
+  class Environment
+    def initialize
+      FileUtils.mkdir_p(Boxes.config.working_dir)
+
+      copy_templates
+      copy_scripts
+    end
+
+    def available_templates
+      t = Dir.glob("#{Boxes.config.working_dir}/templates/*/**")
+      a = t.collect { |c| c.include?('preseed.cfg') ? next : c }.compact
+
+      a.collect do |c|
+        c = c.gsub(Boxes.config.working_dir.to_s + '/templates/', '')
+        c.gsub('.erb', '')
+      end
+    end
+
+    def hidden_templates
+      t = Dir.glob("#{Boxes.config.working_dir}/templates/*/**")
+      a = t.collect { |c| c.include?('preseed.cfg') ? c : next }.compact
+
+      a.collect do |c|
+        c.gsub(Boxes.config.working_dir.to_s + '/templates/', '')
+      end
+    end
+
+    def available_scripts
+      t = Dir.glob("#{Boxes.config.working_dir}/scripts/*")
+      a = t.collect { |c| c.include?('purge.sh') ? next : c }.compact
+
+      a.collect do |c|
+        c.gsub(Boxes.config.working_dir.to_s + '/scripts/', '')
+      end
+    end
+
+    def hidden_scripts
+      t = Dir.glob("#{Boxes.config.working_dir}/scripts/*")
+      a = t.collect { |c| c.include?('purge.sh') ? c : next }.compact
+
+      a.collect do |c|
+        c.gsub(Boxes.config.working_dir.to_s + '/scripts/', '')
+      end
+    end
+
+    private
+
+    def copy_templates
+      templates_dir = Boxes.config.working_dir + 'templates'
+
+      FileUtils.mkdir_p(templates_dir)
+
+      Boxes.config.template_paths.each do |template_path|
+        Dir.glob("#{template_path}/*").each do |src_template|
+          FileUtils.cp_r(src_template, templates_dir)
+        end
+      end
+    end
+
+    def copy_scripts
+      scripts_dir = Boxes.config.working_dir + 'scripts'
+
+      FileUtils.mkdir_p(Boxes.config.working_dir + 'scripts')
+
+      Boxes.config.script_paths.each do |script_path|
+        Dir.glob("#{script_path}/*").each do |src_script|
+          FileUtils.cp_r(src_script, scripts_dir)
+        end
+      end
+    end
+  end
+end

data/lib/boxes/errors.rb

@@ -0,0 +1,19 @@
+module Boxes
+  # A collection of errors which can be raised by boxes.
+  module Errors
+    # Base error class for all other errors.
+    class BoxesError < StandardError; end
+
+    # Raised when a template is missing.
+    class TemplateNotFoundError < BoxesError; end
+
+    # Raised when a script is missing.
+    class ScriptNotFoundError < BoxesError; end
+
+    # Raised when an expected argument is missing.
+    class MissingArgumentError < BoxesError; end
+
+    # Raised when a build fails.
+    class BuildRunError < BoxesError; end
+  end
+end

data/lib/boxes/subprocess.rb

@@ -0,0 +1,39 @@
+module Boxes
+  # Standardise handling the stdout and stderr from Open3.
+  #
+  # @example Print the values returned to stdout and stderr
+  #   Boxes::Utils::Subprocess.run 'ls' do |stdout, stderr, thread|
+  #     puts stdout unless stdout == nil
+  #     puts stderr unless stderr == nil
+  #   end
+  #
+  class Subprocess
+    # Create a new subprocess with a command, with a block for the response.
+    #
+    # @param cmd [String] the command to run
+    # @yield [stdout, stderr, thread] Gives the stdout, stderr and process
+    #   thread to the block.
+    def self.run(command) # rubocop:disable Metrics/MethodLength
+      # see: http://stackoverflow.com/a/1162850/83386
+      Open3.popen3(command) do |_stdin, stdout, stderr, thread|
+        # read each stream from a new thread
+        { out: stdout, err: stderr }.each do |key, stream|
+          Thread.new do
+            stream.each_line do |line|
+              # yield the block depending on the stream
+              if key == :out
+                yield line, nil, thread if block_given?
+              else
+                yield nil, line, thread if block_given?
+              end
+            end
+          end
+        end
+
+        thread.join # don't exit until the external process is done
+
+        thread.value
+      end
+    end
+  end
+end

data/lib/boxes/template.rb

@@ -0,0 +1,50 @@
+module Boxes
+  # Representations of Packer templates.
+  class Template
+    include Boxes::Errors
+
+    attr_reader :name, :template
+
+    # Load a template with a given name.
+    #
+    # @param env [Boxes::Environment] the environment to source templates.
+    # @param name [String] the name of the template.
+    #
+    # @return [Boxes::Template] a template instance.
+    def initialize(env, name)
+      fail(TemplateNotFoundError) unless env.available_templates.include?(name)
+
+      @name = name
+      @template = ''
+      File.open(Boxes.config.working_dir + "templates/#{name}.erb") do |f|
+        @template << f.read
+      end
+    end
+
+    # Render the template.
+    #
+    # @param args [Hash] the values to set.
+    #
+    # @return [String] the rendered template.
+    def render(args)
+      ERB.new(template, nil, '-').result(ERBContext.new(args).get_binding)
+    end
+
+    # A context to render inside, to avoid polluting other classes.
+    class ERBContext
+      # Create a new context with a given hash of values.
+      #
+      # @params args [Hash] the values to substitute.
+      def initialize(args = {})
+        args.each_pair do |k, v|
+          instance_variable_set('@' + k.to_s, v)
+        end
+      end
+
+      # The binding which is passed to ERB.
+      def get_binding # rubocop:disable Style/AccessorMethodName
+        binding
+      end
+    end
+  end
+end

data/lib/boxes/version.rb

@@ -0,0 +1,4 @@
+# Versions and other declarations.
+module Boxes
+  VERSION = '2.0.0'
+end

data/scripts/ansible.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+case $(lsb_release -is) in
+    'ubuntu')
+        apt-add-repository ppa:ansible/ansible
+        apt-get -qy update
+        apt-get -qy install ansible
+    ;;
+    *)
+        easy_install pip
+        pip install ansible
+    ;;
+esac

data/scripts/chef.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Get the Chef package version through their metadata service.
+platform=$(lsb_release -si | tr '[:upper:]' '[:lower:]')
+release=$(lsb_release -sr)
+version_url="https://www.opscode.com/chef/metadata?v=&prerelease=false&nightlies=false&p=$platform&pv=$release&m=x86_64"
+current_version=$(curl -s "$version_url")
+
+version_url=$(echo "$current_version" | awk '/url/{print $2}')
+version_sha=$(echo "$current_version" | awk '/sha256/{print $2}')
+
+# fetch chef
+curl $version_url -o chef.deb
+
+# check the file
+echo "$version_sha  chef.deb" > '/tmp/chef-checksum'
+shasum -a 256 -c '/tmp/chef-checksum'
+if [ $? -ne 0 ]; then
+    echo "Downloaded Chef package failed to checksum."
+    exit 1
+fi
+
+# install
+dpkg -i chef.deb
+
+# cleanup
+rm chef.deb
+rm /tmp/chef-checksum

data/scripts/postinstall.sh

@@ -0,0 +1,42 @@
+# postinstall.sh based upon Mitchell's old basebox example
+
+# mark the build time
+date > /etc/vagrant_box_build_time
+
+# update the apt cache and packages
+case $(lsb_release -cs) in
+    'precise')
+        apt-get clean
+        rm -rf /var/lib/apt/lists/*
+        apt-get clean
+    ;;
+    *)
+    ;;
+esac
+
+apt-get -qy update
+apt-get -qy upgrade
+
+# install some oft used packages
+apt-get -qy install linux-headers-$(uname -r) build-essential
+apt-get -qy install zlib1g-dev libssl-dev
+apt-get -qy install python-software-properties python-setuptools python-dev
+apt-get -qy install ruby1.9.3
+
+# configure password-less sudo
+usermod -a -G sudo vagrant
+echo "%vagrant ALL=NOPASSWD:ALL" > /tmp/vagrant
+mv /tmp/vagrant /etc/sudoers.d/vagrant
+chmod 0440 /etc/sudoers.d/vagrant
+
+# install the vagrant-provided ssh keys
+mkdir -pm 700 /home/vagrant/.ssh
+curl -Lo /home/vagrant/.ssh/authorized_keys \
+  'https://raw.github.com/mitchellh/vagrant/master/keys/vagrant.pub'
+chmod 0600 /home/vagrant/.ssh/authorized_keys
+chown -R vagrant:vagrant /home/vagrant/.ssh
+
+# clean up any artifacts
+rm -f /home/vagrant/shutdown.sh
+
+exit

data/scripts/puppet.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# see: http://docs.puppetlabs.com/guides/puppetlabs_package_repositories.html
+
+# determine the os release
+os_release=$(lsb_release -cs)
+
+# configure the puppet package sources
+wget http://apt.puppetlabs.com/puppetlabs-release-$os_release.deb
+dpkg -i puppetlabs-release-$os_release.deb
+apt-get -q update
+
+# install puppet
+apt-get install -qy puppet

data/scripts/purge.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+##
+# Purge unnecessary data from the image to keep it small.
+#
+# Based on: https://gist.github.com/adrienbrault/3775253
+##
+
+# tidy up DCHP leases
+echo "Cleaning up dhcp..."
+rm /var/lib/dhcp/*
+
+# make sure Udev doesn't block our network
+# http://6.ptmc.org/?p=164
+echo "Cleaning up udev..."
+rm /etc/udev/rules.d/70-persistent-net.rules
+mkdir /etc/udev/rules.d/70-persistent-net.rules
+rm -rf /dev/.udev/
+rm /lib/udev/rules.d/75-persistent-net-generator.rules
+
+# clean up apt
+echo "Cleaning up apt..."
+apt-get -qy autoremove
+apt-get clean -qy
+apt-get autoclean -qy
+
+# nuke the bash history
+echo "Removing bash history..."
+unset HISTFILE
+rm -f /root/.bash_history
+rm -f /home/vagrant/.bash_history
+
+# clean up the logs
+echo "Cleaning up logs..."
+find /var/log -type f | while read f; do echo -ne '' > $f; done;
+
+# zero any and all free space
+echo "Cleaning free space..."
+dd if=/dev/zero of=/EMPTY bs=1M
+rm -f /EMPTY
+
+# whiteout root
+echo "Cleaning up /..."
+#count=`df --sync -kP / | tail -n1  | awk -F ' ' '{print $4}'`; 
+dd if=/dev/zero of=/tmp/whitespace bs=1024;
+rm /tmp/whitespace;
+  
+# whiteout /boot
+echo "Cleaning up /boot..."
+#count=`df --sync -kP /boot | tail -n1 | awk -F ' ' '{print $4}'`;
+dd if=/dev/zero of=/boot/whitespace bs=1024;
+rm /boot/whitespace;
+
+# whiteout the swap
+echo "Cleaning up swap partitions..."
+swappart=`cat /proc/swaps | tail -n1 | awk -F ' ' '{print $1}'`
+swapoff $swappart;
+dd if=/dev/zero of=$swappart;
+mkswap $swappart;
+swapon $swappart;

data/scripts/ruby.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# this installs chruby, ruby-install and a selection of rubies and is used in
+# the 'ruby' special box type.
+
+chruby_version=0.3.9
+rubyinstall_version=0.5.0
+
+# install chruby
+wget -O chruby-$chruby_version.tar.gz https://github.com/postmodern/chruby/archive/v$chruby_version.tar.gz
+tar -xzvf chruby-$chruby_version.tar.gz
+cd chruby-$chruby_version/
+make install
+
+# configure system-wide
+cat << 'EOF' > /etc/profile.d/chruby.sh
+if [ -n "$BASH_VERSION" ] || [ -n "$ZSH_VERSION" ]; then
+    source /usr/local/share/chruby/chruby.sh
+    source /usr/local/share/chruby/auto.sh
+fi
+EOF
+
+# install ruby-install
+wget -O ruby-install-$rubyinstall_version.tar.gz https://github.com/postmodern/ruby-install/archive/v$rubyinstall_version.tar.gz
+tar -xzvf ruby-install-$rubyinstall_version.tar.gz
+cd ruby-install-$rubyinstall_version/
+make install
+
+# install a set of recent MRI Rubies.
+ruby-install ruby 2.1.5
+ruby-install ruby 2.2.0
+ruby-install ruby 2.2.1
+ruby-install ruby 2.2.2
+
+# update gems and install bundler
+source /usr/local/share/chruby/chruby.sh
+for ruby in `chruby`; do
+    chruby-exec $ruby -- gem install bundler
+done
+
+exit