vagrant-aws-extras 0.0.1.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8541630c9b7f68fc17298e586c587fc42edbbe4b
+  data.tar.gz: 2b50384b473b9db962d86874f9ab564faf70aef4
+SHA512:
+  metadata.gz: 088eab6004209804bea6e97fd82e68424dedd60daeecbba81d88e187110f99e70169bacd1f824aa89b4592f3688b0ce64f2d0ac608f5a8b3db8b05253ec3f459
+  data.tar.gz: c99a69be7cf1de02c18a0b3dcafeeb79ffff34adfe84e5844ff6f8a7358cc128ec2e716305b4566c583c096521985b492a1e7bb36718747a9dd486fc227c626a

data/.gitignore

@@ -0,0 +1,13 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile

data/Gemfile

@@ -0,0 +1,12 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+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", :tag => "v1.2.7"
+  gem "vagrant-rspec-ci", "~> 1.0.1"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yleisradion Oy
+
+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,56 @@
+Vagrant AWS Extras
+===================
+
+Create DNS record for box on Vagrant up
+Destroy DNS record on Vagrant destroy
+
+
+TODO
+----
+
+1. Write tests/specs
+2. Add tweak configuration 
+3. Add support for other fog.io providers
+4. Release production ready version
+5. ???
+
+
+Sample Config
+-------------
+
+		Vagrant.configure('2') do |config|
+
+		  config.vm.define "aws-box" do |box|
+		    box.vm.box = "dummy"
+		    box.vm.box_url = "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box"
+		    box.aws_extras.record_zone = "mydomain.com."
+		    box.aws_extras.record_name = "aws-box.mydomain.com."
+		    box.aws_extras.record_type = "CNAME"
+		    box.aws_extras.record_ttl = "60"
+
+		    box.vm.provider "aws" do |provider, override|
+		      provider.tags = { "Name" => "Vagrant plugin test box"}
+		    end
+		  end
+
+		  config.vm.provider :aws do |aws, override|
+		    # Get these from: https://console.aws.amazon.com
+		    aws.access_key_id = ENV['AWS_ACCESS_KEY']
+		    aws.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+
+		    # Get these from: https://console.aws.amazon.com/ec2
+		    aws.keypair_name = ENV['AWS_KEYPAIR']
+		    override.ssh.private_key_path = ENV['AWS_PRIVATE_KEY_PATH']
+
+		    # Security group for deployment
+		    aws.security_groups = [ 'your-security-group-id' ]
+
+		    # AWS region and instance size
+		    aws.region = "eu-west-1"
+
+		    # eu-west-1 & 14.04 LTS i386
+		    aws.ami = "ami-6975691d"
+
+		    override.ssh.username = "ubuntu"
+		  end
+		end

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-aws-extras/action/dns.rb

@@ -0,0 +1,98 @@
+require "log4r"
+require "fog"
+
+module VagrantPlugins
+	module AWS
+		module Extras
+			module Action
+				module DNS
+					class ConnectAWS
+						def initialize(app, env)
+							@app = app 
+							@logger = Log4r::Logger.new("vagrant_aws_extras::action::dns")
+						end
+
+						def call(env)
+							env[:aws_dns_settings] = dns_config = env[:machine].config.aws_extras
+
+							region = env[:machine].provider_config.region
+							domain = dns_config.record_zone
+							region_config = env[:machine].provider_config.get_region_config(region)
+
+							fog_config = {
+            		:provider => :aws
+          		}
+
+							fog_config[:aws_access_key_id] = region_config.access_key_id
+							fog_config[:aws_secret_access_key] = region_config.secret_access_key
+						
+							fog_config[:endpoint] = region_config.endpoint if region_config.endpoint
+							fog_config[:version]  = region_config.version if region_config.version
+
+							if fog_config
+								@logger.info("Connecting to AWS Route53.")
+								env[:aws_dns] = ::Fog::DNS.new(fog_config)
+								env[:aws_dns_zone] = env[:aws_dns].zones.detect { |zone| zone.domain == domain }
+							else
+								@logger.info("AWS not configured.")
+							end
+							@app.call(env)
+						end
+					end
+					class Set
+						def initialize(app, env)
+							@app = app 
+							@logger = Log4r::Logger.new("vagrant_aws_extras::action::dns::set")
+						end
+
+						def call(env)
+							@logger.info("Set DNS name")
+							env[:machine_dns_record] = set(env) if env[:aws_dns_zone].records
+							@app.call(env)
+						end
+
+						def set(env)
+							if existing_record = env[:aws_dns_zone].records.get(env[:aws_dns_settings].record_name)
+								existing_record.modify({
+									:name => env[:aws_dns_settings].record_name,
+									:value => env[:machine_ssh_info][:host],
+									:type => env[:aws_dns_settings].record_type,
+									:ttl => env[:aws_dns_settings].record_ttl
+								})
+							else
+								existing_record = env[:aws_dns_zone].records.create({
+									:name => env[:aws_dns_settings].record_name,
+									:value => env[:machine_ssh_info][:host],
+									:type => env[:aws_dns_settings].record_type,
+									:ttl => env[:aws_dns_settings].record_ttl
+								})
+							end
+							existing_record
+						end
+					end
+
+					class Remove
+						def initialize(app, env)
+							@app = app 
+							@logger = Log4r::Logger.new("vagrant_aws_extras::action::dns::remove")
+						end
+
+						def call(env)
+							@logger.info("Remove DNS name")
+							env[:machine_dns_record] = remove(env) if env[:aws_dns_zone].records
+							@app.call(env)
+						end
+
+						def remove(env)
+							puts "hostname: #{env[:machine_ssh_info][:host]}"
+							puts "REMOVE: #{env[:aws_dns_zone].records} - #{env[:aws_dns_zone].records.detect { |record| record.value.include?(env[:machine_ssh_info][:host]) }}"
+							if existing_record = env[:aws_dns_zone].records.detect { |record| record.value.include?(env[:machine_ssh_info][:host]) }
+								existing_record.destroy
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/vagrant-aws-extras/action.rb

