ievms-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67de3c3a94c58726ee5a753a1e9c5a1509b7c138
-  data.tar.gz: 1e223e62dd5612fb16011419ca67fbfabe5ef73e
+  metadata.gz: 05be8b5a8afb70d2e593f3b8a2d760ea8e25ebd9
+  data.tar.gz: 6a8acce20fd1eeaeb9e141ab1285da86f4d1adf2
 SHA512:
-  metadata.gz: 1f372973ee925225d9b9927773ad789ef5baeef43cbb33ef8e9c00dd13e2f681881c6262d918d374e263ccc73e4d461983582bc5404a076e65bd5603db3f5a33
-  data.tar.gz: 1a44d4a319fbcda6a60b1b0cbc5310d8945bff70718f2d90741c26ee70567569847e72050378ed334e777c9cc9d5efb15e0e4c512a12e308b1fd3c5d215e210d
+  metadata.gz: 8a21fd4b8f5229eff45578a52ad4f1c281a0c9566e51f71cc30b42382b0ddf292b618a72cd4416f07194fe5fad9e875a3a7af0194ec84d439f5f860008dd02c8
+  data.tar.gz: a845e9089277fb1d8a773702fbf46a781f7968e822397dbdf8cc659347d35854df38cbd39d468f8eb08dbabb8856bcbd7280a28938a70049e5eadf426db7a57e

data/README.md

@@ -1,33 +1,30 @@
 # ievms-ruby
 
