Class: OpenC3::ScopeModel

Inherits:
Model show all
Defined in:
lib/openc3/models/scope_model.rb

Constant Summary collapse

PRIMARY_KEY = 
'openc3_scopes'

Instance Attribute Summary collapse

Attributes inherited from Model

#name, #plugin, #scope, #updated_at

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

#check_disable_erb, #destroyed?, filter, find_all_by_plugin, get_all_models, handle_config, set, store, store_queued, #update

Constructor Details

#initialize(name:, text_log_cycle_time: 600, text_log_cycle_size: 50_000_000, text_log_retain_time: nil, tool_log_retain_time: nil, cleanup_poll_time: 900, updated_at: nil, scope: nil) ⇒ ScopeModel

Returns a new instance of ScopeModel.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/openc3/models/scope_model.rb', line 70

def initialize(name:,
  text_log_cycle_time: 600,
  text_log_cycle_size: 50_000_000,
  text_log_retain_time: nil,
  tool_log_retain_time: nil,
  cleanup_poll_time: 900,
  updated_at: nil,
  scope: nil
)
  super(
    PRIMARY_KEY,
    name: name,
    text_log_cycle_time: text_log_cycle_time,
    text_log_cycle_size: text_log_cycle_size,
    text_log_retain_time: text_log_retain_time,
    tool_log_retain_time: tool_log_retain_time,
    cleanup_poll_time: cleanup_poll_time,
    updated_at: updated_at,
    scope: name
  )
  @text_log_cycle_time = text_log_cycle_time
  @text_log_cycle_size = text_log_cycle_size
  @text_log_retain_time = text_log_retain_time
  @tool_log_retain_time = tool_log_retain_time
  @cleanup_poll_time = cleanup_poll_time
  @children = []
end

Instance Attribute Details

#children ⇒ Object

Returns the value of attribute children.



34
35
36
 
# File 'lib/openc3/models/scope_model.rb', line 34

def children
  @children
end

#cleanup_poll_time ⇒ Object

Returns the value of attribute cleanup_poll_time.



39
40
41
 
# File 'lib/openc3/models/scope_model.rb', line 39

def cleanup_poll_time
  @cleanup_poll_time
end

#text_log_cycle_size ⇒ Object

Returns the value of attribute text_log_cycle_size.



36
37
38
 
# File 'lib/openc3/models/scope_model.rb', line 36

def text_log_cycle_size
  @text_log_cycle_size
end

#text_log_cycle_time ⇒ Object

Returns the value of attribute text_log_cycle_time.



35
36
37
 
# File 'lib/openc3/models/scope_model.rb', line 35

def text_log_cycle_time
  @text_log_cycle_time
end

#text_log_retain_time ⇒ Object

Returns the value of attribute text_log_retain_time.



37
38
39
 
# File 'lib/openc3/models/scope_model.rb', line 37

def text_log_retain_time
  @text_log_retain_time
end

#tool_log_retain_time ⇒ Object

Returns the value of attribute tool_log_retain_time.



38
39
40
 
# File 'lib/openc3/models/scope_model.rb', line 38

def tool_log_retain_time
  @tool_log_retain_time
end

Class Method Details

.all(scope: nil) ⇒ Object 



51
52
53
 
# File 'lib/openc3/models/scope_model.rb', line 51

def self.all(scope: nil)
  super(PRIMARY_KEY)
end

.from_json(json, scope: nil) ⇒ Object 



55
56
57
58
59
 
# File 'lib/openc3/models/scope_model.rb', line 55

def self.from_json(json, scope: nil)
  json = JSON.parse(json, :allow_nan => true, :create_additions => true) if String === json
  raise "json data is nil" if json.nil?
  self.new(**json.transform_keys(&:to_sym), scope: scope)
end

.get(name:, scope: nil) ⇒ Object

NOTE: The following three class methods are used by the ModelController and are reimplemented to enable various Model class methods to work



43
44
45
 
# File 'lib/openc3/models/scope_model.rb', line 43

def self.get(name:, scope: nil)
  super(PRIMARY_KEY, name: name)
end

.get_model(name:, scope: nil) ⇒ Object 



