vagrant-box-updater2 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dd4c671549e44b62f5a415a6b2916a38215bc8c
+  data.tar.gz: 4fe91d7cd28fbb1cfe1a70d1f749b85be5c0a76c
+SHA512:
+  metadata.gz: 3761900d2f8a30760e812945b3626be6675637fbe0cc2db0c67897f9f0d09301bd929528d4a3dc1824be3a020b96895f7ce16dc09367b30e04ecbe48e8bec14e
+  data.tar.gz: f3cf1e42cd86538cf64918740819e4faccf523da8bcfdf4cfc6045a2ec239530cf98339c55470ee001a28a3338d06216aa689d906f5def0ec189b1fa92893ec4

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-box-updater.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 spil-ruslan
+
+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,65 @@
+# vagrant-box-updater
+
+Vagrant 1.1+ plugin to detect changes to a remote box's creation date,
+and perform an interactive update if desired.
+
+By default Vagrant just store box images locally and never checks if
+there are updates for that image. Users may therefore end up working
+with outdated boxes.
+
+This plugin hooks into `vagrant box add` and `vagrant up`, saving
+details about each box sources creation date, and optioning performing
+an update when a change is detected.
+
+## Installation
+
+    vagrant plugin install vagrant-box-updater
+
+## Usage
+
+After plugin installed it's recommended to re-add box images so that the
+plugin can collect necessary information about the box.
+
+    vagrant box add --force <source_uri>
+
+To disable the plugin for a project:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+
+  config.box_updater.disable = true
+
+  // ...
+
+end
+```
+
+To enable automatic updates for a project:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+
+  config.box_updater.autoupdate = true
+
+  // ...
+
+end
+```
+## Install from source (Advanced)
+
+1. Clone project
+2. Create a gem file: `rake build`
+3. Install local gem: `vagrant plugin install pkg/vagrant-box-updater-0.0.1.gem`
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require "bundler/setup"
+Bundler::GemHelper.install_tasks

data/lib/vagrant-box-updater.rb

@@ -0,0 +1,2 @@
+require "vagrant"
+require "vagrant-box-updater/plugin"

data/lib/vagrant-box-updater/action/add_box.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+require 'net/http'
+require 'uri'
+require 'base64'
+require 'vagrant-box-updater/util/common'
+
+module VagrantPlugins
+  module BoxUpdater
+    module Action
+      class AddBox
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          box_url = env[:box_url]
+          box_name = env[:box_name]
+          begin
+            modification_attribute = Util::Common.get_modification_attribute(box_url)
+          rescue
+            env[:ui].error("Unable to access: #{box_url}")
+            env[:ui].error("Can not collect image status, please check box url and repeat action")
+            @app.call(env)
+            return 0
+          end
+          @box_attributes = {"url" => box_url}.merge(modification_attribute)
+          path_box_stat_file = Util::Common.get_path_box_stat_file(env, box_name)
+          Util::Common.save_box_stats(path_box_stat_file, @box_attributes)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/action/up_box.rb