-Ruby interface for boxes made by ievms.sh
-(http://xdissent.github.com/ievms). Use this Library to provision your
+[![Gem Version](https://badge.fury.io/rb/ievms-ruby.svg)](https://badge.fury.io/rb/ievms-ruby)
+[![Code Climate](https://codeclimate.com/github/mipmip/ievms-ruby/badges/gpa.svg)](https://codeclimate.com/github/mipmip/ievms-ruby)
+[![Dependency Status](https://gemnasium.com/mipmip/ievms-ruby.svg)](https://gemnasium.com/mipmip/ievms-ruby)
+
+
+Ruby interface for boxes made by ievms.sh. Use this Library to provision your
 IE boxes from https://modern.ie.
 
+Next ievms.sh ievms-ruby also works great in combination with iectrl.
+
 ## Requirements
 
 * VirtualBox >= 5.0.4
 * VirtualBox Extension Pack and Guest Additions >= 5.0.4
 * Host Machine: OSX or Linux (only tested on OSX 10.9 & 10.10)
-* Virtual Machines created by .ievms (only tested with a vanilla "IE9 -
-  Win7" machine
+* Virtual Machines created by .ievms (only tested with vanilla Win7 machines)
 
-## Working
+## Features
 
 * Works with Windows 7
 * Upload files to guest machine
+* Download file from guest machine
 * Execute batch file on guest machine
 * Execute batch file as admin on guest machine
-
-## TODO 0.1
-
-* upload files as admin to guest machine
-* more IE platforms
-* more Win platforms
-* Use as CLI
-* Documentation
-* provisioning example
-* Rubycop
+* Cat file guest machine from cli
 
 ## Installation
 
@@ -43,11 +40,81 @@ Or install it yourself as:
     $ gem install ievms-ruby
 
 ## Usage
-Here's an example provising script using the Gem:
 
+### From CLI
+After gem install you can call:
+
+```bash
+ievmsrb help
+```
+
+to cat a guest file:
+
+```bash
+ievmsrb cat "IE9 - Win7" 'C:\Windows\System32\Drivers\Etc\hosts'
+```
+
+### As library
+Ievms-ruby very usable as provision tool for windows. E.g. for CI. Here's an example
+provisioning script using the Gem:
+
+```ruby
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'ievms/windows_guest'
+
+class ProvisionIE
+
+  # Create interface for the 'IE9 - Win7' virtual box
+  def init
+    @machine = Ievms::WindowsGuest.new 'IE9 - Win7'
+  end
+
+  # Install the choco package manager (APT for Windows)
+  def install_chocolatey
+    print "Installing Chocolatey\n"
+    choco_install_cmd = '@powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString(\'https://chocolatey.org/install.ps1\'))" && SET PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin '
+    @machine.run_command_as_admin(choco_install_cmd)
+  end
+
+  # Install ruby and git stuff, the reason why we wrote ievms-ruby
+  def install_ruby_and_git
+    %w( ruby msysgit ).each do |pkg|
+      @machine.run_command_as_admin "c:\\ProgramData\\chocolatey\\bin\\choco install -y #{pkg}"
+    end
+  end
+end
+
+provision = ProvisionIE.new
+provision.init
+provision.install_chocolatey
+provision.install_ruby_and_git
 ```
-TODO
+
+## TODO 0.1.x first loud release
+
+* Upload files as admin to guest machine
+* Test More Win platforms
+* Execution time out for exec
+* Rubocop refactoring
+
+## Testing
+
+To run the tests you need top fullfil the testing requirements first:
+
+* VirtualBox >= 5.0.4
+* "IE9 - Win7" installed by ievms.sh 
+* Create an new virtual machine called `standbymachine`. Keep the disk size as
+  small as possible. It should be turned off.
+
 ```
+git clone https://github.com/mipmip/ievms-ruby.git
+cd ievms-ruby
+bundle install
+rake
+```
+
 
 ## Contributing
 

data/bin/ievmsrb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'ievms/windows_guest'
+require 'thor'
+
+class IevmsRb < Thor
+
+  desc "cat [vbox name] [filename]", "cat file in VBox guest"
+  def cat(vbox_name,guest_path)
+    init vbox_name
+
+    print @machine.download_string_from_file_to_guest guest_path, true
+    print "\n"
+  end
+
+  private
+
+  def init vbox_name
+    @machine = Ievms::WindowsGuest.new vbox_name
+  end
+end
+
+IevmsRb.start(ARGV)

data/ievms-ruby.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.10"
   spec.add_development_dependency "minitest", "~> 5.1"
 
+  spec.add_runtime_dependency "thor", "~> 0.19"
 end

data/lib/ievms/version.rb

@@ -1,3 +1,3 @@
 module Ievms
-    VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/ievms/windows_guest.rb

@@ -4,14 +4,14 @@ require 'fileutils'
 require 'tempfile'
 
 # VM admin username
-USERNAME='IEUser'
+USERNAME = 'IEUser'
 # VM admin user password
-PASSWD='Passw0rd!'
+PASSWD = 'Passw0rd!'
 
 # IEVMS directory
 IEVMS_HOME = ENV['HOME']+'/.ievms'
 
-
+# ievms interface
 module Ievms
   class WindowsGuest
     attr_accessor :verbose
@@ -25,79 +25,104 @@ module Ievms
     end
 
     # Copy a file to the virtual machine from the ievms home folder.
-    def copy_to_vm src ,dest
-      print "Copying #{src} to #{dest}\n"
+    def copy_to_vm(src ,dest, quiet=false)
+      print "Copying #{src} to #{dest}\n" unless quiet
       guestcontrol_exec "cmd.exe", "cmd.exe /c copy \"E:\\#{src}\" \"#{dest}\""
     end
 
-    def upload_file_to_guest(local_path, guest_path)
+    # Copy a file to the virtual machine from the ievms home folder.
+    def copy_from_vm(src ,dest, quiet=false)
+      print "Copying #{src} to #{dest}\n" unless quiet
+      guestcontrol_exec "cmd.exe", "cmd.exe /c copy \"#{src}\" \"E:\\#{dest}\""
+    end
 
-      # 1 copy to tmp location in .ievms
-      FileUtils.cp local_path, File.join(IEVMS_HOME,File.basename(local_path))
+    def download_file_from_guest(guest_path, local_path, quiet=false)
 
-      # 2 run cp command in machine
-      copy_to_vm File.basename(local_path), guest_path
+      # 1 run cp command in machine
+      copy_from_vm guest_path, File.basename(local_path), quiet
+
+      # 2 copy to tmp location in .ievms
+      FileUtils.cp File.join(IEVMS_HOME,File.basename(local_path)), local_path
 
       # 3 remove tmp file in .ievms
       FileUtils.rm File.join(IEVMS_HOME,File.basename(local_path))
     end
 
-    # execute existibg batch file in Windows guest as Administrator
-    def run_bat_as_admin(guest_path)
-      print "Executing batch file as administrator: #{guest_path}\n"
+    # Upload a local file to the windows guest
+    def upload_file_to_guest(local_path, guest_path, quiet=false)
 
-      guestcontrol_exec "cmd.exe", "cmd.exe /c \"echo #{guest_path} > C:\\Users\\IEUser\\ievms.bat\""
-      guestcontrol_exec "schtasks.exe", "schtasks.exe /run /tn ievms"
+      # 1 copy to tmp location in .ievms
+      FileUtils.cp local_path, File.join(IEVMS_HOME,File.basename(local_path))
+
+      # 2 run cp command in machine
+      copy_to_vm File.basename(local_path), guest_path, quiet
 
+      # 3 remove tmp file in .ievms
+      FileUtils.rm File.join(IEVMS_HOME,File.basename(local_path))
     end
 
-    # execute existibg batch file in Windows guest as Administrator
-    def run_command_as_admin(command)
-      print "Executing command as administrator: #{command}\n"
+    def download_string_from_file_to_guest( guest_path, quiet=false)
+      copy_from_vm guest_path, 'tmpfile.txt', quiet
+      string = IO.read(File.join(IEVMS_HOME,'tmpfile.txt'))
+      FileUtils.rm File.join(IEVMS_HOME,'tmpfile.txt')
+      string
+    end
 
-      run_command 'if exist C:\Users\IEUser\ievms.bat del C:\Users\IEUser\ievms.bat && Exit'
+    def upload_string_as_file_to_guest(string, guest_path, quiet=false)
 
-      #move to method
-      tmp = Tempfile.new('ievms.bat')
-      tmp.write "#{command}\n"
+      tmp = Tempfile.new('txtfile')
+      tmp.write "#{string}\n"
       path = tmp.path
       tmp.rewind
       tmp.close
-      upload_file_to_guest(path, 'C:\Users\IEUser\ievms.bat')
+
+      upload_file_to_guest(path, guest_path, true)
       FileUtils.rm path
+    end
+
+    # execute existibg batch file in Windows guest as Administrator
+    def run_command_as_admin(command,quiet=false)
+      print "Executing command as administrator: #{command}\n" unless quiet
+
+      run_command 'if exist C:\Users\IEUser\ievms.bat del C:\Users\IEUser\ievms.bat && Exit', true
+
+      upload_string_as_file_to_guest(command, 'C:\Users\IEUser\ievms.bat', true)
 
       guestcontrol_exec "schtasks.exe", "schtasks.exe /run /tn ievms"
 
+      while schtasks_query_ievms.include? 'Running'
+        print "."
+        sleep 2
+      end
+      print "\n"
     end
 
     # execute existing batch file in Windows guest
-    def run_command command
-      print "Executing command: #{command}\n"
+    def run_command(command, quiet=false)
+      print "Executing command: #{command}\n" unless quiet
       out, _, _ = guestcontrol_exec "cmd.exe", "cmd.exe /c \"#{command}\""
-      return out
+      out
     end
 
-    # execute existibg batch file in Windows guest
-    def run_bat guest_path
-      print "Executing batch file: #{guest_path}\n"
-      out, _, _ = guestcontrol_exec "cmd.exe", "cmd.exe /c \"#{guest_path}\""
-      return out
+    def schtasks_query_ievms
+      out, _, _ = guestcontrol_exec "schtasks.exe", "schtasks.exe /query /tn ievms"
+      out
     end
 
     private
 
     # execute final guest control shell cmd
     # returns [stdout,stderr,status] from capture3
-    def guestcontrol_exec image, cmd
+    def guestcontrol_exec(image, cmd)
       wait_for_guestcontrol(@vbox_name)
       cmd = "VBoxManage guestcontrol \"#{@vbox_name}\" run --username \"#{USERNAME}\" --password '#{PASSWD}' --exe \"#{image}\" -- #{cmd}"
-      #print cmd + "\n"
+    #  print cmd + "\n"
       return Open3.capture3(cmd)
     end
 
     # function taken from ievms
     # Pause execution until guest control is available for a virtual machine
-    def wait_for_guestcontrol vboxname
+    def wait_for_guestcontrol(vboxname)
       run_level = 0
       while run_level < 3 do
         print "Waiting for #{vboxname} to be available for guestcontrol...\n" if @verbose
@@ -110,7 +135,7 @@ module Ievms
     end
 
     # Is it a virtual machine in VirtualBox?
-    def is_vm vboxname
+    def is_vm(vboxname)
       cmd = "VBoxManage showvminfo \"#{vboxname}\""
 
       _, stderr, _ = Open3.capture3(cmd)

data/test/test_ievms_win7.rb

@@ -25,13 +25,36 @@ class TestWin7 < Minitest::Test
 
   end
 
+  def test_long_admin_cmd
+    @machine.run_command_as_admin 'ping 127.0.0.1 -n 6 > nul'
+  end
+
+  def test_upload_string_as_file
+    @machine.run_command 'if exist C:\Users\IEUser\testfile.txt del C:\Users\IEUser\testfile.txt && Exit'
+
+    content = <<eos
+String is uploaded with ievms-ruby
+
+ohhh yeah....
+eos
+    @machine.upload_string_as_file_to_guest(content, 'C:\Users\IEUser\testfile.txt')
+    assert_equal true, @machine.download_string_from_file_to_guest('C:\Users\IEUser\testfile.txt').include?('ohhh yeah')
+  end
+
+  def test_download_file_from_guest
+    FileUtils.rm '/tmp/testdlfile.txt' if File.exists? '/tmp/testdlfile.txt'
+    @machine.download_file_from_guest('C:\ievms.xml', '/tmp/testdlfile.txt')
+    assert_equal true, File.exists?('/tmp/testdlfile.txt')
+  end
+
   def test_execute_batch_file
 
     @machine.run_command 'if exist C:\Users\IEUser\test.bat del C:\Users\IEUser\test.bat && Exit'
     @machine.run_command 'if exist C:\Users\IEUser\EmptyFile.txt del C:\Users\IEUser\EmptyFile.txt && Exit'
 
     @machine.upload_file_to_guest(File.join(File.dirname(__FILE__), '_test.bat'), 'C:\Users\IEUser\test.bat')
-    @machine.run_bat('C:\Users\IEUser\test.bat')
+    @machine.run_command('C:\Users\IEUser\test.bat')
+    #@machine.run_bat('C:\Users\IEUser\test.bat')
     output_file_exists = @machine.run_command 'if exist C:\Users\IEUser\EmptyFile.txt echo EmptyFileExist && Exit'
 
     assert_equal true, output_file_exists.include?('EmptyFileExist')
@@ -48,7 +71,8 @@ class TestWin7 < Minitest::Test
     @machine.run_command_as_admin 'if exist C:\EmptyFile2.txt del C:\EmptyFile2.txt && Exit'
 
     @machine.upload_file_to_guest(File.join(File.dirname(__FILE__), '_test_as_admin.bat'), 'C:\Users\IEUser\test_as_admin.bat')
-    @machine.run_bat_as_admin('C:\Users\IEUser\test_as_admin.bat')
+    @machine.run_command_as_admin('C:\Users\IEUser\test_as_admin.bat')
+#    @machine.run_bat_as_admin('C:\Users\IEUser\test_as_admin.bat')
     output_file_exists = @machine.run_command 'if exist C:\EmptyFile2.txt echo EmptyFile2Exist && Exit'
 
     assert_equal true, output_file_exists.include?('EmptyFile2Exist')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ievms-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pim Snel
@@ -66,10 +66,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: Ruby interface for boxes made by ievms.sh (http://xdissent.github.com/ievms)
 email:
 - pim@lingewoud.nl
-executables: []
+executables:
+- ievmsrb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -78,6 +93,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/ievmsrb
 - ievms-ruby.gemspec
 - lib/ievms/version.rb
 - lib/ievms/windows_guest.rb