vagrant-unison 0.0.1.dev

data/.gitignore

@@ -0,0 +1,14 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (March, 2013)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2013 Mitchell Hashimoto
+
+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 Unison Plugin
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that syncs files over SSH from a local folder
+to your Vagrant VM (local or on AWS).  Under the covers it uses [Unison](http://www.cis.upenn.edu/~bcpierce/unison/)
+
+**NOTE:** This plugin requires Vagrant 1.1+,
+
+## Features
+
+* Unisoned folder support via `unison` over `ssh` -> will work with any vagrant provider, eg Virtualbox or AWS.
+
+## Usage
+
+1. You must already have [Unison](http://www.cis.upenn.edu/~bcpierce/unison/) installed and in your path.
+     * On Mac you can install this with Homebrew:  `brew install unison`
+     * On Unix (Ubuntu) install using `sudo apt-get install unison`
+     * On Windows, download [2.40.102](http://alan.petitepomme.net/unison/assets/Unison-2.40.102.zip), unzip, rename `Unison-2.40.102 Text.exe` to `unison.exe` and copy to somewhere in your path.
+1. Install using standard Vagrant 1.1+ plugin installation methods. 
+```
+$ vagrant plugin install vagrant-unison
+```
+1. After installing, edit your Vagrantfile and add a configuration directive similar to the below:
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  config.vm.provider :sync do |sync|
+     sync.local_folder = "src/"  #relative to the folder your Vagrantfile is in
+     sync.remote_folder = "src/" #relative to the vagrant home folder -> /home/vagrant
+  end
+end
+```
+1. Start up your starting your vagrant box as normal (eg: `vagrant up`)
+
+## Start syncing Folders
+
+Run `vagrant sync` to start watching the local_folder for changes, and syncing these to your vagrang VM.
+
+Under the covers this uses your system installation of [Unison](http://www.cis.upenn.edu/~bcpierce/unison/), 
+which must be installed in your path.
+
+## Development
+
+To work on the `vagrant-unison` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ bundle
+```
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+that uses it, and uses bundler to execute Vagrant:
+
+```
+$ bundle exec vagrant up 
+$ bundle exec vagrant sync
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new
+
+# Default task is to run the unit tests
+task :default => "spec"

data/lib/vagrant-unison/command.rb

@@ -0,0 +1,51 @@
+require "log4r"
+require "vagrant"
+
+module VagrantPlugins
+  module Unison
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+
+        with_target_vms do |machine|
+
+          ssh_info = machine.ssh_info
+
+          hostpath  = File.expand_path(machine.config.sync.host_folder, @env.root_path)
+          guestpath = machine.config.sync.guest_folder
+
+          # Make sure there is a trailing slash on the host path to
+          # avoid creating an additional directory with rsync
+          hostpath = "#{hostpath}/" if hostpath !~ /\/$/
+
+          @env.ui.info "Unisoning {host}::#{hostpath} --> {guest VM}::#{guestpath}"
+
+          # Create the guest path
+          #machine.communicate.sudo("mkdir -p '#{guestpath}'")
+          #machine.communicate.sudo("chown #{ssh_info[:username]} '#{guestpath}'")
+
+          # Unison over to the guest path using the SSH info
+          command = [
+            "unison", "-batch",
+            "-ignore='Name {git*,.vagrant/,*.DS_Store}'",
+            "-sshargs=\"-p #{ssh_info[:port]} -o StrictHostKeyChecking=no -i '#{ssh_info[:private_key_path]}'\"",
+            hostpath,
+            "ssh://#{ssh_info[:username]}@#{ssh_info[:host]}/#{guestpath}"
+           ]
+
+          r = Vagrant::Util::Subprocess.execute(*command)
+          if r.exit_code != 0
+            raise Vagrant::Errors::UnisonError,
+              :command => command.join(" "),
+              :guestpath => guestpath,
+              :hostpath => hostpath,
+              :stderr => r.stderr
+          end
+
+        end
+
+        0
+      end
+     
+    end
+  end
+end

data/lib/vagrant-unison/config.rb

@@ -0,0 +1,52 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Unison
+    class Config < Vagrant.plugin("2", :config)
+      # The access key ID for accessing AWS.
+      #
+      # @return [String]
+      attr_accessor :host_folder
+
+      # The ID of the AMI to use.
+      #
+      # @return [String]
+      attr_accessor :guest_folder
+
+      def initialize(region_specific=false)
+        @host_folder      = UNSET_VALUE
+        @remote_folder    = UNSET_VALUE
+      end
+
+      #-------------------------------------------------------------------
+      # Internal methods.
+      #-------------------------------------------------------------------
+
+      # def merge(other)
+      #   super.tap do |result|
+      #     # TODO - do something sensible; current last config wins
+      #     result.local_folder = other.local_folder
+      #     result.remote_folder = other.remote_folder
+      #   end
+      # end
+
+      def finalize!
+        # The access keys default to nil
+        @host_folder    = nil if @host_folder    == UNSET_VALUE
+        @guest_folder   = nil if @guest_folder   == UNSET_VALUE
+
+        # Mark that we finalized
+        @__finalized = true
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << I18n.t("vagrant_sync.config.host_folder_required") if @host_folder.nil?
+        errors << I18n.t("vagrant_sync.config.guest_folder_required") if @guest_folder.nil?
+
+        { "Unison" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-unison/errors.rb

@@ -0,0 +1,9 @@
+require "vagrant"
+
+module Vagrant
+  module Errors
+    class UnisonError < VagrantError
+      error_key(:unison_error, "vagrant_unison.errors")
+    end
+  end
+end

data/lib/vagrant-unison/plugin.rb

@@ -0,0 +1,73 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The vagrant-unison plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.1.0"
+  raise "The vagrant-unison plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module Unison
+    class Plugin < Vagrant.plugin("2")
+      name "Unison"
+      description <<-DESC
+      This plugin syncs files over SSH from a local folder
+      to your Vagrant VM (local or on AWS). 
+      DESC
+
+      config "sync" do
+        require_relative "config"
+        Config
+      end
+
+      command "sync" do
+        # Setup logging and i18n
+        setup_logging
+        setup_i18n
+
+        #Return the command
+        require_relative "command"
+        Command
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", Unison.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new("vagrant_sync")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-unison/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Unison
+    VERSION = "0.0.1.dev"
+  end
+end

data/lib/vagrant-unison.rb

@@ -0,0 +1,15 @@
+require "pathname"
+
+require "vagrant-unison/plugin"
+require "vagrant-unison/errors"
+
+module VagrantPlugins
+  module Unison
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  vagrant_unison:
+    
+    config:
+      host_folder_required: |-
+        Host folder is required
+      guest_folder_required: |-
+        Guest folder is required
+
+    errors:
+      unison_error: |-
+        There was an error when attemping to sync folders using unison.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+        Full command causing error: 
+        %{command}

data/spec/vagrant-unison/config_spec.rb

@@ -0,0 +1,31 @@
+require "vagrant-unison/config"
+
+describe VagrantPlugins::Unison::Config do
+  let(:instance) { described_class.new }
+
+  describe "defaults" do
+    subject do
+      instance.tap do |o|
+        o.finalize!
+      end
+    end
+
+    its("host_folder")     { should be_nil }
+    its("guest_folder")    { should be_nil }
+  end
+
+  describe "overriding defaults" do
+    # I typically don't meta-program in tests, but this is a very
+    # simple boilerplate test, so I cut corners here. It just sets
+    # each of these attributes to "foo" in isolation, and reads the value
+    # and asserts the proper result comes back out.
+    [:host_folder, :guest_folder].each do |attribute|
+
+      it "should not default #{attribute} if overridden" do
+        instance.send("#{attribute}=".to_sym, "foo")
+        instance.finalize!
+        instance.send(attribute).should == "foo"
+      end
+    end
+  end
+end

data/vagrant-unison.gemspec

@@ -0,0 +1,57 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-unison/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-unison"
+  s.version       = VagrantPlugins::Unison::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = "David Laing"
+  s.email         = "david@davidlaing.com"
+  s.homepage      = "http://github.com/mrdavidlaing/vagrant-unison"
+  s.summary       = "Vagrant 1.1 plugin to sync local files to VM over SSH"
+  s.description   = "Vagrant 1.1 plugin to sync local files to VM over SSH using Unison"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_runtime_dependency "guard", "~> 1.6.2"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec-core", "~> 2.12.2"
+  s.add_development_dependency "rspec-expectations", "~> 2.12.1"
+  s.add_development_dependency "rspec-mocks", "~> 2.12.1"
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  s.files         = unignored_files
+  s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  s.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-unison
+version: !ruby/object:Gem::Version
+  version: 0.0.1.dev
+  prerelease: 6
+platform: ruby
+authors:
+- David Laing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+description: Vagrant 1.1 plugin to sync local files to VM over SSH using Unison
+email: david@davidlaing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- lib/vagrant-unison/command.rb
+- lib/vagrant-unison/config.rb
+- lib/vagrant-unison/errors.rb
+- lib/vagrant-unison/plugin.rb
+- lib/vagrant-unison/version.rb
+- lib/vagrant-unison.rb
+- LICENSE
+- locales/en.yml
+- Rakefile
+- README.md
+- spec/vagrant-unison/config_spec.rb
+- vagrant-unison.gemspec
+- .gitignore
+homepage: http://github.com/mrdavidlaing/vagrant-unison
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -244591167083494595
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Vagrant 1.1 plugin to sync local files to VM over SSH
+test_files: []