vagrant-mosh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf1674d5eaceb827312236ae52fbaf863d246f95
+  data.tar.gz: ff03c7134727e4169d3ebc5b51986ddef90bca1d
+SHA512:
+  metadata.gz: ff65aa296e50fe852e09272b56c12f37c8d81c1cba6d3404331f1a033e00551ef1537db75b22ecd99749a9342158e40a9807f156b19bb6427e0835287b4f1ec0
+  data.tar.gz: c76a0c52fcfd82ccda0615d23624a842a53434b11906c582bc8bfba99af95600fe9526ccb7d6ec391200d86e7ed085c599be80dfc58e045b485a3d8fee18e039

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/
+tmp/
+.bundle/
+vendor/bundle/
+.vagrant/
+Gemfile.lock
+.envrc

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'vagrant', github: 'mitchellh/vagrant'
+end
+
+group :plugins do
+  gemspec
+  gem 'vagrant-digitalocean'
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Alex Rodionov
+
+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,90 @@
+vagrant-mosh [![Gem Version](https://badge.fury.io/rb/vagrant-mosh.svg)](http://badge.fury.io/rb/vagrant-mosh)
+============
+
+Vagrant plugin to connect to box using [Mosh](https://mosh.mit.edu/).
+
+Installation
+------------
+
+```bash
+$ vagrant plugin install vagrant-mosh
+```
+
+Usage
+-----
+
+Just use it as you would normally use `ssh` command:
+
+```bash
+$ vagrant mosh
+```
+
+Notes
+-----
+
+1. You have to install Mosh both on host and box by yourself.
+2. Plugin has been tested to work with VirtualBox, AWS and DigitalOcean.
+3. If you are using VirtualBox, it's required to use private/public network (that is because we need to have remote IP address from the box).
+
+Testing
+-------
+
+Unfortunately, it's not that easy to write automated tests for it. The test should probably just run `vagrant mosh`, execute command in box and assert the result, but the way Mosh works doesn't allow to just execute the process.
+
+Discussion on `#mosh`:
+
+```
+p0deje: can anybody help me run mosh programmatically?
+p0deje: I want to run mosh from Ruby script, execute command and return
+p0deje: the script works fine for SSH, but not for Mosh
+p0deje: script itself is at https://gist.github.com/p0deje/c5dbfa0d137e8c11d3f5
+chris2: i guess expect doesnt like mosh's efficient redrawing
+...
+chris2: perhaps you can work around by running mosh in tmux and exporting the output of tmux...
+chris2: anyway, you need something that understands ANSI sequences
+```
+
+To test it manually, there is a Vagrantfile which helps you do that:
+
+```bash
+# start all boxes
+$ bundle exec rake box:add
+$ bundle exec vagrant up
+
+$ bundle exec vagrant mosh static_ip   # test VirtualBox static IP networking
+$ bundle exec vagrant mosh dynamic_ip  # test VirtualBox DHCP networking
+
+# remove all boxes
+$ bundle exec vagrant destroy
+$ bundle exec rake box:remove
+```
+
+Also, it's possible to test remote providers (if you have [DigitalOcean](https://www.digitalocean.com/) account):
+
+```bash
+$ export DIGITALOCEAN_TOKEN="your_token"
+$ bundle exec vagrant up digitalocean
+$ bundle exec vagrant mosh digitalocean
+$ bundle exec vagrant destroy digitalocean
+```
+
+TODO
+----
+
+1. Try to forward UDP ports rather finding remote IP address of the box.
+2. Add tests.
+3. Refactor to work as action.
+
+Contributing
+------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* ~~Add tests for it. This is important so I don't break it in a future version unintentionally.~~ (no automated tests exist at the moment)
+* Commit, do not mess with Rakefile, version, or history. If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2015 Alex Rodionov. See LICENSE.md for details.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+namespace :box do
+  desc 'Downloads and adds vagrant box for testing.'
+  task :add do
+    sh 'bundle exec vagrant box add ubuntu/trusty64'
+  end
+
+  desc 'Removes testing vagrant box.'
+  task :remove do
+    sh 'bundle exec vagrant box remove --force ubuntu/trusty64'
+  end
+end

data/Vagrantfile

@@ -0,0 +1,23 @@
+Vagrant.configure('2') do |config|
+  config.vm.box = 'ubuntu/trusty64'
+  config.vm.provision 'shell', path: 'support/provision.sh'
+
+  config.vm.define 'static_ip' do |machine|
+    machine.vm.network :private_network, ip: '192.168.50.6'
+  end
+
+  config.vm.define 'dynamic_ip' do |machine|
+    machine.vm.network :private_network, type: 'dhcp'
+  end
+
+  config.vm.define 'digitalocean', autostart: false do |machine|
+    machine.vm.provider :digital_ocean do |provider, override|
+      override.ssh.private_key_path = '~/.ssh/id_rsa'
+      override.vm.box = 'digital_ocean'
+      override.vm.box_url = 'https://github.com/smdahlen/vagrant-digitalocean/raw/master/box/digital_ocean.box'
+
+      provider.token = ENV['DIGITALOCEAN_TOKEN']
+      provider.image = 'ubuntu-14-04-x64'
+    end
+  end
+end

data/lib/vagrant-mosh.rb

@@ -0,0 +1,4 @@
+require 'vagrant'
+
+require 'vagrant-mosh/plugin'
+require 'vagrant-mosh/version'

data/lib/vagrant-mosh/command.rb

@@ -0,0 +1,93 @@
+module VagrantPlugins
+  module Mosh
+    class Command < Vagrant.plugin(2, :command)
+      def self.synopsis
+        'connects to machine via Mosh'
+      end
+
+      def execute
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant mosh [vm-name]'
+          o.separator ''
+        end
+        argv = parse_options(opts)
+        return unless argv
+
+        with_target_vms(argv, single_target: true) do |vm|
+          ssh_info = vm.ssh_info
+          switch_to_remote_ip(ssh_info, vm) if localhost?(ssh_info[:host])
+          mosh_command = ['mosh', *mosh_arguments(ssh_info)].join(' ')
+          Vagrant::Util::SafeExec.exec(mosh_command)
+        end
+      end
+
+      private
+
+      def localhost?(host)
+        %w[localhost 127.0.0.1].include?(host)
+      end
+
+      def switch_to_remote_ip(ssh_info, vm)
+        ssh_info.delete(:port)
+        if ip = find_remote_ip(vm)
+          ssh_info[:host] = ip
+        else
+          raise "Cannot find remote box IP address. Make sure you're not using NAT."
+        end
+      end
+
+      def find_remote_ip(vm)
+        adapter_numbers = vm.provider.driver.read_network_interfaces.keys
+        adapter_numbers.map do |adapter_number|
+          begin
+            vm.provider.driver.read_guest_ip(adapter_number)
+          rescue Vagrant::Errors::VirtualBoxGuestPropertyNotFound
+            nil
+          end
+        end.compact.first
+      end
+
+      def mosh_arguments(ssh_info)
+        [
+          "--ssh", "'#{ssh_command(ssh_info)}'",
+          "#{ssh_info[:username]}@#{ssh_info[:host]}"
+        ]
+      end
+
+      # This method pretty much duplicates `Vagrant::Util::SSH.exec`.
+      #
+      # It would be great to be able to get this logic from Vagrant itself
+      # but it requires some core changes.
+      def ssh_command(ssh_info)
+        command_options = %W[
+          -o Compression=yes
+          -o DSAAuthentication=yes
+          -o LogLevel=#{ssh_info[:log_level] || 'FATAL'}
+          -o StrictHostKeyChecking=no
+          -o UserKnownHostsFile=/dev/null
+        ]
+
+        if ssh_info[:forward_x11]
+          command_options += %w[
+            -o ForwardX11=yes
+            -o ForwardX11Trusted=yes
+          ]
+        end
+
+        if ssh_info[:forward_agent]
+          command_options += %w[-o ForwardAgent=yes]
+        end
+
+        ssh_info[:private_key_path].each do |path|
+          command_options += ['-i', path]
+        end
+
+        if ssh_info[:port]
+          command_options += ['-p', ssh_info[:port]]
+        end
+
+        "ssh #{command_options.join(' ')}"
+      end
+    end
+  end
+end

data/lib/vagrant-mosh/plugin.rb

@@ -0,0 +1,13 @@
+module VagrantPlugins
+  module Mosh
+    class Plugin < Vagrant.plugin(2)
+      name 'vagrant-mosh'
+      description 'Plugin allows to use Mosh to connect to box.'
+
+      command :mosh do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-mosh/version.rb

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

data/support/provision.sh

@@ -0,0 +1,23 @@
+#!/bin/bash -x
+
+# fix locale
+export LANGUAGE=en_US.UTF-8
+export LANG=en_US.UTF-8
+export LC_ALL=en_US.UTF-8
+sudo locale-gen en_US.UTF-8
+sudo dpkg-reconfigure locales
+
+# Uncomment the following to build using package manager:
+sudo apt-get install -y mosh
+
+# Uncomment the following to build from source:
+# sudo apt-get install -y libncurses5-dev libprotobuf-dev libssl-dev protobuf-compiler zlib1g-dev
+# sudo apt-get install -y autoconf build-essential git pkg-config
+# git clone https://github.com/keithw/mosh
+# cd mosh
+# ./autogen.sh
+# ./configure
+# make
+# sudo make install
+# cd ../
+# rm -rf mosh/

data/vagrant-mosh.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'vagrant-mosh/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'vagrant-mosh'
+  s.version     = VagrantPlugins::Mosh::VERSION
+  s.author      = 'Alex Rodionov'
+  s.email       = 'p0deje@gmail.com'
+  s.homepage    = 'http://github.com/p0deje/vagrant-mosh'
+  s.summary     = 'Use Mosh to connect to box'
+  s.description = 'Vagrant plugin to use Mosh to connect to box'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-mosh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Rodionov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-10 00:00:00.000000000 Z
+dependencies:
+- !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: Vagrant plugin to use Mosh to connect to box
+email: p0deje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant-mosh.rb
+- lib/vagrant-mosh/command.rb
+- lib/vagrant-mosh/plugin.rb
+- lib/vagrant-mosh/version.rb
+- support/provision.sh
+- vagrant-mosh.gemspec
+homepage: http://github.com/p0deje/vagrant-mosh
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Use Mosh to connect to box
+test_files: []