vagrant-mutagen-utilizer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd4daac4c84ca803dd88af7064506e7cc44673ca02faae37c1d6ead2d62df066
+  data.tar.gz: d8ba9fb0c995b258fdeecde18600e150c779483a356e1c00376058aaa65013e0
+SHA512:
+  metadata.gz: 4c228743cb8b3809ff833d7eacdc8cc42f9246e3997e85ff91396676f5c142400592fbfd9fae04f0d25a7c66f09b942a496b208c4d81cc834143362be51f1d20
+  data.tar.gz: 8da39bc9ff094062f1e22d5a557ebe186244cb18736dbe2797f45e8287806f5a0f2246794ff5bff3e5478d3db5743cae1e2ef81102ccced89bdf3a1c7f0596e4

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: "https://github.com/hashicorp/vagrant.git"
+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,85 @@
+# Vagrant::Mutagen::Utilizer
+
+This plugin forked from [vagrant-mutagen](https://github.com/dasginganinja/vagrant-mutagen) and made the following modifications.
+
+* Is is not to be elevated to administrative privileges
+  * In many cases, the plugin executor has permission of SSH user configuration file
+* Organized orchestration related to VM status (Basic ideas is below)
+  * Have an entry in the SSH configuration file exist only while the VM is running
+  * Running an project of mutagen only while the VM is running
+
+
+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-utilizer
+
+Uninstall it with:
+
+    $ vagrant plugin uninstall vagrant-mutagen-utilizer
+
+Update the plugin with:
+
+    $ vagrant plugin update vagrant-mutagen-utilizer
+
+## Usage
+
+You need to set `orchestrate` and `config.vm.hostname`.
+
+    config.mutagen_utilizer.orchestrate = true
+
+This hostname will be used for the entry in the `~/.ssh/config` file.
+
+Orchestration also requires a `mutagen.yml` file configured for your project.
+
+### Example Project Orchestration Config (`mutagen.yml`)
+
+As an example starting point you can use the following for a Drupal project:
+```
+sync:
+  defaults:
+    mode: "two-way-resolved"
+    ignore:
+      vcs: false
+      paths:
+        - /.idea/
+        - /vendor/**/.git/
+        - contrib/**/.git/
+        - node_modules/
+        - /web/sites/**/files/
+    symlink:
+      mode: "portable"
+    watch:
+      mode: "portable"
+    permissions:
+      defaultFileMode: 0644
+      defaultDirectoryMode: 0755
+  app:
+    alpha: "your-vm.hostname:/srv/www/app/"
+    beta: "./app/"
+```
+
+## Installing development version
+
+If you would like to install vagrant-mutagen-utilizer on the development version perform the following:
+
+```
+git clone https://github.com/ryu-sato/vagrant-mutagen-utilizer
+cd vagrant-mutagen-utilizer
+git checkout develop
+gem build vagrant-mutagen-utilizer.gemspec
+vagrant plugin install vagrant-mutagen-utilizer-*.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

data/Rakefile

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

data/lib/vagrant-mutagen-utilizer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'vagrant_mutagen_utilizer/version'
+require 'vagrant_mutagen_utilizer/plugin'
+
+module VagrantPlugins
+  # MutagenUtilizer
+  module MutagenUtilizer
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('..', __dir__))
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/action/remove_config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../orchestrator'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    module Action
+      # Remove SSH config entry from user ssh config file
+      class RemoveConfig
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @config = env[:machine].config
+          @console = env[:ui]
+        end
+
+        def call(env)
+          return unless @config.orchestrate?
+
+          o = Orchestrator.new(@machine, @console)
+          o.remove_ssh_config_entry
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/action/save_machine_identifier.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../orchestrator'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    module Action
+      class SaveMachineIdentifier
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          o = Orchestrator.new(@machine, @console)
+          o.save_machine_identifier
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/action/start_orchestration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../orchestrator'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    module Action
+      # Start mutagen project
+      class StartOrchestration
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @config = env[:machine].config
+          @console = env[:ui]
+        end
+
+        def call(env)
+          return unless @config.orchestrate?
+
+          o = Orchestrator.new(@machine, @console)
+          o.start_orchestration
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/action/terminate_orchestration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../orchestrator'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    module Action
+      # Terminate mutagen project
+      class TerminateOrchestration
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @config = env[:machine].config
+          @console = env[:ui]
+        end
+
+        def call(env)
+          return unless @config.orchestrate?
+
+          o = Orchestrator.new(@machine, @console)
+          o.terminate_orchestration
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/action/update_config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../orchestrator'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    module Action
+      # Update ssh config entry
+      # If ssh config entry already exists, just entry appended
+      class UpdateConfig
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @config = env[:machine].config
+          @console = env[:ui]
+        end
+
+        def call(env)
+          return unless @config.orchestrate?
+
+          o = Orchestrator.new(@machine, @console)
+          o.update_ssh_config_entry
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/config.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'vagrant'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    # Config
+    # You can access Config class through machine object (ex. machine.config)
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :orchestrate
+      attr_accessor :ssh_user_config_path
+
+      # Only use private
+      attr_accessor :machine_id
+
+      def initialize
+        super
+
+        @orchestrate = UNSET_VALUE
+        @ssh_user_config_path = UNSET_VALUE
+      end
+
+      def finalize!
+        @orchestrate = false if @orchestrate == UNSET_VALUE
+        @ssh_user_config_path = File.expand_path('~/.ssh/config') if @ssh_user_config_path == UNSET_VALUE
+      end
+
+      def orchestrate?
+        @orchestrate
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/orchestrator.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module MutagenUtilizer
+    # Class for orchestrate with mutagen
+    class Orchestrator
+      def initialize(machine, console)
+        @machine = machine
+        @console = console
+      end
+
+      # Update ssh config entry
+      # If ssh config entry already exists, just entry appended
+      def update_ssh_config_entry
+        hostname = @machine.config.vm.hostname
+
+        logging(:info, 'Checking for SSH config entries')
+        if ssh_config_entry_exist?
+          logging(:info, "  updating SSH Config entry for: #{hostname}")
+          remove_from_ssh_config
+        else
+          logging(:info, "  adding entry to SSH config for: #{hostname}")
+        end
+        append_to_ssh_config(ssh_config_entry)
+      end
+
+      # Remove ssh config entry
+      def remove_ssh_config_entry
+        return unless ssh_config_entry_exist?
+
+        logging(:info, 'Removing SSH config entry')
+        remove_from_ssh_config
+      end
+
+      def start_orchestration
+        return if mutagen_project_started?
+
+        logging(:info, 'Starting mutagen project orchestration (config: /mutagen.yml)')
+        start_mutagen_project || logging(:error, 'Failed to start mutagen project (see error above)')
+        # show project status to indicate if there are conflicts
+        list_mutagen_project
+      end
+
+      def terminate_orchestration
+        return unless mutagen_project_started?
+
+        logging(:info, 'Terminating mutagen project orchestration')
+        terminate_mutagen_project || logging(:error, 'Failed to terminate mutagen project (see error above)')
+      end
+
+      def save_machine_identifier
+        @machine.config.mutagen_utilizer.machine_id = @machine.id
+      end
+
+      private
+
+      def logging(level, message, with_prefix = true)
+        prefix = with_prefix ? '[vagrant-mutagen-utilize] ' : ''
+
+        @console.send(level, "#{prefix}#{message}")
+      end
+
+      def ssh_user_config_path
+        @machine.config.mutagen_utilizer.ssh_user_config_path
+      end
+
+      # Create a regular expression that will match the vagrant-mutagen-utilize signature
+      def ssh_config_entry_pattern
+        hostname = @machine.config.vm.hostname
+
+        Regexp.new("^(#{Regexp.escape(signature)}).*$\nHost #{hostname}.*$")
+      end
+
+      def ssh_config_removing_pattern
+        escaped_signature = Regexp.escape(signature)
+
+        Regexp.new("^(#{escaped_signature}).*?(^#{escaped_signature}).*$", Regexp::MULTILINE)
+      end
+
+      def signature
+        name = @machine.name
+        # When destroing a VM, the machine.id is set to nil, so it refer the ID saved before destroying.
+        uuid = @machine.id || @machine.config.mutagen_utilizer.machine_id
+        hashed_id = Digest::MD5.hexdigest(uuid)
+
+        %(# VAGRANT: #{hashed_id} (#{name}) / #{uuid})
+      end
+
+      def ssh_config_entry
+        hostname = @machine.config.vm.hostname
+
+        # Get the SSH config from Vagrant
+        sshconfig = `vagrant ssh-config --host #{hostname}`
+        # Trim Whitespace from end
+        sshconfig = sshconfig.gsub(/^$\n/, '')
+        sshconfig = sshconfig.chomp
+
+        %(#{signature}\n#{sshconfig}\n#{signature})
+      end
+
+      def ssh_config_entry_exist?
+        File.read(ssh_user_config_path).match?(ssh_config_entry_pattern)
+      end
+
+      def validate_ssh_config_writable
+        return true if File.writable_real?(ssh_user_config_path)
+
+        logging(:info, "You don't have permission of #{ssh_user_config_path}. " \
+                'You should manually adding equivalent entries to the config file.')
+
+        false
+      end
+
+      def append_to_ssh_config(entry)
+        return if entry.length.zero?
+        return unless validate_ssh_config_writable
+
+        logging(:info, "Writing the following config to (#{ssh_user_config_path})")
+        logging(:info, entry, false)
+        append_line_feed_to_end_of_file_if_not_exist(ssh_user_config_path)
+        File.open(ssh_user_config_path, 'a') do |f|
+          f.write(entry)
+        end
+      end
+
+      def remove_from_ssh_config
+        return unless validate_ssh_config_writable
+
+        content = File.read(ssh_user_config_path)
+        new_content = content.gsub(ssh_config_removing_pattern, '')
+        File.open(ssh_user_config_path, 'w') do |f|
+          f.write(new_content)
+        end
+      end
+
+      def append_line_feed_to_end_of_file_if_not_exist(path)
+        # It is set "true" as default because
+        #   when it doesn't know if file is ending with line feed or not, it should not add the line feed.
+        is_file_end_with_line_feed = true
+        File.open(path, 'a+') do |f|
+          f.seek(-1, IO::SEEK_END).zero? || (logging(:warning, "Cannot seek file #{path}") && break)
+          c = f.getc
+          is_file_end_with_line_feed = false if c != "\r" && c != "\n"
+        end
+        return if is_file_end_with_line_feed
+
+        File.open(path, 'a') do |f|
+          f.puts('')
+        end
+      end
+
+      # Define methods to controll mutagen
+      DISCARD_STDOUT = Vagrant::Util::Platform.windows? ? '>nul'  : '>/dev/null'
+      DISCARD_STDERR = Vagrant::Util::Platform.windows? ? '2>nul' : '2>/dev/null'
+      MUTAGEN_METHODS = {
+        # mutagen project list returns 1 on error when no project is started
+        "mutagen_project_started?": "mutagen project list #{DISCARD_STDOUT} #{DISCARD_STDERR}",
+        'start_mutagen_project': 'mutagen project start',
+        'terminate_mutagen_project': 'mutagen project terminate',
+        'list_mutagen_project': 'mutagen project list'
+      }.freeze
+      MUTAGEN_METHODS.each_pair do |method_name, command|
+        define_method method_name do
+          system(command)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/plugin.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'action/update_config'
+require_relative 'action/remove_config'
+require_relative 'action/start_orchestration'
+require_relative 'action/terminate_orchestration'
+require_relative 'action/save_machine_identifier'
+
+module VagrantPlugins
+  module MutagenUtilizer
+    # Plugin to utilize mutagen
+    class MutagenUtilizerPlugin < Vagrant.plugin('2')
+      name 'Mutagen Utilizer'
+      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_utilizer) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:mutagen_utilizer, :machine_action_up) do |hook|
+        hook.append(Action::UpdateConfig)
+        hook.append(Action::StartOrchestration)
+      end
+
+      action_hook(:mutagen_utilizer, :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_utilizer, :machine_action_halt) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::RemoveConfig)
+      end
+
+      action_hook(:mutagen_utilizer, :machine_action_suspend) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::RemoveConfig)
+      end
+
+      action_hook(:mutagen_utilizer, :machine_action_destroy) do |hook|
+        hook.prepend(Action::SaveMachineIdentifier)
+        hook.append(Action::RemoveConfig)
+        hook.append(Action::TerminateOrchestration)
+      end
+
+      action_hook(:mutagen_utilizer, :machine_action_reload) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::UpdateConfig)
+        hook.append(Action::StartOrchestration)
+      end
+
+      action_hook(:mutagen_utilizer, :machine_action_resume) do |hook|
+        hook.append(Action::TerminateOrchestration)
+        hook.append(Action::UpdateConfig)
+        hook.append(Action::StartOrchestration)
+      end
+    end
+  end
+end

