packer-config 0.0.3

data/README.md

@@ -0,0 +1,107 @@
+# packer-config
+
+A Ruby model that lets you build [Packer](http://packer.io) configurations in Ruby.
+
+Building the Packer JSON configurations in raw JSON can be quite an adventure.
+There's limited facilities for variable expansion and absolutely no support for
+nice things like comments. I decided it would just be easier to have an object
+model to build the Packer configurations in that would easily write to the
+correct JSON format. It also saved me having to remember the esoteric Packer
+syntax for referencing variables and whatnot in the JSON.
+
+Bonus: you can really go to town with templates when it's all done it Ruby.
+
+## Installation
+
+    gem install packer-config
+
+## Examples
+
+### Packing a Vagrant Basebox from a CentOS ISO Using VirtualBox
+
+This example is based on the integration test [spec/integration/centos_vagrant_spec.rb](spec/integration/centos_vagrant_spec.rb). It produces a Vagrant Basebox that's provisionable with [Chef](http://www.getchef.com/) and the packer config and provisioning is taken from the [Bento](https://github.com/opscode/bento) project from the OpsCode crew.
+
+    OS = 'centos-6.5'
+
+    pconfig = Packer::Config.new "#{OS}-vagrant.json"
+    pconfig.description "#{OS} VirtualBox Vagrant"
+    pconfig.add_variable 'mirror', 'http://mirrors.kernel.org/centos'
+    pconfig.add_variable 'my_version', '0.0.1'
+    pconfig.add_variable 'chef_version', 'latest'
+
+    builder = pconfig.add_builder Packer::Builder::VIRTUALBOX_ISO
+    builder.boot_command ["<tab> text ks=http://#{pconfig.macro.HTTPIP}:#{pconfig.macro.HTTPPort}/#{OS}-ks.cfg<enter><wait>"]
+    builder.boot_wait '10s'
+    builder.disk_size 40960
+    builder.guest_additions_path "VBoxGuestAdditions_#{pconfig.macro.Version}.iso"
+    builder.guest_os_type "RedHat_64"
+    builder.http_directory "scripts/kickstart"
+    builder.iso_checksum '32c7695b97f7dcd1f59a77a71f64f2957dddf738'
+    builder.iso_checksum_type 'sha1'
+    builder.iso_url "#{pconfig.variable 'mirror'}/6.5/isos/x86_64/CentOS-6.5-x86_64-bin-DVD1.iso"
+    builder.output_directory "#{OS}-x86_64-virtualbox"
+    builder.shutdown_command "echo 'vagrant'|sudo -S /sbin/halt -h -p"
+    builder.ssh_password "vagrant"
+    builder.ssh_port 22
+    builder.ssh_username "vagrant"
+    builder.ssh_wait_timeout "10000s"
+    builder.vboxmanage [
+      [
+        "modifyvm",
+        pconfig.macro.Name,
+        "--memory",
+        "480"
+      ],
+      [
+        "modifyvm",
+        pconfig.macro.Name,
+        "--cpus",
+        "1"
+      ]
+    ]
+    builder.virtualbox_version_file ".vbox_version"
+    builder.vm_name "packer-#{OS}-x86_64"
+
+    provisioner = pconfig.add_provisioner Packer::Provisioner::FILE
+    provisioner.source 'scripts/hello.sh'
+    provisioner.destination '/home/vagrant/hello.sh'
+
+    provisioner = pconfig.add_provisioner Packer::Provisioner::SHELL
+    provisioner.scripts [
+      'scripts/fix-slow-dns.sh',
+      'scripts/sshd.sh',
+      'scripts/vagrant.sh',
+      'scripts/vmtools.sh',
+      'scripts/chef.sh',
+      'scripts/cleanup.sh',
+      'scripts/minimize.sh'
+    ]
+    provisioner.environment_vars [
+      "CHEF_VERSION=#{pconfig.variable 'chef_version'}",
+      "MY_VERSION=#{pconfig.variable 'my_version'}"
+    ]
+    provisioner.execute_command "echo 'vagrant' | #{pconfig.macro.Vars} sudo -S -E bash '#{pconfig.macro.Path}'"
+
+    postprocessor = pconfig.add_postprocessor Packer::PostProcessor::VAGRANT
+    postprocessor.output File.join('builds', pconfig.macro.Provider, "#{OS}-x86_64-#{pconfig.variable 'my_version'}.box")
+
+    pconfig.validate
+    pconfig.build
+
+## Development
+
+### Continuous Integration
+
+I'm using Travis CI to build and test on every push to the public github repository. You can find the Travis CI page for this project here: https://travis-ci.org/ianchesal/packer-config/
+
+### Branching in Git
+
+I'm using [git-flow](http://nvie.com/posts/a-successful-git-branching-model/) for development in git via github. I've loved the branching model git-flow proposed from day one and the addon to git makes it very intuitive and easy to follow. I generally don't push my `feature/*` branches to the public repository; I do keep `development` and `master` up to date here though.
+
+### TODO Work
+
+Please see [TODO.md](TODO.md) for the short list of big things I thought worth writing down.
+
+## Contact Me
+
+Questions or comments about `packer-config`? Hit me up at ian.chesal@gmail.com or ianc@squareup.com.

data/Rakefile

@@ -0,0 +1,47 @@
+# Encoding: utf-8
+# Copyright 2014 Ian Chesal
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+require 'fileutils'
+
+RuboCop::RakeTask.new(:lint)
+
+task :default => [:lint, 'test:spec']
+
+task :build => ['test:spec'] do
+  `gem build packer-config.gemspec`
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = Dir['spec/**/*_spec.rb'].reject{ |f| f['/integration'] }
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = "spec/integration/**/*_spec.rb"
+  end
+end
+
+CLEAN = FileList['deployment_dir/**/*'].exclude('*.txt')
+
+task :clean do
+  FileList['spec/integration/packer_cache/*'].each do |f|
+    FileUtils.rm_f(f)
+  end
+  Dir.glob('spec/integration/builds/*').select {|f| File.directory? f}.each do |d|
+    FileUtils.rm_rf(d)
+  end
+end

data/TODO.md

@@ -0,0 +1,8 @@
+# TODO
+
+* Add an option to Packer::Config#validate to run the configuration through packer's `validate` command
+* Add spec tests for every method on every sub-class. Found during integration testing that some methods on the sub-classes had typos in the `__*` method calls. Spec tests would have caught this.
+* Look in to something like VCR to drive the tests of the child classes -- there's a lot of repetitive testing that could be done on them.
+* Add missing builders, provisioners and post-processors. I only implemented the builders, provisioners and post-processors that I'm currently using.
+* Refactor the child classes. I get the feeling that these could be implemented in some better, templated, type of way
+* Building can take a long time. Look in to a way to query the state of a build. Maybe return the stdout from it on query.

data/lib/packer-config.rb

@@ -0,0 +1,181 @@
+# Encoding: utf-8
+# Copyright 2014 Ian Chesal
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'json'
+require 'open3'
+require 'packer/dataobject'
+require 'packer/builder'
+require 'packer/provisioner'
+require 'packer/postprocessor'
+require 'packer/macro'
+require 'packer/envvar'
+
+module Packer
+  class Config < Packer::DataObject
+
+    VERSION = '0.0.2'
+
+    attr_accessor :builders
+    attr_accessor :postprocessors
+    attr_accessor :provisioners
+    attr_accessor :packer
+    attr_accessor :packer_options
+    attr_reader   :macro
+    attr_reader   :envvar
+    attr_reader   :output_file
+
+    def initialize(file)
+      super()
+      self.data['variables'] = {}
+      self.output_file = file
+      self.builders = []
+      self.provisioners = []
+      self.postprocessors = []
+      self.packer = 'packer'
+      self.packer_options = []
+      self.macro = Macro.new
+      self.envvar = EnvVar.new
+    end
+
+    def validate
+      super
+      if self.builders.length == 0
+        raise DataValidationError.new("At least one builder is required")
+      end
+      self.builders.each do |thing|
+        thing.validate
+      end
+      self.provisioners.each do |thing|
+        thing.validate
+      end
+      self.postprocessors.each do |thing|
+        thing.validate
+      end
+      self.write
+      Dir.chdir(File.dirname(self.output_file)) do
+        cmd = [self.packer, 'validate', File.basename(self.output_file)].join(' ')
+        stdout, stderr, status = Open3.capture3(cmd)
+        raise PackerBuildError.new(stderr) unless status == 0
+      end
+      self.delete
+    end
+
+    class DumpError < StandardError
+    end
+
+    def dump(format='json', pretty=false)
+      data_copy = self.deep_copy
+      data_copy['builders'] = []
+      self.builders.each do |thing|
+        data_copy['builders'].push(thing.deep_copy)
+      end
+      if self.provisioners.length > 0
+        data_copy['provisioners'] = []
+        self.provisioners.each do |thing|
+          data_copy['provisioners'].push(thing.deep_copy)
+        end
+      end
+      if self.postprocessors.length > 0
+        data_copy['post-processors'] = []
+        self.postprocessors.each do |thing|
+          data_copy['post-processors'].push(thing.deep_copy)
+        end
+      end
+      case format
+      when 'json'
+        if pretty
+          JSON.pretty_generate(data_copy)
+        else
+          data_copy.to_json
+        end
+      else
+        raise DumpError.new("Unrecognized format #{format} use one of ['json']")
+      end
+    end
+
+    def write(format='json')
+      File.write(self.output_file, self.dump(format))
+    end
+
+    def delete
+      File.delete(self.output_file)
+    end
+
+    class PackerBuildError < StandardError
+    end
+
+    def build
+      self.validate
+      self.write
+      Dir.chdir(File.dirname(self.output_file)) do
+        cmd = [self.packer, 'build', self.packer_options, File.basename(self.output_file)].join(' ')
+        stdout, stderr, status = Open3.capture3(cmd)
+        raise PackerBuildError.new(stderr) unless status == 0
+      end
+      self.delete
+    end
+
+    def description(description)
+      self.__add_string('description', description)
+    end
+
+    def min_packer_version(version)
+      self.__add_string('min_packer_version', version)
+    end
+
+    def variables
+      self.data['variables']
+    end
+
+    def add_builder(type)
+      builder = Packer::Builder.get_builder(type)
+      self.builders.push(builder)
+      builder
+    end
+
+    def add_provisioner(type)
+      provisioner = Packer::Provisioner.get_provisioner(type)
+      self.provisioners.push(provisioner)
+      provisioner
+    end
+
+    def add_postprocessor(type)
+      postprocessor = Packer::PostProcessor.get_postprocessor(type)
+      self.postprocessors.push(postprocessor)
+      postprocessor
+    end
+
+    def add_variable(name, value)
+      variables_copy = Marshal.load(Marshal.dump(self.variables))
+      variables_copy[name.to_s] = value.to_s
+      self.__add_hash('variables', variables_copy)
+    end
+
+    class UndefinedVariableError < StandardError
+    end
+
+    def variable(name)
+      unless self.variables.has_key? name
+        raise UndefinedVariableError.new("No variable named #{name} has been defined -- did you forget to call add_variable?")
+      end
+      "{{user `#{name}`}}"
+    end
+
+    private
+    attr_writer :output_file
+    attr_writer :macro
+    attr_writer :envvar
+
+  end
+end

data/lib/packer/builder.rb

@@ -0,0 +1,65 @@
+# Encoding: utf-8
+# Copyright 2014 Ian Chesal
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'packer/builders/all'
+
+module Packer
+  class Builder < DataObject
+
+    AMAZON_EBS      = 'amazon-ebs'
+    AMAZON_INSTANCE = 'amazon-instance'
+    DOCKER          = 'docker'
+    VIRTUALBOX_ISO  = 'virtualbox-iso'
+
+    VALID_BUILDER_TYPES = [
+      AMAZON_EBS,
+      AMAZON_INSTANCE,
+      DOCKER,
+      VIRTUALBOX_ISO
+    ]
+
+    class UnrecognizedBuilderTypeError < StandardError
+    end
+
+    def self.get_builder(type)
+      unless validate_type(type)
+        raise UnrecognizedBuilderTypeError.new("Unrecognized builder type #{type}")
+      end
+      {
+        AMAZON_EBS      => Packer::Builder::Amazon::EBS,
+        AMAZON_INSTANCE => Packer::Builder::Amazon::Instance,
+        DOCKER          => Packer::Builder::Docker,
+        VIRTUALBOX_ISO  => Packer::Builder::VirtualBoxISO
+      }.fetch(type).new
+    end
+
+    def self.types
+      VALID_BUILDER_TYPES
+    end
+
+    def initialize
+      super
+      self.add_required('type')
+    end
+
+    def name(name)
+      self.__add_string('name', name)
+    end
+
+    private
+    def self.validate_type(type)
+      VALID_BUILDER_TYPES.include? type
+    end
+  end
+end

data/lib/packer/builders/all.rb

@@ -0,0 +1,17 @@
+# Encoding: utf-8
+# Copyright 2014 Ian Chesal
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'packer/builders/amazon'
+require 'packer/builders/docker'
+require 'packer/builders/virtualbox'

data/lib/packer/builders/amazon.rb

@@ -0,0 +1,214 @@
+# Encoding: utf-8
+# Copyright 2014 Ian Chesal
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'packer/builder'
+require 'packer/dataobject'
+
+module Packer
+  class Builder < Packer::DataObject
+    class Amazon < Builder
+
+      def initialize
+        super
+        self.add_required(
+          'ami_name',
+          'instance_type',
+          'region',
+          'source_ami',
+          'ssh_username'
+        )
+      end
+
+      def access_key(key)
+        self.__add_string('access_key', key)
+      end
+
+      def ami_name(name)
+        self.__add_string('ami_name', name)
+      end
+
+      def instance_type(type)
+        self.__add_string('instance_type', type)
+      end
+
+      def region(name)
+        self.__add_string('region', name)
+      end
+
+      def source_ami(name)
+        self.__add_string('source_ami', name)
+      end
+
+      def ssh_username(username)
+        self.__add_string('ssh_username', username)
+      end
+
+      def secret_key(key)
+        self.__add_string('secret_key', key)
+      end
+
+      def ami_block_device_mappings(mappings)
+        self.__add_array_of_hashes('ami_block_device_mappings', mappings)
+      end
+
+      def ami_description(description)
+        self.__add_string('ami_description', description)
+      end
+
+      def ami_groups(groups)
+        self.__add_array_of_strings('ami_groups', groups)
+      end
+
+      def ami_product_codes(codes)
+        self.__add_array_of_strings('ami_product_codes', codes)
+      end
+
+      def ami_regions(regions)
+        self.__add_array_of_strings('ami_regions', regions)
+      end
+
+      def ami_users(users)
+        self.__add_array_of_strings('ami_users', users)
+      end
+
+      def ami_virtualization_type(type)
+        self.__add_string('ami_virtualization_type', type)
+      end
+
+      def associate_public_ip_address(bool)
+        self.__add_boolean('associate_public_ip_address', bool)
+      end
+
+      def availability_zone(zone)
+        self.__add_string('availability_zone', zone)
+      end
+
+      def enhanced_networking(bool)
+        self.__add_boolean('enhanced_networking', bool)
+      end
+
+      def iam_instance_profile(profile)
+        self.__add_string('iam_instance_profile', profile)
+      end
+
+      def launch_block_device_mappings(mappings)
+        self.__add_array_of_hashes('launch_block_device_mappings', mappings)
+      end
+
+      def run_tags(tags)
+        self.__add_hash('run_tags', tags)
+      end
+
+      def security_group_id(id)
+        self.__add_string('security_group_id', id, %w[security_group_ids])
+      end
+
+      def security_group_ids(ids)
+        self.__add_array_of_strings('security_group_ids', ids, %w[security_group_id])
+      end
+
+      def ssh_port(port)
+        self.__add_integer('ssh_port', port)
+      end
+
+      def ssh_private_key_file(file)
+        self.__add_string('ssh_private_key_file', file)
+      end
+
+      def ssh_timeout(time)
+        self.__add_string('ssh_timeout', time)
+      end
+
+      def subnet_id(id)
+        self.__add_string('subnet_id', id)
+      end
+
+      def tags(tags)
+        self.__add_hash('tags', tags)
+      end
+
+      def temporary_key_pair_name(name)
+        self.__add_string('temporary_key_pair_name', name)
+      end
+
+      def user_data(data)
+        self.__add_string('user_data', data)
+      end
+
+      def user_data_file(file)
+        self.__add_string('user_data_file', file)
+      end
+
+      def vpc_id(id)
+        self.__add_string('vpc_id', id)
+      end
+
+      class EBS < Amazon
+        def initialize
+          super
+          self.data['type'] = AMAZON_EBS
+        end
+      end
+
+      class Instance < Amazon
+        def initialize
+          super
+          self.data['type'] = AMAZON_INSTANCE
+          self.add_required(
+            'account_id',
+            's3_bucket',
+            'x509_cert_path',
+            'x509_key_path'
+          )
+        end
+
+        def account_id(id)
+          self.__add_string('account_id', id)
+        end
+
+        def s3_bucket(bucket)
+          self.__add_string('s3_bucket', bucket)
+        end
+
+        def x509_cert_path(path)
+          self.__add_string('x509_cert_path', path)
+        end
+
+        def x509_key_path(path)
+          self.__add_string('x509_key_path', path)
+        end
+
+        def bundle_destination(directory)
+          self.__add_string('bundle_destination', directory)
+        end
+
+        def bundle_prefix(prefix)
+          self.__add_string('bundle_prefix', prefix)
+        end
+
+        def bundle_upload_command(command)
+          self.__add_string('bundle_upload_command', command)
+        end
+
+        def bundle_vol_command(command)
+          self.__add_string('bundle_vol_command', command)
+        end
+
+        def x509_upload_path(path)
+          self.__add_string('x509_upload_path', path)
+        end
+      end
+    end
+  end
+end