vagrant-notify-forwarder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3036da0c84c970b025b499e3db1f161b4834f8a
+  data.tar.gz: 8716f2cea05962cdb24329a4c95163bd52c3bd96
+SHA512:
+  metadata.gz: d52251ae022a89c51f319b8f6db84aa5b2fe7b3a0e0c4aec6a77f52c1a18b6c7bb01d7ee976abcfd90b4688fe0cd8bedfe3f0d552862157b160f9d4961eeef7e
+  data.tar.gz: 25705479032b9e2db1e5aa33e2e9a0c7a8f2fb9f5eb5327d4abe5aec0cf6a8a839cf6b90ab9899ce415ec04fa4814eeda8d13bf74d57b532209e919eebb5b3d7

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-notify-forwarder", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 mhallin
+
+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,41 @@
+# Vagrant file system notification forwarder plugin
+
+A vagrant plugin that uses [notify-forwarder](https://github.com/mhallin/notify-forwarder) to
+forward file system events from the host to the guest automatically on all shared folders.
+
+This is useful for auto reloading file systems that rebuild when files change. Normally, they have
+to use CPU intensive polling when watching shared folders. This plugin makes them able to use
+inotify or similar for improved performance and reduced CPU usage.
+
+## Installation and usage
+
+```terminal
+$ vagrant plugin install vagrant-notify-forwarder
+$ vagrant reload
+```
+
+By default, this sets up UDP port 29324 for port forwarding. If you're already using this port, or
+if you want to change it, add the following line to your `Vagrantfile`:
+
+```ruby
+config.notify_forwarder.port = 22020 # Or your port number
+```
+
+The server and guest binaries will be automatically downloaded from the notify-forwarder repo's
+releases and verified with SHA256.
+
+## Supported operating systems
+
+To conserve size and dependencies, the plugin downloads binaries for supported platforms. This
+plugin supports the same host/guest platforms as `notify-forwarder` itself:
+
+* FreeBSD 64 bit as guest,
+* Linux 64 bit as host and guest, and
+* Mac OS X 64 bit as host and guest.
+
+If you're running an unsupported host or guest and want to disable this plugin for a specific
+machine, add the following line to your `Vagrantfile`:
+
+```ruby
+config.notify_forwarder.enable = false
+```

data/lib/vagrant-notify-forwarder.rb

@@ -0,0 +1,39 @@
+require "vagrant"
+
+module VagrantNotifyForwarderPlugin
+
+  class Plugin < Vagrant.plugin("2")
+    name "vagrant-notify-forwarder"
+    description "Wrapper around the notify-forwarder file system event forwarder"
+
+    register_boot_hooks = lambda do |hook|
+      require_relative "vagrant-notify-forwarder/action"
+
+      hook.after Vagrant::Action::Builtin::Provision,
+                 VagrantNotifyForwarderPlugin::Action::StartHostForwarder
+      hook.after VagrantNotifyForwarderPlugin::Action::StartHostForwarder,
+                 VagrantNotifyForwarderPlugin::Action::StartClientForwarder
+    end
+
+    register_halt_hooks = lambda do |hook|
+      require_relative "vagrant-notify-forwarder/action"
+
+      hook.before Vagrant::Action::Builtin::GracefulHalt,
+                  VagrantNotifyForwarderPlugin::Action::StopHostForwarder
+    end
+
+    config "notify_forwarder" do
+      require_relative "vagrant-notify-forwarder/config"
+
+      VagrantNotifyForwarderPlugin::Config::Config
+    end
+
+    action_hook :start_notify_forwarder, :machine_action_up, &register_boot_hooks
+    action_hook :start_notify_forwarder, :machine_action_reload, &register_boot_hooks
+
+    action_hook :stop_notify_forwarder, :machine_action_halt, &register_halt_hooks
+    action_hook :stop_notify_forwarder, :machine_action_reload, &register_halt_hooks
+
+  end
+
+end

data/lib/vagrant-notify-forwarder/action.rb

@@ -0,0 +1,183 @@
+module VagrantNotifyForwarderPlugin
+
+  module Action
+
+    class Utils
+      @@OS_NAMES = {
+        "Linux" => :linux,
+        "Darwin" => :darwin,
+        "FreeBSD" => :freebsd,
+      }
+
+      @@HARDWARE_NAMES = {
+        "x86_64" => :x86_64,
+      }
+
+      def self.parse_os_name(data)
+        @@OS_NAMES[data.strip] or :unsupported
+      end
+
+      def self.parse_hardware_name(data)
+        @@HARDWARE_NAMES[data.strip] or :unsupported
+      end
+
+      def self.host_pidfile(env)
+        env[:machine].data_dir.join('notify_watcher_host_pid')
+      end
+
+      def self.ensure_binary_downloaded(env, os, hardware)
+        download_urls = {
+          [:linux, :x86_64] => ['https://github.com/mhallin/notify-forwarder/releases/download/release/v0.1.0/notify-forwarder_linux_x64',
+                                '7d14996963f45d9b1c85e78d0aa0c94371d585d0ccabae482c2ef5968417a7f0'],
+          [:darwin, :x86_64] => ['https://github.com/mhallin/notify-forwarder/releases/download/release/v0.1.0/notify-forwarder_osx_x64',
+                                 'd8ad61d9b70394b55bc22c94771ca6f88f0f51868617c3b2c55654ebde866c23'],
+          [:freebsd, :x86_64] => ['https://github.com/mhallin/notify-forwarder/releases/download/release/v0.1.0/notify-forwarder_freebsd_x64',
+                                  '2df0884958b2469dd7113660cf2de01e9e5dd8fcad0213bff3335833e6668f84'],
+        }
+
+        url, sha256sum = download_urls[[os, hardware]]
+        path = env[:tmp_path].join File.basename(url)
+        should_download = true
+
+        if File.exists? path
+          digest = Digest::SHA256.file(path).hexdigest
+
+          if digest == sha256sum
+            should_download = false
+          end
+        end
+
+        if should_download
+          env[:ui].info 'Notify-forwarder: Downloading client'
+          downloader = Vagrant::Util::Downloader.new url, path
+          downloader.download!
+        end
+
+        File.chmod(0755, path)
+
+        path
+      end
+    end
+
+    class StartHostForwarder
+      def initialize(app, env)
+        @app = app
+      end
+
+      def ensure_binary_downloaded(env)
+        os = Utils.parse_os_name `uname -s`
+        hardware = Utils.parse_hardware_name `uname -m`
+
+        env[:ui].error 'Notify-forwarder: Unsupported host operating system' if os == :unsupported
+        env[:ui].error 'Notify-forwarder: Unsupported host hardware' if hardware == :unsupported
+
+        if os != :unsupported and hardware != :unsupported
+          Utils.ensure_binary_downloaded env, os, hardware
+        end
+      end
+
+      def start_watcher(env, command)
+        pid = Process.spawn command
+        Process.detach(pid)
+
+        pidfile = Utils.host_pidfile env
+        pidfile.open('w+') do |f|
+          f.write(pid)
+        end
+      end
+
+      def call(env)
+        if env[:machine].config.notify_forwarder.enable
+          port = env[:machine].config.notify_forwarder.port
+          env[:machine].config.vm.network :forwarded_port, host: port, guest: port, protocol: 'udp'
+        end
+
+        @app.call env
+
+        if env[:machine].config.notify_forwarder.enable
+          path = ensure_binary_downloaded env
+          return unless path
+
+          args = "watch -c 127.0.0.1:#{port}"
+
+          env[:machine].config.vm.synced_folders.each do |id, options|
+            unless options[:disabled]
+              hostpath = File.absolute_path(options[:hostpath])
+              guestpath = options[:guestpath]
+
+              args += " #{hostpath} #{guestpath}"
+            end
+          end
+
+          start_watcher env, "#{path} #{args}"
+        end
+      end
+    end
+
+    class StopHostForwarder
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        @app.call env
+
+        return unless env[:machine].config.notify_forwarder.enable
+
+        pidfile = Utils.host_pidfile env
+        if File.exists? pidfile
+          pidfile.open('r') do |f|
+            pid = f.read.to_i
+
+            begin
+              Process.kill 'TERM', pid
+            rescue Errno::ESRCH
+            end
+          end
+        end
+      end
+    end
+
+    class StartClientForwarder
+      def initialize(app, env)
+        @app = app
+      end
+
+      def ensure_binary_downloaded(env)
+        os = :unsupported
+        hardware = :unsupported
+
+        env[:machine].communicate.execute('uname -s') do |type, data|
+          os = Utils.parse_os_name data if type == :stdout
+        end
+
+        env[:machine].communicate.execute('uname -m') do |type, data|
+          hardware = Utils.parse_hardware_name data if type == :stdout
+        end
+
+        env[:ui].error 'Notify-forwarder: Unsupported client operating system' if os == :unsupported
+        env[:ui].error 'Notify-forwarder: Unsupported client hardware' if hardware == :unsupported
+
+        if os != :unsupported and hardware != :unsupported
+          Utils.ensure_binary_downloaded env, os, hardware
+        end
+      end
+
+      def call(env)
+        @app.call env
+
+        return unless env[:machine].config.notify_forwarder.enable
+
+        path = ensure_binary_downloaded env
+        return unless path
+
+        port = env[:machine].config.notify_forwarder.port
+
+        env[:machine].communicate.upload(path, "/tmp/notify-forwarder")
+        env[:machine].communicate.execute("nohup /tmp/notify-forwarder receive -p #{port} &")
+      end
+    end
+
+  end
+
+end

data/lib/vagrant-notify-forwarder/config.rb

@@ -0,0 +1,20 @@
+module VagrantNotifyForwarderPlugin
+  module Config
+
+    class Config < Vagrant.plugin("2", :config)
+      attr_accessor :port
+      attr_accessor :enable
+
+      def initialize
+        @port = UNSET_VALUE
+        @enable = UNSET_VALUE
+      end
+
+      def finalize!
+        @port = 29324 if @port == UNSET_VALUE
+        @enable = true if @enable == UNSET_VALUE
+      end
+    end
+
+  end
+end

data/lib/vagrant-notify-forwarder/version.rb

@@ -0,0 +1,3 @@
+module VagrantNotifyForwarderPlugin
+  VERSION = "0.1.0"
+end

data/vagrant-notify-forwarder.gemspec

@@ -0,0 +1,18 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-notify-forwarder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-notify-forwarder"
+  spec.version       = VagrantNotifyForwarderPlugin::VERSION
+  spec.authors       = ["Magnus Hallin"]
+  spec.email         = ["mhallin@gmail.com"]
+  spec.summary       = "A vagrant plugin that forwards file system events from the host to the guest"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/mhallin/vagrant-notify-forwarder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-notify-forwarder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Magnus Hallin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-04 00:00:00.000000000 Z
+dependencies: []
+description: A vagrant plugin that forwards file system events from the host to the
+  guest
+email:
+- mhallin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/vagrant-notify-forwarder.rb
+- lib/vagrant-notify-forwarder/action.rb
+- lib/vagrant-notify-forwarder/config.rb
+- lib/vagrant-notify-forwarder/version.rb
+- vagrant-notify-forwarder.gemspec
+homepage: https://github.com/mhallin/vagrant-notify-forwarder
+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.14
+signing_key: 
+specification_version: 4
+summary: A vagrant plugin that forwards file system events from the host to the guest
+test_files: []