openc3 5.8.1 → 5.9.0

data/lib/openc3/models/trigger_group_model.rb

@@ -26,14 +26,8 @@ require 'openc3/topics/autonomic_topic'
 
 module OpenC3
   class TriggerGroupError < StandardError; end
-
   class TriggerGroupInputError < TriggerGroupError; end
 
-  # INPUT:
-  #  {
-  #    "name": "FOOBAR",
-  #    "color": "#000000",
-  #  }
   class TriggerGroupModel < Model
     PRIMARY_KEY = '__TRIGGER__GROUP'.freeze
 
@@ -59,67 +53,39 @@ module OpenC3
     def self.delete(name:, scope:)
       model = self.get(name: name, scope: scope)
       if model.nil?
-        raise TriggerGroupInputError.new "invalid group: #{name} not found"
+        raise TriggerGroupInputError.new "group '#{name}' does not exist"
       end
       triggers = TriggerModel.names(scope: scope, group: name)
       if triggers.empty?
         Store.hdel("#{scope}#{PRIMARY_KEY}", name)
         model.notify(kind: 'deleted')
       else
-        raise TriggerGroupError.new "failed to delete #{name} triggers: #{triggers}"
+        raise TriggerGroupError.new "group '#{name}' has dependent triggers: #{triggers}"
       end
     end
 
-    attr_reader :name, :scope, :color, :updated_at
+    attr_reader :name, :scope, :updated_at
 
-    def initialize(name:, scope:, color: nil, updated_at: nil)
-      if name.nil? || scope.nil?
-        raise GroupTriggerInputError.new "name, or scope must not be nil"
-      end
+    def initialize(name:, scope:, updated_at: nil)
       unless name.is_a?(String)
-        raise TriggerGroupInputError.new "invalid name: '#{name}'"
+        raise TriggerGroupInputError.new "invalid group name: '#{name}'"
       end
       if name.include?('_')
-        raise TriggerGroupInputError.new "invalid name: '#{name}' can not include an underscore '_'"
+        raise TriggerGroupInputError.new "group name '#{name}' can not include an underscore"
       end
       super("#{scope}#{PRIMARY_KEY}", name: name, scope: scope)
       @microservice_name = "#{scope}__TRIGGER_GROUP__#{name}"
-      update_color(color: color)
       @updated_at = updated_at
     end
 
-    def update_color(color: nil)
-      if color.nil?
-        color = '#%06x' % (rand * 0xffffff)
-      end
-      valid_color = color =~ /[0-9a-fA-F]{6}/
-      if valid_color.nil?
-        raise TriggerGroupInputError.new "invalid color must be in hex format. #FF0000"
-      end
-      unless color.start_with?('#')
-        color = "##{color}"
-      end
-      @color = color
-    end
-
-    def create
-      unless Store.hget(@primary_key, @name).nil?
-        raise TriggerGroupInputError.new "exsisting TriggerGroup found: #{@name}"
-      end
-      @updated_at = Time.now.to_nsec_from_epoch
-      Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
+    def create(update: false)
+      super(update: update)
       notify(kind: 'created')
     end
 
-    def update
-      @updated_at = Time.now.to_nsec_from_epoch
-      Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
-      notify(kind: 'updated')
-    end
-
-    # @return [String] generated from the TriggerGroupModel
+    # @return [String] generated from the TriggerModel
     def to_s
-      return "(TriggerGroupModel :: #{@name})"
+      return "OpenC3::TriggerGroupModel:#{@scope}:#{@name})"
     end
 
     # @return [Hash] generated from the TriggerGroupModel
@@ -127,7 +93,6 @@ module OpenC3
       return {
         'name' => @name,
         'scope' => @scope,
-        'color' => @color,
         'updated_at' => @updated_at,
       }
     end
@@ -136,9 +101,7 @@ module OpenC3
     def self.from_json(json, name:, scope:)
       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, name: name, scope: scope)
+      self.new(**json.transform_keys(&:to_sym), name: name, scope: scope)
     end
 
     # @return [] update the redis stream / trigger topic that something has changed
@@ -173,15 +136,18 @@ module OpenC3
       topics = ["#{@scope}__openc3_autonomic"]
       if MicroserviceModel.get_model(name: @microservice_name, scope: @scope).nil?
         create_microservice(topics: topics)
