vagrant-ami 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile
+.vagrant

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-ami.gemspec
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Ryan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Create AMIs from Vagrant EC2 boxes
+
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds a command
+to create [AWS](http://aws.amazon.com) AMIs.
+
+This plugin has a very short lifespan in terms of usefulness.
+
+Technically this plugin is already superseded by [Packer](http://packer.io) which
+is a more general solution for creating various types of machine images.
+
+However, Packer does not yet have the same level of provisioner support enjoyed
+by Vagrant. Until then, I need a simple way to make AMIs based on Vagrant EC2 boxes
+provisioned with Puppet and Chef, which can be called easily from Jenkins.
+
+**NOTE:** This plugin requires Vagrant 1.2+,
+
+
+## Features
+
+* Create AMIs from Vagrant-managed EC2 instances
+* Assign tags to newly-created AMIs
+
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After
+bringing up an AwS instance issue the command to create the AMI as shown
+below.
+
+```
+$ vagrant plugin install vagrant-ami
+...
+$ vagrant up --provider=aws
+...
+$ vagrant create_ami --name my-ami --desc "My AMI" --tags role=test,environment=dev
+...
+$ vagrant destroy
+```
+
+vagrant-ami relies heavily on vagrant-aws, and reuses all of its configuration settings.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new
+
+# Default task is to run the unit tests
+task :default => "spec"

data/lib/vagrant-ami.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-ami/plugin"
+
+module VagrantPlugins
+  module AMI
+    lib_path = Pathname.new(File.expand_path("../vagrant-ami", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-ami/action.rb

@@ -0,0 +1,27 @@
+require "pathname"
+
+require "vagrant/action/builder"
+require "vagrant-aws/action"
+
+module VagrantPlugins
+  module AMI
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to create EC2 AMIs.
+      def self.action_create_ami
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use VagrantPlugins::AWS::Action::ConnectAWS
+          b.use CreateAMI
+        end
+      end
+
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :CreateAMI, action_root.join("create_ami")
+    end
+  end
+end

data/lib/vagrant-ami/action/create_ami.rb

@@ -0,0 +1,74 @@
+require 'date'
+require 'vagrant-aws/util/timer'
+require 'vagrant-aws/errors'
+require 'vagrant/util/retryable'
+
+module VagrantPlugins
+  module AMI
+    module Action
+      # This runs the configured instance.
+      class CreateAMI
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_ami::action::create_ami")
+        end
+
+        def call(env)
+          if env[:machine].state.id != :running
+            puts "Skipping #{env[:machine].name}: not running"
+          else
+            _create_ami(env)
+          end
+
+        end
+
+        protected
+
+        def _create_ami(env)
+            env[:ui].info("Creating AMI named '#{env[:name]}'for #{env[:machine].name} (#{env[:machine].id})")
+
+            # TODO this isn't getting logged
+            @logger.info("Description: #{env[:desc]} Tags: #{env[:tags]}")
+
+            # TODO error handling on create_image/tags
+            # this raises an error if AMI name already exists
+            # see this for error handling examples
+            # https://github.com/mitchellh/vagrant-aws/blob/master/lib/vagrant-aws/action/run_instance.rb#L79
+            server = env[:aws_compute].servers.get(env[:machine].id)
+            begin
+              data = env[:aws_compute].create_image(server.identity, env[:name], env[:desc])
+            rescue Excon::Errors::BadRequest => e
+              if e.response.body =~ /InvalidAMIName.Duplicate/ 
+                raise VagrantPlugins::AWS::Errors::FogError,
+                  :message => "An AMI named #{env[:name]} already exists"
+              end
+              raise
+            end
+
+            image_id = data.body["imageId"]
+
+            image = env[:aws_compute].images.get(image_id)
+            env[:ui].info("Creating #{image_id}")
+
+            # Wait for the image to be ready
+            # TODO should have a configurable timeout for this
+            while true
+              # If we're interrupted then just back out
+              break if env[:interrupted]
+              image = env[:aws_compute].images.get(image_id)
+              break if image.ready?
+              sleep 2
+            end
+
+            unless env[:tags].empty?
+              env[:ui].info("Adding tags to AMI")
+              env[:aws_compute].create_tags(image_id, env[:tags])
+            end
+            env[:ui].info("Created #{image_id}")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ami/commands/create_ami.rb

@@ -0,0 +1,54 @@
+require 'optparse'
+
+module VagrantPlugins
+  module AMI
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+
+        options = {
+            :tags => {}
+        }
+
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant create_ami [vm-name]"
+          o.separator ""
+
+          o.on("-n", "--name NAME", "AMI Name") do |n|
+            options[:name] = n
+          end
+
+          o.on("-d", "--desc DESCRIPTION", "AMI Description.") do |d|
+            options[:desc] = d
+          end
+
+          o.on("-t", "--tags key1=val1,keyN=valN", Array, "Optional tags to assign to the AMI.") do |t|
+            options[:tags] = Hash[t.map {|kv| kv.split("=")}]
+          end
+
+          # TODO add option to wait until AMI creation is complete?
+          # TODO does this work if the instance is terminated immediately after hte create_ami call
+          # is issues?
+
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return if !argv
+        
+        if options[:name].nil? or options[:desc].nil?
+          raise Vagrant::Errors::CLIInvalidOptions, :help => opts.help.chomp
+        end
+
+        with_target_vms(argv, :reverse => true) do |machine|
+          @env.action_runner.run(VagrantPlugins::AMI::Action.action_create_ami, {
+            :machine    => machine,
+            :name       => options[:name],
+            :desc       => options[:desc],
+            :tags       => options[:tags]
+          })
+        end
+        0
+      end
+    end
+  end
+end

data/lib/vagrant-ami/config.rb

@@ -0,0 +1,50 @@
+require "vagrant"
+
+module VagrantPlugins
+  module AMI
+    class Config < Vagrant.plugin("2", :config)
+      # The tags for created AMIs.
+      #
+      # @return [Hash<String, String>]
+      attr_accessor :tags
+
+      def initialize(region_specific=false)
+        @tags           = {}
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+
+        errors << I18n.t("vagrant_aws.config.region_required") if @region.nil?
+
+        if @region
+          # Get the configuration for the region we're using and validate only
+          # that region.
+          config = get_region_config(@region)
+
+          if !config.use_iam_profile
+            errors << I18n.t("vagrant_aws.config.access_key_id_required") if \
+              config.access_key_id.nil?
+            errors << I18n.t("vagrant_aws.config.secret_access_key_required") if \
+              config.secret_access_key.nil?
+          end
+
+          errors << I18n.t("vagrant_aws.config.ami_required") if config.ami.nil?
+        end
+
+        { "AWS Provider" => errors }
+      end
+
+      # This gets the configuration for a specific region. It shouldn't
+      # be called by the general public and is only used internally.
+      def get_region_config(name)
+        if !@__finalized
+          raise "Configuration must be finalized before calling this method."
+        end
+
+        # Return the compiled region config
+        @__compiled_region_configs[name] || self
+      end
+    end
+  end
+end

data/lib/vagrant-ami/plugin.rb

@@ -0,0 +1,61 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant AMI plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.2.0"
+  raise "The Vagrant AMI plugin is only compatible with Vagrant 1.2+"
+end
+
+module VagrantPlugins
+  module AMI
+    class Plugin < Vagrant.plugin("2")
+      name "AMI"
+      description <<-DESC
+      This plugin allows Vagrant to create EC2 AMIs.
+      DESC
+
+      #config(:ami, :provider) do
+      #  require_relative "config"
+      #  Config
+      #end
+
+      command("create-ami") do
+        require File.expand_path("../commands/create_ami.rb", __FILE__)
+        Command
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new("vagrant_ami")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ami/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Ami
+    VERSION = "0.0.1"
+  end
+end

data/vagrant-ami.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-ami/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-ami"
+  spec.version       = Vagrant::Ami::VERSION
+  spec.authors       = "Mike Ryan"
+  spec.email         = "mike@epitech.nl"
+  spec.description   = "Enables Vagrant to create EC2 AMIs."
+  spec.summary       = "Enables Vagrant to create EC2 AMIs."
+  spec.homepage      = "http://www.epitech.nl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "vagrant-aws"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-ami
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &12417060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *12417060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12416600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12416600
+- !ruby/object:Gem::Dependency
+  name: vagrant-aws
+  requirement: &12416120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12416120
+description: Enables Vagrant to create EC2 AMIs.
+email: mike@epitech.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-ami.rb
+- lib/vagrant-ami/.plugin.rb.swp
+- lib/vagrant-ami/action.rb
+- lib/vagrant-ami/action/.create_ami.rb.swp
+- lib/vagrant-ami/action/create_ami.rb
+- lib/vagrant-ami/commands/.create_ami.rb.swp
+- lib/vagrant-ami/commands/create_ami.rb
+- lib/vagrant-ami/config.rb
+- lib/vagrant-ami/plugin.rb
+- lib/vagrant-ami/version.rb
+- vagrant-ami.gemspec
+homepage: http://www.epitech.nl
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1894379412045326636
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1894379412045326636
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Enables Vagrant to create EC2 AMIs.
+test_files: []