vagrant-zscp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdd2eade49cf4518b306f9d3cc7c632b5b3c2284
+  data.tar.gz: e8eabad1df92ff74a4e9ab87bf667526f91dc0b2
+SHA512:
+  metadata.gz: 0395f36643d5936006adbe2eefca8e57923cb488d1f26307c250690a255bb11823574b265c5a239213159de19588af47730556b5c0cdc144e1466ea5f4fe417a
+  data.tar.gz: 0146d484e0611c501ee795c306ecc65ef67ac32c5a2aa5dcc629da34f1de9a48e76dce807e86cf07e13a8874b93ad786f441dc39f844c937596f3571cf633d82

data/.gitignore

@@ -0,0 +1 @@
+/*.gem

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-zscp", path: "."
+end

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vagrant/zscp"
+
+# 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

data/bin/setup

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

data/lib/vagrant/zscp.rb

@@ -0,0 +1,2 @@
+require "vagrant/zscp/version"
+require "vagrant/zscp/plugin"

data/lib/vagrant/zscp/command/zscp.rb

@@ -0,0 +1,57 @@
+require 'optparse'
+
+require "vagrant/action/builtin/mixin_synced_folders"
+require_relative "../helper"
+
+module Vagrant
+  module Zscp
+    module Command
+      class Rsync < Vagrant.plugin("2", :command)
+        include Vagrant::Action::Builtin::MixinSyncedFolders
+
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = "Usage: vagrant zscp [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.provider.capability?(:proxy_machine)
+              proxy = machine.provider.capability(:proxy_machine)
+              if proxy
+                machine.ui.warn("vagrant.rsync_proxy_machine")
+                machine = proxy
+              end
+            end
+
+            if !machine.communicate.ready?
+              machine.ui.error("vagrant.rsync_communicator_not_ready")
+              error = true
+              next
+            end
+
+            # Determine the rsync synced folders for this machine
+            folders = synced_folders(machine, cached: true)[:zscp]
+            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|
+              ZscpHelper.scp(machine, ssh_info, folder_opts)
+            end
+          end
+
+          return error ? 1 : 0
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/zscp/helper.rb

@@ -0,0 +1,51 @@
+module Vagrant
+  module Zscp
+    # This is a helper that abstracts out the functionality of scping
+    # folders so that it can be called from anywhere.
+    class ZscpHelper
+      def self.scp(machine, ssh_info, opts)
+        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 (opts[:zscp_include])
+          included_files = opts[:zscp_include].join(' ')
+        else
+          included_files = '.'
+        end
+
+        username = ssh_info[:username]
+        host     = ssh_info[:host]
+
+        if !hostpath.end_with?("/")
+          hostpath += "/"
+        end
+
+        machine.ui.info("Sending #{hostpath} to #{guestpath}")
+        Dir.mktmpdir { |dir|
+          machine.ui.info("Removing remote #{guestpath}")
+          machine.communicate.execute("sudo rm -rf #{guestpath}; sudo mkdir -p #{guestpath}; sudo chown #{username}:$(id -gn) #{guestpath}")
+
+          machine.ui.info("Compressing #{hostpath} into #{dir}/temp.tar.gz")
+          `tar -czLf #{dir}/temp.tar.gz -C #{hostpath} #{included_files}`
+
+          machine.ui.info("Copying #{dir}/temp.tar.gz to #{guestpath}")
+          command = [
+            "scp",
+            '-o StrictHostKeyChecking=no',
+            '-o UserKnownHostsFile=/dev/null',
+            "-o port=#{ssh_info[:port]}",
+            "-i '#{ssh_info[:private_key_path][0]}'",
+            "#{dir}/temp.tar.gz",
+            "#{username}@#{host}:#{guestpath}"
+          ].join(' ')
+          system(command)
+
+          machine.ui.info("Extracting remotely #{guestpath}/temp.tar.gz")
+          machine.communicate.execute("tar -xzf #{guestpath}/temp.tar.gz -C #{guestpath}; rm #{guestpath}/temp.tar.gz")
+        }
+        machine.ui.info("#{guestpath} synchronised")
+      end
+    end
+  end
+end

data/lib/vagrant/zscp/plugin.rb

@@ -0,0 +1,27 @@
+require "vagrant"
+
+module Vagrant
+  module Zscp
+    # This plugin implements zSCP synced folders.
+    # It will also compress folders into a targz file to reduce back and forth
+    # communication
+    #
+    class Plugin < Vagrant.plugin("2")
+      name "zSCP synced folders"
+      description <<-EOF
+      The zSCP synced folders plugin enables you to use SCP as a synced folder
+      implementation.
+      EOF
+
+      command("zscp", primary: false) do
+        require_relative "command/zscp"
+        Command::Rsync
+      end
+
+      synced_folder("zscp", 5) do
+        require_relative "synced_folder"
+        SyncedFolder
+      end
+    end
+  end
+end

data/lib/vagrant/zscp/synced_folder.rb

@@ -0,0 +1,30 @@
+require "log4r"
+
+require_relative "helper"
+
+module Vagrant
+  module Zscp
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      def initialize(*args)
+        super
+        @logger = Log4r::Logger.new("vagrant::synced_folders::zscp")
+      end
+
+      def usable?(machine, raise_error=false)
+        return true
+      end
+
+      def prepare(machine, folders, opts)
+        # Nothing is necessary to do before VM boot.
+      end
+
+      def enable(machine, folders, opts)
+        ssh_info = machine.ssh_info
+
+        folders.each do |id, folder_opts|
+          ZscpHelper.scp(machine, ssh_info, folder_opts)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/zscp/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Zscp
+    VERSION = "0.1.0"
+  end
+end

data/vagrant-zscp.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant/zscp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-zscp"
+  spec.version       = Vagrant::Zscp::VERSION
+  spec.authors       = ["Colin Hebert"]
+  spec.email         = ["chebert@atlassian.com"]
+
+  spec.summary       = %q{Copies files to a vagrant VM using scp and compressing the content.}
+  spec.description   = %q{Copies files to a vagrant VM using scp and compressing the content.}
+  spec.homepage      = "https://www.atlassian.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "log4r", "~> 1.1"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-zscp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colin Hebert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Copies files to a vagrant VM using scp and compressing the content.
+email:
+- chebert@atlassian.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vagrant/zscp.rb
+- lib/vagrant/zscp/command/zscp.rb
+- lib/vagrant/zscp/helper.rb
+- lib/vagrant/zscp/plugin.rb
+- lib/vagrant/zscp/synced_folder.rb
+- lib/vagrant/zscp/version.rb
+- vagrant-zscp.gemspec
+homepage: https://www.atlassian.com
+licenses: []
+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: Copies files to a vagrant VM using scp and compressing the content.
+test_files: []