Class: RSMP::Site

Inherits:
Node
  • Object
show all
Includes:
Components
Defined in:
lib/rsmp/node/site/site.rb,
lib/rsmp/options/site_options.rb

Overview

RSMP site implementation that manages proxies and components.

Direct Known Subclasses

TLC::TrafficControllerSite

Defined Under Namespace

Classes: Options

Instance Attribute Summary collapse

Attributes included from Components

#components, #main

Attributes inherited from Node

#archive, #clock, #collector, #deferred, #error_queue, #task

Attributes included from Task

#task

Attributes included from Logging

#archive

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Components

#add_component, #check_main_component, #clear_alarm_timestamps, #component_list, #find_component, #infer_component_type, #initialize_components, #natural_sort_key, #setup_components

Methods inherited from Node

#author, #check_required_settings, #clear_deferred, #defer, #distribute_error, #do_deferred, #ignore_errors, #inspect, #now, #process_deferred, #stop_subtasks

Methods included from Task

#initialize_task, #restart, #start, #stop_subtasks, #stop_task, #task_status, #wait, #wait_for_condition

Methods included from Logging

#author, #initialize_logging, #log

Constructor Details

#initialize(options = {}) ⇒ Site

Returns a new instance of Site.



12
13
14
15
16
17
18
19
20
 
# File 'lib/rsmp/node/site/site.rb', line 12

def initialize(options = {})
  super
  initialize_components
  handle_site_settings options
  @proxies = []
  @sleep_condition = Async::Notification.new
  @proxies_condition = Async::Notification.new
  build_proxies
end

Instance Attribute Details

#core_version ⇒ Object (readonly)

Returns the value of attribute core_version.



6
7
8
 
# File 'lib/rsmp/node/site/site.rb', line 6

def core_version
  @core_version
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



6
7
8
 
# File 'lib/rsmp/node/site/site.rb', line 6

def logger
  @logger
end

#proxies ⇒ Object (readonly)

Returns the value of attribute proxies.



6
7
8
 
# File 'lib/rsmp/node/site/site.rb', line 6

def proxies
  @proxies
end

#site_settings ⇒ Object (readonly)

Returns the value of attribute site_settings.



6
7
8
 
# File 'lib/rsmp/node/site/site.rb', line 6

def site_settings
  @site_settings
end

Class Method Details

.options_class ⇒ Object 



8
9
10
 
# File 'lib/rsmp/node/site/site.rb', line 8

def self.options_class
  RSMP::Site::Options
end

Instance Method Details

#aggregated_status_changed(component, _options = {}) ⇒ Object 



120
121
122
123
124
 
# File 'lib/rsmp/node/site/site.rb', line 120

def aggregated_status_changed(component, _options = {})
  @proxies.each do |proxy|
    proxy.send_aggregated_status component if proxy.ready?
  end
end

#alarm_acknowledged(alarm_state) ⇒ Object 



126
127
128
 
# File 'lib/rsmp/node/site/site.rb', line 126

def alarm_acknowledged(alarm_state)
  send_alarm AlarmAcknowledged.new(alarm_state.to_hash)
end

#alarm_activated_or_deactivated(alarm_state) ⇒ Object 



134
135
136
 
# File 'lib/rsmp/node/site/site.rb', line 134

def alarm_activated_or_deactivated(alarm_state)
  send_alarm AlarmIssue.new(alarm_state.to_hash)
end

#alarm_suspended_or_resumed(alarm_state) ⇒ Object 



130
131
132
 
# File 'lib/rsmp/node/site/site.rb', line 130

def alarm_suspended_or_resumed(alarm_state)
  send_alarm AlarmSuspended.new(alarm_state.to_hash)
end

#build_component(id:, type:, settings:) ⇒ Object 



182
183
184
185
186
187
188
189
190
 
# File 'lib/rsmp/node/site/site.rb', line 182

def build_component(id:, type:, settings:)
  settings ||= {}
  if type == 'main'
    Component.new id: id, node: self, type: type, name: settings['name'], grouped: true,
                  ntsoid: settings['ntsOId'], xnid: settings['xNId']
  else
    Component.new id: id, node: self, type: type, name: settings['name'], grouped: false
  end
end

#build_proxies ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rsmp/node/site/site.rb', line 105

def build_proxies
  @site_settings['supervisors'].each do |supervisor_settings|
    @proxies << SupervisorProxy.new({
                                      site: self,
                                      task: @task,
                                      settings: @site_settings,
                                      ip: supervisor_settings['ip'],
                                      port: supervisor_settings['port'],
                                      logger: @logger,
                                      archive: @archive,
                                      collect: @collect
                                    })
  end
end

#check_core_versions ⇒ Object

Raises:



71
72
73
74
75
76
77
78
79
 
# File 'lib/rsmp/node/site/site.rb', line 71

