vagrant-rsync-back 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ebb0b6a7417809cc6743de98dec4333de70c7ee
+  data.tar.gz: e942aed14a268627f741a9793f83290f2e21c517
+SHA512:
+  metadata.gz: 0fd0c2c43a9ab1231303f6e192542b10ce60209a43c9909da887bf12df00bff1aab50633c7b1f235522a416628f50a9c80e7631e15f0a9dee53702dcc60a040f
+  data.tar.gz: 19874ba46f8f6aaad08f6cfbdc693f3b2be8e3568e39eeda7f1e7f89ba833415960de6ee2599d5c5b743e64e564abe368239ba884bdfc161f073f3c7ba96dde8

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo
+example/files/*
+example/vagrant/.vagrant

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.1 (April 4, 2014)
+
+Initial release.
+
+FEATURES:
+
+- Implement rsync back from guest to host.
+
+## Backlog
+
+- Test more.
+- Test on Windows.

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-rsync-back.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => 'v1.5.1'
+  gem "pry"
+end
+
+group :plugins do
+  gem "vagrant-rsync-back", path: "."
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Steven Merrill
+
+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,34 @@
+# vagrant-rsync-back
+
+A plugin for Vagrant 1.5.1+ that lets you rsync from guest to host.
+
+## Getting started
+
+This plugin has only been lightly tested. It might eat all your data! (Use at
+your own risk.)
+
+To get started, you need to have Vagrant 1.5.1 installed on your host machine.
+To install the plugin, use the following command.
+
+```bash
+vagrant plugin install vagrant-rsync-back
+```
+
+Then once you have generated some content on the guest that you want to bring
+back to the host, run the rsync-back command.
+
+```bash
+vagrant rsync-back
+```
+
+## Why rsync back?
+
+Sometimes, the application on your host will write things to the source code
+directory that you want to sync back to the host. A Drupal-specific example
+is generating new Features to disk and then wanting to commit them to git
+from the host machine.
+
+## Author
+
+Steven Merrill (@stevenmerrill) built this based on vagrant-gatling-rsync.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/vagrant/Vagrantfile

@@ -0,0 +1,16 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "hashicorp/precise64"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  config.vm.synced_folder "../files", "/opt/vagrant/rsynced_folder", type: "rsync",
+    rsync__exclude: [".git/", ".idea/"]
+end

data/lib/vagrant-rsync-back.rb

@@ -0,0 +1,23 @@
+# This file is required because Vagrant's plugin system expects
+# a eponymous ruby file matching the rubygem.
+#
+# So this gem is called 'vagrant-rsync-auto' and thus vagrant tries
+# to require "vagrant-rsync-auto"
+
+require "vagrant-rsync-back/plugin"
+
+require "pathname"
+
+module VagrantPlugins
+  module RsyncBack
+    lib_path = Pathname.new(File.expand_path("../vagrant-rsync-back", __FILE__))
+    autoload :Errors, lib_path.join("errors")
+
+    # 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/lib/vagrant-rsync-back/command/rsync_back.rb

@@ -0,0 +1,157 @@
+require "log4r"
+require "optparse"
+
+require "vagrant"
+
+# Monkeypatch RsyncHelper for now. Maybe merge this into Vagrant proper?
+require Vagrant.source_root.join("plugins/synced_folders/rsync/helper")
+VagrantPlugins::SyncedFolderRSync::RsyncHelper.class_eval do
+  def self.rsync_single(machine, ssh_info, opts, rsync_back=false)
+    # Folder info
+    guestpath = opts[:guestpath]
+    hostpath  = opts[:hostpath]
+    hostpath  = File.expand_path(hostpath, machine.env.root_path)
+    hostpath  = Vagrant::Util::Platform.fs_real_path(hostpath).to_s
+
+    if Vagrant::Util::Platform.windows?
+      # rsync for Windows expects cygwin style paths, always.
+      hostpath = Vagrant::Util::Platform.cygwin_path(hostpath)
+    end
+
+    # Make sure the host path ends with a "/" to avoid creating
+    # a nested directory...
+    if rsync_back
+      if !guestpath.end_with?("/")
+        guestpath += "/"
+      end
+    else
+      if !hostpath.end_with?("/")
+        hostpath += "/"
+      end
+    end
+
+    # Folder options
+    opts[:owner] ||= ssh_info[:username]
+    opts[:group] ||= ssh_info[:username]
+
+    # Connection information
+    username = ssh_info[:username]
+    host     = ssh_info[:host]
+    rsh = [
+      "ssh -p #{ssh_info[:port]} -o StrictHostKeyChecking=no",
+      ssh_info[:private_key_path].map { |p| "-i '#{p}'" },
+    ].flatten.join(" ")
+
+    # Exclude some files by default, and any that might be configured
+    # by the user.
+    excludes = ['.vagrant/']
+    excludes += Array(opts[:exclude]).map(&:to_s) if opts[:exclude]
+    excludes.uniq!
+
+    # Get the command-line arguments
+    args = nil
+    args = Array(opts[:args]) if opts[:args]
+    args ||= ["--verbose", "--archive", "--delete", "-z"]
+
+    # On Windows, we have to set the chmod flag to avoid permission issues
+    if Vagrant::Util::Platform.windows?
+      args << "--chmod=ugo=rwX"
+    end
+
+    # Build up the actual command to execute
+    command_parts = [
+      "rsync",
+      args,
+      "-e", rsh,
+      excludes.map { |e| ["--exclude", e] },
+      hostpath,
+      "#{username}@#{host}:#{guestpath}",
+    ]
+
+    command_parts = command_parts.concat(command_parts.slice!(-2, 2).reverse) if rsync_back
+    command = command_parts.flatten
+
+    # The working directory should be the root path
+    command_opts = {}
+    command_opts[:workdir] = machine.env.root_path.to_s
+
+    if rsync_back
+      machine.ui.info(I18n.t(
+        "vagrant.rsync_folder", guestpath: hostpath, hostpath: guestpath))
+    else
+      machine.ui.info(I18n.t(
+        "vagrant.rsync_folder", guestpath: guestpath, hostpath: hostpath))
+    end
+
+    if excludes.length > 1
+      machine.ui.info(I18n.t(
+        "vagrant.rsync_folder_excludes", excludes: excludes.inspect))
+    end
+
+    # If we have tasks to do before rsyncing, do those.
+    if machine.guest.capability?(:rsync_pre)
+      machine.guest.capability(:rsync_pre, opts) unless rsync_back
+    end
+
+    r = Vagrant::Util::Subprocess.execute(*(command + [command_opts]))
+    if r.exit_code != 0
+      raise Vagrant::Errors::RSyncError,
+        command: command.join(" "),
+        guestpath: guestpath,
+        hostpath: hostpath,
+        stderr: r.stderr
+    end
+
+    # If we have tasks to do after rsyncing, do those.
+    if machine.guest.capability?(:rsync_post)
+      machine.guest.capability(:rsync_post, opts) unless rsync_back
+    end
+  end
+end
+
+module VagrantPlugins
+  module RsyncBack
+    class RsyncBackCommand < Vagrant.plugin(2, :command)
+      include Vagrant::Action::Builtin::MixinSyncedFolders
+
+      def self.synopsis
+        "syncs rsync synced folders from remote machine"
+      end
+
+      def execute
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant rsync-back [vm-name]"
+          o.separator ""
+        end
+
+        # Parse the options and return if we don't have any target.
+        argv = parse_options(opts)
+        return if !argv
+
+        # Go through each machine and perform the rsync
+        error = false
+        with_target_vms(argv) do |machine|
+          if !machine.communicate.ready?
+            machine.ui.error(I18n.t("vagrant.rsync_communicator_not_ready"))
+            error = true
+            next
+          end
+
+          # Determine the rsync synced folders for this machine
+          folders = synced_folders(machine)[:rsync]
+          next if !folders || folders.empty?
+
+          # Get the SSH info for this machine so we can access it
+          ssh_info = machine.ssh_info
+
+          # Sync them!
+          folders.each do |id, folder_opts|
+            VagrantPlugins::SyncedFolderRSync::RsyncHelper.rsync_single(machine, ssh_info, folder_opts, true)
+          end
+        end
+
+        return error ? 1 : 0
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-back/errors.rb

@@ -0,0 +1,19 @@
+require "vagrant"
+
+module VagrantPlugins
+  module RsyncBack
+    module Errors
+      class VagrantRsyncBackError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_rsync_back.errors")
+      end
+
+      class OnlyOSXLinuxSupportError < VagrantRsyncBackError
+        error_key(:only_osx_linux_support)
+      end
+
+      class Vagrant15RequiredError < VagrantRsyncBackError
+        error_key(:vagrant_15_required)
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-back/plugin.rb

@@ -0,0 +1,35 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant gatling rsync 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.5.1"
+  raise Errors::Vagrant15RequiredError
+end
+
+module VagrantPlugins
+  module RsyncBack
+    class Plugin < Vagrant.plugin("2")
+      name "Rsync Back"
+      description <<-DESC
+      Rsync back from the guest to the host.
+      DESC
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", RsyncBack.source_root)
+        I18n.reload!
+      end
+
+      command("rsync-back", primary: false) do
+        setup_i18n
+
+        require_relative "command/rsync_back"
+        RsyncBackCommand
+      end
+    end
+  end
+end

data/lib/vagrant-rsync-back/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module RsyncBack
+    VERSION = "0.0.1"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  vagrant_gatling_rsync:
+    errors:
+      only_osx_linux_support: |-
+        This plugin currently only supports Max OS X and Linux hosts.
+      vagrant_15_required: |-
+        This plugin requires Vagrant 1.5.1 or newer to function.
+

data/vagrant-rsync-back.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-rsync-back/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-rsync-back"
+  spec.version       = VagrantPlugins::RsyncBack::VERSION
+  spec.authors       = ["Steven Merrill"]
+  spec.email         = ["steven.merrill@gmail.com"]
+  spec.summary       = %q{Rsync in reverse to pull files from your Vagrant rsynced folders.}
+  spec.description   = %q{Rsync in reverse to pull files from your Vagrant rsynced folders.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # @TODO: Remove example files from the built gem.
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-rsync-back
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Merrill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Rsync in reverse to pull files from your Vagrant rsynced folders.
+email:
+- steven.merrill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example/vagrant/Vagrantfile
+- lib/vagrant-rsync-back.rb
+- lib/vagrant-rsync-back/command/rsync_back.rb
+- lib/vagrant-rsync-back/errors.rb
+- lib/vagrant-rsync-back/plugin.rb
+- lib/vagrant-rsync-back/version.rb
+- locales/en.yml
+- vagrant-rsync-back.gemspec
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Rsync in reverse to pull files from your Vagrant rsynced folders.
+test_files: []