61
62
63
64
65
66
67
68
 
# File 'lib/openc3/models/scope_model.rb', line 61

def self.get_model(name:, scope: nil)
  json = get(name: name)
  if json
    return from_json(json)
  else
    return nil
  end
end

.names(scope: nil) ⇒ Object 



47
48
49
 
# File 'lib/openc3/models/scope_model.rb', line 47

def self.names(scope: nil)
  super(PRIMARY_KEY)
end

Instance Method Details

#as_json(*a) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/openc3/models/scope_model.rb', line 118

def as_json(*a)
  { 'name' => @name,
    'updated_at' => @updated_at,
    'text_log_cycle_time' => @text_log_cycle_time,
    'text_log_cycle_size' => @text_log_cycle_size,
    'text_log_retain_time' => @text_log_retain_time,
    'tool_log_retain_time' => @tool_log_retain_time,
    'cleanup_poll_time' => @cleanup_poll_time,
   }
end

#create(update: false, force: false, queued: false) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/openc3/models/scope_model.rb', line 98

def create(update: false, force: false, queued: false)
  # Ensure there are no "." in the scope name - prevents gems accidently becoming scope names
  raise "Invalid scope name: #{@name}" if @name !~ /^[a-zA-Z0-9_-]+$/
  @name = @name.upcase
  super(update: update, force: force, queued: queued)
end

#deploy(gem_path, variables) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/openc3/models/scope_model.rb', line 242

def deploy(gem_path, variables)
  seed_database()

  # Create DEFAULT trigger group model
  model = TriggerGroupModel.get(name: 'DEFAULT', scope: @scope)
  unless model
    model = TriggerGroupModel.new(name: 'DEFAULT', scope: @scope)
    model.create()
    model.deploy()
  end

  # Create UNKNOWN target for display of unknown data
  model = TargetModel.new(name: "UNKNOWN", scope: @scope)
  model.create

  @parent = "#{@scope}__SCOPEMULTI__#{@scope}"

  # OpenC3 Log Microservice
  deploy_openc3_log_messages_microservice(gem_path, variables, @parent)

  # UNKNOWN CommandLog Microservice
  deploy_unknown_commandlog_microservice(gem_path, variables, @parent)

  # UNKNOWN PacketLog Microservice
  deploy_unknown_packetlog_microservice(gem_path, variables, @parent)

  # Periodic Microservice
  deploy_periodic_microservice(gem_path, variables, @parent)

  # Scope Cleanup Microservice
  deploy_scopecleanup_microservice(gem_path, variables, @parent)

  # Multi Microservice to parent other scope microservices
  deploy_scopemulti_microservice(gem_path, variables)
end

#deploy_openc3_log_messages_microservice(gem_path, variables, parent) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/openc3/models/scope_model.rb', line 129

def deploy_openc3_log_messages_microservice(gem_path, variables, parent)
  microservice_name = "#{@scope}__OPENC3__LOG"
  topics = ["#{@scope}__openc3_log_messages"]
  # Also log the NOSCOPE messages with this microservice for the DEFAULT scope
  if @scope == 'DEFAULT'
    topics << "NOSCOPE__openc3_log_messages"
  end
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "text_log_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    options: [
      ["CYCLE_TIME", @text_log_cycle_time],
      ["CYCLE_SIZE", @text_log_cycle_size],
    ],
    topics: topics,
    parent: parent,
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  @children << microservice_name if parent
  Logger.info "Configured microservice #{microservice_name}"
end

#deploy_periodic_microservice(gem_path, variables, parent) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/openc3/models/scope_model.rb', line 198

def deploy_periodic_microservice(gem_path, variables, parent)
  microservice_name = "#{@scope}__PERIODIC__#{@scope}"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "periodic_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    parent: parent,
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  @children << microservice_name if parent
  Logger.info "Configured microservice #{microservice_name}"
end

#deploy_scopecleanup_microservice(gem_path, variables, parent) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/openc3/models/scope_model.rb', line 213

def deploy_scopecleanup_microservice(gem_path, variables, parent)
  microservice_name = "#{@scope}__SCOPECLEANUP__#{@scope}"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "scope_cleanup_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    parent: parent,
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  @children << microservice_name if parent
  Logger.info "Configured microservice #{microservice_name}"
