vagrant-docker-nsenter 0.0.2

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/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 0.0.2 (June 28, 2014)
+
+BUG FIXES:
+
+Fix a bug that I introduced right before pushing 0.0.1.
+
+## 0.0.1 (June 28, 2014)
+
+Initial release.
+
+FEATURES:
+
+- Add the `vagrant docker-nsenter` command.
+
+## Backlog
+
+- Test on Linux hosts without a proxy VM.

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-docker-nsenter.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => 'v1.6.3'
+end
+
+group :plugins do
+  gem "vagrant-docker-nsenter", 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,70 @@
+# vagrant-docker-nsenter
+
+This plugin allows you to use the `nsenter` command from your host (or from
+your proxy VM if you are on Windows or Mac OS X) to run commands in your
+Vagrant-provisioned Docker containers.
+
+You can run non-interactive commands on all your containers or an interactive
+command on a single container. The command defaults to an interactive
+invocation of `/bin/bash` so that you get a shell in the container.
+
+## Considerations
+
+The default boot2docker proxy VM does not come with nsenter. There
+[an issue open for its inclusion in the boot2docker project](https://github.com/boot2docker/boot2docker/issues/374).
+
+Therefore, at this time, this plugin may only be useful when running a custom
+proxy VM using [the vagrant_vagrantfile or vagrant_machine options](https://docs.vagrantup.com/v2/docker/configuration.html)
+to the Docker provider.
+
+## Getting started
+
+To get started, you need to have Vagrant 1.6+ installed on your host machine.
+To install the plugin, use the following command.
+
+```bash
+vagrant plugin install vagrant-docker-nsenter
+```
+
+## Working with this plugin
+
+The syntax for this command is similar to `vagrant docker-run` in that you
+must put the commands you wish to run after an `--`.
+
+The command will default to running interactively, but you may also specify
+`--no-interactive` to run commands non-interactively.
+
+Output of non-interactive commands defaults to being prefixed with the
+container name. This can be disabled with the `--no-prefix` flag.
+
+Given three containers called `web`, `php`, and `mysql` you can run a single
+non-interactive command on all hosts.
+
+```bash
+$ vagrant docker-nsenter --no-interactive -- hostname
+==> mysql: 6223741bc113
+==> php: 71dca3d53a0f
+==> web: fe1d05768d5b
+```
+
+Or if you did not want prefixed output, add `--no-prefix`.
+
+```bash
+$ vagrant docker-nsenter --no-interactive --no-prefix -- hostname
+6223741bc113
+71dca3d53a0f
+fe1d05768d5b
+```
+
+Finally, if you wanted to get an interactive shell, you can just invoke
+`vagrant docker-nsenter` with the machine name. This will default to running
+`/bin/bash`.
+
+```bash
+$ vagrant docker-nsenter mysql
+root@6223741bc113:/#
+```
+
+## Author
+
+Steven Merrill (@stevenmerrill) wrote this for use at @phase2.

data/Rakefile

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

data/lib/vagrant-docker-nsenter.rb

@@ -0,0 +1,20 @@
+# This file is required because Vagrant's plugin system expects
+# an eponymous ruby file matching the rubygem.
+#
+# So this gem is called 'vagrant-docker-nsenter' and thus vagrant tries
+# to require "vagrant-docker-nsenter"
+
+require "vagrant-docker-nsenter/plugin"
+
+require "pathname"
+
+module VagrantPlugins
+  module DockerNSEnter
+    lib_path = Pathname.new(File.expand_path("../vagrant-docker-nsenter", __FILE__))
+    autoload :Errors, lib_path.join("errors")
+
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-docker-nsenter/command/nsenter.rb

@@ -0,0 +1,95 @@
+module VagrantPlugins
+  module DockerNSEnter
+    module Command
+      class NSEnter < Vagrant.plugin("2", :command)
+        def self.synopsis
+          "Use nsenter to start a command in a running container."
+        end
+
+        def execute
+          options = {}
+          options[:interactive] = true
+          options[:prefix] = true
+
+          opts = OptionParser.new do |o|
+            o.banner = "Usage: vagrant docker-nsenter [command...]"
+            o.separator ""
+            o.separator "Options:"
+            o.separator ""
+
+            o.on("--[no-]interactive", "Run the command interactively") do |i|
+              options[:interactive] = i
+            end
+
+            o.on("--[no-]prefix", "Prefix the output with the machine name") do |p|
+              options[:prefix] = p
+            end
+
+          end
+
+          # Parse out the extra args to send to nsenter, which is everything
+          # after the "--"
+          command     = nil
+          split_index = @argv.index("--")
+          if split_index
+            command = @argv.drop(split_index + 1)
+            @argv   = @argv.take(split_index)
+          end
+
+          # Parse the options
+          argv = parse_options(opts)
+          return if !argv
+
+          # Assume /bin/bash if no command is provided.
+          if !split_index
+            command = ["/bin/bash"]
+          end
+
+          target_opts = { provider: :docker }
+          target_opts[:single_target] = options[:pty]
+
+          with_target_vms(argv, target_opts) do |machine|
+            # Run it!
+            execute_single(machine, options, command)
+          end
+          0
+        end
+
+        protected
+
+        # Gets the PID of the container and then runs the command in it via
+        # "sudo nsenter." Note that boot2docker does not currently ship with
+        # nsenter, so this will only work with other proxy VMs.
+        def execute_single(machine, options, command)
+          # @TODO: Check to see if the proxy VM has `nsenter` installed.
+          pid_command = ["docker", "inspect", "--format", "{{.State.Pid}}", machine.id]
+
+          pid = 0
+          pid_data = ""
+          machine.provider.driver.execute(*pid_command, options) do |type, data|
+            pid_data += data
+          end
+          # @TODO: Error handling.
+          pid = pid_data.to_i.to_s
+
+          nsenter_command = ["sudo", "nsenter", "-m", "-u", "-n", "-i", "-p", "-t", pid, "--"].concat(command)
+
+          # Run this interactively if asked.
+          nsenter_options = options
+          nsenter_options[:stdin] = true if options[:interactive]
+
+          nsenter_data = ""
+          machine.provider.driver.execute(*nsenter_command, nsenter_options) do |type, data|
+            nsenter_data += data
+          end
+
+          output_options = {}
+          output_options[:prefix] = false if !options[:prefix]
+          machine.ui.output(nsenter_data.chomp!, **output_options) if !nsenter_data.empty?
+
+          exit 0 if options[:interactive]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-docker-nsenter/errors.rb

@@ -0,0 +1,16 @@
+require "vagrant"
+
+module VagrantPlugins
+  module DockerNSEnter
+    module Errors
+      class VagrantDockerNSEnterError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_docker_nsenter.errors")
+      end
+
+      class VagrantTooOld < VagrantDockerNSEnterError
+        error_key(:vagrant_16_required)
+      end
+    end
+  end
+end
+

data/lib/vagrant-docker-nsenter/plugin.rb

@@ -0,0 +1,39 @@
+begin
+    require "vagrant"
+rescue LoadError
+    raise "The Vagrant docker-nsenter 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.6.0"
+  raise Errors::VagrantTooOld
+end
+
+module VagrantPlugins
+  module DockerNSEnter
+    class Plugin < Vagrant.plugin("2")
+      name "docker-nsenter"
+      description <<-EOF
+      The vagrant-docker-nsenter plugin lets you run commands in containers
+      that are not running SSH.
+      EOF
+
+      command "docker-nsenter" do
+        require_relative "command/nsenter"
+        #init!
+        Command::NSEnter
+      end
+
+      #protected
+
+      #def self.init!
+        #return if defined?(@_init)
+        #I18n.load_path << File.expand_path(
+          #"templates/locales/providers_docker.yml", Vagrant.source_root)
+        #I18n.reload!
+        #@_init = true
+      #end
+    end
+  end
+end

data/lib/vagrant-docker-nsenter/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module DockerNSEnter
+    VERSION = "0.0.2"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  vagrant_docker_nsenter:
+    errors:
+      vagrant_16_required: |-
+        This plugin requires Vagrant 1.6.0 or newer to function.

data/test.rb

@@ -0,0 +1 @@
+puts @argv.join(" ")

data/vagrant-docker-nsenter.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-docker-nsenter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-docker-nsenter"
+  spec.version       = VagrantPlugins::DockerNSEnter::VERSION
+  spec.authors       = ["Steven Merrill"]
+  spec.email         = ["steven.merrill@gmail.com"]
+  spec.summary       = %q{A way to attach to Vagrant-managed Docker containers.}
+  spec.description   = %q{The docker-nsenter plugin allows you to use the nsenter binary on your host or the Vagrant proxy VM to run commands or get a shell in Vagrant-managed Docker containers.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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,116 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-docker-nsenter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Steven Merrill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: pry
+  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'
+description: The docker-nsenter plugin allows you to use the nsenter binary on your
+  host or the Vagrant proxy VM to run commands or get a shell in Vagrant-managed Docker
+  containers.
+email:
+- steven.merrill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vagrant-docker-nsenter.rb
+- lib/vagrant-docker-nsenter/command/nsenter.rb
+- lib/vagrant-docker-nsenter/errors.rb
+- lib/vagrant-docker-nsenter/plugin.rb
+- lib/vagrant-docker-nsenter/version.rb
+- locales/en.yml
+- test.rb
+- vagrant-docker-nsenter.gemspec
+homepage: ''
+licenses:
+- MIT
+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: 388879333041889696
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 388879333041889696
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A way to attach to Vagrant-managed Docker containers.
+test_files: []