boxes 2.0.0

data/scripts/vmtools.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+##
+# Configure the relevant VM tools for this builder.
+##
+
+case $PACKER_BUILDER_TYPE in
+    'virtualbox-iso')
+        echo "Installing VirtualBox Guest Additions..."
+        apt-get -qy install dkms
+        mount -o loop /home/vagrant/VBoxGuestAdditions.iso /mnt
+        sh /mnt/VBoxLinuxAdditions.run
+        umount /mnt
+        
+        rm -f /home/vagrant/VBoxGuestAdditions.iso
+    ;;
+    'vmware-iso')
+        echo "Installing VMware Tools..."
+        mkdir -p /mnt/cdrom
+        mount -o loop /home/vagrant/linux.iso /mnt/cdrom
+
+        cd /tmp
+        tar -zxpf /mnt/cdrom/VMwareTools-*.tar.gz -C /tmp/
+        /tmp/vmware-tools-distrib/vmware-install.pl -d
+
+        umount /mnt/cdrom
+        rm -f /home/vagrant/linux.iso
+    ;;
+    *)
+        printf "Nothing to do for the %s builder type.\n" $PACKER_BUILDER_TYPE
+    ;;
+esac

data/spec/boxes/builder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Boxes::Builder do
+  let(:env) { Boxes::Environment.new }
+
+  describe '#initialize' do
+    it 'unpacks the arguments for the build' do
+      build = Boxes::Builder.new(env, name: 'build-name',
+                                      provider: 'vmware',
+                                      template: 'ubuntu/trusty64',
+                                      scripts: ['ruby.sh'])
+
+      expect(build.template.name).to eq 'ubuntu/trusty64'
+      expect(build.scripts).to include('ruby.sh')
+    end
+
+    it 'requires a name' do
+      expect do
+        Boxes::Builder.new(env, provider: 'vmware', template: 'ubuntu/trusty64')
+      end.to raise_error(Boxes::Errors::MissingArgumentError)
+    end
+
+    it 'requires a provider' do
+      expect do
+        Boxes::Builder.new(env, name: 'build-name', template: 'ubuntu/trusty64')
+      end.to raise_error(Boxes::Errors::MissingArgumentError)
+    end
+
+    it 'requires a template' do
+      expect do
+        Boxes::Builder.new(env, name: 'build-name', provider: 'vmware')
+      end.to raise_error(Boxes::Errors::MissingArgumentError)
+    end
+
+    it 'throws an exception on unknown templates' do
+      expect do
+        Boxes::Builder.new(env, name: 'build-name',
+                                provider: 'vmware',
+                                template: 'nope/nope')
+      end.to raise_error(Boxes::Errors::TemplateNotFoundError)
+    end
+
+    it 'throws an exception on unknown scripts' do
+      expect do
+        Boxes::Builder.new(env, name: 'build-name',
+                                provider: 'vmware',
+                                template: 'ubuntu/trusty64',
+                                scripts: ['nope.sh'])
+      end.to raise_error(Boxes::Errors::ScriptNotFoundError)
+    end
+  end
+end

