vagrant-cachier 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 447f8c66ad65b17a8bc2cc5a63b238bc1879868a
-  data.tar.gz: a3f75f32e121e33d545a5c5f3cc0c6fee5126462
+  metadata.gz: 8e3d1a6bde8fed89429d000fe1cb4ad3d966873c
+  data.tar.gz: da33a199d777158597f0aa29df079eb63f7909b8
 SHA512:
-  metadata.gz: 092fae1c133849f86db12eb0f0b05f29d11d74b43b58bba425993ccddda8fc05fc4118d26ea2b66822eb0147df7a47523706db482ee1fd859d1bb9b4ce47e627
-  data.tar.gz: 8bdefb1e24bbb057f98a2c21f6bb0d22c55bfc7decf5af34dc910b4e90599380d2bcc61520668bcaa5c16faf1ea9444a3102662b5f6ac374101e68c67889e070
+  metadata.gz: 91ff3706421615c7f68d1fafa796ee0e9fa58ae2eee63aa35a4e02f49b73be7a8c7266e72b467af91e2d98b323b6faafb87e9c5436e4710bc4a0ea641b4ed6da
+  data.tar.gz: 8f1533ddbe6be87b8fa7beacf54d3d3627abcf2d6b797a09fbcf2cee722e23a82d6a7f5c745adc29ec0f17ef8adcb2324bcaccef70d38cebd0028b817bf7e45a

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.4.0](https://github.com/fgrehm/vagrant-cachier/compare/v0.3.3...v0.4.0) (Oct 23, 2013)
+
+FEATURES:
+
+  - Support for [npm](https://npmjs.org/) [GH-51]
+  - Support for [Composer](http://getcomposer.org/) [GH-48]
+  - Support for `apt-cacher-ng` [GH-30]
+
+BUG FIXES:
+
+  - Allow halting nonresponsive machine when plugin is installed [GH-8]
+
 ## [0.3.3](https://github.com/fgrehm/vagrant-cachier/compare/v0.3.2...v0.3.3) (Sep 11, 2013)
 
 BUG FIXES:

data/Gemfile.lock

@@ -1,26 +1,26 @@
 GIT
   remote: git://github.com/fgrehm/vagrant-global-status.git
-  revision: 860a7ce70ff4596621af492e47eace5631f47324
+  revision: a0295400a0e47756cbcb8f97ed9f4449b1fb6b56
   specs:
-    vagrant-global-status (0.1.0)
+    vagrant-global-status (0.1.1)
 
 GIT
   remote: git://github.com/fgrehm/vagrant-lxc.git
-  revision: 5ae82681cdedaf2a6f778e005dd65014fc7c2cec
+  revision: 225af5622767059708278db29d42941e93d41994
   specs:
-    vagrant-lxc (0.5.1.dev)
+    vagrant-lxc (0.6.4.dev)
 
 GIT
   remote: git://github.com/fgrehm/vagrant-pristine.git
-  revision: 5c400d7850fc5f98d9601b59f4c3bd74818650de
+  revision: 4638491786943bfbf6f115b1fc379f069963fe46
   specs:
-    vagrant-pristine (0.2.0)
+    vagrant-pristine (0.3.0)
 
 GIT
   remote: git://github.com/mitchellh/vagrant.git
-  revision: 16002d03c07f842a23497543129fa99f40f2bbc0
+  revision: 57e95323b6600b146167f0f14f83b22dd31dd03f
   specs:
-    vagrant (1.2.8.dev)
+    vagrant (1.3.6.dev)
       childprocess (~> 0.3.7)
       erubis (~> 2.7.0)
       i18n (~> 0.6.0)
@@ -31,7 +31,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-cachier (0.3.3)
+    vagrant-cachier (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -56,7 +56,7 @@ GEM
     erubis (2.7.0)
     ffi (1.9.0)
     highline (1.6.19)
-    i18n (0.6.4)
+    i18n (0.6.5)
     ipaddress (0.8.0)
     json (1.7.7)
     librarian (0.1.0)
@@ -97,7 +97,7 @@ GEM
     thor (0.18.1)
     vagrant-librarian-chef (0.1.2)
       librarian-chef
-    vagrant-omnibus (1.1.0)
+    vagrant-omnibus (1.1.2)
     yajl-ruby (1.1.0)
 
 PLATFORMS

data/README.md

@@ -208,6 +208,65 @@ folder under the result of running `rvm info` as the default SSH user (usualy
 it is already installed before enabling the bucket, otherwise you won't benefit
 from this plugin.
 
+#### [npm](https://npmjs.org/)
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'some-box-with-nodejs-installed'
+  config.cache.enable :npm
+end
+```
+
+Compatible with probably any type of linux guest distro, will hook into npm's
+cache directory under the result of running `npm config get cache` as
+the default SSH user (usually `vagrant`) on your guest.
+If you use
+[nvm](https://github.com/creationix/nvm) / [n](https://github.com/visionmedia/n)
+on the guest machine, make sure it is already installed before enabling
+the bucket, otherwise you won't benefit from this plugin.
+
+#### [Composer](http://getcomposer.org/)
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'some-box-with-php-installed'
+  config.cache.enable :composer
+end
+```
+
+Compatible with probably any type of linux guest distro, will cache guests'
+`$HOME/.composer` if PHP is detected.
+
+##### APT-CACHER
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'some-debian-box'
+  config.cache.enable :apt_cacher
+end
+```
+
+This is useful, if you are using containers inside your VMs, e.g VirtualBox -> LXC.
+This would allow you to reuse packages without sharing folder inside VirtualBox. Only
+works with NFS-shared folders (since `vboxsf` is enforcing `vagrant`-user and `apt-cacher`
+is running under `apt-cacher-ng` user)
+
+    # install apt-cacher on (Host)-VM
+    $ sudo apt-get install apt-cacher-ng
+
+    # get the IP for eth0 interface
+    $ ifconfig eth0 |grep "inet addr"|awk '{print $2}' |cut -c6-20
+
+    # configure mirror on for your docker/LXC instances:
+    $ echo 'Acquire::http { Proxy "http://X.X.X.X:3142"; };' > /etc/apt/apt.conf.d/10mirror
+
+    # check, if working by tailing log on (Host)-VM, while installing packages on (Guest)-VMs
+    $ tail -f /var/log/apt-cacher-ng/apt-cacher.log
+
+
+Used by Debian-like Linux distros, will get configured under guest's `/var/cache/apt-cacher-ng`.
+
+
 ## Finding out disk space used by buckets
 
 _TODO_

data/development/Vagrantfile

@@ -44,11 +44,29 @@ Vagrant.configure("2") do |config|
     fi
   '
 
+  config.vm.provision :shell, inline: '
+    if ! [ -d /home/vagrant/.nvm ]; then
+      apt-get install git -y
+      HOME=/home/vagrant su -p vagrant -l -c "
+        curl https://raw.github.com/creationix/nvm/master/install.sh | sh
+      "
+    fi
+  '
+
+  config.vm.provision :shell, inline: '
+    if ! [ -d /home/vagrant/.nvm/v0.10* ]; then
+      HOME=/home/vagrant su -p vagrant -l -c "
+        nvm install 0.10
+        nvm alias default 0.10
+      "
+    fi
+  '
+
   debian_like_configs = lambda do |debian|
     # Here we have the RubyGems cache bucket configured to the right path, so we
     # bundle the project
     debian.vm.provision :shell, inline: '
-      sudo apt-get install git -y
+      sudo apt-get install -y git php5-cli
       HOME=/home/vagrant su -p vagrant -l -c "cd /vagrant && bundle"
     '
   end
@@ -86,5 +104,4 @@ Vagrant.configure("2") do |config|
         pacman -Syu --noconfirm libffi git
         HOME=/home/vagrant su -p vagrant -l -c "cd /vagrant && bundle"'
   end
-
 end

data/lib/vagrant-cachier/action/clean.rb

@@ -1,3 +1,5 @@
+require 'timeout'
+
 module VagrantPlugins
   module Cachier
     class Action
@@ -8,29 +10,54 @@ module VagrantPlugins
         end
 
         def call(env)
-          @env = env
+          @env     = env
+          @machine = env[:machine]
 
-          if env[:machine].state.id == :running && symlinks.any?
+          if symlinks.any?
             env[:ui].info I18n.t('vagrant_cachier.cleanup')
-            symlinks.each do |symlink|
-              remove_symlink symlink
+            if sshable?
+              symlinks.each do |symlink|
+                remove_symlink symlink
+              end
             end
 
-            File.delete env[:machine].data_dir.join('cache_dirs').to_s
+            File.delete @machine.data_dir.join('cache_dirs').to_s
           end
 
           @app.call env
         end
 
+        def sshable?
+          return if @machine.state.id != :running
+
+          # By default Vagrant will keep trying [1] to ssh connect to the VM for
+          # a long and we've got to prevent that from happening, so we just wait
+          # a few seconds and assume that the VM is halted / unresponsive and we
+          # carry on if it times out.
+          #   [1] - https://github.com/mitchellh/vagrant/blob/57e95323b6600b146167f0f14f83b22dd31dd03f/plugins/communicators/ssh/communicator.rb#L185-L200
+          begin
+            Timeout.timeout(35) do
+              while true
+                return true if @machine.communicate.ready?
+                sleep 0.5
+              end
+            end
+          rescue Timeout::Error
+            @env[:ui].warn(I18n.t('vagrant_cachier.unable_to_ssh'))
+          end
+
+          return false
+        end
+
         def symlinks
           # TODO: Check if file exists instead of a blank rescue
-          @symlinks ||= @env[:machine].data_dir.join('cache_dirs').read.split rescue []
+          @symlinks ||= @machine.data_dir.join('cache_dirs').read.split rescue []
         end
 
         def remove_symlink(symlink)
-          if @env[:machine].communicate.test("test -L #{symlink}")
+          if @machine.communicate.test("test -L #{symlink}")
             @logger.debug "Removing symlink for '#{symlink}'"
-            @env[:machine].communicate.sudo("unlink #{symlink}")
+            @machine.communicate.sudo("unlink #{symlink}")
           end
         end
       end

data/lib/vagrant-cachier/bucket.rb

@@ -15,12 +15,12 @@ module VagrantPlugins
       end
 
       def self.bucket_name
-        # TODO: Handle MultiWord bucket classes
-        self.name.split('::').last.downcase
+        class_name = self.name.split('::').last
+        class_name.scan(/[A-Z][a-z]*/).map{|x| x.downcase}.join("_")
       end
 
       def self.install(name, env, configs)
-        bucket = const_get(name.to_s.capitalize)
+        bucket = const_get(name.to_s.split("_").map{|x| x.capitalize}.join(""))
         bucket.new(name, env, configs).install
       end
 
@@ -39,3 +39,6 @@ require_relative "bucket/gem"
 require_relative "bucket/pacman"
 require_relative "bucket/yum"
 require_relative "bucket/rvm"
+require_relative "bucket/apt_cacher"
+require_relative "bucket/composer"
+require_relative "bucket/npm"

data/lib/vagrant-cachier/bucket/apt_cacher.rb

@@ -0,0 +1,39 @@
+# Apt-Cacher NG is a caching proxy for software packages which are downloaded by
+# Unix/Linux system distribution mechanisms from mirror servers accessible via HTTP.
+module VagrantPlugins
+  module Cachier
+    class Bucket
+      class AptCacher < Bucket
+        def self.capability
+          :apt_cacher_dir
+        end
+
+        def install
+          machine = @env[:machine]
+          guest   = machine.guest
+
+          if guest.capability?(:apt_cacher_dir)
+            if machine.config.cache.enable_nfs
+              guest_path = guest.capability(:apt_cacher_dir)
+
+              @env[:cache_dirs] << guest_path
+
+              machine.communicate.tap do |comm|
+                comm.execute("mkdir -p /tmp/vagrant-cache/#{@name}")
+                unless comm.test("test -L #{guest_path}")
+                  comm.sudo("rm -rf #{guest_path}")
+                  comm.sudo("mkdir -p `dirname #{guest_path}`")
+                  comm.sudo("ln -s /tmp/vagrant-cache/#{@name} #{guest_path}")
+                end
+              end
+            else
+              @env[:ui].info I18n.t('vagrant_cachier.nfs_required', bucket: 'apt-cacher')
+            end
+          else
+            @env[:ui].info I18n.t('vagrant_cachier.skipping_bucket', bucket: 'apt-cacher')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cachier/bucket/composer.rb

@@ -0,0 +1,34 @@
+module VagrantPlugins
+  module Cachier
+    class Bucket
+      class Composer < Bucket
+        def self.capability
+          :composer_path
+        end
+
+        def install
+          machine = @env[:machine]
+          guest   = machine.guest
+
+          if guest.capability?(:composer_path)
+            if composer_path = guest.capability(:composer_path)
+              bucket_path = "/tmp/vagrant-cache/#{@name}"
+              @env[:cache_dirs] << composer_path
+
+              machine.communicate.tap do |comm|
+                comm.execute("mkdir -p #{bucket_path}")
+
+                unless comm.test("test -L #{composer_path}")
+                  comm.sudo("rm -rf #{composer_path}")
+                  comm.sudo("ln -s #{bucket_path} #{composer_path}")
+               end
+              end
+            end
+          else
+            @env[:ui].info I18n.t('vagrant_cachier.skipping_bucket', bucket: 'Composer')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cachier/bucket/npm.rb

@@ -0,0 +1,33 @@
+module VagrantPlugins
+  module Cachier
+    class Bucket
+      class Npm < Bucket
+        def self.capability
+          :npm_cache_dir
+        end
+
+        def install
+          machine = @env[:machine]
+          guest   = machine.guest
+
+          if guest.capability?(:npm_cache_dir)
+            guest_path = guest.capability(:npm_cache_dir)
+
+            @env[:cache_dirs] << guest_path
+
+            machine.communicate.tap do |comm|
+              comm.execute("mkdir -p /tmp/vagrant-cache/#{@name}")
+              unless comm.test("test -L #{guest_path}")
+                comm.execute("rm -rf #{guest_path}")
+                comm.execute("mkdir -p `dirname #{guest_path}`")
+                comm.execute("ln -s /tmp/vagrant-cache/#{@name} #{guest_path}")
+              end
+            end
+          else
+            @env[:ui].info I18n.t('vagrant_cachier.skipping_bucket', bucket: 'npm')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cachier/cap/debian/apt_cacher_dir.rb

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module Cachier
+    module Cap
+      module Debian
+        module AptCacherDir
+          def self.apt_cacher_dir(machine)
+            # cat /etc/apt-cacher-ng/acng.conf |grep CacheDir
+            '/var/cache/apt-cacher-ng'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cachier/cap/linux/composer_path.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module Cachier
+    module Cap
+      module Linux
+        module ComposerPath
+          def self.composer_path(machine)
+            composer_path = nil
+            machine.communicate.tap do |comm|
+              return unless comm.test('which php')
+              comm.execute 'echo $HOME' do |buffer, output|
+                composer_path = output.chomp if buffer == :stdout
+              end
+            end
+            return "#{composer_path}/.composer"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cachier/cap/linux/npm_cache_dir.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module Cachier
+    module Cap
+      module Linux
+        module NpmCacheDir
+          def self.npm_cache_dir(machine)
+            npm_cache_dir = nil
+            machine.communicate.tap do |comm|
+              return unless comm.test('which npm')
+              comm.execute 'npm config get cache' do |buffer, output|
+                npm_cache_dir = output.chomp if buffer == :stdout
+              end
+            end
+            return npm_cache_dir
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cachier/plugin.rb

@@ -26,16 +26,31 @@ module VagrantPlugins
         Cap::Linux::RvmPath
       end
 
+      guest_capability 'linux', 'composer_path' do
+        require_relative 'cap/linux/composer_path'
+        Cap::Linux::ComposerPath
+      end
+
       guest_capability 'linux', 'chef_file_cache_path' do
         require_relative 'cap/linux/chef_file_cache_path'
         Cap::Linux::ChefFileCachePath
       end
 
+      guest_capability 'linux', 'npm_cache_dir' do
+        require_relative 'cap/linux/npm_cache_dir'
+        Cap::Linux::NpmCacheDir
+      end
+
       guest_capability 'debian', 'apt_cache_dir' do
         require_relative 'cap/debian/apt_cache_dir'
         Cap::Debian::AptCacheDir
       end
 
+      guest_capability 'debian', 'apt_cacher_dir' do
+        require_relative 'cap/debian/apt_cacher_dir'
+        Cap::Debian::AptCacherDir
+      end
+
       guest_capability 'redhat', 'yum_cache_dir' do
         require_relative 'cap/redhat/yum_cache_dir'
         Cap::RedHat::YumCacheDir

data/lib/vagrant-cachier/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Cachier
-    VERSION = "0.3.3"
+    VERSION = "0.4.0"
   end
 end

data/locales/en.yml

@@ -6,11 +6,16 @@ en:
       Skipping %{bucket} cache bucket as the guest machine does not support it
     unknown_cache_scope: |-
       Unknown cache scope '%{cache_scope}' (allowed scopes: %{allowed})
+    nfs_required: |-
+      The '%{bucket}' cache bucket requires NFS to be enabled, please add
+      `config.cache.enable_nfs = true` to your Vagrantfile.
     will_fix_machine_cache_dir: |-
       A vagrant-cachier provider specific cache dir was found under
       '%{current_path}' and it will be moved to
       '%{new_path}' as it is the new path for keeping machine
       scoped cache dirs starting with the 0.3.0 version of the plugin.
+    unable_to_ssh: |-
+      vagrant-cachier was unable to SSH into the VM to remove symlinks!
   vagrant:
     errors:
       multiple_provider_specific_cache_dirs_found: |-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-cachier
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Fabio Rehm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies: []
 description: Speed up vagrant boxes provisioning
 email:
@@ -32,15 +32,21 @@ files:
 - lib/vagrant-cachier/action/ensure_single_cache_root.rb
 - lib/vagrant-cachier/bucket.rb
 - lib/vagrant-cachier/bucket/apt.rb
+- lib/vagrant-cachier/bucket/apt_cacher.rb
 - lib/vagrant-cachier/bucket/chef.rb
+- lib/vagrant-cachier/bucket/composer.rb
 - lib/vagrant-cachier/bucket/gem.rb
+- lib/vagrant-cachier/bucket/npm.rb
 - lib/vagrant-cachier/bucket/pacman.rb
 - lib/vagrant-cachier/bucket/rvm.rb
 - lib/vagrant-cachier/bucket/yum.rb
 - lib/vagrant-cachier/cap/arch/pacman_cache_dir.rb
 - lib/vagrant-cachier/cap/debian/apt_cache_dir.rb
+- lib/vagrant-cachier/cap/debian/apt_cacher_dir.rb
 - lib/vagrant-cachier/cap/linux/chef_file_cache_path.rb
+- lib/vagrant-cachier/cap/linux/composer_path.rb
 - lib/vagrant-cachier/cap/linux/gemdir.rb
+- lib/vagrant-cachier/cap/linux/npm_cache_dir.rb
 - lib/vagrant-cachier/cap/linux/rvm_path.rb
 - lib/vagrant-cachier/cap/redhat/yum_cache_dir.rb
 - lib/vagrant-cachier/config.rb
@@ -76,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Speed up vagrant boxes provisioning