7297

pending completion

Build # 7297

Build Type

cron

travis-ci-com

Committed by

Fryguy

Commit Message

<a href="https://github.com/ManageIQ/manageiq-providers-vmware/commit/<a class=hub.com/ManageIQ/manageiq-providers-vmware/commit/<a class="double-link" href="https://git"><a class=hub.com/ManageIQ/manageiq-providers-vmware/commit/<a class="double-link" href="https://git"><a class=hub.com/ManageIQ/manageiq-providers-vmware/commit/<a class="double-link" href="https://git"><a class=hub.com/ManageIQ/manageiq-providers-vmware/commit/af3e8adb2e35f1533edac84b32bffc7e3b0b33e0">af3e8adb2<a href="https://github.com/ManageIQ/manageiq-providers-vmware/commit/af3e8adb2e35f1533edac84b32bffc7e3b0b33e0">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/ManageIQ/manageiq-providers-vmware/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/ManageIQ/manageiq-providers-vmware/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/ManageIQ/manageiq-providers-vmware/commit/af3e8adb2e35f1533edac84b32bffc7e3b0b33e0&quot;&gt;af3e8adb2&lt;/a&gt;&lt;a href=&quot;https://github.com/ManageIQ/manageiq-providers-vmware/commit/af3e8adb2e35f1533edac84b32bffc7e3b0b33e0&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/ManageIQ/manageiq-providers-vmware/commit/af3e8adb2e35f1533edac84b32bffc7e3b0b33e0&amp;quot;&amp;gt;&amp;amp;quot;&amp;amp;gt;Merge pull request #779 from agrare/remote_console_ticket_vim_string

Ensure Remote Console tickets aren&amp;amp;amp;#39;t VimString&lt;/a&gt;s