data/spec/boxes/config_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Boxes::Config do
+  let(:config) { Boxes::Config.new }
+
+  context 'with no ENV modification' do
+    it 'tries to load a user config file if one exists' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+      allow(YAML).to receive(:load_file).and_return({})
+
+      config
+
+      config_path = Pathname.new('~/.boxes/config.yml').expand_path
+      expect(YAML).to have_received(:load_file).with(config_path)
+    end
+
+    it 'has a set of default config values' do
+      expect(described_class::DEFAULTS).to be_a(Hash)
+    end
+
+    it 'has a home directory' do
+      expect(config.home_dir).to eq Pathname.new('~/.boxes').expand_path
+    end
+
+    it 'has a working directory' do
+      expect(config.working_dir).to eq Pathname.new('~/.boxes/tmp').expand_path
+    end
+
+    it 'has an array of template paths' do
+      expect(config.template_paths).to be_a Array
+    end
+
+    it 'supports adding additional template paths' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+      allow(YAML).to receive(:load_file).and_return(
+        template_paths: ['~/user_templates'])
+
+      default_templates = Boxes::Config::DEFAULTS[:template_paths]
+
+      expect(config.template_paths).to include('~/user_templates')
+      expect(config.template_paths).to include(default_templates.first)
+    end
+
+    it 'does not duplicate template path values' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+
+      default_templates = Boxes::Config::DEFAULTS[:template_paths]
+
+      allow(YAML).to receive(:load_file).and_return(
+        template_paths: default_templates)
+
+      expect(config.template_paths).to include(default_templates.first)
+      expect(config.template_paths.count).to eq default_templates.count
+    end
+
+    it 'has an array of script paths' do
+      expect(config.script_paths).to be_a Array
+    end
+
+    it 'supports adding additional script paths' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+      allow(YAML).to receive(:load_file).and_return(
+        script_paths: ['~/user_scripts'])
+
+      default_scripts = Boxes::Config::DEFAULTS[:script_paths]
+
+      expect(config.script_paths).to include('~/user_scripts')
+      expect(config.script_paths).to include(default_scripts.first)
+    end
+
+    it 'does not duplicate script path values' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+
+      default_scripts = Boxes::Config::DEFAULTS[:script_paths]
+
+      allow(YAML).to receive(:load_file).and_return(
+        script_paths: default_scripts)
+
+      expect(config.script_paths).to include(default_scripts.first)
+      expect(config.script_paths.count).to eq default_scripts.count
+    end
+
+    it 'has an array of environment variables' do
+      expect(config.environment_vars).to be_a Array
+    end
+
+    it 'supports adding additional environment variables' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+      allow(YAML).to receive(:load_file).and_return(
+        environment_vars: [{ 'CUSTOM_VAR' => 'TRUE' }])
+
+      default_env_vars = Boxes::Config::DEFAULTS[:environment_vars]
+
+      expect(config.environment_vars).to include('CUSTOM_VAR' => 'TRUE')
+      expect(config.environment_vars).to include(default_env_vars.first)
+    end
+
+    it 'does not duplicate environment variable values' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+
+      default_env_vars = Boxes::Config::DEFAULTS[:environment_vars]
+
+      allow(YAML).to receive(:load_file).and_return(
+        environment_vars: default_env_vars)
+
+      expect(config.environment_vars).to include(default_env_vars.first)
+      expect(config.environment_vars.count).to eq default_env_vars.count
+    end
+  end
+
+  context 'with ENV modification' do
+    it 'tries to load a different user config file' do
+      allow_any_instance_of(Pathname).to receive(:exist?).and_return(true)
+      allow(YAML).to receive(:load_file).and_return({})
+
+      ENV['BOXES_HOME_DIR'] = '/something'
+
+      config
+
+      config_path = Pathname.new('/something/config.yml').expand_path
+      expect(YAML).to have_received(:load_file).with(config_path)
+
+      ENV.delete 'BOXES_HOME_DIR'
+    end
+
+    it 'can change the home directory' do
+      ENV['BOXES_HOME_DIR'] = '/something'
+
+      expect(config.home_dir).to eq Pathname.new('/something')
+
+      ENV.delete 'BOXES_HOME_DIR'
+    end
+
+    it 'can change the working directory' do
+      ENV['BOXES_WORKING_DIR'] = '/something'
+
+      expect(config.working_dir).to eq Pathname.new('/something')
+
+      ENV.delete 'BOXES_WORKING_DIR'
+    end
+  end
+end