+        notify(kind: 'deployed')
       end
     end
 
     def undeploy
       if TriggerModel.names(scope: scope, group: name).empty?
         model = MicroserviceModel.get_model(name: @microservice_name, scope: @scope)
-        model.destroy if model
+        if model
+          model.destroy
+          notify(kind: 'undeployed')
+        end
       end
     end
-
   end
 end

data/lib/openc3/models/trigger_model.rb

@@ -17,17 +17,18 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/model'
 require 'openc3/models/microservice_model'
 require 'openc3/models/target_model'
+require 'openc3/models/trigger_group_model'
+require 'openc3/models/reaction_model'
 require 'openc3/topics/autonomic_topic'
 
 module OpenC3
   class TriggerError < StandardError; end
-
   class TriggerInputError < TriggerError; end
 
   # INPUT:
@@ -38,6 +39,7 @@ module OpenC3
   #      "target": "INST",
   #      "packet": "ADCS",
   #      "item": "POSX",
+  #      "valueType": "RAW",
   #    },
   #    "operator": ">",
   #    "right": {
@@ -51,13 +53,16 @@ module OpenC3
     LIMIT_TYPE = 'limit'.freeze
     FLOAT_TYPE = 'float'.freeze
     STRING_TYPE = 'string'.freeze
+    REGEX_TYPE = 'regex'.freeze
     TRIGGER_TYPE = 'trigger'.freeze
 
-    def self.create_mini_id
-      time = (Time.now.to_f * 10_000_000).to_i
-      jitter = rand(10_000_000) 
-      key = "#{jitter}#{time}".to_i.to_s(36)
-      return "TV0-#{key}"
+    def self.create_unique_name(group:, scope:)
+      trigger_names = self.names(group: group, scope: scope) # comes back sorted
+      num = 1 # Users count with 1
+      if trigger_names[-1]
+        num = trigger_names[-1][4..-1].to_i + 1
+      end
+      return "TRIG#{num}"
     end
 
     # @return [TriggerModel] Return the object with the name at
@@ -82,10 +87,10 @@ module OpenC3
     def self.delete(name:, group:, scope:)
       model = self.get(name: name, group: group, scope: scope)
       if model.nil?
-        raise TriggerInputError.new "invalid operation group: #{group} trigger: #{name} not found"
+        raise TriggerInputError.new "trigger #{group}:#{name} does not exist"
       end
       unless model.dependents.empty?
-        raise TriggerError.new "failed to delete #{name} dependents: #{model.dependents}"
+        raise TriggerError.new "#{group}:#{name} has dependents: #{model.dependents}"
       end
       model.roots.each do | trigger |
         trigger_model = self.get(name: trigger, group: group, scope: scope)
@@ -93,24 +98,67 @@ module OpenC3
         trigger_model.update()
       end
       Store.hdel("#{scope}#{PRIMARY_KEY}#{group}", name)
-      model.notify(kind: 'deleted')
+      # No notification as this is only called via trigger_controller which already notifies
     end
 
-    def validate_operand(operand:)
+    attr_reader :name, :scope, :state, :group, :enabled, :left, :operator, :right, :dependents, :roots
+
+    def initialize(
+      name:,
+      scope:,
+      group:,
+      left:,
+      operator:,
+      right:,
+      state: false,
+      enabled: true,
+      dependents: nil,
+      updated_at: nil
+    )
+      super("#{scope}#{PRIMARY_KEY}#{group}", name: name, scope: scope)
+      @roots = []
+      @group = group
+      @state = state
+      @enabled = enabled
+      @left = validate_operand(operand: left)
+      @operator = validate_operator(operator: operator)
+      @right = validate_operand(operand: right, right: true)
+      @dependents = dependents
+      @updated_at = updated_at
+      selected_group = TriggerGroupModel.get(name: @group, scope: @scope)
+      if selected_group.nil?
+        raise TriggerInputError.new "failed to find group: '#{@group}'"
+      end
+    end
+
+    # Modifiers for the trigger_controller update action
+    def left=(left)
+      @left = validate_operand(operand: left)
+    end
+    def right=(right)
+      @right = validate_operand(operand: right, right: true)
+    end
+    def operator=(operator)
+      @operator = validate_operator(operator: operator)
+    end
+
+    def validate_operand(operand:, right: false)
+      return operand if right and @operator.include?('CHANGE')
       unless operand.is_a?(Hash)
         raise TriggerInputError.new "invalid operand: #{operand}"
       end
