Class: OnlyofficeWebdriverWrapper::HeadlessHelper

Inherits:
Object
  • Object
show all
Includes:
RealDisplayTools, RubyHelper
Defined in:
lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb

Overview

Class for using headless gem

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RubyHelper

#debug?, #os_64_bit?

Methods included from RealDisplayTools

#real_display_connected?, #xrandr_result

Constructor Details

#initialize(resolution_x = 1680, resolution_y = 1050) ⇒ HeadlessHelper

Returns a new instance of HeadlessHelper.



14
15
16
17
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 14

def initialize(resolution_x = 1680, resolution_y = 1050)
  @resolution_x = resolution_x
  @resolution_y = resolution_y
end

Instance Attribute Details

#headless_instance ⇒ Object

Returns the value of attribute headless_instance.



10
11
12
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 10

def headless_instance
  @headless_instance
end

#resolution_x ⇒ Object

Returns the value of attribute resolution_x.



11
12
13
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 11

def resolution_x
  @resolution_x
end

#resolution_y ⇒ Object

Returns the value of attribute resolution_y.



12
13
14
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 12

def resolution_y
  @resolution_y
end

Instance Method Details

#running? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 55

def running?
  !headless_instance.nil?
end

#should_start? ⇒ True, False

Check if should start headless

Returns:

  • (True, False) —

    result



21
22
23
24
25
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 21

def should_start?
  return false if debug?
  return false if OSHelper.mac?
  true
end

#start ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 27

def start
  create_session = if real_display_connected?
                     should_start?
                   else
                     true
                   end
  return unless create_session
  OnlyofficeLoggerHelper.log('Starting Headless Session')
  begin
    @headless_instance = Headless.new(reuse: false,
                                      destroy_at_exit: true,
                                      dimensions: "#{@resolution_x + 1}x#{@resolution_y + 1}x24")
  rescue Exception => e
    OnlyofficeLoggerHelper.log("xvfb not started with problem #{e}")
    RspecHelper.clean_up(true)
    @headless_instance = Headless.new(reuse: false,
                                      destroy_at_exit: true,
                                      dimensions: "#{@resolution_x + 1}x#{@resolution_y + 1}x24")
  end
  headless_instance.start
end

#stop ⇒ Object 



49
50
51
52
53
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 49

def stop
  return unless running?
  OnlyofficeLoggerHelper.log('Stopping Headless Session')
  headless_instance.destroy
end

#take_screenshot(scr_path = '/tmp/screenshot.png') ⇒ Object 



59
60
61
62
63
 
# File 'lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb', line 59

def take_screenshot(scr_path = '/tmp/screenshot.png')
  return unless running?
  headless_instance.take_screenshot(scr_path)
  OnlyofficeLoggerHelper.log("Took Screenshot to file: #{scr_path}")
end