data/spec/boxes/environment_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Boxes::Environment do
+  include FakeFS::SpecHelpers
+
+  let(:env) { Boxes::Environment.new }
+
+  before do
+    current_directory = File.expand_path('../../..', __FILE__)
+
+    FileUtils.mkdir_p(current_directory + '/templates')
+    FileUtils.mkdir_p(current_directory + '/templates/ubuntu')
+    FileUtils.touch(current_directory + '/templates/ubuntu/trusty64.erb')
+    FileUtils.touch(current_directory + '/templates/ubuntu/preseed.cfg')
+
+    FileUtils.mkdir_p(current_directory + '/scripts')
+    FileUtils.touch(current_directory + '/scripts/postinstall.sh')
+    FileUtils.touch(current_directory + '/scripts/purge.sh')
+  end
+
+  describe '#initialize' do
+    it 'successfully builds up a working tree' do
+      working_dir = Boxes.config.working_dir
+      test_template = working_dir + 'templates/ubuntu/trusty64.erb'
+      test_script = working_dir + 'scripts/postinstall.sh'
+
+      env
+
+      [working_dir,
+       working_dir + 'templates',
+       working_dir + 'scripts'].each do |e|
+        expect(File.directory?(e)).to be_truthy
+      end
+
+      expect(File.exist?(test_template)).to be_truthy
+      expect(File.exist?(test_script)).to be_truthy
+    end
+  end
+
+  describe '#available_templates' do
+    it 'lists available templates' do
+      expect(env.available_templates).to be_a(Array)
+      expect(env.available_templates).to include('ubuntu/trusty64')
+    end
+
+    it 'doesn\'t include hidden templates' do
+      expect(env.available_templates).not_to include('ubuntu/preseed.cfg')
+    end
+  end
+
+  describe '#hidden_templates' do
+    it 'lists hidden templates' do
+      expect(env.hidden_templates).to include('ubuntu/preseed.cfg')
+    end
+  end
+
+  describe '#available_scripts' do
+    it 'lists available scripts' do
+      expect(env.available_scripts).to be_a(Array)
+      expect(env.available_scripts).to include('postinstall.sh')
+    end
+
+    it 'doesn\'t include hidden scripts' do
+      expect(env.available_scripts).not_to include('purge.sh')
+    end
+  end
+
+  describe '#hidden_scripts' do
+    it 'lists hidden scripts' do
+      expect(env.hidden_scripts).to include('purge.sh')
+    end
+  end
+end

data/spec/boxes/subprocess_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Boxes::Subprocess do
+  let(:command) do
+    File.expand_path 'spec/support/subprocess_command.rb'
+  end
+
+  it 'runs a command and yields a block' do
+    expect { |b| Boxes::Subprocess.run(command, &b) }.to yield_control
+  end
+
+  it 'runs a command and returns stdout' do
+    total_stdout = ''
+    Boxes::Subprocess.run(command) do |stdout, _stderr, _thread|
+      total_stdout << stdout
+    end
+
+    expect(total_stdout).to eq "A happy output.\n"
+  end
+
+  it 'runs a command and returns stderr' do
+    total_stderr = ''
+    Boxes::Subprocess.run(command) do |_stdout, stderr, _thread|
+      total_stderr << stderr
+    end
+
+    expect(total_stderr).to eq "An unhappy output.\n"
+  end
+
+  it 'returns a status code' do
+    status = Boxes::Subprocess.run(command) { |_stdout, _stderr, _thread| }
+
+    expect(status.exitstatus).to eq 5
+  end
+end