@@ -0,0 +1,142 @@
+require 'yaml'
+require 'net/http'
+require 'uri'
+require 'vagrant-box-updater/util/common'
+
+module VagrantPlugins
+  module BoxUpdater
+    module Action
+      class UpBox
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          require 'time'
+          box_name = env[:machine].config.vm.box
+          box_url  = env[:machine].config.vm.box_url
+	        path_box_stat_file = Util::Common.get_path_box_stat_file(env, box_name)
+
+          disable_plugin_flag = env[:machine].config.box_updater.disable
+          if disable_plugin_flag == true
+            env[:ui].warn("Update disabled")    
+            @app.call(env)
+            return 0
+          end
+
+          enable_autoupdate_flag = env[:machine].config.box_updater.autoupdate
+
+          stat_file = env[:home_path].join(box_name + ".stat")
+
+          # Create empty stat file if missing 
+          if !File.file?(stat_file)
+            env[:ui].info("Local stat file not found: #{stat_file}")
+            @box_attributes = {"modification_date" => nil, "url" => box_url}
+	          Util::Common.save_box_stats(path_box_stat_file, @box_attributes)
+          end
+
+          box_stats = YAML.load_file(stat_file)
+
+          box_url = box_stats["url"]
+
+          current_modification_date = box_stats["Last-Modified"] 
+          # "Etag" attribute is not in use - but we may use it in future
+          # What we trying to achieve : some public resources such as github.com does not provide "Last-Modified"
+          # but "Etag" id, so optionally we may need number of generic methods to decide if object modified
+          current_modification_etag = box_stats["Etag"] 
+
+          if current_modification_date == nil and current_modification_etag != nil
+            env[:ui].warn("Not enough data to decide whether image need to be updated")
+            env[:ui].warn("Remote server does not provide \"Last-Modified\" field in the header but \"Etag\" which is not supported at the moment")
+            env[:ui].warn("This is known issue for some websites (like github.com)")
+            env[:ui].warn("If you want to have this functionality added, please, fire feature request on oficial plugin page on github")
+            @app.call(env)
+            return 0
+          end
+
+          if current_modification_date == nil
+            env[:ui].warn("Not enough data to decide whether image need to be updated")
+            env[:ui].warn("Please, add box again \"vagrant box add -f\" so it'll update image data")
+            @app.call(env)
+            return 0
+          end
+
+          if box_url == nil
+            env[:ui].warn("Local box url is not set")
+            env[:ui].warn("Unable to check remote box")
+            env[:ui].warn("Please, add box again \"vagrant box add -f\" so it'll update image data")
+            @app.call(env)
+            return 0
+          end
+
+          begin
+            env[:ui].info("Verify remote image data: #{box_url}")
+            remote_modification_attribute = Util::Common.get_modification_attribute(box_url)
+          rescue 
+            env[:ui].warn("Unable access: #{box_url}")
+            env[:ui].warn("Skip remote box check")
+            @app.call(env)
+            return 0
+          end
+
+          if remote_modification_attribute['Last-Modified'] == nil
+            env[:ui].warn("Can not retrieve any useful data for: #{box_url}")
+            env[:ui].warn("Skip remote box check")
+            @app.call(env)
+            return 0
+          end
+          remote_modification_timestamp = remote_modification_attribute['Last-Modified'].is_a?(Time) ? remote_modification_attribute['Last-Modified'] : Time.parse(remote_modification_attribute['Last-Modified'])
+          current_modification_timestamp = current_modification_date.is_a?(Time) ? current_modification_date : Time.parse(current_modification_date)
+
+          #env[:ui].info("Remote box timestamp #{remote_modification_timestamp}")
+          #env[:ui].info("Local box timestamp #{current_modification_timestamp}")
+
+          if current_modification_timestamp.to_i < remote_modification_timestamp.to_i
+	          box_stats = Util::Common.read_box_stats(path_box_stat_file, box_name)
+	          if box_stats['ignored_image_attribute'] and box_stats['ignored_image_attribute'].to_i == remote_modification_timestamp.to_i
+              env[:ui].warn("Modified image detected, this update set to be ignored until next change")
+	          else
+              env[:ui].warn("Modified image detected : #{box_stats['url']} #{remote_modification_attribute}")
+              env[:ui].warn("Your current box was last-modified: #{current_modification_timestamp}")
+	            if enable_autoupdate_flag == true || ask_confirm(env,"Would you like to update the box? \nIf negative - we keep ignoring this update, and notify only when another update detected. \nType (Y/N)")
+                env[:ui].info("Going to update and replace box \"#{box_name}\" now!")
+                provider = nil
+                env[:action_runner].run(Vagrant::Action.action_box_add, {
+                  :box_name     => box_name,
+                  :box_provider => provider,
+                  :box_url      => box_url,
+                  :box_force    => true,
+                  :box_download_insecure => true,
+                 })
+              else
+                env[:ui].warn("This update will be ignored")   
+	              Util::Common.add_box_stats(path_box_stat_file, {'ignored_image_attribute' => remote_modification_timestamp})
+                @app.call(env)
+              end
+	          end
+	        else
+            env[:ui].info("Box is uptodate")
+          end
+
+          @app.call(env)
+        end
+        
+        private 
+
+        def ask_confirm(env, message)
+          choice = nil
+          # If we have a force key set and we're forcing, then set
+          # the result to "Y"
+          choice = "Y" if @force_key && env[@force_key]
+          # If we haven't chosen yes, then ask the user via TTY
+          choice = env[:ui].ask(message) if !choice
+          # The result is only true if the user said "Y"
+          result = choice && choice.upcase == "Y"
+          return result  
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/config.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module BoxUpdater
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :disable, :autoupdate
+
+      def initialize
+        @disable = false
+        @autoupdate = false
+      end
+
+      def finalize!
+        @disable = false if @disable == UNSET_VALUE
+        @autoupdate = false if @autoupdate == UNSET_VALUE
+      end
+
+      def validate(machine)
+        {}
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/plugin.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module BoxUpdater
+    class Plugin < Vagrant.plugin('2')
+      name 'Vagrant BoxUpdater'
+      description 'Plugin allows to check source box for updates and interactively prompt user when update is available.'
+
+      config(:box_updater) do
+        require_relative 'config'
+        Config
+      end
+
+      #action_hook 'do-before-boot' do |hook|
+      #  require_relative 'action/up_box'
+      #  #hook.after ::Vagrant::Action::Builtin::ConfigValidate, VagrantPlugins::BoxUpdater::Action::UpBox
+      #  hook.before Vagrant::Action::Builtin::Provision, VagrantPlugins::BoxUpdater::Action::UpBox
+      #end
+
+      action_hook(:do_before_boot, :machine_action_up) do |hook|
+	      require_relative 'action/up_box'
+        hook.prepend(VagrantPlugins::BoxUpdater::Action::UpBox)
+        hook.prepend(V)
+      end
+
+      action_hook 'on_update' do |hook|
+        require_relative 'action/add_box'
+        hook.after ::Vagrant::Action::Builtin::BoxAdd, VagrantPlugins::BoxUpdater::Action::AddBox
+      end
+
+    end
+  end 
+end

