vagrant-listen-server 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cfeb1cec6dac82766c551f2f274d37e3c0de392
+  data.tar.gz: 834d63a319938c3c5421ec444156b827f510a6d1
+SHA512:
+  metadata.gz: 17bec5357fa7ea92af00b9954c61c9034ef08d3db310a43524d5f0f789d02c0dee2fe12ce8ad662cb8f405314861dad027f0207ccf5a20eec69c89018c2449b8
+  data.tar.gz: a3c4f81f2255169a77bfc4c139a8052c538cb74664510664114d33d586a3c1021c829ff7e617abe185f169bfcd2ae356c5cfd25d3045061a3961e83b6984ba46

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+end
+
+group :plugins do
+  gem 'vagrant-listen-server', path: '.'
+  gem 'listen'
+  gem 'celluloid'
+  gem 'celluloid-io'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Kelso
+
+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,94 @@
+# vagrant-listen-server
+
+Forward filesystem events from a host to a client
+
+
+Vagrant's shared folders don't pass file modification notifications to the
+guest. That means editing files locally won't trigger off inotify file events,
+which means any build / test / servers that need to reload on change have to
+poll for changes.
+
+If you're using virtualbox, vboxsf performance really really sucks. Hard links
+are impossible. Statting takes forever.
+ * http://mitchellh.com/comparing-filesystem-performance-in-virtual-machines
+
+Since polling implementations will probably rely on statting the file in some
+way, this creates a pretty awful experience.
+
+
+The answer - forwarding filesystem events
+
+The listen gem is already used by vagrant, (as part of rsync-auto) and allows forwarding of filesystem events over TCP.
+
+# The listen gem, as used by rsync-auto, is apparently a bit of a resource hog
+# because it stats all files before sending events.
+
+
+## Clients
+
+The main reason I developed this was to allow filesystem events to be pushed
+to a broccoli build pipeline.
+
+Ideally, you can subscribe to the file changes and trigger builds / whatever in
+your app
+
+You can also write a simple server that touches all files on the guest, however
+you'll have to be aware of loops created if filesystem notifications are passed
+back from the guest to the host.
+
+
+
+## Usage
+
+Install the plugin:
+
+`vagrant plugin install vagrant-listen-server`
+
+Then in your Vagrantfile:
+
+```ruby
+  if Vagrant.has_plugin? 'vagrant-listen-server'
+    config.listen_server.ip = '172.168.172.16'
+    config.listen_server.port = 4000
+    config.listen_server.folders = '../beyondpricing/client'
+    config.listen_server.pid_file = '/tmp/beyond.listen.pid'
+  end
+```
+
+
+## Other options
+
+ * rsync-auto
+#   * http://docs.vagrantup.com/v2/cli/rsync-auto.html
+#  Filesystem is shared using rsync-auto protocol instead of vboxsf
+#  Pros: Pushes files onto guest, so guest can fire native events
+#  Cons: Slow, apparently a resource hog.
+
+     
+ * rsync-mirror
+   https://github.com/ingenerator/vagrant-mirror/
+   Looks good, but super outdated.
+
+     
+
+
+## Development
+
+To develop locally
+```
+gem build vagrant-listen-server.gemspec
+vagrant plugin install vagrant-listen-server-0.0.1.gem
+```
+
+Other good vagrant plugins used for reference:
+* https://github.com/mitchellh/vagrant-aws/blob/master/Rakefile
+* vagrant-ls - http://www.noppanit.com/create-simple-vagrant-plugin/
+
+
+## TODO:
+
+Listen maybe is a bit of a resource hog:
+ * https://github.com/mitchellh/vagrant/issues/3249
+
+There might be some better, native implementations that make this faster. e.g.
+ * https://fsnotify.org/

data/Rakefile

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

data/lib/vagrant-listen-server.rb

@@ -0,0 +1,10 @@
+require 'vagrant-listen-server/version'
+require 'vagrant-listen-server/plugin'
+
+module VagrantPlugins
+  module ListenServer
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/vagrant-listen-server/action.rb