data/lib/vagrant_mutagen_utilizer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module MutagenUtilizer
+    VERSION = '0.2.0'
+  end
+end

data/vagrant-mutagen-utilizer.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant_mutagen_utilizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vagrant-mutagen-utilizer'
+  spec.version       = VagrantPlugins::MutagenUtilizer::VERSION
+  spec.authors       = ['Ryu Sato']
+  spec.email         = ['ryu@weseek.co.jp']
+  spec.description   = 'Enables Vagrant to utilize mutagen for project sync'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/ryu-sato/vagrant-mutagen-utilizer'
+  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,87 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-mutagen-utilizer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ryu Sato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-19 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:
+- ryu@weseek.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-mutagen-utilizer.rb
+- lib/vagrant_mutagen_utilizer/action/remove_config.rb
+- lib/vagrant_mutagen_utilizer/action/save_machine_identifier.rb
+- lib/vagrant_mutagen_utilizer/action/start_orchestration.rb
+- lib/vagrant_mutagen_utilizer/action/terminate_orchestration.rb
+- lib/vagrant_mutagen_utilizer/action/update_config.rb
+- lib/vagrant_mutagen_utilizer/config.rb
+- lib/vagrant_mutagen_utilizer/orchestrator.rb
+- lib/vagrant_mutagen_utilizer/plugin.rb
+- lib/vagrant_mutagen_utilizer/version.rb
+- vagrant-mutagen-utilizer.gemspec
+homepage: https://github.com/ryu-sato/vagrant-mutagen-utilizer
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Enables Vagrant to utilize mutagen for project sync
+test_files: []