console-launcher 0.0.8 → 0.0.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzdlYmU5NTgzZmI5NTlmYzdhYmZiYmQ2OGMwNzQ3MmRmNDA2YjkzNg==
+    NTU4NDAyMmFiMTAwNDZjYjNiODRkMTRmODg1MDcxOGFhZjNhYjFkMg==
   data.tar.gz: !binary |-
-    MDU4Y2JlNmIxODI1OGE4ODE3Njg2NzJiNzg3OGFmZjFjODA3ZDU5Yw==
+    YjQ2ODFhMWNjZWIwNTg3ZjQ0MzIyMmRkNjFjMWJhZTFlNDIxODk5ZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YmE0YTFkMWRjZGQ4NjUwZTkzYzcxOWYyYWQ3NTE1ZDY0MTVjMWUyNTJmNjFk
-    ZmM5MmM1MTZkN2M5NWE3MDVhZTg2NzIyZDZmZWM3OTZiMjZkNzlkNTc0YWZm
-    ZTUyN2M0NTU2N2ZiMTEyZmFlNjFkZWJiZDk4YWU2Yjg2YjhmNWM=
+    MTQ4MDA2ZjEwZDAyZWJmZDMyYzgxMDliNGVkZDNjOWYwOGMzNWNmMmM1Y2U0
+    ZjdjYmU2MGEzYzc4ZDZiNDI0OWRjYjVjZTkyMjRmYzMzZDViYmFjZTFiNzFk
+    MzkxZmEzZjcyMDNmNjJlMTlmMWUyODExYTQ5ZjhmNTg0NmE4Njc=
   data.tar.gz: !binary |-
-    ZGUzYmM3NTRhNTVlYmJlYWI4NjQwZDMxY2Q5YmQ1YzZlYzMzNGQwZGYyYzY3
-    ZDgyYjIyNjBiMTUzZTZkMThjODg5YzVmZDdjN2FjMjQ3NWRlYTlkMTE2ZTli
-    ZDJmNGFlMTc3NTNjMDdlZmM3ZGY1MTI3YjY1MTFhZDI0NmVkMDk=
+    ZWYzM2U2ZWFjZDlkMWQ3MjhjMWM4MDBjOWE5OTg1ODIxZmU1YTA3MTQ2NzIx
+    ZTE2YzE2NzgxN2Y5MzkyMjI0ZGVmMzZlNTYwNmQyODhkNjYzZTMwYzM4Y2M4
+    Zjg5NTUwMDc0ZmQ5ODdkYWVlY2JjZWM3ZDIyYjBkNGRmMWRiN2M=

data/bin/console-launcher

@@ -35,45 +35,30 @@ require 'optparse'
 require 'yaml'
 include Helper
 
-options = {
-    print: false,
-    dryrun: false,
-    host: nil,
-    user: "admin@internal",
-    pass: nil
-}
-
-CONFIG_FILE = File.join(ENV['HOME'], '.config-launcher.rc.yaml')
-if File.exists? CONFIG_FILE
-  config_options = YAML.load_file(CONFIG_FILE)
-  options.merge!(config_options)
-else
-  File.open(CONFIG_FILE, 'w') { |file| YAML::dump(options, file) }
-  STDERR.puts "Initialized configuration file in #{CONFIG_FILE}"
-end
+Helper.load_options
 
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
 
   opts.on('--print', 'Print the command that is called to launch the Console Session') do
-    options[:print] = true
+    Helper::OPTIONS[:print] = true
   end
 
   opts.on('-d', '--dry-run', 'Do not execute the Remote Viewer Application') do
-    options[:dryrun] = true
+    Helper::OPTIONS[:dryrun] = true
   end
 
   opts.on('-h', '--host HOSTNAME', 'The Hostname of your RHEV-M Installation') do |host|
-    options[:host] = strip_url(host)
+    Helper::OPTIONS[:host] = strip_url(host)
   end
 
   opts.on('-u', '--username USERNAME', 'The Username used to establish the connection to --host (defaults to admin@internal)') do |u|
-    options[:user] = u
+    Helper::OPTIONS[:user] = u
   end
 
   opts.on('-p', '--password PASSWORD', 'The Password used to establish the connection to --host') do |pass|
