vagrant-mutagen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d35c8b9d8ef5789d2926e9419241aaffb0a3bf7e
+  data.tar.gz: 01c3ff65862716f420ec6aa71eaa5f4352338563
+SHA512:
+  metadata.gz: 74348654116def10f2ac84888028a0d4266c969c7ef39ea56947ff1262e6ca0daf7416ba6467e5b1569c81a90fa4b805cd123be87fe5b61ebcf1920a63dba075
+  data.tar.gz: 31a0defcf41c8292abf85ffd61a3160ea2600a053d4657349f1ae15f70523c8dd98009add9f291b9a3df468977d8b3e4f3ab8c7b8ba582ec1fea5ed1b56f7ee0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+.idea
+*.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,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.6.2'
+end
+
+group :plugins do
+  gemspec
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Falk Kühnel
+
+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::Mutagen
+
+[![Gem Version](https://badge.fury.io/rb/vagrant-mutagen.svg)](https://badge.fury.io/rb/vagrant-mutagen)
+[![Gem](https://img.shields.io/gem/dt/vagrant-mutagen.svg)](https://rubygems.org/gems/vagrant-mutagen)
+[![Gem](https://img.shields.io/gem/dtv/vagrant-mutagen.svg)](https://rubygems.org/gems/vagrant-mutagen)
+
+This plugin adds an entry to your `~/.ssh/config` file on the host system.
+
+On **up**, **resume** and **reload** commands, it tries to add the information, if it does not already exist in your config file. 
+On **halt**, **destroy**, and **suspend**, those entries will be removed again.
+
+
+## Installation
+
+    $ vagrant plugin install vagrant-mutagen
+
+Uninstall it with:
+
+    $ vagrant plugin uninstall vagrant-mutagen
+
+Update the plugin with:
+
+    $ vagrant plugin update vagrant-mutagen
+
+## Usage
+
+You currently only need to set `orchestrate` and `config.vm.hostname`.
+
+    config.mutagen.orchestrate = true
+
+This hostname will be used for the entry in the `~/.ssh/config` file.
+
+## Installing development version
+
+If you would like to install vagrant-mutagen on the development version perform the following:
+
+```
+git clone https://github.com/dasginganinja/vagrant-mutagen
+cd vagrant-mutagen
+git checkout develop
+gem build vagrant-mutagen.gemspec
+vagrant plugin install vagrant-mutagen-*.gem
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request on the `develop` branch
+
+
+## Versions
+
+### 0.1.0
+* Added config to enable orchestration.
+* Added new actions to start and terminate orchestration.
+* Hooked new actions into vagrant lifecycle events.
+* Refactored vagrant-hostsupdater hosts commands for config.
+
+### 0.0.1
+* Started with vagrant-hostsupdater 1.1.0
+* Changed all references of hostsupdater to mutagen.
+* Have not tested anything, but this is pushed up.

data/Rakefile

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

data/lib/vagrant-mutagen.rb

@@ -0,0 +1,11 @@
+require "vagrant-mutagen/version"
+require "vagrant-mutagen/plugin"
+
+module VagrantPlugins
+  module Mutagen
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end
+

data/lib/vagrant-mutagen/Action/CacheConfig.rb

@@ -0,0 +1,22 @@
+module VagrantPlugins
+  module Mutagen
+    module Action
+      class CacheConfig
+        include Mutagen
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          if mutagen_enabled
+            cacheConfigEntries
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/Action/RemoveConfig.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module Mutagen
+    module Action
+      class RemoveConfig
+        include Mutagen
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @ui = env[:ui]
+        end
+
+        def call(env)
+          machine_action = env[:machine_action]
+          if machine_action != :destroy || !@machine.id
+            if machine_action != :suspend
+              if machine_action != :halt
+                if mutagen_enabled
+                  @ui.info "[vagrant-mutagen] Removing SSH config entry"
+                  removeConfigEntries
+                end
+              end
+            end
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/Action/StartOrchestration.rb

@@ -0,0 +1,25 @@
+require_relative "../Mutagen"
+module VagrantPlugins
+  module Mutagen
+    module Action
+      class StartOrchestration
+        include Mutagen
+
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @ui = env[:ui]
+        end
+
+        def call(env)
+          if mutagen_enabled
+            startOrchestration
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/Action/TerminateOrchestration.rb

@@ -0,0 +1,25 @@
+require_relative "../Mutagen"
+module VagrantPlugins
+  module Mutagen
+    module Action
+      class TerminateOrchestration
+        include Mutagen
+
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @ui = env[:ui]
+        end
+
+        def call(env)
+          if mutagen_enabled
+            terminateOrchestration
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/Action/UpdateConfig.rb

@@ -0,0 +1,26 @@
+require_relative "../Mutagen"
+module VagrantPlugins
+  module Mutagen
+    module Action
+      class UpdateConfig
+        include Mutagen
+
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @ui = env[:ui]
+        end
+
+        def call(env)
+          if mutagen_enabled
+            @ui.info "[vagrant-mutagen] Checking for SSH config entries"
+            addConfigEntries()
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/Mutagen.rb

@@ -0,0 +1,189 @@
+#TODO: remove before commit, just used for testing with .to_yaml function
+require 'yaml'
+module VagrantPlugins
+  module Mutagen
+    module Mutagen
+      if ENV['VAGRANT_MUTAGEN_SSH_CONFIG_PATH']
+        @@ssh_user_config_path = ENV['VAGRANT_MUTAGEN_SSH_CONFIG_PATH']
+      else
+        @@ssh_user_config_path = '~/.ssh/config'
+      end
+      @@ssh_user_config_path = File.expand_path(@@ssh_user_config_path)
+
+      def addConfigEntries
+        # Prepare some needed variables
+        uuid = @machine.id
+        name = @machine.name
+        hostname = @machine.config.vm.hostname
+        # New Config for ~/.ssh/config
+        newconfig = ''
+
+        # Read contents of SSH config file
+        file = File.open(@@ssh_user_config_path, "rb")
+        configContents = file.read
+        # Check for existing entry for hostname in config
+        entryPattern = configEntryPattern(hostname, name, uuid)
+        if configContents.match(/#{entryPattern}/)
+          @ui.info "[vagrant-mutagen]   found SSH Config entry for: #{hostname}"
+        else
+          @ui.info "[vagrant-mutagen]   adding entry to SSH config for: #{hostname}"
+          # Get SSH config from Vagrant
+          newconfig = createConfigEntry(hostname, name, uuid)
+        end
+
+        # Append vagrant ssh config to end of file
+        addToSSHConfig(newconfig)
+      end
+
+      def addToSSHConfig(content)
+        return if content.length == 0
+
+        @ui.info "[vagrant-mutagen] Writing the following config to (#@@ssh_user_config_path)"
+        @ui.info content
+        if !File.writable_real?(@@ssh_user_config_path)
+          @ui.info "[vagrant-mutagen] This operation requires administrative access. You may " +
+                       "skip it by manually adding equivalent entries to the config file."
+          if !sudo(%Q(sh -c 'echo "#{content}" >> #@@ssh_user_config_path'))
+            @ui.error "[vagrant-mutagen] Failed to add config, could not use sudo"
+          end
+        elsif Vagrant::Util::Platform.windows?
+          require 'tmpdir'
+          uuid = @machine.id || @machine.config.mutagen.id
+          tmpPath = File.join(Dir.tmpdir, 'hosts-' + uuid + '.cmd')
+          File.open(tmpPath, "w") do |tmpFile|
+          tmpFile.puts(">>\"#{@@ssh_user_config_path}\" echo #{content}")
+          end
+          sudo(tmpPath)
+          File.delete(tmpPath)
+        else
+          content = "\n" + content + "\n"
+          hostsFile = File.open(@@ssh_user_config_path, "a")
+          hostsFile.write(content)
+          hostsFile.close()
+        end
+      end
+
+      # Create a regular expression that will match the vagrant-mutagen signature
+      def configEntryPattern(hostname, name, uuid = self.uuid)
+        hashedId = Digest::MD5.hexdigest(uuid)
+        Regexp.new("^# VAGRANT: #{hashedId}.*$\nHost #{hostname}.*$")
+      end
+
+      def createConfigEntry(hostname, name, uuid = self.uuid)
+        # Get the SSH config from Vagrant
+        sshconfig = `vagrant ssh-config --host #{hostname}`
+        # Trim Whitespace from end
+        sshconfig = sshconfig.gsub /^$\n/, ''
+        sshconfig = sshconfig.chomp
+        # Return the entry
+        %Q(#{signature(name, uuid)}\n#{sshconfig}\n#{signature(name, uuid)})
+      end
+
+      def cacheConfigEntries
+        @machine.config.mutagen.id = @machine.id
+      end
+
+      def removeConfigEntries
+        if !@machine.id and !@machine.config.mutagen.id
+          @ui.info "[vagrant-mutagen] No machine id, nothing removed from #@@ssh_user_config_path"
+          return
+        end
+        file = File.open(@@ssh_user_config_path, "rb")
+        configContents = file.read
+        uuid = @machine.id || @machine.config.mutagen.id
+        hashedId = Digest::MD5.hexdigest(uuid)
+        if configContents.match(/#{hashedId}/)
+          removeFromConfig
+        end
+      end
+
+      def removeFromConfig(options = {})
+        uuid = @machine.id || @machine.config.mutagen.id
+        hashedId = Digest::MD5.hexdigest(uuid)
+        if !File.writable_real?(@@ssh_user_config_path) || Vagrant::Util::Platform.windows?
+          if !sudo(%Q(sed -i -e '/# VAGRANT: #{hashedId}/,/# VAGRANT: #{hashedId}/d' #@@ssh_user_config_path))
+            @ui.error "[vagrant-mutagen] Failed to remove config, could not use sudo"
+          end
+        else
+          hosts = ""
+          pair_started = false
+          pair_ended = false
+          File.open(@@ssh_user_config_path).each do |line|
+            # Reset
+            if pair_started == true && pair_ended == true
+              pair_started = pair_ended = false
+            end
+            if line.match(/#{hashedId}/)
+              if pair_started == true
+                pair_ended = true
+              end
+              pair_started = true
+            end
+            hosts << line unless pair_started
+          end
+          hosts.strip!
+          hostsFile = File.open(@@ssh_user_config_path, "w")
+          hostsFile.write(hosts)
+          hostsFile.close()
+        end
+      end
+
+      def signature(name, uuid = self.uuid)
+        hashedId = Digest::MD5.hexdigest(uuid)
+        %Q(# VAGRANT: #{hashedId} (#{name}) / #{uuid})
+      end
+
+      def sudo(command)
+        return if !command
+        if Vagrant::Util::Platform.windows?
+          require 'win32ole'
+          args = command.split(" ")
+          command = args.shift
+          sh = WIN32OLE.new('Shell.Application')
+          sh.ShellExecute(command, args.join(" "), '', 'runas', 0)
+        else
+          return system("sudo #{command}")
+        end
+      end
+
+      def orchestration_enabled()
+        return @machine.config.mutagen.orchestrate == true
+      end
+
+      def mutagen_enabled()
+        return orchestration_enabled()
+      end
+
+      def startOrchestration()
+        daemonCommand = "mutagen daemon start"
+        projectStartedCommand = "mutagen project list >/dev/null 2>/dev/null"
+        projectStartCommand = "mutagen project start"
+        projectStatusCommand = "mutagen project list"
+        if !system(daemonCommand)
+          @ui.error "[vagrant-mutagen] Failed to start mutagen daemon"
+        end
+        if !system(projectStartedCommand) # mutagen project list returns 1 on error when no project is started
+          @ui.info "[vagrant-mutagen] Starting mutagen project orchestration (config: /mutagen.yml)"
+          if !system(projectStartCommand)
+            @ui.error "[vagrant-mutagen] Failed to start mutagen project (see error above)"
+          end
+        end
+        system(projectStatusCommand) # show project status to indicate if there are conflicts
+      end
+
+      def terminateOrchestration()
+        projectStartedCommand = "mutagen project list >/dev/null 2>/dev/null"
+        projectTerminateCommand = "mutagen project terminate"
+        projectStatusCommand = "mutagen project list 2>/dev/null"
+        if system(projectStartedCommand) # mutagen project list returns 1 on error when no project is started
+          @ui.info "[vagrant-mutagen] Stopping mutagen project orchestration"
+          if !system(projectTerminateCommand)
+            @ui.error "[vagrant-mutagen] Failed to stop mutagen project (see error above)"
+          end
+        end
+        system(projectStatusCommand)
+      end
+
+    end
+  end
+end

data/lib/vagrant-mutagen/command.rb

@@ -0,0 +1,30 @@
+module VagrantPlugins
+  module Mutagen
+    class Command < Vagrant.plugin('2', :command)
+      #include HostsFile
+
+      def execute
+        # options = {}
+        # opts = OptionParser.new do |o|
+        #   o.banner = 'Usage: vagrant hostmanager [vm-name]'
+        #   o.separator ''
+
+        #   o.on('--provider provider', String,
+        #     'Update machines with the specific provider.') do |provider|
+        #     options[:provider] = provider
+        #   end
+        # end
+
+        # argv = parse_options(opts)
+        # options[:provider] ||= @env.default_provider
+
+        # generate(@env, options[:provider].to_sym)
+
+        # with_target_vms(argv, options) do |machine|
+        #   update(machine)
+        # end
+        puts "ran command"
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/config.rb

@@ -0,0 +1,14 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Mutagen
+    class Config < Vagrant.plugin("2", :config)
+        attr_accessor :id
+        attr_accessor :orchestrate
+
+        def initialize
+          @orchestrate = false
+        end
+    end
+  end
+end

data/lib/vagrant-mutagen/plugin.rb

@@ -0,0 +1,70 @@
+require "vagrant-mutagen/Action/UpdateConfig"
+require "vagrant-mutagen/Action/CacheConfig"
+require "vagrant-mutagen/Action/RemoveConfig"
+require "vagrant-mutagen/Action/StartOrchestration"
+require "vagrant-mutagen/Action/TerminateOrchestration"
+
+module VagrantPlugins
+  module Mutagen
+    class Plugin < Vagrant.plugin('2')
+      name 'Mutagen'
+      description <<-DESC
+        This plugin manages the ~/.ssh/config file for the host machine. An entry is
+        created for the hostname attribute in the vm.config.
+      DESC
+
+      config(:mutagen) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:mutagen, :machine_action_up) do |hook|
+        hook.append(Action::UpdateConfig)
+        hook.append(Action::StartOrchestration)
+      end
+
+      action_hook(:mutagen, :machine_action_provision) do |hook|
+        hook.before(Vagrant::Action::Builtin::Provision, Action::UpdateConfig)
+        hook.before(Vagrant::Action::Builtin::Provision, Action::StartOrchestration)
+      end
+
+      action_hook(:mutagen, :machine_action_halt) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::RemoveConfig)
+      end
+
+      action_hook(:mutagen, :machine_action_suspend) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::RemoveConfig)
+      end
+
+      action_hook(:mutagen, :machine_action_destroy) do |hook|
+        hook.prepend(Action::CacheConfig)
+      end
+
+      action_hook(:mutagen, :machine_action_destroy) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::RemoveConfig)
+      end
+
+      action_hook(:mutagen, :machine_action_reload) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.prepend(Action::RemoveConfig)
+        hook.append(Action::UpdateConfig)
+        hook.append(Action::StartOrchestration)
+      end
+
+      action_hook(:mutagen, :machine_action_resume) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.prepend(Action::RemoveConfig)
+        hook.append(Action::UpdateConfig)
+        hook.append(Action::StartOrchestration)
+      end
+
+      command(:mutagen) do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-mutagen/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Mutagen
+    VERSION = '0.1.0'
+  end
+end

data/vagrant-mutagen.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-mutagen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vagrant-mutagen'
+  spec.version       = VagrantPlugins::Mutagen::VERSION
+  spec.authors       = ['Tom Donahue']
+  spec.email         = ['dasginganinja@gmail.com']
+  spec.description   = %q{Enables Vagrant to utilize mutagen for project sync}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/dasginganinja/vagrant-mutagen'
+  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,89 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-mutagen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Donahue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-13 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: Enables Vagrant to utilize mutagen for project sync
+email:
+- dasginganinja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-mutagen.rb
+- lib/vagrant-mutagen/Action/CacheConfig.rb
+- lib/vagrant-mutagen/Action/RemoveConfig.rb
+- lib/vagrant-mutagen/Action/StartOrchestration.rb
+- lib/vagrant-mutagen/Action/TerminateOrchestration.rb
+- lib/vagrant-mutagen/Action/UpdateConfig.rb
+- lib/vagrant-mutagen/Mutagen.rb
+- lib/vagrant-mutagen/command.rb
+- lib/vagrant-mutagen/config.rb
+- lib/vagrant-mutagen/plugin.rb
+- lib/vagrant-mutagen/version.rb
+- vagrant-mutagen.gemspec
+homepage: https://github.com/dasginganinja/vagrant-mutagen
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Enables Vagrant to utilize mutagen for project sync
+test_files: []