data/lib/vagrant-box-updater/util/common.rb

@@ -0,0 +1,83 @@
+module VagrantPlugins
+  module BoxUpdater
+    module Util
+      class Common
+
+        def self.get_path_box_stat_file(env, box_name)
+          YAML::ENGINE.yamler='psych'
+          stat_file = env[:home_path].join(box_name + ".stat")
+	  return stat_file
+        end
+
+        def self.save_box_stats(stat_file, box_attributes)
+          YAML::ENGINE.yamler='psych'
+          File.open(stat_file, 'w+') {|f| f.write(box_attributes.to_yaml) }
+        end
+
+        def self.add_box_stats(stat_file, box_attributes)
+          YAML::ENGINE.yamler='psych'
+	  content = YAML.load_file(stat_file)
+	  content = content.merge(box_attributes)
+          #env[:ui].info("Save to: #{stat_file}")
+          File.open(stat_file, 'w+') {|f| f.write(content.to_yaml) }
+        end
+
+        def self.read_box_stats(stat_file, box_name)
+          YAML::ENGINE.yamler='psych'
+	  content = YAML.load_file(stat_file)
+	  return content
+        end
+
+        def self.get_modification_attribute(box_path)
+          if !box_path.start_with? "http"
+            ref_modification_attribute = method(:get_local_file_modification_date?)
+          else
+            ref_modification_attribute = method(:get_url_modification_attribute?)
+          end
+
+          modification_attribute = ref_modification_attribute.call(box_path)
+          return modification_attribute
+        end
+        
+        def self.get_url_modification_attribute?(url)
+          response = fetch_url(url)
+          return { 'Last-Modified' => response['Last-Modified'] } if response['Last-Modified']
+          return { 'Etag' => response['ETag'].delete("\"") } if response['Etag']
+        end
+        
+        def self.fetch_url(uri_str, limit = 10)
+          # You should choose better exception.
+          raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+        
+          uri = URI.parse(uri_str)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.port == 443)
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+          # if we have a user and password then chances are we want to use basic auth
+          if !uri.user.nil? and !uri.password.nil?
+            auth = 'Basic ' + Base64.encode64( "#{uri.user}:#{uri.password}" ).chomp
+            headers = {
+                "Authorization" => auth
+            }
+          end
+
+          response = http.head(uri.request_uri, headers || nil)
+
+          case response
+          when Net::HTTPSuccess     then response
+          when Net::HTTPRedirection then fetch_url(response['location'], limit - 1)
+          else
+            response.error!
+          end
+        end
+        
+        def self.get_local_file_modification_date?(url)
+          mtime = File.mtime(url)
+          return { 'Last-Modified' => mtime }
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+    module BoxUpdater
+      VERSION = "0.0.5"
+    end
+  end

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require 'vagrant-box-updater'

data/vagrant-box-updater.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-box-updater/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vagrant-box-updater2"
+  gem.version       = Vagrant::BoxUpdater::VERSION
+  gem.authors       = ["Ruslan Lutsenko", "Alex House"]
+  gem.email         = ["ruslan.lutcenko@gmail.com", "alex.house@performancehorizon.com"]
+  gem.description   = "vagrant plugin which save details about added box image (image creation timestamp image source path), during start of virtual machine checks the source url of a box image for updates (use 'Last-Modified' header to detect changes), notify user and perform interactive download of the box image if update detected"
+  gem.summary       = "Vagrant plugin to detect and notify on update of remote box images"
+  gem.homepage      = "https://github.com/alexhouse/vagrant-box-updater"
+
+	# 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
+
+  gem.files         = unignored_files
+  gem.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  gem.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-box-updater2
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Ruslan Lutsenko
+- Alex House
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-13 00:00:00.000000000 Z
+dependencies: []
+description: vagrant plugin which save details about added box image (image creation
+  timestamp image source path), during start of virtual machine checks the source
+  url of a box image for updates (use 'Last-Modified' header to detect changes), notify
+  user and perform interactive download of the box image if update detected
+email:
+- ruslan.lutcenko@gmail.com
+- alex.house@performancehorizon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/vagrant-box-updater/action/add_box.rb
+- lib/vagrant-box-updater/action/up_box.rb
+- lib/vagrant-box-updater/config.rb
+- lib/vagrant-box-updater/plugin.rb
+- lib/vagrant-box-updater/util/common.rb
+- lib/vagrant-box-updater/version.rb
+- lib/vagrant-box-updater.rb
+- lib/vagrant_init.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- vagrant-box-updater.gemspec
+- .gitignore
+- lib/vagrant-box-updater/action/.up_box.rb.swp
+homepage: https://github.com/alexhouse/vagrant-box-updater
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to detect and notify on update of remote box images
+test_files: []