vagrant-docker-exec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5198d96cebf4c78b519b45f40a017d51cb4dea26
+  data.tar.gz: 9c42a1eb45c0352c5e234871ad11dfc24268eb3b
+SHA512:
+  metadata.gz: b28359a1de1c549285c0c686ae95c6ec68bde4447c601affad0ac5c2a6dbd144d9f5b340a23bf42799bd3522b421b3b613b00acb17a4435dc17aeb319d7cd81c
+  data.tar.gz: 6199d68ef06414df4e53f90df2779a153aab5a5a6fa3a8a1f38decf6501f0fe5542ca86bd6cda0ef5043053dcf565644c538f043b0f08811e0ac76f18198509d

data/.gitignore

@@ -0,0 +1,5 @@
+.vagrant
+Gemfile.lock
+Vagrantfile
+Vagrantfile.proxy
+www

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+	gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-docker-exec", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 William Kolean
+
+MIT License
+
+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,43 @@
+# vagrant-docker-exec
+
+This plugin allows you to run `docker exec` on a running container.
+
+## Known Issues
+
+Docker exec requires Docker 1.3.0 or higher. boot2docker provided by Vagrant is version 1.2 and does not support exec, so a proxy VM is required to use
+this plugin until boot2docker is updated.
+
+This plugin has been tested on Mac OS X.
+
+## Getting Started
+
+To install the plugin, run the following command:
+```bash
+vagrant plugin install vagrant-docker-exec
+```
+
+## Usage
+
+```bash
+vagrant docker-exec [options] [container] -- [command] [args]
+```
+--[no-]detach Run in the background
+
+-t, --[no-]tty Open an interactive shell
+
+To create a new file in a container named `nginx`
+
+```bash
+vagrant docker-exec nginx -- touch /var/www/html/test.html
+```
+
+To open an interactive shell in a conatiner named `nginx`
+
+```bash
+vagrant docker-exec -t nginx -- bash
+```
+
+To simplify opening a shell, you can use the shortcut `vagrant docker-shell [container]`
+
+## Author
+William Kolean william.kolean@gmail.com

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/lib/vagrant-docker-exec.rb

@@ -0,0 +1,17 @@
+require "pathname"
+
+require "vagrant-docker-exec/plugin"
+
+module VagrantPlugins
+  module DockerExec
+    lib_path = Pathname.new(File.expand_path("../vagrant-docker-exec", __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-docker-exec/command/exec.rb

@@ -0,0 +1,85 @@
+module VagrantPlugins
+  module DockerExec
+    class Command < Vagrant.plugin("2", "command")
+      def self.synopsis
+        "run a new command in a running docker container"
+      end
+
+      def execute
+        options = {}
+        options[:detach] = false
+        options[:pty] = false
+
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant docker-exec [command...]"
+          o.separator ""
+          o.separator "Options:"
+          o.separator ""
+
+          o.on("--[no-]detach", "Run in the background") do |d|
+            options[:detach] = d
+          end
+
+          o.on("-t", "--[no-]tty", "Allocate a pty") do |t|
+            options[:pty] = t
+          end
+        end
+
+        # Parse out the extra args to send to SSH, 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
+
+        # Show the error if we don't have "--" _after_ parse_options
+        # so that "-h" and "--help" work properly.
+        if !split_index
+          @env.ui.error(I18n.t("vagrant_docker_exec.exec_command_required"))
+          return 1
+        end
+
+        target_opts = { provider: :docker }
+        target_opts[:single_target] = options[:pty]
+
+        with_target_vms(argv, target_opts) do |machine|
+          if machine.state.id != :running
+            @env.ui.info("#{machine.name} is not running.")
+            next
+          end
+
+          # Run it!
+          exec_command(machine, options, command)
+        end
+
+        return 0
+      end
+
+      def exec_command(machine, options, command)
+
+        exec_cmd = %W(docker exec)
+        exec_cmd << "-i" << "-t" if options[:pty]
+        exec_cmd << options[:name]
+        exec_cmd += options[:extra_args] if options[:extra_args]
+        exec_cmd.concat(command)
+
+        # Run this interactively if asked.
+        exec_options = options
+        exec_options[:stdin] = true if options[:pty]
+
+        output = ""
+        machine.provider.driver.execute(*cmd, exec_options) do |type, data|
+          output += data
+        end
+
+      end
+
+    end
+  end
+end

data/lib/vagrant-docker-exec/command/shell.rb

@@ -0,0 +1,42 @@
+module VagrantPlugins
+  module DockerExec
+    class Command < Vagrant.plugin("2", "command")
+      def self.synopsis
+        "open a shell in a running docker container"
+      end
+
+      def execute
+
+        options = {}
+        options[:detach]  = false
+        options[:pty]     = true
+        options[:stdin]   = true
+
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant docker-shell [container]"
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return if !argv
+
+        target_opts = { provider: :docker }
+        target_opts[:single_target] = options[:pty]
+
+        with_target_vms(argv, target_opts) do |machine|
+          command = ["docker", "exec", "-it"]
+          command << machine.name.to_s
+          command << "bash"
+          
+          output = ""
+          machine.provider.driver.execute(*command, options) do |type, data|
+            output += data
+          end
+        end
+
+        return 0
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "This plugin must run within Vagrant."
+end
+
+module VagrantPlugins
+  module DockerExec
+    class Plugin < Vagrant.plugin("2")
+      name "docker-exec"
+      description "The vagrant-docker-exec plugin lets you run commands in a docker container"
+
+      command "docker-exec" do
+        require_relative "command/exec"
+        Command
+      end
+
+      command "docker-shell" do
+        require_relative "command/shell"
+        Command
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", DockerExec.source_root)
+        I18n.reload!
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module DockerExec
+  	VERSION = "0.1.0"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  vagrant_docker_exec :
+    exec_command_required |-
+      `vagrant docker-exec` requires a command to execute. This command
+      must be specified after a `--` in the command line. This is used
+      to separate machine name and options from the actual command to
+      execute. An example is show below:
+
+        vagrant docker-exec web -- rails new .

data/vagrant-docker-exec.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-docker-exec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-docker-exec"
+  spec.version       = VagrantPlugins::DockerExec::VERSION
+  spec.authors       = ["William Kolean"]
+  spec.email         = ["william.kolean@gmail.com"]
+  spec.summary       = %q{docker-exec runs a new command in a running container.}
+  spec.description   = %q{Vagrant plugin adding the command docker-exec [options] container -- [command] which invokes `docker exec` to run a command in a running container.}
+  spec.homepage      = "https://github.com/wkolean/vagrant-docker-exec"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-docker-exec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Kolean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Vagrant plugin adding the command docker-exec [options] container --
+  [command] which invokes `docker exec` to run a command in a running container.
+email:
+- william.kolean@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-docker-exec.rb
+- lib/vagrant-docker-exec/command/exec.rb
+- lib/vagrant-docker-exec/command/shell.rb
+- lib/vagrant-docker-exec/plugin.rb
+- lib/vagrant-docker-exec/version.rb
+- locales/en.yml
+- vagrant-docker-exec.gemspec
+homepage: https://github.com/wkolean/vagrant-docker-exec
+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: docker-exec runs a new command in a running container.
+test_files: []