86300

pending completion

Build # 86300

Build Type

cron

travis-ci-com

Committed by

Fryguy

Commit Message

<a href="https://github.com/ManageIQ/manageiq/commit/<a class=hub.com/ManageIQ/manageiq/commit/<a class="double-link" href="https://git"><a class=hub.com/ManageIQ/manageiq/commit/<a class="double-link" href="https://git"><a class=hub.com/ManageIQ/manageiq/commit/<a class="double-link" href="https://git"><a class=hub.com/ManageIQ/manageiq/commit/61cd4a556ec5d3695071e14ca1773b68ce94a43f">61cd4a556<a href="https://github.com/ManageIQ/manageiq/commit/61cd4a556ec5d3695071e14ca1773b68ce94a43f">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/ManageIQ/manageiq/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/ManageIQ/manageiq/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/commit/61cd4a556ec5d3695071e14ca1773b68ce94a43f&quot;&gt;61cd4a556&lt;/a&gt;&lt;a href=&quot;https://github.com/ManageIQ/manageiq/commit/61cd4a556ec5d3695071e14ca1773b68ce94a43f&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/ManageIQ/manageiq/commit/61cd4a556ec5d3695071e14ca1773b68ce94a43f&amp;quot;&amp;gt;&amp;amp;quot;&amp;amp;gt;Merge pull request #21603 from agrare/fix_ems_event_manager_refresh

Fix EmsEvent#manager_refresh full-refresh target