@@ -0,0 +1,37 @@
+require "pathname"
+require "vagrant/action/builder"
+require "vagrant-aws/action/connect_aws"
+require "vagrant-aws/action/read_ssh_info"
+
+module VagrantPlugins
+	module AWS
+		module Extras
+			module Action
+				include Vagrant::Action::Builtin
+
+				def self.action_up
+					Vagrant::Action::Builder.new.tap do |builder|
+						builder.use ConfigValidate
+						builder.use	::VagrantPlugins::AWS::Action::ConnectAWS
+						builder.use ::VagrantPlugins::AWS::Action::ReadSSHInfo
+						builder.use DNS::ConnectAWS
+						builder.use DNS::Set
+					end
+				end
+
+				def self.action_destroy
+					Vagrant::Action::Builder.new.tap do |builder|
+						builder.use ConfigValidate
+						builder.use	::VagrantPlugins::AWS::Action::ConnectAWS
+						builder.use ::VagrantPlugins::AWS::Action::ReadSSHInfo
+						builder.use DNS::ConnectAWS			
+						builder.use DNS::Remove
+					end
+				end
+
+				action_root = Pathname.new(File.expand_path("../action", __FILE__))
+				autoload :DNS, action_root.join("dns")
+			end
+		end
+	end
+end

data/lib/vagrant-aws-extras/config.rb

@@ -0,0 +1,70 @@
+require "vagrant"
+
+module VagrantPlugins
+  module AWS
+  	module Extras
+  		class Config < Vagrant.plugin("2", :config)  			
+  			# The record zone for machine
+  			#
+  			# @return [String]
+  			attr_accessor :record_zone
+
+  			# The record type for machine
+  			#
+  			# @return [String]
+	  		attr_accessor :record_type
+	    
+				# The record name for machine
+  			#
+  			# @return [String]
+	  		attr_accessor :record_name
+
+	  		# The record ttl value for machine
+  			#
+  			# @return [Integer]
+	  		attr_accessor :record_ttl
+	    
+	    	# The flag for remove dns record on suspend
+	    	#
+	    	# @return [Boolean]
+	    	attr_accessor :remove_on_suspend
+
+				# The flag for remove dns record on destroy
+	    	#
+	    	# @return [Boolean]
+	    	attr_accessor :remove_on_destroy
+
+	    	def initialize 
+	    		@record_zone = UNSET_VALUE
+	    		@record_type = UNSET_VALUE
+	    		@record_name = UNSET_VALUE
+	    		@record_ttl = UNSET_VALUE
+	    		@remove_on_suspend = UNSET_VALUE
+	    		@remove_on_destroy = UNSET_VALUE
+	    	end
+
+	    	def finalize!
+	    		@record_zone 		 	 = nil if @record_zone == UNSET_VALUE	
+	    		@record_type 			 = "CNAME" if @record_type == UNSET_VALUE
+	    		@record_name 		 = nil if @record_name == UNSET_VALUE
+	    		@record_ttl 			 = 3600 if @record_ttl == UNSET_VALUE
+	    		@remove_on_suspend = true if @remove_on_suspend == UNSET_VALUE
+	    		@remove_on_destroy = true if @remove_on_destroy == UNSET_VALUE
+	    	end
+
+	    	def validate(machine)
+	    		errors = []
+	    		errors.push "record zone must be set" unless @record_zone
+	    		errors.push "record name must be set" unless @record_name
+
+	    		if errors.any?
+	    			return {"aws.extras" => errors}
+	    		else
+	    			return {}
+	    		end
+	    	end
+
+	    end
+  	end	
+  end
+end

data/lib/vagrant-aws-extras/plugin.rb