-      operand_types = [ITEM_TYPE, LIMIT_TYPE, FLOAT_TYPE, STRING_TYPE, TRIGGER_TYPE]
+      operand_types = [ITEM_TYPE, LIMIT_TYPE, FLOAT_TYPE, STRING_TYPE, REGEX_TYPE, TRIGGER_TYPE]
       unless operand_types.include?(operand['type'])
-        raise TriggerInputError.new "invalid operand type: #{operand['type']} must be of type: #{operand_types}"
+        raise TriggerInputError.new "invalid operand, type '#{operand['type']}' must be one of #{operand_types}"
       end
       if operand[operand['type']].nil?
-        raise TriggerInputError.new "invalid operand must contain type: #{operand}"
+        raise TriggerInputError.new "invalid operand, type value '#{operand['type']}' must be a key: #{operand}"
       end
       case operand['type']
       when ITEM_TYPE
-        if operand['target'].nil? || operand['packet'].nil? || operand['raw'].nil?
-          raise TriggerInputError.new "invalid operand must contain target, packet, item, and raw: #{operand}"
+        # We don't need to check for 'item' because the above check already does it
+        if operand['target'].nil? || operand['packet'].nil? || operand['valueType'].nil?
+          raise TriggerInputError.new "invalid operand, must contain target, packet, item and valueType: #{operand}"
         end
       when TRIGGER_TYPE
         @roots << operand[operand['type']]
@@ -119,85 +167,25 @@ module OpenC3
     end
 
     def validate_operator(operator:)
-      unless operator.is_a?(String)
-        raise TriggerInputError.new "invalid operator: #{operator}"
-      end
-      operators = ['>', '<', '>=', '<=']
-      match_operators = ['==', '!=']
+      operators = ['>', '<', '>=', '<=', '==', '!=', 'CHANGES', 'DOES NOT CHANGE']
       trigger_operators = ['AND', 'OR']
       if @roots.empty? && operators.include?(operator)
         return operator
-      elsif @roots.empty? && match_operators.include?(operator)
-        return operator
-      elsif @roots.size() == 2 && trigger_operators.include?(operator)
+      elsif !@roots.empty? && trigger_operators.include?(operator)
         return operator
       elsif operators.include?(operator)
-        raise TriggerInputError.new "invalid operator pair: '#{operator}' must be of type: #{trigger_operators}"
+        raise TriggerInputError.new "invalid operator for triggers: '#{operator}' must be one of #{trigger_operators}"
       else
-        raise TriggerInputError.new "invalid operator: '#{operator}' must be of type: #{operators}"
-      end
-    end
-
-    def validate_description(description:)
-      if description.nil?
-        left_type = @left['type']
-        right_type = @right['type']
-        return "#{@left[left_type]} #{@operator} #{@right[right_type]}"
-      end
-      unless description.is_a?(String)
-        raise TriggerInputError.new "invalid description: #{description}"
-      end
-      return description
-    end
-
-    attr_reader :name, :scope, :state, :group, :active, :left, :operator, :right, :dependents, :roots
-
-    #
-    def initialize(
-      name:,
-      scope:,
-      group:,
-      left:,
-      operator:,
-      right:,
-      state: false,
-      active: true,
-      description: nil,
-      dependents: nil,
-      updated_at: nil
-    )
-      if name.nil? || scope.nil? || group.nil? || left.nil? || operator.nil? || right.nil?
-        raise TriggerInputError.new "#{name}, #{scope}, #{group}, #{left}, #{operator}, or #{right} must not be nil"
+        raise TriggerInputError.new "invalid operator: '#{operator}' must be one of #{operators}"
       end
-      super("#{scope}#{PRIMARY_KEY}#{group}", name: name, scope: scope)
-      @roots = []
-      @group = group
-      @state = state
-      @active = active
-      @left = validate_operand(operand: left)
-      @right = validate_operand(operand: right)
-      @operator = validate_operator(operator: operator)
-      @description = validate_description(description: description)
-      @dependents = dependents
-      @updated_at = updated_at
     end
 
     def verify_triggers
-      unless @group.is_a?(String)
-        raise TriggerInputError.new "invalid group: #{@group}"
-      end
-      selected_group = OpenC3::TriggerGroupModel.get(name: @group, scope: @scope)
-      if selected_group.nil?
-        raise TriggerGroupInputError.new "failed to find group: #{@group}"
-      end
       @dependents = [] if @dependents.nil?
       @roots.each do | trigger |
         model = TriggerModel.get(name: trigger, group: @group, scope: @scope)
         if model.nil?
