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

Attributes inherited from Model

#name, #plugin, #scope, #updated_at

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

#as_config, #destroyed?, filter, find_all_by_plugin, get_all_models, handle_config, set, store, #update

Constructor Details

#initialize(name:, updated_at: nil, scope: nil) ⇒ ScopeModel

Returns a new instance of ScopeModel.



60
61
62
 
# File 'lib/openc3/models/scope_model.rb', line 60

def initialize(name:, updated_at: nil, scope: nil)
  super(PRIMARY_KEY, name: name, scope: name, updated_at: updated_at)
end

Class Method Details

.all(scope: nil) ⇒ Object 



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

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

.from_json(json, scope: nil) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/openc3/models/scope_model.rb', line 43

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?

  json.transform_keys!(&:to_sym)
  self.new(**json, 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



31
32
33
 
# File 'lib/openc3/models/scope_model.rb', line 31

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

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



51
52
53
54
55
56
57
58
 
# File 'lib/openc3/models/scope_model.rb', line 51

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

.limits_set(scope:) ⇒ Object 



189
190
191
 
# File 'lib/openc3/models/scope_model.rb', line 189

def self.limits_set(scope:)
  Store.hget("#{scope}__openc3_system", 'limits_set').intern
end

.names(scope: nil) ⇒ Object 



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

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

Instance Method Details

#as_json(*a) ⇒ Object 



84
85
86
87
 
# File 'lib/openc3/models/scope_model.rb', line 84

def as_json(*a)
  { 'name' => @name,
    'updated_at' => @updated_at }
end

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



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

def create(update: false, force: 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)
end

#deploy(gem_path, variables) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/openc3/models/scope_model.rb', line 89

def deploy(gem_path, variables)
  seed_database()
  ConfigTopic.initialize_stream(@scope)

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

  # OpenC3 Log Microservice
  microservice_name = "#{@scope}__OPENC3__LOG"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "text_log_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    options: [
      # The following options are optional (600 and 50_000_000 are the defaults)
      # ["CYCLE_TIME", "600"], # Keep at most 10 minutes per log
      # ["CYCLE_SIZE", "50_000_000"] # Keep at most ~50MB per log
    ],
    topics: ["#{@scope}__openc3_log_messages"],
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  Logger.info "Configured microservice #{microservice_name}"

  # Notification Log Microservice
  microservice_name = "#{@scope}__NOTIFICATION__LOG"
  microservice = MicroserviceModel.new(
    name: microservice_name,
    cmd: ["ruby", "text_log_microservice.rb", microservice_name],
    work_dir: '/openc3/lib/openc3/microservices',
    options: [
      # The following options are optional (600 and 50_000_000 are the defaults)
      ["CYCLE_TIME", "3600"], # Keep at most 1 hour per log
    ],
    topics: ["#{@scope}__openc3_notifications"],
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  Logger.info "Configured microservice #{microservice_name}"

  # UNKNOWN CommandLog Microservice
  Topic.initialize_streams(["#{@scope}__COMMAND__{UNKNOWN}__UNKNOWN"])
  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: [],
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  Logger.info "Configured microservice #{microservice_name}"

  # UNKNOWN PacketLog Microservice
  Topic.initialize_streams(["#{@scope}__TELEMETRY__{UNKNOWN}__UNKNOWN"])
  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: [],
    scope: @scope
  )
  microservice.create
  microservice.deploy(gem_path, variables)
  Logger.info "Configured microservice #{microservice_name}"
end

#destroy ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/openc3/models/scope_model.rb', line 71

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 



184
185
186
187
 
# File 'lib/openc3/models/scope_model.rb', line 184

def seed_database
  setting = SettingsModel.get(name: 'source_url')
  SettingsModel.set({ name: 'source_url', data: 'https://github.com/OpenC3/openc3' }, scope: @scope) unless setting
end

#undeploy ⇒ Object 



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/openc3/models/scope_model.rb', line 173

def undeploy
  model = MicroserviceModel.get_model(name: "#{@scope}__OPENC3__LOG", scope: @scope)
  model.destroy if model
  model = MicroserviceModel.get_model(name: "#{@scope}__NOTIFICATION__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
end