-    options[:pass] = pass
+    Helper::OPTIONS[:pass] = pass
   end
 
   # This displays the help screen, all programs are
@@ -102,15 +87,15 @@ end
 # the @options. What's left is the list of files to resize.
 optparse.parse!
 
-if options[:host] == nil
+if Helper::OPTIONS[:host] == nil
   puts "ERROR: You have to configure RHEV-M Hostname to connect to"
   puts optparse.help
   exit 1
 end
 
-options[:pass] = get_password() if options[:pass] == nil
+Helper::OPTIONS[:pass] = get_password() if Helper::OPTIONS[:pass] == nil
 
-rhevm = RhevManager.new(options[:host], options[:user], options[:pass])
+rhevm = RhevManager.new(Helper::OPTIONS[:host], Helper::OPTIONS[:user], Helper::OPTIONS[:pass])
 
 while true do
   begin
@@ -118,7 +103,7 @@ while true do
 
     # Print the selection to the User
     puts
-    puts "Running Virtual Machines found for #{options[:host]}:"
+    puts "Running Virtual Machines found for #{Helper::OPTIONS[:host]}:"
     vms.each_with_index do |v, index|
       puts "#{index+1}. Name: #{v.name} Description: #{v.description} State: #{v.state}"
     end
@@ -140,8 +125,8 @@ while true do
 
     if (1..vms.size).member?(index)
       command = rhevm.launch_viewer(index)
-      puts command if options[:print]
-      unless options[:dryrun]
+      puts command if Helper::OPTIONS[:print]
+      unless Helper::OPTIONS[:dryrun]
         pid = Process.fork
 
         if pid.nil?

data/lib/console-launcher.rb

@@ -12,6 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Author::    Juergen Hoffmann  (mailto:buddy@redhat.com)
+# Author::    Vinny Valdez  (mailto:vvaldez@redhat.com)
+# Author::    Thomas Crowe  (mailto:tcrowe@redhat.com)
+# Copyright:: Copyright (c) 2013 Red Hat Inc.
+# License::   http://www.apache.org/licenses/LICENSE-2.0
+
 require 'rubygems'
 require 'rest_client'
 require 'xmlsimple'
@@ -19,121 +25,168 @@ require 'tmpdir' # required to download the certificate files on they fly
 require 'net/http'
 require 'highline/import' # Secure Password Prompting if a user does not provide it when the script is called
 require 'rhev-manager/virtual-machine'