(</a>cherry picked from commit &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/ManageIQ/manageiq/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/ManageIQ/manageiq/commit/<a class="double-link" href="https://github.com/ManageIQ/manageiq/commit/5aafeca5c46c13c807297bf379ef47901d42a36a">5aafeca5c</a>&quot;&gt;5aafeca5c&lt;/a&gt;&quot;&gt;5aafeca5c&lt;/a&gt;&lt;a href=&quot;htt</a>ps://github.com/ManageIQ/manageiq/commit/61cd4a556ec5d3695071e14ca1773b68ce94a43f">)

Run Details

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

32463 of 53356 relevant lines covered (60.84%)

231.91 hits per line

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

86.21

/lib/remote_console/rack_server.rb

# This server allows the user to access remote endpoints through an HTTP(S)
# connection to the appliance. Opposed to a direct access or a forwarded port
# it is not necessary to expose an extra IP:port combination to the client.
#
# It uses socket hijacking to retrieve the underlying TCP socket connection
# of the HTTP request incoming from a client. This socket is detached from
# the Rack middleware and handled by a separate transmitter thread.
# The remote address of the console is determined by a one time secret that
# is part of the URL and it points to a SystemConsole record in the database.
#
# On the lowest level the transmitter thread operates with regular sockets,
# however, both on the client and server side wrappers are used to translate
# between a pair of sockets. Due to some limitations in the websocket driver
# gem, the reading/writing operations are defined in the fetch/issue methods.
#
# The selector for the sockets is provided by an external gem and it handles
# the dependency between the socket pairs, i.e. one should be ready to read
# while other one should be ready to write at the same time. The pairs ready
# for transmission are handled by the `each_ready` iterator. As the iterator
# always returns with a socket to read and a socket to write, the `@adapters`
# hash has been used to access the corresponding wrappers.

require 'surro-gate'
require 'websocket/driver'

module RemoteConsole
  class RackServer
    attr_accessor :logger

    RACK_404 = [404, {'Content-Type' => 'text/plain'}, ['Not found']].freeze
    RACK_YAY = [-1, {}, []].freeze

    def initialize(options = {})
      @logger = options.fetch(:logger, $remote_console_log)
      @logger.info('Initializing RemoteConsole server!')
      @proxy = SurroGate.new(logger)
      @adapters = {}

      @transmitter = Thread.new do
        loop do
          @proxy.select(1000)

          @proxy.each_ready do |left, right|
            begin
              @adapters[left].fetch(64.kilobytes) { |data| @adapters[right].issue(data) } # left -> right
            rescue IOError, IO::WaitReadable, IO::WaitWritable
              cleanup(:info, "Closing RemoteConsole proxy for VM %{vm_id}", left, right)
            rescue StandardError => ex
              cleanup(:error, "RemoteConsole proxy for VM %{vm_id} errored with #{ex} #{ex.backtrace.join("\n")}", left, right)
            end
          end
        end
      end

      @transmitter.abort_on_exception = true
    end

    # Rack entrypoint
    def call(env)
      exp = %r{^/ws/console/([a-zA-Z0-9]+)/?$}.match(env['REQUEST_URI'])
      if WebSocket::Driver.websocket?(env) && same_origin_as_host?(env) && exp.present?
        @logger.info("RemoteConsole connection initiated")
        init_proxy(env, exp[1])
      else
        @logger.error('Invalid RemoteConsole request or URL')
        RACK_404
      end
    end

    # Determine if the transmitter thread is alive or crashed
    def healthy?
      %w(run sleep).include?(@transmitter.status)
    end

    private

    # Sets up the RemoteConsole proxy between the client request and the remote endpoint determined by the secret
    def init_proxy(env, secret)
      record = SystemConsole.find_by!(:url_secret => secret) # Retrieve the ticket record using the secret

      begin
        ws_sock = env['rack.hijack'].call # Hijack the socket from the incoming HTTP connection
        console_sock = TCPSocket.open(record.host_name, record.port) # Open a TCP connection to the remote endpoint

        ws_sock.autoclose = false
        console_sock.autoclose = false

        # These adapters will be used for reading/writing from/to the particular sockets
        @adapters[console_sock] = ClientAdapter.new(record, console_sock)
        @adapters[ws_sock] = ServerAdapter.new(record, env, ws_sock)

        @proxy.push(ws_sock, console_sock)
      rescue StandardError => ex
        cleanup(:error, "RemoteConsole proxy for VM %{vm_id} errored with #{ex} #{ex.backtrace.join("\n")}", console_sock, ws_sock, record)
        RACK_404
      else
        @logger.info("Starting RemoteConsole proxy for VM #{record.vm_id}")
        RACK_YAY # Rack needs this as a return value
      ensure
        # Release the connection because one SPICE console can open multiple TCP connections
        ActiveRecord::Base.connection_pool.release_connection
      end
    end

    # Cleans up a pair of sockets with the related ticket record and emits a log message
    def cleanup(log_level, message, sock_a, sock_b, record = nil)
      record ||= @adapters.values_at(sock_a, sock_b).map { |a| a.try(:record) }.find(&:itself)

      if record
        record.destroy_or_mark # Delete the ticket record from the DB
        @logger.send(log_level, message % {:vm_id => record.vm_id})
      end

      @proxy.pop(sock_a, sock_b) unless sock_a.nil? || sock_b.nil?

      # Close the sockets if they aren't closed yet
      [sock_a, sock_b].each do |sock|
        sock.try(:close)
        @adapters.delete(sock)
      end
    end

    # Primitive same-origin policy checking in production
    def same_origin_as_host?(env)
      proto = Rack::Request.new(env).ssl? ? 'https' : 'http'
      host = env['HTTP_X_FORWARDED_HOST'] ? env['HTTP_X_FORWARDED_HOST'].split(/,\s*/).first : env['HTTP_HOST']
      Rails.env.development? || env['HTTP_ORIGIN'] == "#{proto}://#{host}"
    end
  end
end

1	# This server allows the user to access remote endpoints through an HTTP(S)
2	# connection to the appliance. Opposed to a direct access or a forwarded port
3	# it is not necessary to expose an extra IP:port combination to the client.
4	#
5	# It uses socket hijacking to retrieve the underlying TCP socket connection
6	# of the HTTP request incoming from a client. This socket is detached from
7	# the Rack middleware and handled by a separate transmitter thread.
8	# The remote address of the console is determined by a one time secret that
9	# is part of the URL and it points to a SystemConsole record in the database.
10	#
11	# On the lowest level the transmitter thread operates with regular sockets,
12	# however, both on the client and server side wrappers are used to translate
13	# between a pair of sockets. Due to some limitations in the websocket driver
14	# gem, the reading/writing operations are defined in the fetch/issue methods.
15	#
16	# The selector for the sockets is provided by an external gem and it handles
17	# the dependency between the socket pairs, i.e. one should be ready to read
18	# while other one should be ready to write at the same time. The pairs ready
19	# for transmission are handled by the `each_ready` iterator. As the iterator
20	# always returns with a socket to read and a socket to write, the `@adapters`
21	# hash has been used to access the corresponding wrappers.
22
23	require 'surro-gate'	1✔
24	require 'websocket/driver'	1✔
25
26	module RemoteConsole	1✔
27	class RackServer	1✔
28	attr_accessor :logger	1✔
29
30	RACK_404 = [404, {'Content-Type' => 'text/plain'}, ['Not found']].freeze	1✔
31	RACK_YAY = [-1, {}, []].freeze	1✔
32
33	def initialize(options = {})	1✔
34	@logger = options.fetch(:logger, $remote_console_log)	11✔
35	@logger.info('Initializing RemoteConsole server!')	11✔
36	@proxy = SurroGate.new(logger)	11✔
37	@adapters = {}	11✔
38
39	@transmitter = Thread.new do	11✔
40	loop do	11✔
41	@proxy.select(1000)	11✔
42
43	@proxy.each_ready do \|left, right\|	×
44	begin
45	@adapters[left].fetch(64.kilobytes) { \|data\| @adapters[right].issue(data) } # left -> right	×
46	rescue IOError, IO::WaitReadable, IO::WaitWritable
47	cleanup(:info, "Closing RemoteConsole proxy for VM %{vm_id}", left, right)	×
48	rescue StandardError => ex
49	cleanup(:error, "RemoteConsole proxy for VM %{vm_id} errored with #{ex} #{ex.backtrace.join("\n")}", left, right)	×
50	end
51	end
52	end
53	end
54
55	@transmitter.abort_on_exception = true	11✔
56	end
57
58	# Rack entrypoint
59	def call(env)	1✔
60	exp = %r{^/ws/console/([a-zA-Z0-9]+)/?$}.match(env['REQUEST_URI'])	2✔
61	if WebSocket::Driver.websocket?(env) && same_origin_as_host?(env) && exp.present?	2✔
62	@logger.info("RemoteConsole connection initiated")	1✔
63	init_proxy(env, exp[1])	1✔
64	else
65	@logger.error('Invalid RemoteConsole request or URL')	1✔
66	RACK_404	1✔
67	end
68	end
69
70	# Determine if the transmitter thread is alive or crashed
71	def healthy?	1✔
72	%w(run sleep).include?(@transmitter.status)	×
73	end
74
75	private	1✔
76
77	# Sets up the RemoteConsole proxy between the client request and the remote endpoint determined by the secret
78	def init_proxy(env, secret)	1✔
79	record = SystemConsole.find_by!(:url_secret => secret) # Retrieve the ticket record using the secret	3✔
80
81	begin
82	ws_sock = env['rack.hijack'].call # Hijack the socket from the incoming HTTP connection	2✔
83	console_sock = TCPSocket.open(record.host_name, record.port) # Open a TCP connection to the remote endpoint	1✔
84
85	ws_sock.autoclose = false	1✔
86	console_sock.autoclose = false	1✔
87
88	# These adapters will be used for reading/writing from/to the particular sockets
89	@adapters[console_sock] = ClientAdapter.new(record, console_sock)	1✔
90	@adapters[ws_sock] = ServerAdapter.new(record, env, ws_sock)	1✔
91
92	@proxy.push(ws_sock, console_sock)	1✔
93	rescue StandardError => ex	1✔
94	cleanup(:error, "RemoteConsole proxy for VM %{vm_id} errored with #{ex} #{ex.backtrace.join("\n")}", console_sock, ws_sock, record)	1✔
95	RACK_404	1✔
96	else
97	@logger.info("Starting RemoteConsole proxy for VM #{record.vm_id}")	1✔
98	RACK_YAY # Rack needs this as a return value	1✔
99	ensure
100	# Release the connection because one SPICE console can open multiple TCP connections
101	ActiveRecord::Base.connection_pool.release_connection	2✔
102	end
103	end
104
105	# Cleans up a pair of sockets with the related ticket record and emits a log message
106	def cleanup(log_level, message, sock_a, sock_b, record = nil)	1✔
107	record \|\|= @adapters.values_at(sock_a, sock_b).map { \|a\| a.try(:record) }.find(&:itself)	4✔
108
109	if record	2✔
110	record.destroy_or_mark # Delete the ticket record from the DB	1✔
111	@logger.send(log_level, message % {:vm_id => record.vm_id})	1✔
112	end
113
114	@proxy.pop(sock_a, sock_b) unless sock_a.nil? \|\| sock_b.nil?	2✔
115
116	# Close the sockets if they aren't closed yet
117	[sock_a, sock_b].each do \|sock\|	2✔
118	sock.try(:close)	4✔
119	@adapters.delete(sock)	4✔
120	end
121	end
122
123	# Primitive same-origin policy checking in production
124	def same_origin_as_host?(env)	1✔
125	proto = Rack::Request.new(env).ssl? ? 'https' : 'http'	×
126	host = env['HTTP_X_FORWARDED_HOST'] ? env['HTTP_X_FORWARDED_HOST'].split(/,\s*/).first : env['HTTP_HOST']	×
127	Rails.env.development? \|\| env['HTTP_ORIGIN'] == "#{proto}://#{host}"	×
128	end
129	end
130	end

ManageIQ / manageiq / 86300

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