def check_core_versions
  version = @site_settings['core_version']
  return unless version

  return if RSMP::Schema.core_versions.include? version

  error_str = "Unknown core version: #{version}"
  raise RSMP::ConfigurationError, error_str
end

#check_sxls ⇒ Object

Raises:



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rsmp/node/site/site.rb', line 59

def check_sxls
  raise RSMP::ConfigurationError, 'No SXLs specified' unless sxls

  sxls.each do |sxl|
    name = sxl['name']
    version = sxl['version'].to_s
    raise RSMP::ConfigurationError, 'SXL name cannot be core' if name.to_s == 'core'

    RSMP::Schema.find_schema! name, version, lenient: true
  end
end

#connect_to_supervisor(_task, supervisor_settings) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/rsmp/node/site/site.rb', line 144

def connect_to_supervisor(_task, supervisor_settings)
  proxy = build_proxy({
                        site: self,
                        task: @task,
                        settings: @site_settings,
                        ip: supervisor_settings['ip'],
                        port: supervisor_settings['port'],
                        logger: @logger,
                        archive: @archive,
                        collect: @collect
                      })
  @proxies << proxy
  proxy.start
  @proxies_condition.signal
end

#denormalize_sxls(settings) ⇒ Object 



50
51
52
53
54
55
56
57
 
# File 'lib/rsmp/node/site/site.rb', line 50

def denormalize_sxls(settings)
  sxls = settings['sxls']
  return settings unless sxls.is_a?(Array)

  settings.merge(
    'sxls' => sxls.to_h { |sxl| [sxl['name'], sxl['version']] }
  )
end

#find_supervisor(ip) ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/rsmp/node/site/site.rb', line 175

def find_supervisor(ip)
  @proxies.each do |supervisor|
    return supervisor if ip == :any || supervisor.ip == ip
  end
  nil
end

#handle_site_settings(options = {}) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rsmp/node/site/site.rb', line 38

def handle_site_settings(options = {})
  options_class = self.class.options_class
  settings = options[:site_settings] || {}
  settings = denormalize_sxls(settings)
  @site_options = options_class.new(settings)
  @site_settings = @site_options.to_h

  check_sxls
  check_core_versions
  setup_components @site_settings['components']
end

#log_site_starting ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/rsmp/node/site/site.rb', line 85

def log_site_starting
  log "Starting #{site_type_name} #{@site_settings['site_id']}", level: :info, timestamp: @clock.now
  sxl = "Using SXLs #{sxls.map { |item| "#{item['name']} #{item['version']}" }.join(', ')}"
  version = @site_settings['core_version']
  core = if version
           "accepting only core version #{version}"
         else
           "accepting all core versions [#{RSMP::Schema.core_versions.join(', ')}]"
         end
  log "#{sxl}, #{core}", level: :info, timestamp: @clock.now
end

#primary_sxl ⇒ Object 



26
27
28
 
# File 'lib/rsmp/node/site/site.rb', line 26

def primary_sxl
  sxls.first
end

#run ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/rsmp/node/site/site.rb', line 97

def run
  log_site_starting
  @proxies.each do |proxy|
    proxy.start
    proxy.wait
  end
end

#send_alarm(alarm) ⇒ Object 



138
139
140
141
142
 
# File 'lib/rsmp/node/site/site.rb', line 138

def send_alarm(alarm)
  @proxies.each do |proxy|
    proxy.send_message alarm if proxy.ready? && proxy.receive_alarms?
  end
end

#site_id ⇒ Object 



34
35
36
 
# File 'lib/rsmp/node/site/site.rb', line 34

def site_id
  @site_settings['site_id']
end

#site_type_name ⇒ Object 



81
82
83
 
# File 'lib/rsmp/node/site/site.rb', line 81

def site_type_name
  'site'
end

#stop ⇒ Object

stop



161
162
163
164
 
# File 'lib/rsmp/node/site/site.rb', line 161

def stop
  log "Stopping site #{@site_settings['site_id']}", level: :info
  super
end

#sxl_version ⇒ Object 



30
31
32
 
# File 'lib/rsmp/node/site/site.rb', line 30

def sxl_version
  primary_sxl && primary_sxl['version']
end

#sxls ⇒ Object 



22
23
24
 
# File 'lib/rsmp/node/site/site.rb', line 22

def sxls
  @site_settings['sxls']
end

#wait_for_supervisor(ip, timeout) ⇒ Object 



166
167
168
169
170
171
172
173
 
# File 'lib/rsmp/node/site/site.rb', line 166

def wait_for_supervisor(ip, timeout)
  supervisor = find_supervisor ip
  return supervisor if supervisor

  wait_for_condition(@proxy_condition, timeout: timeout) { find_supervisor ip }
rescue Async::TimeoutError
  raise RSMP::TimeoutError, "Supervisor '#{ip}' did not connect within #{timeout}s"
end