-          raise TriggerInputError.new "failed to find dependent trigger: #{trigger}"
-        end
-        if model.group != @group
-          raise TriggerInputError.new "failed group dependent trigger: #{trigger}"
+          raise TriggerInputError.new "failed to find dependent trigger: '#{@group}:#{trigger}'"
         end
         unless model.dependents.include?(@name)
           model.update_dependents(dependent: @name)
@@ -208,7 +196,7 @@ module OpenC3
 
     def create
       unless Store.hget(@primary_key, @name).nil?
-        raise TriggerInputError.new "exsisting Trigger found: #{@name}"
+        raise TriggerInputError.new "existing trigger found: '#{@name}'"
       end
       verify_triggers()
       @updated_at = Time.now.to_nsec_from_epoch
@@ -220,40 +208,31 @@ module OpenC3
       verify_triggers()
       @updated_at = Time.now.to_nsec_from_epoch
       Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
-      notify(kind: 'updated')
+      # No notification as this is only called via trigger_controller which already notifies
     end
 
-    def enable
-      @state = true
+    def state=(value)
+      @state = value
       @updated_at = Time.now.to_nsec_from_epoch
       Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
+      notify(kind: @state.to_s)
+    end
+
+    def notify_enable
+      @enabled = true
       notify(kind: 'enabled')
     end
 
-    def disable
+    def notify_disable
+      @enabled = false
       @state = false
-      @updated_at = Time.now.to_nsec_from_epoch
-      Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
       notify(kind: 'disabled')
     end
 
-    def activate
-      @active = true
-      @updated_at = Time.now.to_nsec_from_epoch
-      Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
-      notify(kind: 'activated')
-    end
-
-    def deactivate
-      @active = false
-      @state = false
+    def disable
+      notify_disable()
       @updated_at = Time.now.to_nsec_from_epoch
       Store.hset(@primary_key, @name, JSON.generate(as_json(:allow_nan => true)))
-      notify(kind: 'deactivated')
-    end
-
-    def modify
-      raise "TODO"
     end
 
     # ["#{@scope}__DECOM__{#{@target}}__#{@packet}"]
@@ -262,7 +241,7 @@ module OpenC3
       if @left['type'] == ITEM_TYPE
         topics["#{@scope}__DECOM__{#{left['target']}}__#{left['packet']}"] = 1
       end
-      if @right['type'] == ITEM_TYPE
+      if @right and @right['type'] == ITEM_TYPE
         topics["#{@scope}__DECOM__{#{right['target']}}__#{right['packet']}"] = 1
       end
       return topics.keys
@@ -278,7 +257,7 @@ module OpenC3
 
     # @return [String] generated from the TriggerModel
     def to_s
-      return "(TriggerModel :: #{@name} :: #{group} :: #{@description})"
+      return "OpenC3::TriggerModel:#{@scope}:#{group}:#{@name})"
     end
 
     # @return [Hash] generated from the TriggerModel
@@ -287,9 +266,8 @@ module OpenC3
         'name' => @name,
         'scope' => @scope,
         'state' => @state,
-        'active' => @active,
+        'enabled' => @enabled,
         'group' => @group,
-        'description' => @description,
         'dependents' => @dependents,
         'left' => @left,
         'operator' => @operator,
@@ -302,9 +280,7 @@ module OpenC3
     def self.from_json(json, name:, scope:)
       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, name: name, scope: scope)
+      self.new(**json.transform_keys(&:to_sym), name: name, scope: scope)
     end
 
     # @return [] update the redis stream / trigger topic that something has changed
@@ -316,18 +292,5 @@ module OpenC3
       }
       AutonomicTopic.write_notification(notification, scope: @scope)
     end
-
-    # @param [String] kind - the status such as "event" or "error"
-    # @param [String] message - an optional message to include in the event
-    def log(kind:, message: nil)
-      notification = {
-        'kind' => kind,
-        'type' => 'log',
-        'time' => Time.now.to_i,
-        'name' => @name,
-      }
-      notification['message'] = message unless message.nil?
-      AutonomicTopic.write_notification(notification, scope: @scope)
-    end
   end
 end

data/lib/openc3/packets/json_packet.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3'
@@ -110,8 +110,7 @@ module OpenC3
         value = @json_hash["#{name}__C"]
         return value if value
       end
