savi-vagrant-notify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d92053eacab1ebcd98c6b67f67676fc5eb5a9696
+  data.tar.gz: b1102a33b1b5be79e89b932a6f20d2dda492a2d4
+SHA512:
+  metadata.gz: 80fdeaf03c9d5f73eb2f95a7dbe714f280bd04e7ef7e79b468a662ef9ab7867065a7e5ad0d55bf16c1b32f1740ada4c9756f2bb68bead105861b0080d3a506d2
+  data.tar.gz: 1baaac6d972014177b137268a4f3d98444ca814b0ef603cc5d33f56c63f95065732d78d846e1c9ab331820e57cb630021b85c6b9d4e1fb43d49e436d2f185cca

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vagrant/
+/Vagrantfile

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", git: "https://github.com/pward123/savi-vagrant-notify.git#change-project-name"
+end
+
+group :plugins do
+  gem "savi-vagrant-notify", 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,59 @@
+# savi-vagrant-notify
+
+A vagrant plugin that removes the need for port forwarding udp in the otherwise excellent [vagrant-notify-forwarder](https://github.com/mhallin/vagrant-notify-forwarder) plugin.
+
+Instead of sending the udp notification to 127.0.0.1, this plugin looks up the public ip of the guest vm and forwards all notifications to that address.
+
+Thanks to [vagrant-address](https://github.com/mkuzmin/vagrant-address) for figuring out how to look up the address.
+
+The remainder of this document has only minor changes from the document in the [original](https://github.com/mhallin/vagrant-notify-forwarder/blob/030173561dcaaa64d9161bd52b1216cc7d1e0748/README.md).
+
+# 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 savi-vagrant-notify
+$ vagrant reload
+```
+
+The server and guest binaries will be automatically downloaded from the notify-forwarder repo's
+releases and verified with SHA256.
+
+### Permissions
+
+The client in the guest OS will run as root by default, assuming passwordless `sudo` works. If this
+does *not* work, you can disable privilege escalation in your `Vagrantfile`:
+
+```ruby
+config.notify_forwarder.run_as_root = false
+```
+
+## 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
+```
+
+## Contributors
+
+* [CharlieC3](https://github.com/CharlieC3)
+* [hedinfaok](https://github.com/hedinfaok)
+* [seff](https://github.com/seff)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "savi-vagrant-notify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/savi-vagrant-notify.rb

@@ -0,0 +1,10 @@
+require 'savi-vagrant-notify/plugin'
+require 'savi-vagrant-notify/config'
+
+module VagrantPlugins
+  module SaviVagrantNotify
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/savi-vagrant-notify/action/check_boot_state.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module SaviVagrantNotify
+    module Action
+      class CheckBootState
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          return unless env[:machine].config.notify_forwarder.enable
+          $BOOT_SAVED = env[:machine].state.id == :saved
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/savi-vagrant-notify/action/start_client_forwarder.rb

@@ -0,0 +1,57 @@
+require 'savi-vagrant-notify/utils'
+
+module VagrantPlugins
+  module SaviVagrantNotify
+    module Action
+      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 'SAVI-Vagrant-Notify Unsupported client operating system' if os == :unsupported
+          env[:ui].error 'SAVI-Vagrant-Notify 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 if $BOOT_SAVED
+
+          return unless env[:machine].config.notify_forwarder.enable
+
+          path = ensure_binary_downloaded env
+          return unless path
+
+          port = env[:machine].config.notify_forwarder.port
+
+          start_command = "nohup /tmp/notify-forwarder receive -p #{port} &"
+
+          if env[:machine].config.notify_forwarder.run_as_root
+            start_command = "sudo #{start_command}"
+          end
+
+          env[:machine].communicate.upload(path, "/tmp/notify-forwarder")
+          env[:ui].output("Starting notify-forwarder ...")
+          env[:machine].communicate.execute(start_command)
+          env[:ui].detail("SAVI-Vagrant-Notify guest listening for file change notifications on 0.0.0.0:#{port}.")
+        end
+      end
+    end
+  end
+end

data/lib/savi-vagrant-notify/action/start_host_forwarder.rb

@@ -0,0 +1,62 @@
+require 'savi-vagrant-notify/utils'
+
+module VagrantPlugins
+  module SaviVagrantNotify
+    module Action
+      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 'SAVI-Vagrant-Notify Unsupported host operating system' if os == :unsupported
+          env[:ui].error 'SAVI-Vagrant-Notify 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('a+') do |f|
+            f.write("#{pid}\n")
+          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
+
+            address = env[:machine].provider.capability(:public_address)
+            env[:machine].config.vm.synced_folders.each do |id, options|
+              unless options[:disabled]
+                hostpath = File.expand_path(options[:hostpath], env[:root_path])
+                guestpath = options[:guestpath]
+
+                args = "watch -c #{address}:#{port} #{hostpath} #{guestpath}"
+                start_watcher env, "#{path} #{args}"
+                env[:ui].detail("SAVI-Vagrant-Notify host sending file change notifications to #{address}:#{port}")
+                env[:ui].detail("SAVI-Vagrant-Notify host forwarding notifications on #{hostpath} to #{guestpath}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/savi-vagrant-notify/action/stop_host_forwarder.rb

@@ -0,0 +1,34 @@
+require 'savi-vagrant-notify/utils'
+
+module VagrantPlugins
+  module SaviVagrantNotify
+    module Action
+      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|
+              f.readlines.each do |process|
+                pid = process.to_i
+                begin
+                  Process.kill 'TERM', pid
+                rescue Errno::ESRCH
+                end
+              end
+              pidfile.delete
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/savi-vagrant-notify/plugin.rb

@@ -0,0 +1,70 @@
+require 'vagrant'
+
+$BOOT_SAVED = false
+
+module VagrantPlugins
+  module SaviVagrantNotify
+    class Plugin < Vagrant.plugin('2')
+      name 'savi-vagrant-notify'
+      description 'Version of vagrant-notify-forwarder that does not require port forwarding'
+
+      register_boot_hooks = lambda do |hook|
+        require_relative 'action/start_host_forwarder'
+        require_relative 'action/start_client_forwarder'
+        require_relative 'action/check_boot_state'
+
+        hook.before VagrantPlugins::ProviderVirtualBox::Action::Resume,
+                    SaviVagrantNotify::Action::CheckBootState
+        hook.after Vagrant::Action::Builtin::Provision,
+                  SaviVagrantNotify::Action::StartHostForwarder
+        hook.after SaviVagrantNotify::Action::StartHostForwarder,
+                  SaviVagrantNotify::Action::StartClientForwarder
+      end
+
+      register_suspend_hooks = lambda do |hook|
+        require_relative 'action/stop_host_forwarder'
+
+        hook.before VagrantPlugins::ProviderVirtualBox::Action::Suspend,
+                    SaviVagrantNotify::Action::StopHostForwarder
+      end
+
+      register_resume_hooks = lambda do |hook|
+        require_relative 'action/start_host_forwarder'
+
+        hook.after VagrantPlugins::ProviderVirtualBox::Action::Provision,
+                    SaviVagrantNotify::Action::StartHostForwarder
+      end
+
+      register_halt_hooks = lambda do |hook|
+        require_relative 'action/stop_host_forwarder'
+
+        hook.before Vagrant::Action::Builtin::GracefulHalt,
+                    SaviVagrantNotify::Action::StopHostForwarder
+      end
+
+      register_destroy_hooks = lambda do |hook|
+        require_relative 'action/stop_host_forwarder'
+
+        hook.before Vagrant::Action::Builtin::GracefulHalt,
+                    SaviVagrantNotify::Action::StopHostForwarder
+      end
+
+      config(:notify_forwarder) do
+        require_relative '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_suspend, &register_suspend_hooks
+      action_hook :stop_notify_forwarder, :machine_action_resume, &register_resume_hooks
+
+      action_hook :stop_notify_forwarder, :machine_action_halt, &register_halt_hooks
+      action_hook :stop_notify_forwarder, :machine_action_reload, &register_halt_hooks
+
+      action_hook :stop_notify_forwarder, :machine_action_destroy, &register_destroy_hooks
+
+    end
+  end
+end

data/lib/savi-vagrant-notify/utils.rb

@@ -0,0 +1,63 @@
+require 'vagrant/util/downloader'
+
+module VagrantPlugins
+  module SaviVagrantNotify
+    class Utils
+      @@OS_NAMES = {
+          "Linux" => :linux,
+          "Darwin" => :darwin,
+          "FreeBSD" => :freebsd,
+      }
+
+      @@HARDWARE_NAMES = {
+          "x86_64" => :x86_64,
+          "amd64" => :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.ensure_binary_downloaded(env, os, hardware)
+        download_urls = {
+            [:linux, :x86_64] => %w(https://github.com/mhallin/notify-forwarder/releases/download/release/v0.1.1/notify-forwarder_linux_x64
+                                fc00ce7e30ae87daa10fb3bc4d77e06571998b408ff79a4aef3189f5210dc914),
+            [:darwin, :x86_64] => %w(https://github.com/mhallin/notify-forwarder/releases/download/release/v0.1.1/notify-forwarder_osx_x64
+                                317f3ffea15393668bf04b128cef1545031eaf306eeb2c4a345a95d8c6e1c941),
+            [:freebsd, :x86_64] => %w(https://github.com/mhallin/notify-forwarder/releases/download/release/v0.1.1/notify-forwarder_freebsd_x64
+                                  082ceac8f5fbda6abc5e2872a6c748241f243f2d780c96d50b3f11f8e96ca65b),
+        }
+
+        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 'SAVI-Vagrant-Notify Downloading client'
+          downloader = Vagrant::Util::Downloader.new url, path
+          downloader.download!
+        end
+
+        File.chmod(0755, path)
+
+        path
+      end
+
+      def self.host_pidfile(env)
+        env[:machine].data_dir.join('notify_watcher_host_pid')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module SaviVagrantNotify
+    VERSION = "0.1.0"
+  end
+end

data/savi-vagrant-notify.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "savi-vagrant-notify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "savi-vagrant-notify"
+  spec.version       = VagrantPlugins::SaviVagrantNotify::VERSION
+  spec.authors       = ["Paul Ward"]
+  spec.email         = ["pward@savicontrols.com"]
+
+  spec.summary       = "Version of vagrant-notify-forwarder that does not need port forwarding"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/pward123/savi-vagrant-notify"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  #   `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # end
+  spec.files         = `git ls-files -z`.split("\x0")
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: savi-vagrant-notify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Ward
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Version of vagrant-notify-forwarder that does not need port forwarding
+email:
+- pward@savicontrols.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/savi-vagrant-notify.rb
+- lib/savi-vagrant-notify/action/check_boot_state.rb
+- lib/savi-vagrant-notify/action/start_client_forwarder.rb
+- lib/savi-vagrant-notify/action/start_host_forwarder.rb
+- lib/savi-vagrant-notify/action/stop_host_forwarder.rb
+- lib/savi-vagrant-notify/config.rb
+- lib/savi-vagrant-notify/plugin.rb
+- lib/savi-vagrant-notify/utils.rb
+- lib/savi-vagrant-notify/version.rb
+- savi-vagrant-notify.gemspec
+homepage: https://github.com/pward123/savi-vagrant-notify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pward123/savi-vagrant-notify
+  source_code_uri: 'TODO: Put your gem''s public repo URL here.'
+  changelog_uri: 'TODO: Put your gem''s CHANGELOG.md URL here.'
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Version of vagrant-notify-forwarder that does not need port forwarding
+test_files: []