Class: RSMP::Validator::SiteTester

Inherits:
Tester
  • Object
show all
Defined in:
lib/rsmp/validator/site_tester.rb

Overview

Helper class for testing RSMP sites. Runs a local RSMP supervisor inside an Async reactor. Only one site is expected to connect to the supervisor.

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tester

#config, #connected, #disconnected, #isolated, #reconnected, sentinel_errors, #stop

Methods included from Log

#log

Class Attribute Details

.instance ⇒ Object

Returns the value of attribute instance.



8
9
10
 
# File 'lib/rsmp/validator/site_tester.rb', line 8

def instance
  @instance
end

Class Method Details

.connected(options = {}) ⇒ Object 



10
11
12
 
# File 'lib/rsmp/validator/site_tester.rb', line 10

def connected(options = {}, &)
  instance.connected(options, &)
end

.disconnected ⇒ Object 



18
19
20
 
# File 'lib/rsmp/validator/site_tester.rb', line 18

def disconnected(&)
  instance.disconnected(&)
end

.isolated(options = {}) ⇒ Object 



22
23
24
 
# File 'lib/rsmp/validator/site_tester.rb', line 22

def isolated(options = {}, &)
  instance.isolated(options, &)
end

.reconnected(options = {}) ⇒ Object 



14
15
16
 
# File 'lib/rsmp/validator/site_tester.rb', line 14

def reconnected(options = {}, &)
  instance.reconnected(options, &)
end

.stop ⇒ Object 



26
27
28
 
# File 'lib/rsmp/validator/site_tester.rb', line 26

def stop
  instance.stop
end

Instance Method Details

#apply_security_codes ⇒ Object 



46
47
48
49
50
51
 
# File 'lib/rsmp/validator/site_tester.rb', line 46

def apply_security_codes
  security_codes = config.dig('secrets', 'security_codes')
  return unless security_codes && !@supervisor_config['sites']['default']['security_codes']

  @supervisor_config['sites']['default']['security_codes'] = security_codes
end

#build_node(options) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rsmp/validator/site_tester.rb', line 69

def build_node(options)
  logger = create_supervisor_logger(@supervisor_config)
  supervisor_settings = ConfigNormalizer.normalize_supervisor_settings(@supervisor_config.deep_merge(options))

  RSMP::Supervisor.new(
    supervisor_settings: supervisor_settings,
    logger: logger,
    collect: options['collect']
  )
end

#create_supervisor_logger(supervisor_config) ⇒ Object 



102
103
104
105
106
107
108
109
110
 
# File 'lib/rsmp/validator/site_tester.rb', line 102

def create_supervisor_logger(supervisor_config)
  log_settings = supervisor_config.is_a?(Hash) ? supervisor_config['log'] : nil
  logger_settings = RSMP::Validator.node_log_settings.merge('prefix' => '[SUPERVISOR]')
  return RSMP::Logger.new(logger_settings) unless log_settings && !log_settings.empty?

  logger_settings.merge!(log_settings)
  logger_settings.delete('stream') if log_settings['path']
  RSMP::Logger.new(logger_settings)
end

#parse_config ⇒ Object 



31
32
33
34
 
# File 'lib/rsmp/validator/site_tester.rb', line 31

def parse_config
  setup_supervisor_config
  validate_timeouts
end

#setup_supervisor_config ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/rsmp/validator/site_tester.rb', line 36

def setup_supervisor_config
  @supervisor_config = config['local_supervisor']
  raise "config 'local_supervisor' is missing" unless @supervisor_config

  @supervisor_config['max_sites'] ||= 1
  @supervisor_config['sites'] ||= {}
  @supervisor_config['sites']['default'] ||= {}
  apply_security_codes
end

#validate_timeouts ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rsmp/validator/site_tester.rb', line 53

def validate_timeouts
  %w[
    connect
    ready
    status_response
    status_update
    subscribe
    command
    command_response
    alarm
    disconnect
  ].each do |key|
    raise "config 'timeouts/#{key}' is missing" unless config['timeouts'][key]
  end
end

#wait_for_connection ⇒ Object 



80
81
82
83
84
85
86
87
88
 
# File 'lib/rsmp/validator/site_tester.rb', line 80

def wait_for_connection
  @proxy = @node.proxies.first
  return if @proxy

  log 'Waiting for site to connect'
  @proxy = @node.wait_for_site(:any, timeout: config['timeouts']['connect'])
rescue RSMP::TimeoutError
  raise RSMP::ConnectionError, "Site did not connect within #{config['timeouts']['connect']}s"
end

#wait_for_handshake ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rsmp/validator/site_tester.rb', line 90

def wait_for_handshake
  return if @proxy.ready?

  log 'Waiting for handshake to complete'
  @proxy.wait_for_state :ready, timeout: config['timeouts']['ready']
  log 'Ready'
  return if @initial_unsubscribe_done

  @proxy.unsubscribe_from_all component: RSMP::Validator.get_config('main_component')
  @initial_unsubscribe_done = true
end