-      value = @json_hash[name]
-      return value if value
+      return @json_hash[name]
     end
 
     def read_with_limits_state(name, value_type = :CONVERTED, reduced_type = nil)

data/lib/openc3/script/commands.rb

@@ -168,6 +168,16 @@ module OpenC3
       _cmd('cmd_raw_no_checks', nil, *args, **kwargs)
     end
 
+    # Builds a command binary
+    #
+    # Accepts two different calling styles:
+    #   build_command("TGT CMD with PARAM1 val, PARAM2 val")
+    #   build_command('TGT','CMD',{'PARAM1'=>val,'PARAM2'=>val})
+    def build_command(*args, **kwargs)
+      extract_string_kwargs_to_args(args, kwargs)
+      $api_server.build_command(*args)
+    end
+
     # Returns whether the specified command is hazardous
     #
     # Accepts two different calling styles:

data/lib/openc3/script/script.rb

@@ -38,6 +38,7 @@ require 'openc3/script/plugins'
 require 'openc3/utilities/authentication'
 
 $api_server = nil
+$script_runner_api_server = nil
 $disconnect = false
 $openc3_scope = ENV['OPENC3_SCOPE'] || 'DEFAULT'
 $openc3_in_cluster = false

data/lib/openc3/top_level.rb

@@ -349,17 +349,6 @@ module OpenC3
     return log_file
   end
 
-  # Catch fatal exceptions within the block
-  # This is intended to catch exceptions before the GUI is available
-  def self.catch_fatal_exception
-    yield
-  rescue Exception => error
-    unless SystemExit === error or SignalException === error
-      Logger.level = Logger::FATAL
-      OpenC3.handle_fatal_exception(error, false)
-    end
-  end
-
   # Write a message to the Logger, write an exception file, and popup a GUI
   # window if try_gui. Finally 'exit 1' is called to end the calling program.
   #
@@ -369,7 +358,6 @@ module OpenC3
     unless SystemExit === error or SignalException === error
       $openc3_fatal_exception = error
       self.write_exception_file(error)
-      Logger.level = Logger::FATAL
       Logger.fatal "Fatal Exception! Exiting..."
       Logger.fatal error.formatted
       if $stdout != STDOUT

data/lib/openc3/utilities/authorization.rb

@@ -43,7 +43,7 @@ rescue LoadError
         if $openc3_authorize
           raise AuthError.new("Token is required") unless token
           unless OpenC3::AuthModel.verify(token, permission: permission)
-            raise AuthError.new("Current role is invalid for '#{permission}' permission")
+            raise AuthError.new("Password is invalid for '#{permission}' permission")
           end
         end
       end

data/lib/openc3/utilities/bucket_require.rb

@@ -39,6 +39,8 @@ OpenC3.disable_warnings do
           @bucket_require_cache[args[0]] = true
           return true
         end
+      rescue LoadError => err
+        raise err
       rescue Exception => err
         raise LoadError, "#{err.class}:#{err.message}", err.backtrace
       end
@@ -57,7 +59,9 @@ OpenC3.disable_warnings do
           scope = $openc3_scope
         end
         OpenC3::BucketUtilities.bucket_load(*args, scope: scope)
-      rescue Exception
+      rescue LoadError => err
+        raise err
+      rescue Exception => err
         raise LoadError, "#{err.class}:#{err.message}", err.backtrace
       end
     end

data/lib/openc3/utilities/bucket_utilities.rb

@@ -31,17 +31,20 @@ module OpenC3
     DIRECTORY_TIMESTAMP_FORMAT = "%Y%m%d"
 
     def self.bucket_load(*args, scope: $openc3_scope)
+      scope = ENV['OPENC3_SCOPE'] unless scope
+      scope = 'DEFAULT' unless scope
       path = args[0]
 
       # Only support TARGET files
       if path[0] == '/' or path.split('/')[0].to_s.upcase != path.split('/')[0]
-        raise LoadError
+        raise LoadError, "only relative TARGET files are allowed -- #{path}"
       end
       extension = File.extname(path)
       path = path + '.rb' if extension == ""
 
       # Retrieve the text of the script from S3
       text = TargetFile.body(scope, path)
+      raise LoadError, "Bucket file #{path} not found for scope #{scope}" unless text
 
       # Execute the script directly without instrumentation because we are doing require/load
       Object.class_eval(text, path, 1)