@@ -0,0 +1,43 @@
+begin
+  require "vagrant"
+rescue LoadError 
+  raise "The Vagrant AWS Extras plugin must be run with Vagrant"
+end
+
+if Vagrant::VERSION < "1.2.0"
+  raise "The Vagrant AWS Extras plugin is only compatible with Vagrant 1.2+"
+end
+
+module VagrantPlugins
+  module AWS
+    module Extras
+      class Plugin < Vagrant.plugin('2')
+        name 'AWS Extras'
+
+        description <<-DESC
+          This plugin extends AWS plugin
+        DESC
+
+        config(:aws_extras) do
+          require_relative 'config'
+          Config
+        end
+        
+        %w{up provision}.each do |action|
+          action_hook(:set_dns_record, "machine_action_#{action}".to_sym) do |hook|
+            require_relative 'action'  
+            hook.append VagrantPlugins::AWS::Extras::Action.action_up
+          end
+        end
+        
+        %w{suspend destroy}.each do |action|
+          action_hook(:remove_dns_record, "machine_action_#{action}".to_sym) do |hook|
+            require_relative 'action'
+            hook.prepend VagrantPlugins::AWS::Extras::Action.action_destroy
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-aws-extras/version.rb

@@ -0,0 +1,7 @@
+module VagrantPlugins
+  module AWS
+  	module Extras
+    	VERSION = "0.0.1.rc1"
+    end
+  end
+end

data/lib/vagrant-aws-extras.rb

@@ -0,0 +1,12 @@
+require "pathname"
+require "vagrant-aws-extras/plugin"
+
+module VagrantPlugins
+  module AWS
+  	module Extras
+		  def self.source_root
+		  	@source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+		  end
+		end
+  end
+end

data/spec/vagrant-aws-extras/action/dns_spec.rb

@@ -0,0 +1,42 @@
+require "fog"
+require "rspec"
+require "vagrant-aws-extras/action/dns"
+
+Fog.mock!
+
+describe VagrantPlugins::AWS::Extras::Action::DNS do
+	
+	describe VagrantPlugins::AWS::Extras::Action::DNS::ConnectAWS do
+		let(:instance) { described_class.new(mock('config'), mock('app')) }
+
+	  # Ensure tests are not affected by AWS credential environment variables
+	  before :each do
+	    ENV.stub(:[] => nil)
+	  end
+
+		it "return zone"
+	end
+
+	describe VagrantPlugins::AWS::Extras::Action::DNS::Set do
+		let(:instance) { described_class.new(mock('config'), mock('app')) }
+
+	  # Ensure tests are not affected by AWS credential environment variables
+	  before :each do
+	    ENV.stub(:[] => nil)
+	  end
+
+		it "set record"
+	end
+
+	describe VagrantPlugins::AWS::Extras::Action::DNS::Remove do
+		let(:instance) { described_class.new(mock('config'), mock('app')) }
+
+	  # Ensure tests are not affected by AWS credential environment variables
+	  before :each do
+	    ENV.stub(:[] => nil)
+	  end
+
+		it "destroy record"
+	end
+
+end

data/spec/vagrant-aws-extras/config_spec.rb

@@ -0,0 +1,5 @@
+require "vagrant-aws-extras/config"
+
+describe VagrantPlugins::AWS::Extras::Config do 
+	it "should check configs"
+end

data/vagrant-aws-extras.gemspec

@@ -0,0 +1,61 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'vagrant-aws-extras/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-aws-extras"
+  spec.version       = VagrantPlugins::AWS::Extras::VERSION
+  spec.authors       = ["Jaakko Suutarla"]
+  spec.email         = ["jaakko.suutarla@yle.fi"]
+  spec.description   = %q{Enables Vagrant to update dns records when using AWS Route53}
+  spec.summary       = %q{Enables Vagrant to update dns records when using AWS Route53}
+  spec.homepage      = "https://github.com/yle/vagrant-aws-extras"
+  spec.license       = "MIT"
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  spec.files         = unignored_files
+  spec.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  spec.require_path = "lib"
+
+  spec.required_rubygems_version = ">= 1.3"
+
+  spec.add_runtime_dependency "vagrant-aws", "~> 0.3.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-core", "~> 2.12.2"
+  spec.add_development_dependency "rspec-expectations", "~> 2.12.1"
+  spec.add_development_dependency "rspec-mocks", "~> 2.12.1"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-aws-extras
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc1
+platform: ruby
+authors:
+- Jaakko Suutarla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant-aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+description: Enables Vagrant to update dns records when using AWS Route53
+email:
+- jaakko.suutarla@yle.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/vagrant-aws-extras/action/dns.rb
+- lib/vagrant-aws-extras/action.rb
+- lib/vagrant-aws-extras/config.rb
+- lib/vagrant-aws-extras/plugin.rb
+- lib/vagrant-aws-extras/version.rb
+- lib/vagrant-aws-extras.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- spec/vagrant-aws-extras/action/dns_spec.rb
+- spec/vagrant-aws-extras/config_spec.rb
+- vagrant-aws-extras.gemspec
+- .gitignore
+homepage: https://github.com/yle/vagrant-aws-extras
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.3'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Enables Vagrant to update dns records when using AWS Route53
+test_files: []