@@ -0,0 +1,92 @@
+require 'celluloid'
+require 'listen'
+
+module VagrantPlugins
+  module ListenServer
+    module Action
+      class StartServer
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          @env = env
+          @ui = env[:ui]
+          @machine = env[:machine]
+
+          config = @machine.config.listen_server
+          folders = config.folders
+          host = "#{config.ip}:#{config.port}"
+
+          @ui.info "Starting listen server - #{host}"
+
+          # Check whether the daemon is already running.
+          if File.exists? config.pid_file
+            pid = File.read config.pid_file
+            begin
+              Process.getpgid pid.to_i
+              @ui.info 'Warning - listen server already running'
+              return @app.call(env)
+            rescue Errno::ESRCH
+              @ui.info 'Warning - stale PID file'
+            end
+          end
+
+          out = @app.call(env)
+
+          # Vagrant-notify uses fork here, but that doesn't work on windows:
+          #  https://github.com/fgrehm/vagrant-notify/blob/master/lib/vagrant-notify/server.rb
+          # Only real option is to switch to Process.spawn? I need a windows
+          # machine to test it out on...
+          pid = fork do
+            $0 = "vagrant-listen-server - #{@machine.name}"
+            listener = Listen.to folders, forward_to: host do |modified, added, removed|
+              File.open('/tmp/listen.txt', 'a+') do |f|
+                f.puts 'listen fired', modified, added, removed
+              end
+            end
+
+            begin
+              listener.start
+            rescue Errno::EADDRNOTAVAIL
+              @ui.info "Can't start server - Port in use"
+              exit
+            end
+            sleep
+          end
+
+          Process.detach pid
+          File.write config.pid_file, pid
+          @ui.info "Listen server started on PID #{pid}"
+
+          out
+        end
+      end
+
+      class KillServer
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          @ui = env[:ui]
+          config = env[:machine].config.listen_server
+          @ui.info 'Killing listen server'
+          if File.exists? config.pid_file
+            pid = File.read config.pid_file
+            begin
+              Process.kill 'INT', pid.to_i
+            rescue Errno::ESRCH
+              @ui.info 'Stale PID file - no server found'
+            end
+            File.delete config.pid_file
+          else
+            @ui.info 'No listen server found'
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-listen-server/config.rb

@@ -0,0 +1,10 @@
+module VagrantPlugins
+  module ListenServer
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :ip
+      attr_accessor :port
+      attr_accessor :folders
+      attr_accessor :pid_file
+    end
+  end
+end

data/lib/vagrant-listen-server/plugin.rb

@@ -0,0 +1,42 @@
+require_relative 'action'
+
+module VagrantPlugins
+  module ListenServer
+    class Plugin < Vagrant.plugin('2')
+      name 'ListenServer'
+
+      description <<-DESC
+        Start a Listen server to forward filesystem events to the client VM.
+      DESC
+
+      config(:listen_server) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:listen_server, :machine_action_up) do |hook|
+        hook.append(Action::StartServer)
+      end
+
+      action_hook(:listen_server, :machine_action_halt) do |hook|
+        hook.append(Action::KillServer)
+      end
+
+      action_hook(:listen_server, :machine_action_suspend) do |hook|
+        hook.append(Action::KillServer)
+      end
+
+      action_hook(:listen_server, :machine_action_destroy) do |hook|
+        hook.append(Action::KillServer)
+      end
+
+      action_hook(:listen_server, :machine_action_reload) do |hook|
+        hook.append(Action::StartServer)
+      end
+
+      action_hook(:listen_server, :machine_action_resume) do |hook|
+        hook.append(Action::StartServer)
+      end
+    end
+  end
+end

data/lib/vagrant-listen-server/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ListenServer
+    VERSION = '0.0.2'
+  end
+end

data/vagrant-listen-server.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-listen-server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vagrant-listen-server'
+  spec.version       = VagrantPlugins::ListenServer::VERSION
+  spec.authors       = ['David Kelso']
+  spec.email         = ['david@kelso.id.au']
+  spec.summary       = %q{Guard / Listen TCP server to publich filesystem events to guests.}
+  spec.homepage      = 'https://github.com/zaius/vagrant-listen-server'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'celluloid', '~> 0.16'
+  spec.add_runtime_dependency 'celluloid-io', '~> 0.16', '>= 0.16.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-listen-server
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- David Kelso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- david@kelso.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-listen-server.rb
+- lib/vagrant-listen-server/action.rb
+- lib/vagrant-listen-server/config.rb
+- lib/vagrant-listen-server/plugin.rb
+- lib/vagrant-listen-server/version.rb
+- vagrant-listen-server.gemspec
+homepage: https://github.com/zaius/vagrant-listen-server
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Guard / Listen TCP server to publich filesystem events to guests.
+test_files: []