vgrnt 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ec9d0aba10f8e4965ff0be10e8734933faa88c0
-  data.tar.gz: a3434a03c3abe317c00a78cda479be664aa9e3cd
+  metadata.gz: f8323a806adea255394c51d19b359c5ceb3f19be
+  data.tar.gz: e5f2a0f951de3281b168fdf4c773e450be3a40c8
 SHA512:
-  metadata.gz: 1e73e399f049fbf2c68312e1b7ea5c55e9d22ae6dd21cc7f5cea59aba198d943493019014fe642ff4bfce9e9e6d14bff30d81bc9d6d8c70d90a24ee367ba88db
-  data.tar.gz: 6527718cba50263df9bafcf60aa40fed17f74eae4ea2c6d428b7383b2ceb4906503cb2f3e4eb045439de3623c03281676da206ed8a039ad3868a9d759044eaaf
+  metadata.gz: b9b1c2561570adcb5348d37e6d6d697b3d595ed7b7aa4d86eac7417aeb73f0f4953076090e52b9d0711d5f95bade4c3be903d1f784a9675b3bda1eef41081f51
+  data.tar.gz: 284e2a10e4d795c60f62cd33c52173553b916eb3fdedfda8afede4ccee657245c5cc444c31f791e5bc86f77ebd34c63dabf2e35f18a088419d9c2858f1ff46db

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.0.5](https://github.com/dergachev/vagrant/compare/v0.0.4...v0.0.5) (Dec 10, 2013)
+
+FEATURES:
+
+  - Added 'vgrnt np' support.
+
+IMPROVEMENTS:
+
+  - Refactored codebase a bit:
+    - Extracted shelling out logic into Vgrnt::Util::Exec
+    - Extracted logger helpers into Vgrnt::Util::Logger
+    - Improved Vgrnt::Util::Exec to allow capturing of stderr for testing
+
 ## [0.0.4](https://github.com/dergachev/vagrant/compare/v0.0.3...v0.0.4) (Dec 3, 2013)
 
 BUGFIX:

data/README.md

@@ -77,6 +77,16 @@ vgrnt vboxmanage metrics query VM_ID
 # =>    VBoxManage metrics query 0398e43a-d35f-4c84-bc81-6807f5d11262
 ```
 
+### vgrnt np
+
+Same as `VAGRANT_NO_PLUGINS=1 vagrant <args>`. Useful for speeding up any
+command `vgrnt` doesn't support.
+
+```
+vgrnt np provision
+# Executing "VAGRANT_NO_PLUGINS=1 vagrant provision"
+```
+
 ## Installation
 
 vgrnt *should not* be installed as a vagrant plugin. Instead, just install the gem:

data/docs/DEVNOTES.md

@@ -12,7 +12,7 @@ cd ~/code/vgrnt
 
 # after making code changes, increment version number, build the gem locally
 vim lib/vgrnt/version.rb +/VERSION # increment version counter, eg to 0.0.3
-rake build  # package the gem into ./pkg/vgrnt-0.0.3.gem
+bundle exec rake build  # package the gem into ./pkg/vgrnt-0.0.3.gem
 
 # install and test the gem locally
 gem uninstall vgrnt
@@ -24,8 +24,7 @@ vgrnt ssh -- ls /
 vim CHANGELOG.md      # add v0.0.3 details
 git commit -m "Publishing v0.0.3" CHANGELOG.md lib/vgrnt/version.rb
 
-rake release
-git push --tags
+bundle exec rake release
 ```
 
 ## Creating a gem

data/lib/vgrnt/base.rb

@@ -1,28 +1,12 @@
 require 'thor'
 require 'open3'
+require 'vgrnt/util/logger'
 require 'vgrnt/util/virtualbox'
 require 'vgrnt/util/vagrantfile'
+require 'vgrnt/util/exec'
 
-module Vgrnt
-  class Logger
-
-    def stdout(str)
-      $stdout.puts str unless str.empty?
-    end
-
-    def notice(str)
-      $stderr.puts str unless str.empty?
-    end
 
-    def debug(str)
-      $stderr.puts str if !str.empty? && ENV['VAGRANT_LOG'] == 'debug'
-    end
-
-    def error(str)
-      # terminal codes for red
-      $stderr.puts "\e[31m" + str + "\e[0m" unless str.empty?
-    end
-  end
+module Vgrnt
 
   #  Undoes the automatic removal of -- in Thor::Options.peek. Otherwise "vgrnt ssh precise -- ls /"
   #  is parsed as "precise ls /". TODO: is there a less hacky way to handle this?
@@ -32,12 +16,11 @@ module Vgrnt
     end
   end
 
-
   class App < Thor
 
     def initialize(*args)
       super(*args)
-      @logger = Logger.new
+      @logger = Vgrnt::Util::Logger
     end
 
     desc "ssh [vm-name] [-- extra ssh args]", "Runs vagrant ssh without bootstrapping vagrant."
@@ -74,14 +57,7 @@ module Vgrnt
         end
       end
 
-      # Using IO.popen is important:
-      # - POpen3 ignores STDIN. Backticks buffer stdout. Kernel::exec breaks rspec.
-      # - getc instead of gets fixes the 1 line lag.
-      IO.popen(ssh_command) do |io|
-        while c = io.getc do 
-          putc c
-        end
-      end
+      Vgrnt::Util::Exec.popen(ssh_command)
     end
 
     desc "ssh-config [vm-name]", "Store output of 'vagrant ssh-config' to .vgrnt-sshconfig"
@@ -114,6 +90,13 @@ module Vgrnt
       end
     end
 
+    desc "np [args]", "Executes 'VAGRANT_NO_PLUGINS=1 vagrant [args ...]'"
+    def np(*args)
+      command = (["VAGRANT_NO_PLUGINS=1", "vagrant" ] + args).join(" ")
+      Vgrnt::Util::Exec.popen(command)
+    end
+
+
     # desc "provision", "Run vagrant provision like last time"
     # def provision
     #   raise "Not implemented yet. Likely requires creating vagrant-vgrnt."
@@ -166,10 +149,7 @@ module Vgrnt
 
       @logger.debug "Executing: #{command}"
       #TODO: windows support (path to VBoxManage.exe")
-      Open3.popen3(command) do |stdin, stdout, stderr|
-        @logger.stdout stdout.read
-        @logger.error stderr.read
-      end
+      Vgrnt::Util::Exec.popen(command)
     end
   end
 end

data/lib/vgrnt/util/exec.rb

@@ -0,0 +1,31 @@
+module Vgrnt
+  module Util
+    module Exec
+      # used when wanting pass STDIN without buffering
+      def self.popen(command)
+        # Using IO.popen is important:
+        # - Open3.popen3 ignores STDIN. Backticks buffer stdout. Kernel::exec breaks rspec.
+        # - getc instead of gets fixes the 1 line lag.
+        IO.popen(command) do |io|
+          while c = io.getc do 
+            putc c
+          end
+        end
+      end
+      
+      # used when we want to capture stdout, stderr separately and don't care about buffering on stdin
+      def self.popen3(command, logger = Vgrnt::Util::Logger)
+        Open3.popen3(command) do |stdin, stdout, stderr|
+          logger.stdout stdout.read
+          logger.error stderr.read
+        end
+      end
+      
+      def self.exec(command)
+        raise "NOT IMPLEMENTED"
+        # FIXME: stop using exec, it's too hard to test without stubbing
+        exec(command)
+      end
+    end
+  end
+end

data/lib/vgrnt/util/logger.rb

@@ -0,0 +1,23 @@
+module Vgrnt
+  module Util
+    class Logger
+
+      def self.stdout(str)
+        $stdout.puts str unless str.empty?
+      end
+
+      def self.notice(str)
+        $stderr.puts str unless str.empty?
+      end
+
+      def self.debug(str)
+        $stderr.puts str if !str.empty? && ENV['VAGRANT_LOG'] == 'debug'
+      end
+
+      def self.error(str)
+        # terminal codes for red
+        $stderr.puts "\e[31m" + str + "\e[0m" unless str.empty?
+      end
+    end
+  end
+end

data/lib/vgrnt/version.rb

@@ -1,3 +1,3 @@
 module Vgrnt
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/acceptance/app_spec.rb

@@ -16,6 +16,11 @@ describe Vgrnt::App do
         output = vagrant_stdout { Vgrnt::App.start(%w{ssh -- whoami}) }
         expect(output).to eq "vagrant\n"
       end
+
+      it 'preserves stderr' do
+        output = vagrant_stderr { Vgrnt::App.start(%w{ssh -- grep --bob }) }
+        expect(output).to include "grep: unrecognized option '--bob'"
+      end
     end
 
     describe "#ssh-config", :slow do
@@ -26,6 +31,7 @@ describe Vgrnt::App do
       it 'with default VM specified explicitly' do
         expect( in_vagrant_env { File.exists? '.vgrnt-sshconfig' } ).to be_false
         stderr = vagrant_stderr { Vgrnt::App.start(%w{ssh-config default}) }
+        expect(stderr).to include "Created ./.vgrnt-sshconfig with the following: Host default"
         expect( in_vagrant_env { File.exists? '.vgrnt-sshconfig' } ).to be_true
       end
 
@@ -68,6 +74,17 @@ describe Vgrnt::App do
         expect(vgrnt_output).to include(vagrant_output)
       end
     end
+
+    describe "#np" do
+      it "'np status' is identical to 'vagrant status'", :slow do
+        # default                   saved (virtualbox)
+        vagrant_output = vagrant_stdout { puts `VAGRANT_NO_PLUGINS=1 vagrant status | grep '(virtualbox)$'` }
+        expect(vagrant_output).to match /default +running \(virtualbox\)/
+
+        vgrnt_output = vagrant_stdout { Vgrnt::App.start(%w{np status}) }
+        expect(vgrnt_output).to include(vagrant_output)
+      end
+    end
   end
 
   context "when running from ./spec/acceptance/fixtures/neveron" do

data/spec/acceptance/support/acceptance_helper.rb

@@ -28,6 +28,9 @@ module AcceptanceExampleGroup
   end
 
   def vagrant_stderr(&block)
+    # stubbing because IO.popen in Vgrnt::Util::Exec prevents stderr from being capturable.
+    Vgrnt::Util::Exec.stub(:popen) { |cmd| Vgrnt::Util::Exec.popen3(cmd) }
+
     capture_in_vagrant_env(:stderr, &block)
   end
 

data/spec/unit/app_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Vgrnt::App do
+  describe "#np" do
+    it 'executes correctly' do
+      Vgrnt::Util::Exec.stub(:popen) { |arg| arg }
+      output = Vgrnt::App.start(%w{np ssh default -- whoami})
+      expect(output).to eq "VAGRANT_NO_PLUGINS=1 vagrant ssh default -- whoami"
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vgrnt
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alex Dergachev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -85,6 +85,8 @@ files:
 - docs/vboxmanage-irregular-commands.txt
 - lib/vgrnt.rb
 - lib/vgrnt/base.rb
+- lib/vgrnt/util/exec.rb
+- lib/vgrnt/util/logger.rb
 - lib/vgrnt/util/vagrantfile.rb
 - lib/vgrnt/util/virtualbox.rb
 - lib/vgrnt/version.rb
@@ -95,6 +97,7 @@ files:
 - spec/acceptance/support/acceptance_helper.rb
 - spec/acceptance/util_spec.rb
 - spec/spec_helper.rb
+- spec/unit/app_spec.rb
 - spec/unit/fixtures/util_vagrantfile/Vagrantfile-misc1
 - spec/unit/fixtures/util_vagrantfile/Vagrantfile-multi
 - spec/unit/fixtures/util_vagrantfile/Vagrantfile-plugins
@@ -133,6 +136,7 @@ test_files:
 - spec/acceptance/support/acceptance_helper.rb
 - spec/acceptance/util_spec.rb
 - spec/spec_helper.rb
+- spec/unit/app_spec.rb
 - spec/unit/fixtures/util_vagrantfile/Vagrantfile-misc1
 - spec/unit/fixtures/util_vagrantfile/Vagrantfile-multi
 - spec/unit/fixtures/util_vagrantfile/Vagrantfile-plugins