(cherry picked from commit &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/ManageIQ/manageiq-providers-vmware/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/ManageIQ/manageiq-providers-vmware/commit/<a class="double-link" href="https://github.com/ManageIQ/manageiq-providers-vmware/commit/c031f88b918eb1b8b35ebb3d8df1e233471c6140">c031f88b9</a>&quot;&gt;c031f88b9&lt;/a&gt;&quot;&gt;c031f88b9&lt;/a&gt;&lt;a href=&quot;htt</a>ps://github.com/ManageIQ/manageiq-providers-vmware/commit/af3e8adb2e35f1533edac84b32bffc7e3b0b33e0">)

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

762 of 6598 relevant lines covered (11.55%)

0.12 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

22.03

/app/models/manageiq/providers/vmware/infra_manager/vm/remote_console.rb

module ManageIQ::Providers::Vmware::InfraManager::Vm::RemoteConsole
  def console_supported?(type)
    %w(VMRC VNC WEBMKS).include?(type.upcase)
  end

  def validate_remote_console_acquire_ticket(protocol, options = {})
    raise(MiqException::RemoteConsoleNotSupportedError, "#{protocol} remote console requires the vm to be registered with a management system.") if ext_management_system.nil?

    raise(MiqException::RemoteConsoleNotSupportedError, "remote console requires console credentials") if ext_management_system.authentication_type(:console).nil? && protocol == "vmrc"

    options[:check_if_running] = true unless options.key?(:check_if_running)
    raise(MiqException::RemoteConsoleNotSupportedError, "#{protocol} remote console requires the vm to be running.") if options[:check_if_running] && state != "on"
  end

  def remote_console_acquire_ticket(userid, originating_server, protocol)
    send("remote_console_#{protocol.to_s.downcase}_acquire_ticket", userid, originating_server)
  end

  def remote_console_acquire_ticket_queue(protocol, userid)
    task_opts = {
      :action => "acquiring Vm #{name} #{protocol.to_s.upcase} remote console ticket for user #{userid}",
      :userid => userid
    }

    queue_opts = {
      :class_name  => self.class.name,
      :instance_id => id,
      :method_name => 'remote_console_acquire_ticket',
      :priority    => MiqQueue::HIGH_PRIORITY,
      :role        => 'ems_operations',
      :zone        => my_zone,
      :args        => [userid, MiqServer.my_server.id, protocol]
    }

    MiqTask.generic_action_with_callback(task_opts, queue_opts)
  end

  #
  # VMRC
  #

  def remote_console_vmrc_acquire_ticket(_userid = nil, _originating_server = nil)
    validate_remote_console_acquire_ticket("vmrc")
    ticket = ext_management_system.remote_console_vmrc_acquire_ticket

    {
      :ticket     => ticket.to_s, # Ensure ticket is a basic String not a VimString
      :remote_url => build_vmrc_url(ticket),
      :proto      => 'remote'
    }
  end

  def validate_remote_console_vmrc_support
    validate_remote_console_acquire_ticket("vmrc")
    ext_management_system.validate_remote_console_vmrc_support
    true
  end

  #
  # WebMKS
  #

  def remote_console_webmks_acquire_ticket(userid, originating_server = nil)
    validate_remote_console_acquire_ticket("webmks")
    ticket = ext_management_system.vm_remote_console_webmks_acquire_ticket(self)

    SystemConsole.force_vm_invalid_token(id)

    console_args = {
      :user       => User.find_by(:userid => userid),
      :vm_id      => id,
      :ssl        => true,
      :protocol   => 'webmks',
      :secret     => ticket['ticket'].to_s, # Ensure ticket is a basic String not a VimString
      :url_secret => SecureRandom.hex,
    }

    SystemConsole.launch_proxy_if_not_local(console_args, originating_server, ticket['host'].to_s, ticket['port'].to_i)
  end

  def validate_remote_console_webmks_support
    validate_remote_console_acquire_ticket("webmks")
    ext_management_system.validate_remote_console_webmks_support
    true
  end

  #
  # HTML5 selects the best available console type (VNC or WebMKS)
  #
  def remote_console_html5_acquire_ticket(userid, originating_server = nil)
    protocol = 'vnc' if ext_management_system.api_version.to_f < 6.0 # Force VNC protocol for API version lower than 6.0
    protocol ||= with_provider_object { |v| v.extraConfig["RemoteDisplay.vnc.enabled"] == "true" } ? 'vnc' : 'webmks'
    send("remote_console_#{protocol}_acquire_ticket", userid, originating_server)
  end

  #
  # VNC
  #
  def remote_console_vnc_acquire_ticket(userid, originating_server)
    require 'securerandom'

    validate_remote_console_acquire_ticket("vnc")

    password     = SecureRandom.base64[0, 8] # Random password from the Base64 character set
    host_port    = host.reserve_next_available_vnc_port

    # Determine if any Vms on this Host already have this port, and if so, disable them
    old_vms = host.vms_and_templates.where(:vnc_port => host_port)
    old_vms.each do |old_vm|
      _log.info "Disabling VNC on #{old_vm.class.name} id: [#{old_vm.id}] name: [#{old_vm.name}], since the port is being reused."
      old_vm.with_provider_object do |vim_vm|
        vim_vm.setRemoteDisplayVncAttributes(:enabled => false, :port => nil, :password => nil)
      end
    end
    old_vms.update_all(:vnc_port => nil)

    # Enable on this Vm with the requested port and random password
    _log.info "Enabling VNC on #{self.class.name} id: [#{id}] name: [#{name}]"
    with_provider_object do |vim_vm|
      vim_vm.setRemoteDisplayVncAttributes(:enabled => true, :port => host_port, :password => password)
    end
    update(:vnc_port => host_port)

    SystemConsole.force_vm_invalid_token(id)

    console_args = {
      :user       => User.find_by(:userid => userid),
      :vm_id      => id,
      :ssl        => false,
      :protocol   => 'vnc',
      :secret     => password,
      :url_secret => SecureRandom.hex
    }
    host_address = host.hostname

    SystemConsole.launch_proxy_if_not_local(console_args, originating_server, host_address, host_port)
  end

  private

  # Method to generate the remote URI for the VMRC console
  def build_vmrc_url(ticket)
    url = URI::Generic.build(:scheme   => "vmrc",
                             :userinfo => "clone:#{ticket}",
                             :host     => ext_management_system.hostname || ext_management_system.ipaddress,
                             :port     => 443,
                             :path     => "/",
                             :query    => "moid=#{ems_ref}").to_s
    # VMRC doesn't like brackets around IPv6 addresses
    url.sub(/(.*)\[/, '\1').sub(/(.*)\]/, '\1')
  end
end

1	module ManageIQ::Providers::Vmware::InfraManager::Vm::RemoteConsole	1✔
2	def console_supported?(type)	1✔
3	%w(VMRC VNC WEBMKS).include?(type.upcase)	×
4	end
5
6	def validate_remote_console_acquire_ticket(protocol, options = {})	1✔
7	raise(MiqException::RemoteConsoleNotSupportedError, "#{protocol} remote console requires the vm to be registered with a management system.") if ext_management_system.nil?	×
8
9	raise(MiqException::RemoteConsoleNotSupportedError, "remote console requires console credentials") if ext_management_system.authentication_type(:console).nil? && protocol == "vmrc"	×
10
11	options[:check_if_running] = true unless options.key?(:check_if_running)	×
12	raise(MiqException::RemoteConsoleNotSupportedError, "#{protocol} remote console requires the vm to be running.") if options[:check_if_running] && state != "on"	×
13	end
14
15	def remote_console_acquire_ticket(userid, originating_server, protocol)	1✔
16	send("remote_console_#{protocol.to_s.downcase}_acquire_ticket", userid, originating_server)	×
17	end
18
19	def remote_console_acquire_ticket_queue(protocol, userid)	1✔
20	task_opts = {
21	:action => "acquiring Vm #{name} #{protocol.to_s.upcase} remote console ticket for user #{userid}",	×
22	:userid => userid
23	}
24
25	queue_opts = {
26	:class_name => self.class.name,	×
27	:instance_id => id,
28	:method_name => 'remote_console_acquire_ticket',
29	:priority => MiqQueue::HIGH_PRIORITY,
30	:role => 'ems_operations',
31	:zone => my_zone,
32	:args => [userid, MiqServer.my_server.id, protocol]
33	}
34
35	MiqTask.generic_action_with_callback(task_opts, queue_opts)	×
36	end
37
38	#
39	# VMRC
40	#
41
42	def remote_console_vmrc_acquire_ticket(_userid = nil, _originating_server = nil)	1✔
43	validate_remote_console_acquire_ticket("vmrc")	×
44	ticket = ext_management_system.remote_console_vmrc_acquire_ticket	×
45
46	{
47	:ticket => ticket.to_s, # Ensure ticket is a basic String not a VimString	×
48	:remote_url => build_vmrc_url(ticket),
49	:proto => 'remote'
50	}
51	end
52
53	def validate_remote_console_vmrc_support	1✔
54	validate_remote_console_acquire_ticket("vmrc")	×
55	ext_management_system.validate_remote_console_vmrc_support	×
56	true	×
57	end
58
59	#
60	# WebMKS
61	#
62
63	def remote_console_webmks_acquire_ticket(userid, originating_server = nil)	1✔
64	validate_remote_console_acquire_ticket("webmks")	×
65	ticket = ext_management_system.vm_remote_console_webmks_acquire_ticket(self)	×
66
67	SystemConsole.force_vm_invalid_token(id)	×
68
69	console_args = {
70	:user => User.find_by(:userid => userid),	×
71	:vm_id => id,
72	:ssl => true,
73	:protocol => 'webmks',
74	:secret => ticket['ticket'].to_s, # Ensure ticket is a basic String not a VimString
75	:url_secret => SecureRandom.hex,
76	}
77
78	SystemConsole.launch_proxy_if_not_local(console_args, originating_server, ticket['host'].to_s, ticket['port'].to_i)	×
79	end
80
81	def validate_remote_console_webmks_support	1✔
82	validate_remote_console_acquire_ticket("webmks")	×
83	ext_management_system.validate_remote_console_webmks_support	×
84	true	×
85	end
86
87	#
88	# HTML5 selects the best available console type (VNC or WebMKS)
89	#
90	def remote_console_html5_acquire_ticket(userid, originating_server = nil)	1✔
91	protocol = 'vnc' if ext_management_system.api_version.to_f < 6.0 # Force VNC protocol for API version lower than 6.0	×
92	protocol \|\|= with_provider_object { \|v\| v.extraConfig["RemoteDisplay.vnc.enabled"] == "true" } ? 'vnc' : 'webmks'	×
93	send("remote_console_#{protocol}_acquire_ticket", userid, originating_server)	×
94	end
95
96	#
97	# VNC
98	#
99	def remote_console_vnc_acquire_ticket(userid, originating_server)	1✔
100	require 'securerandom'	×
101
102	validate_remote_console_acquire_ticket("vnc")	×
103
104	password = SecureRandom.base64[0, 8] # Random password from the Base64 character set	×
105	host_port = host.reserve_next_available_vnc_port	×
106
107	# Determine if any Vms on this Host already have this port, and if so, disable them
108	old_vms = host.vms_and_templates.where(:vnc_port => host_port)	×
109	old_vms.each do \|old_vm\|	×
110	_log.info "Disabling VNC on #{old_vm.class.name} id: [#{old_vm.id}] name: [#{old_vm.name}], since the port is being reused."	×
111	old_vm.with_provider_object do \|vim_vm\|	×
112	vim_vm.setRemoteDisplayVncAttributes(:enabled => false, :port => nil, :password => nil)	×
113	end
114	end
115	old_vms.update_all(:vnc_port => nil)	×
116
117	# Enable on this Vm with the requested port and random password
118	_log.info "Enabling VNC on #{self.class.name} id: [#{id}] name: [#{name}]"	×
119	with_provider_object do \|vim_vm\|	×
120	vim_vm.setRemoteDisplayVncAttributes(:enabled => true, :port => host_port, :password => password)	×
121	end
122	update(:vnc_port => host_port)	×
123
124	SystemConsole.force_vm_invalid_token(id)	×
125
126	console_args = {
127	:user => User.find_by(:userid => userid),	×
128	:vm_id => id,
129	:ssl => false,
130	:protocol => 'vnc',
131	:secret => password,
132	:url_secret => SecureRandom.hex
133	}
134	host_address = host.hostname	×
135
136	SystemConsole.launch_proxy_if_not_local(console_args, originating_server, host_address, host_port)	×
137	end
138
139	private	1✔
140
141	# Method to generate the remote URI for the VMRC console
142	def build_vmrc_url(ticket)	1✔
143	url = URI::Generic.build(:scheme => "vmrc",	×
144	:userinfo => "clone:#{ticket}",
145	:host => ext_management_system.hostname \|\| ext_management_system.ipaddress,
146	:port => 443,
147	:path => "/",
148	:query => "moid=#{ems_ref}").to_s
149	# VMRC doesn't like brackets around IPv6 addresses
150	url.sub(/(.)\[/, '\1').sub(/(.)\]/, '\1')	×
151	end
152	end

ManageIQ / manageiq-providers-vmware / 7297

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous