openc3 5.0.6

data/lib/openc3/models/metric_model.rb

@@ -0,0 +1,59 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/models/model'
+
+module OpenC3
+  class MetricModel < EphemeralModel
+    PRIMARY_KEY = '__openc3__metric'.freeze
+
+    # NOTE: The following three class methods are used by the ModelController
+    # and are reimplemented to enable various Model class methods to work
+    def self.get(name:, scope:)
+      super("#{scope}#{PRIMARY_KEY}", name: name)
+    end
+
+    def self.names(scope:)
+      super("#{scope}#{PRIMARY_KEY}")
+    end
+
+    def self.all(scope:)
+      super("#{scope}#{PRIMARY_KEY}")
+    end
+
+    def self.destroy(scope:, name:)
+      EphemeralStore.hdel("#{scope}#{PRIMARY_KEY}", name)
+    end
+
+    def initialize(name:, scope:, metric_name:, label_list:)
+      super("#{scope}#{PRIMARY_KEY}", name: name, scope: scope)
+      @metric_name = metric_name
+      @label_list = label_list
+    end
+
+    def as_json(*a)
+      {
+        'name' => @name,
+        'updated_at' => @updated_at,
+        'metric_name' => @metric_name,
+        'label_list' => @label_list
+      }
+    end
+  end
+end

data/lib/openc3/models/microservice_model.rb

@@ -0,0 +1,206 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/top_level'
+require 'openc3/models/model'
+require 'openc3/utilities/s3'
+
+module OpenC3
+  class MicroserviceModel < Model
+    PRIMARY_KEY = 'openc3_microservices'
+
+    attr_accessor :cmd
+    attr_accessor :options
+    attr_accessor :needs_dependencies
+
+    # NOTE: The following three class methods are used by the ModelController
+    # and are reimplemented to enable various Model class methods to work
+    def self.get(name:, scope: nil)
+      super(PRIMARY_KEY, name: name)
+    end
+
+    def self.names(scope: nil)
+      scoped = []
+      unscoped = super(PRIMARY_KEY)
+      unscoped.each do |name|
+        if !scope or name.split("__")[0] == scope
+          scoped << name
+        end
+      end
+      scoped
+    end
+
+    def self.all(scope: nil)
+      scoped = {}
+      unscoped = super(PRIMARY_KEY)
+      unscoped.each do |name, json|
+        if !scope or name.split("__")[0] == scope
+          scoped[name] = json
+        end
+      end
+      scoped
+    end
+
+    # Called by the PluginModel to allow this class to validate it's top-level keyword: "MICROSERVICE"
+    def self.handle_config(parser, keyword, parameters, plugin: nil, needs_dependencies: false, scope:)
+      case keyword
+      when 'MICROSERVICE'
+        parser.verify_num_parameters(2, 2, "#{keyword} <Folder Name> <Name>")
+        # Create name by adding scope and type 'USER' to indicate where this microservice came from
+        return self.new(folder_name: parameters[0], name: "#{scope}__USER__#{parameters[1].upcase}", plugin: plugin, needs_dependencies: needs_dependencies, scope: scope)
+      else
+        raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
+      end
+    end
+
+    # Create a microservice model to be deployed to S3
+    def initialize(
+      name:,
+      folder_name: nil,
+      cmd: [],
+      work_dir: '.',
+      env: {},
+      topics: [],
+      target_names: [],
+      options: [],
+      container: nil,
+      updated_at: nil,
+      plugin: nil,
+      needs_dependencies: false,
+      scope:
+    )
+      parts = name.split("__")
+      if parts.length != 3
+        raise "name '#{name}' must be formatted as SCOPE__TYPE__NAME"
+      end
+      if parts[0] != scope
+        raise "name '#{name}' scope '#{parts[0]}' doesn't match scope parameter '#{scope}'"
+      end
+
+      super(PRIMARY_KEY, name: name, updated_at: updated_at, plugin: plugin, scope: scope)
+      @folder_name = folder_name
+      @cmd = cmd
+      @work_dir = work_dir
+      @env = env
+      @topics = topics
+      @target_names = target_names
+      @options = options
+      @container = container
+      @needs_dependencies = needs_dependencies
+    end
+
+    def as_json(*a)
+      {
+        'name' => @name,
+        'folder_name' => @folder_name,
+        'cmd' => @cmd,
+        'work_dir' => @work_dir,
+        'env' => @env,
+        'topics' => @topics,
+        'target_names' => @target_names,
+        'options' => @options,
+        'container' => @container,
+        'updated_at' => @updated_at,
+        'plugin' => @plugin,
+        'needs_dependencies' => @needs_dependencies,
+      }
+    end
+
+    def as_config
+      result = "MICROSERVICE #{@folder_name ? @folder_name : 'nil'} #{@name.split("__")[-1]}\n"
+      result << "  CMD #{@cmd.join(' ')}\n"
+      result << "  WORK_DIR \"#{@work_dir}\"\n"
+      @topics.each do |topic_name|
+        result << "  TOPIC #{topic_name}\n"
+      end
+      @target_names.each do |target_name|
+        result << "  TARGET_NAME #{target_name}\n"
+      end
+      @env.each do |key, value|
+        result << "  ENV #{key} \"#{value}\"\n"
+      end
+      @options.each do |option|
+        result << "  OPTION #{option.join(" ")}\n"
+      end
+      result << "  CONTAINER #{@container}\n" if @container != 'openc3-base'
+      result
+    end
+
+    def handle_config(parser, keyword, parameters)
+      case keyword
+      when 'ENV'
+        parser.verify_num_parameters(2, 2, "#{keyword} <Key> <Value>")
+        @env[parameters[0]] = parameters[1]
+      when 'WORK_DIR'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Dir>")
+        @work_dir = parameters[0]
+      when 'TOPIC'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Topic Name>")
+        @topics << parameters[0]
+      when 'TARGET_NAME'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Target Name>")
+        @target_names << parameters[0]
+      when 'CMD'
+        parser.verify_num_parameters(1, nil, "#{keyword} <Args>")
+        @cmd = parameters.dup
+      when 'OPTION'
+        parser.verify_num_parameters(2, nil, "#{keyword} <Option Name> <Option Values>")
+        @options << parameters.dup
+      when 'CONTAINER'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Container Image Name>")
+        @container = parameters[0]
+      else
+        raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
+      end
+      return nil
+    end
+
+    def deploy(gem_path, variables, validate_only: false)
+      return unless @folder_name
+
+      variables["microservice_name"] = @name
+      start_path = "/microservices/#{@folder_name}/"
+      Dir.glob(gem_path + start_path + "**/*") do |filename|
+        next if filename == '.' or filename == '..' or File.directory?(filename)
+
+        path = filename.split(gem_path)[-1]
+        key = "#{@scope}/microservices/#{@name}/" + path.split(start_path)[-1]
+
+        # Load microservice files
+        data = File.read(filename, mode: "rb")
+        OpenC3.set_working_dir(File.dirname(filename)) do
+          data = ERB.new(data, trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable?
+        end
+        unless validate_only
+          Aws::S3::Client.new.put_object(bucket: 'config', key: key, body: data)
+          ConfigTopic.write({ kind: 'created', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
+        end
+      end
+    end
+
+    def undeploy
+      rubys3_client = Aws::S3::Client.new
+      prefix = "#{@scope}/microservices/#{@name}/"
+      rubys3_client.list_objects(bucket: 'config', prefix: prefix).contents.each do |object|
+        rubys3_client.delete_object(bucket: 'config', key: object.key)
+      end
+      ConfigTopic.write({ kind: 'deleted', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
+    end
+  end
+end

data/lib/openc3/models/microservice_status_model.rb

@@ -0,0 +1,74 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/models/model'
+
+module OpenC3
+  class MicroserviceStatusModel < EphemeralModel
+    PRIMARY_KEY = 'openc3_microservice_status'
+
+    attr_accessor :state
+    attr_accessor :count
+    attr_accessor :error
+    attr_accessor :custom
+
+    # NOTE: The following three class methods are used by the ModelController
+    # and are reimplemented to enable various Model class methods to work
+    def self.get(name:, scope:)
+      super("#{scope}__#{PRIMARY_KEY}", name: name)
+    end
+
+    def self.names(scope:)
+      super("#{scope}__#{PRIMARY_KEY}")
+    end
+
+    def self.all(scope:)
+      super("#{scope}__#{PRIMARY_KEY}")
+    end
+
+    def initialize(
+      name:,
+      state: nil,
+      count: 0,
+      error: nil,
+      custom: nil,
+      updated_at: nil,
+      plugin: nil,
+      scope:
+    )
+      super("#{scope}__#{PRIMARY_KEY}", name: name, updated_at: updated_at, plugin: plugin, scope: scope)
+      @state = state
+      @count = count
+      @error = error
+      @custom = custom
+    end
+
+    def as_json(*a)
+      {
+        'name' => @name,
+        'state' => @state,
+        'count' => @count,
+        'error' => @error.as_json(:allow_nan => true),
+        'custom' => @custom.as_json(:allow_nan => true),
+        'plugin' => @plugin,
+        'updated_at' => @updated_at
+      }
+    end
+  end
+end

data/lib/openc3/models/model.rb

@@ -0,0 +1,204 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/utilities/store'
+require 'openc3/config/config_parser'
+
+module OpenC3
+  class Model
+    attr_accessor :name
+    attr_accessor :updated_at
+    attr_accessor :plugin
+    attr_accessor :scope
+
+    def self.store
+      Store
+    end
+
+    # NOTE: The following three methods must be reimplemented by Model subclasses
+    # without primary_key to support other class methods.
+
+    # @return [Hash|nil] Hash of this model or nil if name not found under primary_key
+    def self.get(primary_key, name:)
+      json = store.hget(primary_key, name)
+      if json
+        return JSON.parse(json, :allow_nan => true, :create_additions => true)
+      else
+        return nil
+      end
+    end
+
+    # @return [Array<String>] All the names stored under the primary key
+    def self.names(primary_key)
+      store.hkeys(primary_key).sort
+    end
+
+    # @return [Array<Hash>] All the models (as Hash objects) stored under the primary key
+    def self.all(primary_key)
+      hash = store.hgetall(primary_key)
+      hash.each do |key, value|
+        hash[key] = JSON.parse(value, :allow_nan => true, :create_additions => true)
+      end
+      hash
+    end
+    # END NOTE
+
+    # Loops over all items and returns objects that match a key value pair
+    def self.filter(key, value, scope:, use_regex: false)
+      filtered = {}
+      results = all(scope: scope)
+      regex = nil
+      regex = Regexp.new(value) if use_regex
+      results.each do |name, result|
+        if regex
+          if result[key] =~ regex
+            filtered[name] = result
+          end
+        else
+          if result[key] == value
+            filtered[name] = result
+          end
+        end
+      end
+      return filtered
+    end
+
+    # Sets (updates) the redis hash of this model
+    def self.set(json, scope:)
+      json[:scope] = scope
+      json.transform_keys!(&:to_sym)
+      self.new(**json).create(force: true)
+    end
+
+    # @return [Model] Model generated from the passed JSON
+    def self.from_json(json, scope:)
+      json = JSON.parse(json, :allow_nan => true, :create_additions => true) if String === json
+      raise "json data is nil" if json.nil?
+
+      json[:scope] = scope
+      json.transform_keys!(&:to_sym)
+      self.new(**json, scope: scope)
+    end
+
+    # Calls self.get and then from_json to turn the Hash configuration into a Ruby Model object.
+    # @return [Object|nil] Model object or nil if name not found under primary_key
+    def self.get_model(name:, scope:)
+      json = get(name: name, scope: scope)
+      if json
+        return from_json(json, scope: scope)
+      else
+        return nil
+      end
+    end
+
+    # @return [Array<Object>] All the models (as Model objects) stored under the primary key
+    def self.get_all_models(scope:)
+      models = {}
+      all(scope: scope).each { |name, json| models[name] = from_json(json, scope: scope) }
+      models
+    end
+
+    # @return [Array<Object>] All the models (as Model objects) stored under the primary key
+    #   which have the plugin attribute
+    def self.find_all_by_plugin(plugin:, scope:)
+      result = {}
+      models = get_all_models(scope: scope)
+      models.each do |name, model|
+        result[name] = model if model.plugin == plugin
+      end
+      result
+    end
+
+    def self.handle_config(parser, model, keyword, parameters)
+      raise "must be implemented by subclass"
+    end
+
+    # Store the primary key and keyword arguments
+    def initialize(primary_key, **kw_args)
+      @primary_key = primary_key
+      @name = kw_args[:name]
+      @updated_at = kw_args[:updated_at]
+      @plugin = kw_args[:plugin]
+      @scope = kw_args[:scope]
+      @destroyed = false
+    end
+
+    # Update the Redis hash at primary_key and set the field "name"
+    # to the JSON generated via calling as_json
+    def create(update: false, force: false)
+      unless force
+        existing = self.class.store.hget(@primary_key, @name)
+        if existing
+          raise "#{@primary_key}:#{@name} already exists at create" unless update
+        else
+          raise "#{@primary_key}:#{@name} doesn't exist at update" if update
+        end
+      end
+      @updated_at = Time.now.to_nsec_from_epoch
+      self.class.store.hset(@primary_key, @name, JSON.generate(self.as_json(:allow_nan => true)))
+    end
+
+    # Alias for create(update: true)
+    def update
+      create(update: true)
+    end
+
+    # Deploy the model into the OpenC3 system. Subclasses must implement this
+    # and typically create MicroserviceModels to implement.
+    def deploy(gem_path, variables)
+      raise "must be implemented by subclass"
+    end
+
+    # Undo the actions of deploy and remove the model from OpenC3.
+    # Subclasses must implement this as by default it is a noop.
+    def undeploy
+    end
+
+    # Delete the model from the Store
+    def destroy
+      @destroyed = true
+      undeploy()
+      self.class.store.hdel(@primary_key, @name)
+    end
+
+    # Indicate if destroy has been called
+    def destroyed?
+      @destroyed
+    end
+
+    # @return [Hash] JSON encoding of this model
+    def as_json(*a)
+      { 'name' => @name,
+        'updated_at' => @updated_at,
+        'plugin' => @plugin,
+        'scope' => @scope }
+    end
+
+    # TODO: Not currently used but may be used by a XTCE or other format to OpenC3 conversion
+    def as_config
+      ""
+    end
+  end
+
+  class EphemeralModel < Model
+    def self.store
+      EphemeralStore
+    end
+  end
+end

data/lib/openc3/models/note_model.rb

@@ -0,0 +1,122 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+# https://www.rubydoc.info/gems/redis/Redis/Commands/SortedSets
+
+require 'openc3/models/sorted_model'
+
+module OpenC3
+  class NoteModel < SortedModel
+    NOTE_TYPE = 'note'.freeze
+    PRIMARY_KEY = '__NOTE'.freeze
+
+    def self.pk(scope)
+      "#{scope}#{PRIMARY_KEY}"
+    end
+
+    attr_reader :stop, :color, :description, :type
+
+    # @param [String] scope - OpenC3 scope to track event to
+    # @param [Integer] start - start of the event in seconds from Epoch
+    # @param [Integer] stop - stop of the event in seconds from Epoch
+    # @param [String] color - The event color
+    # @param [String] description - What the event is about
+    def initialize(
+      scope:,
+      start:,
+      stop:,
+      color: nil,
+      description:,
+      type: NOTE_TYPE,
+      updated_at: 0
+    )
+      super(start: start, scope: scope, updated_at: updated_at)
+      @start = start
+      @stop = stop
+      @color = color
+      @description = description
+      @type = type # For the as_json, from_json round trip
+    end
+
+    # Validates the instance variables: @start, @stop, @color, @description
+    def validate(update: false)
+      validate_start(update: update)
+      validate_stop()
+      validate_color()
+    end
+
+    def validate_stop()
+      unless @stop.is_a?(Integer)
+        raise SortedInputError.new "stop must be integer: #{@stop}"
+      end
+      if @stop.to_i < @start
+        raise SortedInputError.new "stop: #{@stop} must be >= start: #{@start}"
+      end
+      @stop = @stop.to_i
+    end
+
+    def validate_color()
+      if @color.nil?
+        @color = '#%06x' % (rand * 0xffffff)
+      end
+      unless @color =~ /(#*)([0-9,a-f,A-f]{6})/
+        raise SortedInputError.new "invalid color, must be in hex format, e.g. #FF0000"
+      end
+      @color = "##{@color}" unless @color.start_with?('#')
+    end
+
+    # Update the Redis hash at primary_key based on the initial passed start
+    # The member is set to the JSON generated via calling as_json
+    def create(update: false)
+      validate(update: update)
+      @updated_at = Time.now.to_nsec_from_epoch
+      NoteModel.destroy(scope: @scope, start: update) if update
+      Store.zadd(@primary_key, @start, JSON.generate(as_json(:allow_nan => true)))
+      if update
+        notify(kind: 'updated')
+      else
+        notify(kind: 'created')
+      end
+    end
+
+    # Update the Redis hash at primary_key
+    def update(start:, stop:, color:, description:)
+      orig_start = @start
+      @start = start
+      @stop = stop
+      @color = color
+      @description = description
+      create(update: orig_start)
+    end
+
+    # @return [Hash] generated from the NoteModel
+    def as_json(*a)
+      return {
+        'scope' => @scope,
+        'start' => @start,
+        'stop' => @stop,
+        'color' => @color,
+        'description' => @description,
+        'type' => NOTE_TYPE,
+        'updated_at' => @updated_at,
+      }
+    end
+    alias to_s as_json
+  end
+end

data/lib/openc3/models/notification_model.rb

@@ -0,0 +1,40 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+module OpenC3
+  class NotificationModel
+    attr_reader :time, :severity, :url, :title, :body
+
+    def initialize(time:, severity:, url:, title:, body:)
+      @time = time
+      @severity = severity
+      @url = url
+      @title = title
+      @body = body
+    end
+
+    def as_json(*a)
+      { "time" => @time,
+        "severity" => @severity,
+        "url" => @url,
+        "title" => @title,
+        "body" => @body }
+    end
+  end
+end