data/spec/boxes/template_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Boxes::Template do
+  include FakeFS::SpecHelpers
+
+  let(:env) { Boxes::Environment.new }
+
+  before do
+    current_directory = File.expand_path('../../..', __FILE__)
+
+    FileUtils.mkdir_p(current_directory + '/templates')
+    FileUtils.mkdir_p(current_directory + '/templates/ubuntu')
+
+    mock_template = <<-EOF
+    <% @scripts.each do |s| %>
+    <%= s %>
+    <% end %>
+    EOF
+
+    File.open(current_directory + '/templates/ubuntu/trusty64.erb', 'w') do |f|
+      f.puts mock_template
+    end
+  end
+
+  describe '#initialize' do
+    it 'can read in a known template' do
+      template = described_class.new(env, 'ubuntu/trusty64')
+
+      expect(template.template).to be_a(String)
+    end
+
+    it 'throws an exception if the template is missing' do
+      expect do
+        described_class.new(env, 'nope/nope')
+      end.to raise_error(Boxes::Errors::TemplateNotFoundError)
+    end
+
+    it 'stores the template name' do
+      template = described_class.new(env, 'ubuntu/trusty64')
+
+      expect(template.name).to eq 'ubuntu/trusty64'
+    end
+  end
+
+  describe '#render' do
+    it 'renders a template with a set of variables' do
+      template = described_class.new(env, 'ubuntu/trusty64')
+      rendered = template.render(scripts: ['ruby.sh'])
+
+      expect(rendered).to include('ruby.sh')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'fakefs/spec_helpers'
+
+require 'boxes'

data/spec/support/subprocess_command.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+STDOUT.puts 'A happy output.'
+
+STDERR.puts 'An unhappy output.'
+
+exit 5

data/templates/debian/preseed.cfg

@@ -0,0 +1,69 @@
+#
+# Based upon: https://help.ubuntu.com/12.04/installation-guide/example-preseed.txt
+#
+
+# localisation
+d-i debian-installer/locale string en_US.utf8
+d-i console-keymaps-at/keymap select us
+
+# networking
+d-i netcfg/choose_interface select auto
+d-i netcfg/get_hostname string unassigned-hostname
+d-i netcfg/get_domain string unassigned-domain
+d-i netcfg/wireless_wep string
+
+# apt mirrors
+d-i mirror/country string manual
+d-i mirror/http/hostname string http.us.debian.org
+d-i mirror/http/directory string /debian
+d-i mirror/http/proxy string
+
+# clock and time zone
+d-i clock-setup/utc boolean true
+d-i time/zone string GMT
+d-i clock-setup/ntp boolean true
+
+# partitioning
+d-i partman-auto/method string lvm
+d-i partman-lvm/device_remove_lvm boolean true
+d-i partman-md/device_remove_md boolean true
+d-i partman-lvm/confirm boolean true
+d-i partman-lvm/confirm_nooverwrite boolean true
+
+#d-i partman-auto-lvm/guided_size string max
+d-i partman-auto/choose_recipe select atomic
+d-i partman-partitioning/confirm_write_new_label boolean true
+d-i partman/choose_partition select finish
+d-i partman/confirm boolean true
+d-i partman/confirm_nooverwrite boolean true
+
+# users
+d-i passwd/root-login boolean false
+d-i passwd/user-fullname string Vagrant User
+d-i passwd/username string vagrant
+d-i passwd/user-password password vagrant
+d-i passwd/user-password-again password vagrant
+d-i user-setup/allow-password-weak boolean true
+d-i user-setup/encrypt-home boolean false
+
+# packages
+tasksel tasksel/first multiselect standard
+#d-i pkgsel/install-language-support boolean false
+d-i pkgsel/include string openssh-server nfs-common curl ntp acpid sudo bzip2 rsync git
+d-i pkgsel/upgrade select full-upgrade
+d-i pkgsel/update-policy select none
+d-i popularity-contest/participate boolean false
+postfix postfix/main_mailer_type select No configuration
+
+# boot loader
+d-i grub-installer/only_debian boolean true
+
+# hide the shutdown notice
+d-i finish-install/reboot_in_progress note
+
+# advanced options
+
+# ensure the default VirtualBox additions doesn't install
+d-i preseed/early_command string sed -i \
+  '/in-target/idiscover(){/sbin/discover|grep -v VirtualBox;}' \
+  /usr/lib/pre-pkgsel.d/20install-hwpackages