vagrant_box_version 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 448b6eb663ff3e362c5e8953ffc7491ee52d7e6b
+  data.tar.gz: 30b6be9f3f652ccebdbdb21622d7efa138c578ce
+SHA512:
+  metadata.gz: bcda7ad27f8749a59a5c128c53b2dbe8a79fadda2ee9034ecd3586263e3d9a6ed23e92f4e83199f9661c2dc24702ede3e046cec512211a0ef5fb31533979c302
+  data.tar.gz: 33674f0b3bd51c28536219b64f86308ce46c42ac271e3aa72c1b05bc358f69727cea832bfd1786f0e87a704643d7dc98225ccbc3c3092aaececc663e9db770b6

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_version.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hootsuite Media Inc.
+
+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 Version Plugin
+
+This plugin allows users of vagrant boxes to check they have the latest
+available version. It's designed to do so in the simplest way possible.
+
+It provides two things:
+
+1. A convention for storing version information inside vagrant boxes
+2. A plugin that checks that the version available on a remote server is the
+	 same as the current box version.
+
+Versions are stored inside the box in `include/version` and just contain a
+version identifier. The part of that version number before the first dash is
+parsed as an integer for comparison. We use 
+`[jenkins build number]-[git short revision]`.
+
+The purpose of this plugin is to enable organizations to continuously improve
+their vagrant-backed dev environments, and treat them as disposable (á la
+[Chad Fowler][fowler])
+
+## Usage
+
+### For box publishers
+
+Boxes should include a file called `version` containing your version of the
+box. Simply create the file with the desired content and include it in your
+packaged box when you run:
+
+    vagrant package --include version
+
+The plugin requires a file with the name `[box-name].box.version` to be
+installed in a known HTTP/HTTPS/FTP location. We upload them alongside the box
+with the same jenkins job that builds boxes.
+
+### For box users
+
+Once the plugin is installed (`vagrant plugin install vagrant_box_version`),
+simply add the location of your box server's version files to your config,
+e.g.
+
+    config.version.url = http://my-vagrant-box.es/
+
+You can then run `vagrant version` to check you have the latest version. If
+you don't or either remote or local version can't be determined, you will be
+warned about it.
+
+### Installation from source.
+
+Simply run `rake build`, and then
+`vagrant plugin install pkg/vagrant_box_version`.
+
+### Extension points
+
+This is always going to be minimal. However in the future it might:
+
+* Allow a regex-based version format that identifies points of comparison.
+* Offer to update your box for you (destroying the current box)
+* Provide more flexibility about version information source (frankly unlikely)
+
+## Contributing
+
+Contributions in the form of pull requests are are very welcome, though anyone
+wanting to produce a full box package manager might want to start again.
+
+[fowler]: http://chadfowler.com/blog/2013/06/23/immutable-deployments/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant_box_version/command.rb

@@ -0,0 +1,69 @@
+require "vagrant"
+
+module VagrantBoxVersion
+  require "open-uri"
+
+  class VersionString
+    attr_reader :build, :hash
+    include Comparable
+
+    def initialize(string)
+      @build = string.strip[/[^-]*/].to_i
+      @hash = if string.include? "-" then string.strip.split("-")[1] else "" end
+    end
+
+    def to_s
+      "#@build-#@hash"
+    end
+
+    def <=>(other)
+      build <=> other.build
+    end
+  end
+
+  class Command < Vagrant.plugin(2, :command)
+
+    def execute
+      ui = @env.ui
+
+      with_target_vms() do |machine|
+        box = machine.box
+        unless box.nil?
+          version = local_version(box.directory)
+          remote = remote_version(machine.config.version.url, box.name)
+
+          ui.info("Local version is #{version || "unknown"}")
+
+          if (version || VersionString.new("0")) < (remote || VersionString.new("0"))
+            ui.warn("Version #{remote} is available!")
+            ui.info("To update, run:")
+            ui.info("  vagrant destroy && vagrant box remove #{box.name} #{box.provider.to_s}")
+          elsif version.nil?
+            ui.warn("Local version couldn't be determined. You should probably upgrade your box.")
+          elsif remote.nil?
+            ui.warn("Remote version couldn't be determined. Try again later.")
+          else
+            ui.success("You are up to date!")
+          end
+        else
+          ui.success("There is no local box yet. Nothing to do.")
+        end
+      end
+    end
+
+    private
+
+    def local_version(boxdir)
+      versionfile = File.join(boxdir, "include", "version")
+      if File.exists? versionfile then VersionString.new(File.read(versionfile)) else nil end
+    end
+
+    def remote_version(server, name)
+      begin
+        VersionString.new(open("#{server}/#{name}.box.version").read)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/vagrant_box_version/config.rb

@@ -0,0 +1,22 @@
+module VagrantBoxVersion
+
+  class Config < Vagrant.plugin("2", :config)
+    attr_accessor :url
+
+    def initialize()
+      @url = UNSET_VALUE
+    end
+
+    def finalize!
+      @url = "" if @url == UNSET_VALUE
+    end
+
+    def validate(machine)
+      if @url.empty?
+        { "version" => ["config.version.url must be set"] }
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/vagrant_box_version/plugin.rb

@@ -0,0 +1,27 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "This plugin must be run from within Vagrant."
+end
+
+if Vagrant::VERSION < "1.2.0"
+  raise "This plugin is only compatible with Vagrant 1.2+"
+end
+
+
+module VagrantBoxVersion
+  class Plugin < Vagrant.plugin("2")
+
+    name "Vagrant Box Version Plugin"
+
+    command "version" do
+      require_relative "command"
+      Command
+    end
+
+    config "version" do
+      require_relative "config"
+      Config
+    end
+  end
+end

data/lib/vagrant_box_version/version.rb

@@ -0,0 +1,3 @@
+module VagrantBoxVersion
+  VERSION = "0.0.1"
+end

data/lib/vagrant_box_version.rb

@@ -0,0 +1,3 @@
+require "vagrant_box_version/version"
+require "vagrant_box_version/plugin"
+

data/vagrant_box_version.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant_box_version/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant_box_version"
+  spec.version       = VagrantBoxVersion::VERSION
+  spec.authors       = ["Edd Steel"]
+  spec.email         = ["edward.steel@hootsuite.com"]
+  spec.description   = "Plugin to provide version information for boxes"
+  spec.summary       = "Plugin to provide version information for boxes"
+  spec.homepage      = ""
+  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"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: vagrant_box_version
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Edd Steel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Plugin to provide version information for boxes
+email:
+- edward.steel@hootsuite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant_box_version.rb
+- lib/vagrant_box_version/command.rb
+- lib/vagrant_box_version/config.rb
+- lib/vagrant_box_version/plugin.rb
+- lib/vagrant_box_version/version.rb
+- vagrant_box_version.gemspec
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Plugin to provide version information for boxes
+test_files: []