+require 'rbconfig'
+
+# This class provides utility methods to encapsulates RESTful access to the RHEV Manager.
+# Since the returned response is in XML this class transforms the XML Response into Ruby Objects.
+
+class RhevManager
+
+  TMP_DIR = Dir.tmpdir
+
+  def initialize(host, user, password)
+    @host = host
+    @user = user
+    @pass = password
+
+    # Create a little helper object that we will use to
+    # make connections to the REST API
+    @rhevm = RestClient::Resource.new(
+        "https://" + @host,
+        :user => @user,
+        :password => @pass,
+        :ssl_ca_cert => @cert,
+        :ssl_version => "SSLv3",
+        :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
+    get_cert
+  end
 
-  class RhevManager
-
-    TMP_DIR = Dir.tmpdir
-
-    def initialize(host, user, password)
-      @host = host
-      @user = user
-      @pass = password
-
-      # Create a little helper object that we will use to
-      # make connections to the REST API
-      @rhevm = RestClient::Resource.new(
-          "https://" + @host,
-          :user => @user,
-          :password => @pass,
-          :ssl_ca_cert => @cert,
-          :ssl_version => "SSLv3",
-          :verify_ssl => OpenSSL::SSL::VERIFY_NONE)
-      get_cert
-    end
-
-    def get_cert()
-      # download the certificate file on the fly
-      begin
-        cert = File.new(TMP_DIR + "/" + @host + ".crt", "w+")
-        Net::HTTP.start(@host) do |http|
-          begin
-            http.request_get('/ca.crt') do |resp|
-              resp.read_body do |segment|
-                cert.write(segment)
-              end
+  # Download the Server SSL Certificate file on the fly
+  def get_cert()
+    begin
+      cert = File.new(TMP_DIR + "/" + @host + ".crt", "w+")
+      Net::HTTP.start(@host) do |http|
+        begin
+          http.request_get('/ca.crt') do |resp|
+            resp.read_body do |segment|
+              cert.write(segment)
             end
-          ensure
-            cert.close()
           end
+        ensure
+          cert.close()
         end
-        @cert = cert.path
-      rescue => e
-        raise "There has been an error downloading the certificate file from #{@host}: #{e.message}"
       end
+      @cert = cert.path
+    rescue => e
+      raise "There has been an error downloading the certificate file from #{@host}: #{e.message}"
     end
+  end
 
-    def get_vms()
-      @vms = Array.new # Clear out array
-                       # get the vms api and get the list of vms
-      vms_data = XmlSimple.xml_in(@rhevm["/api/vms"].get.body, {'ForceArray' => false})
-
-      # Iterate through the VM's and get all the
-      # required information
-      vms_data['vm'].each do |vm|
-        # Making sure we only consider VM's that are in state up (so they do have a console to connect to)
-        # and that have the spice protocol enabled as the connection mode
-        if vm['status']['state'] == "up" && vm['display']['type'] == "spice"
-          @vms.push(VirtualMachine.new(vm))
-        end
-      end
-      return @vms
-    end
+  # Returns an array of VirtualMachine ruby objects that are running on the RHEV Manager
 
-    def launch_viewer(index)
-      vm = @vms[index-1]
-
-      # let us no gather the host subject
-      hosts_data = XmlSimple.xml_in(@rhevm["/api/hosts/"+vm.host_uuid].get.body, {'ForceArray' => false})
-      host_subject = hosts_data['certificate']['subject']
-
-      ticket_data = XmlSimple.xml_in(@rhevm["/api/vms/" + vm.id + "/ticket"].post("<action><ticket><expiry>30</expiry></ticket></action>", :content_type => 'application/xml').body, {'ForceArray' => false})
-      password = ticket_data['ticket']['value']
-
-      # Creating the .vv File for the connection
-      # download the certificate file on the fly
-      @vv = File.new(TMP_DIR + "/" + vm.name + ".vv", "w+")
-      begin
-        @vv.puts("[virt-viewer]")
-        @vv.puts("type=spice")
-        @vv.puts("host=#{vm.address}")
-        @vv.puts("port=#{vm.port}")
-        @vv.puts("password=#{password}")
-        @vv.puts("tls-port=#{vm.secure_port}")
-        @vv.puts("fullscreen=0")
-        @vv.puts("title=vm:#{vm.name} - %d - Press SHIFT+F12 to Release Cursor")
-        @vv.puts("enable-smartcard=0")
-        @vv.puts("enable-usb-autoshare=1")
-        @vv.puts("usb-filter=-1,-1,-1,-1,0")
-        @vv.puts("host-subject=#{host_subject}")
-        @vv.puts("toggle-fullscreen=shift+f11")
-        @vv.puts("release-cursor=shift+f12")
-      ensure
-        @vv.close()
-      end
+  def get_vms()
+    @vms = Array.new # Clear out array
+
+    # get the vms api and get the list of vms
+    vms_data = XmlSimple.xml_in(@rhevm["/api/vms"].get.body, {'ForceArray' => false})
 
-      # Now that we have all the information we can print the cmd line
-      puts "Console to VM: #{vm.name} state: #{vm.state} is started"
+    # Iterate through the VM's and get all the
+    # required information
+    vms_data['vm'].each do |vm|
+      # Making sure we only consider VM's that are in state up (so they do have a console to connect to)
+      # and that have the spice protocol enabled as the connection mode
+      if vm['status']['state'] == "up" && vm['display']['type'] == "spice"
+        @vms.push(VirtualMachine.new(vm))
+      end
+    end
+    return @vms
+  end
 
-      command = "/Applications/RemoteViewer.app/Contents/MacOS/RemoteViewer --spice-ca-file #{@cert} #{@vv.path}"
+  # This method takes an index that is used to query the VirtualMachine Array for the VM that is supposed to
+  # be started. It then queries the RHEV Manager for the correct subject and then requests a ticket for the
+  # console session.
+  # It then creates a .vv file that is used to be passed to the RemoteViewer Application. It returns the command
+  # to be launched because we fork the process and detach from the RemoteViewer process so we are able to launch
+  # more than one Console Session at once.
+  def launch_viewer(index)
+    vm = @vms[index-1]
+
+    # let us no gather the host subject
+    hosts_data = XmlSimple.xml_in(@rhevm["/api/hosts/"+vm.host_uuid].get.body, {'ForceArray' => false})
+    host_subject = hosts_data['certificate']['subject']
+
+    ticket_data = XmlSimple.xml_in(@rhevm["/api/vms/" + vm.id + "/ticket"].post("<action><ticket><expiry>30</expiry></ticket></action>", :content_type => 'application/xml').body, {'ForceArray' => false})
+    password = ticket_data['ticket']['value']
+
+    # Creating the .vv File for the connection
+    # download the certificate file on the fly
+    @vv = File.new(TMP_DIR + "/" + vm.name + ".vv", "w+")
+    begin
+      @vv.puts("[virt-viewer]")
+      @vv.puts("type=spice")
+      @vv.puts("host=#{vm.address}")
+      @vv.puts("port=#{vm.port}")
+      @vv.puts("password=#{password}")
+      @vv.puts("tls-port=#{vm.secure_port}")
+      @vv.puts("fullscreen=0")
+      @vv.puts("title=vm:#{vm.name} - %d - Press SHIFT+F12 to Release Cursor")
+      @vv.puts("enable-smartcard=0")
+      @vv.puts("enable-usb-autoshare=1")
+      @vv.puts("usb-filter=-1,-1,-1,-1,0")
+      @vv.puts("host-subject=#{host_subject}")
+      @vv.puts("toggle-fullscreen=shift+f11")
+      @vv.puts("release-cursor=shift+f12")
+    ensure
+      @vv.close()
     end
 
+    # Now that we have all the information we can print the cmd line
+    puts "Console to VM: #{vm.name} state: #{vm.state} is started"
 
+    command = "#{Helper::OPTIONS[:viewer]} --spice-ca-file #{@cert} #{@vv.path}"
   end
 
+
+end
+
 module Helper
 
+  CONFIG_FILE = File.join(ENV['HOME'], '.console-launcher.rc.yaml')
+
+  OPTIONS = {
+      print: false,
+      dryrun: false,
+      host: nil,
+      user: "admin@internal",
+      pass: nil
+  }
+
+  OPTIONS[:viewer] = case RbConfig::CONFIG['host_os']
+                       when /mac|darwin/ then
+                         "/Applications/RemoteViewer.app/Contents/MacOS/RemoteViewer"
+                       when /linux|bsd|cygwin/ then
+                         "/usr/bin/remote-viewer"
+                       when /mswin|mingw/ then
+                         "C:/Program Files/VirtViewer/bin/remote-viewer.exe"
+                       # when /solaris|sunos/     then :Linux # needs testing..
+                       else
+                         raise "Your OS(#{ RbConfig::CONFIG['host_os'] }) is not yet supported"
+                     end
+
+  def load_options
+    if File.exists? CONFIG_FILE
+      config_options = YAML.load_file(CONFIG_FILE)
+      OPTIONS.merge!(config_options)
+
+      unless config_options.has_key?(:viewer)
+        File.open(CONFIG_FILE, 'w') { |file| YAML::dump(OPTIONS, file) }
+      end
+    else
+      File.open(CONFIG_FILE, 'w') { |file| YAML::dump(OPTIONS, file) }
+      STDERR.puts "Initialized configuration file in #{CONFIG_FILE}"
+    end
+  end
+
   # queries the User for a password
   def get_password(prompt="RHEV-M Password: ")
     ask(prompt) { |q| q.echo = "*" }
   end
 
+  # Remove any leading http or https from the host
   def strip_url(url)
-    # Remove any leading http or https from the host
     url = url.split("://")[1] if url.include? "://"
     return url
   end
 
-  def initialize
 
-  end
 end

data/lib/console-launcher_version.rb

@@ -1,4 +1,4 @@
 
 module ConsoleLauncher
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console-launcher
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Juergen Hoffmann
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client