end

#deploy_scopemulti_microservice(gem_path, variables) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/openc3/models/scope_model.rb', line 228

def deploy_scopemulti_microservice(gem_path, variables)
  microservice_name = "#{@scope}__SCOPEMULTI__#{@scope}"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "multi_microservice.rb", *@children],
    work_dir: '/openc3/lib/openc3/microservices',
    target_names: [],
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  Logger.info "Configured microservice #{microservice_name}"
end

#deploy_unknown_commandlog_microservice(gem_path, variables, parent) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/openc3/models/scope_model.rb', line 154

def deploy_unknown_commandlog_microservice(gem_path, variables, parent)
  microservice_name = "#{@scope}__COMMANDLOG__UNKNOWN"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "log_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    options: [
      ["RAW_OR_DECOM", "RAW"],
      ["CMD_OR_TLM", "CMD"],
      ["CYCLE_TIME", "3600"], # Keep at most 1 hour per log
    ],
    topics: ["#{@scope}__COMMAND__{UNKNOWN}__UNKNOWN"],
    target_names: [],
    parent: parent,
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  @children << microservice_name if parent
  Logger.info "Configured microservice #{microservice_name}"
end

#deploy_unknown_packetlog_microservice(gem_path, variables, parent) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openc3/models/scope_model.rb', line 176

def deploy_unknown_packetlog_microservice(gem_path, variables, parent)
  microservice_name = "#{@scope}__PACKETLOG__UNKNOWN"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "log_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    options: [
      ["RAW_OR_DECOM", "RAW"],
      ["CMD_OR_TLM", "TLM"],
      ["CYCLE_TIME", "3600"], # Keep at most 1 hour per log
    ],
    topics: ["#{@scope}__TELEMETRY__{UNKNOWN}__UNKNOWN"],
    target_names: [],
    parent: parent,
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  @children << microservice_name if parent
  Logger.info "Configured microservice #{microservice_name}"
end

#destroy ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/openc3/models/scope_model.rb', line 105

def destroy
  if @name != 'DEFAULT'
    # Remove all the plugins for this scope
    plugins = PluginModel.get_all_models(scope: @name)
    plugins.each do |plugin_name, plugin|
      plugin.destroy
    end
    super()
  else
    raise "DEFAULT scope cannot be destroyed"
  end
end

#seed_database ⇒ Object 



303
304
305
306
307
308
309
310
 
# File 'lib/openc3/models/scope_model.rb', line 303

def seed_database
  setting = SettingModel.get(name: 'source_url')
  SettingModel.set({ name: 'source_url', data: 'https://github.com/OpenC3/cosmos' }, scope: @scope) unless setting
  setting = SettingModel.get(name: 'rubygems_url')
  SettingModel.set({ name: 'rubygems_url', data: 'https://rubygems.org' }, scope: @scope) unless setting
  setting = SettingModel.get(name: 'pypi_url')
  SettingModel.set({ name: 'pypi_url', data: 'https://pypi.org' }, scope: @scope) unless setting
end

#undeploy ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/openc3/models/scope_model.rb', line 278

def undeploy
  model = MicroserviceModel.get_model(name: "#{@scope}__SCOPEMULTI__#{@scope}", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__SCOPECLEANUP__#{@scope}", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__OPENC3__LOG", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__COMMANDLOG__UNKNOWN", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__PACKETLOG__UNKNOWN", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__PERIODIC__#{@scope}", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__TRIGGER_GROUP__DEFAULT", scope: @scope)
  model.destroy if model

  # Delete the topics we created for the scope
  Topic.del("#{@scope}__COMMAND__{UNKNOWN}__UNKNOWN")
  Topic.del("#{@scope}__TELEMETRY__{UNKNOWN}__UNKNOWN")
  Topic.del("#{@scope}__openc3_targets")
  Topic.del("#{@scope}__CONFIG")
  Topic.del("#{@scope}__openc3_autonomic")
  Topic.del("#{@scope}__TRIGGER__GROUP")
end