openc3 7.2.1 → 7.4.0

data/lib/openc3/packets/telemetry.rb

@@ -59,7 +59,7 @@ module OpenC3
       def packets(target_name)
         upcase_target_name = target_name.to_s.upcase
         target_packets = @config.telemetry[upcase_target_name]
-        raise "Telemetry target '#{upcase_target_name}' does not exist" unless target_packets
+        raise "Telemetry target '#{upcase_target_name}' does not exist (packets lookup)" unless target_packets
 
         target_packets
       end
@@ -177,7 +177,7 @@ module OpenC3
       if LATEST_PACKET_NAME.casecmp(packet_name).zero?
         target_upcase = target_name.to_s.upcase
         target_latest_data = @config.latest_data[target_upcase]
-        raise "Telemetry Target '#{target_upcase}' does not exist" unless target_latest_data
+        raise "Telemetry target '#{target_upcase}' does not exist (item_names lookup)" unless target_latest_data
 
         item_names = target_latest_data.keys
       else
@@ -208,7 +208,7 @@ module OpenC3
       target_upcase = target_name.to_s.upcase
       item_upcase = item_name.to_s.upcase
       target_latest_data = @config.latest_data[target_upcase]
-      raise "Telemetry target '#{target_upcase}' does not exist" unless target_latest_data
+      raise "Telemetry target '#{target_upcase}' does not exist (latest_packets lookup)" unless target_latest_data
 
       packets = @config.latest_data[target_upcase][item_upcase]
       raise "Telemetry item '#{target_upcase} #{LATEST_PACKET_NAME} #{item_upcase}' does not exist" unless packets

data/lib/openc3/processors/processor.rb

@@ -15,6 +15,8 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+require 'openc3/packets/packet'
+
 module OpenC3
   class Processor
     # @return [Symbol] The value type for the processor

data/lib/openc3/script/autonomic.rb

@@ -67,7 +67,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_group_destroy error: #{parsed['error']}"
+            raise "autonomic_group_destroy error: #{parsed['message']}"
           else
             raise "autonomic_group_destroy failed"
           end
@@ -105,7 +105,7 @@ module OpenC3
         if response.nil? || response.status != 201
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_trigger_create error: #{parsed['error']}"
+            raise "autonomic_trigger_create error: #{parsed['message']}"
           else
             raise "autonomic_trigger_create failed"
           end
@@ -136,7 +136,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_trigger_enable error: #{parsed['error']}"
+            raise "autonomic_trigger_enable error: #{parsed['message']}"
           else
             raise "autonomic_trigger_enable failed"
           end
@@ -154,7 +154,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_trigger_disable error: #{parsed['error']}"
+            raise "autonomic_trigger_disable error: #{parsed['message']}"
           else
             raise "autonomic_trigger_disable failed"
           end
@@ -176,7 +176,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_trigger_update error: #{parsed['error']}"
+            raise "autonomic_trigger_update error: #{parsed['message']}"
           else
             raise "autonomic_trigger_update failed"
           end
@@ -194,7 +194,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_trigger_destroy error: #{parsed['error']}"
+            raise "autonomic_trigger_destroy error: #{parsed['message']}"
           else
             raise "autonomic_trigger_destroy failed"
           end
@@ -232,7 +232,7 @@ module OpenC3
         if response.nil? || response.status != 201
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_reaction_create error: #{parsed['error']}"
+            raise "autonomic_reaction_create error: #{parsed['message']}"
           else
             raise "autonomic_reaction_create failed"
           end
@@ -263,7 +263,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_reaction_enable error: #{parsed['error']}"
+            raise "autonomic_reaction_enable error: #{parsed['message']}"
           else
             raise "autonomic_reaction_enable failed"
           end
@@ -281,7 +281,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_reaction_disable error: #{parsed['error']}"
+            raise "autonomic_reaction_disable error: #{parsed['message']}"
           else
             raise "autonomic_reaction_disable failed"
           end
@@ -299,7 +299,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_reaction_execute error: #{parsed['error']}"
+            raise "autonomic_reaction_execute error: #{parsed['message']}"
           else
             raise "autonomic_reaction_execute failed"
           end
@@ -322,7 +322,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_reaction_update error: #{parsed['error']}"
+            raise "autonomic_reaction_update error: #{parsed['message']}"
           else
             raise "autonomic_reaction_update failed"
           end
@@ -340,7 +340,7 @@ module OpenC3
         if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response.body)
-            raise "autonomic_reaction_destroy error: #{parsed['error']}"
+            raise "autonomic_reaction_destroy error: #{parsed['message']}"
           else
             raise "autonomic_reaction_destroy failed"
           end

data/lib/openc3/script/commands.rb

@@ -106,7 +106,7 @@ module OpenC3
       cmd_params.each do |param_name, _param_value|
         param = command['items'].find { |item| item['name'] == param_name }
         unless param
-          raise "Packet item '#{target_name} #{cmd_name} #{param_name}' does not exist"
+          raise "Item '#{target_name} #{cmd_name} #{param_name}' does not exist (command parameter validation)"
         end
       end
       _log_cmd(command, raw, no_range, no_hazardous)

data/lib/openc3/script/extract.rb

@@ -20,7 +20,11 @@ require 'openc3/utilities/store'
 
 module OpenC3
   module Extract
-    SCANNING_REGULAR_EXPRESSION = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | (?:\[(?:[^\\\[\]]|\\.)*\]) | \S+ }x # "
+    # Tokenizer for command parameters: matches double quoted strings, single quoted strings,
+    # bracket delimited arrays (one level of nesting), a bare comma delimiter, or bare words
+    # (runs of non-whitespace, non-comma characters). Commas are tokenized separately so
+    # whitespace around them is optional.
+    SCANNING_REGULAR_EXPRESSION = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | (?:\[(?:[^\\\[\]]|\\.|\[(?:[^\\\[\]]|\\.)*\])*\]) | , | [^\s,]+ }x # "
 
     private
 
@@ -88,35 +92,26 @@ module OpenC3
         second_half = split_string[1].scan(SCANNING_REGULAR_EXPRESSION)
         keyword = nil
         value = nil
-        comma = nil
         second_half.each do |item|
-          unless keyword
+          if item == ','
+            # A comma completes the current keyword / value pair.
+            # A comma with nothing pending is a leading or duplicated comma.
+            raise "Missing command parameter before comma: #{text}" unless keyword
+            raise "Missing value for last command parameter: #{text}" unless value
+            add_cmd_parameter(keyword, value, packet, cmd_params)
+            keyword = nil
+            value = nil
+          elsif keyword.nil?
             keyword = item
-            next
-          end
-          unless value
-            if item[-1..-1] == ','
-              value = item[0..-2]
-              comma = true
-            else
-              value = item
-              next
-            end
-          end
-          unless comma
-            raise "Missing comma in command parameters: #{text}" if item != ','
+          elsif value.nil?
+            value = item
+          else
+            raise "Missing comma in command parameters: #{text}"
           end
-          add_cmd_parameter(keyword, value, packet, cmd_params)
-          keyword = nil
-          value = nil
-          comma = nil
         end
         if keyword
-          if value
-            add_cmd_parameter(keyword, value, packet, cmd_params)
-          else
-            raise "Missing value for last command parameter: #{text}"
-          end
+          raise "Missing value for last command parameter: #{text}" unless value
+          add_cmd_parameter(keyword, value, packet, cmd_params)
         end
       end
 

data/lib/openc3/script/script.rb

@@ -241,7 +241,7 @@ module OpenC3
     # script_run("INST/procedures/collect.rb")
     #
     def initialize_offline_access
-      keycloak_url = ENV['OPENC3_KEYCLOAK_URL']
+      keycloak_url = ENV.fetch('OPENC3_KEYCLOAK_URL', nil)
       if keycloak_url.nil? or keycloak_url.empty?
         raise "initialize_offline_access only valid in COSMOS Enterprise. OPENC3_KEYCLOAK_URL environment variable must be set."
       end
@@ -383,4 +383,4 @@ module OpenC3
   end
 end
 
-$VERBOSE = saved_verbose
+$VERBOSE = saved_verbose

data/lib/openc3/script/storage.rb

@@ -169,17 +169,17 @@ module OpenC3
 
     def _get_uri(url)
       if $openc3_in_cluster
-        case ENV['OPENC3_CLOUD']
+        case ENV.fetch('OPENC3_CLOUD', nil)
         when 'local'
-          bucket_url = ENV["OPENC3_BUCKET_URL"] || "http://openc3-buckets:9000"
+          bucket_url = ENV.fetch("OPENC3_BUCKET_URL", "http://openc3-buckets:9000")
           URI.parse("#{bucket_url}#{url}")
         when 'aws'
-          URI.parse("https://s3.#{ENV['AWS_REGION']}.amazonaws.com" + url)
+          URI.parse("https://s3.#{ENV.fetch('AWS_REGION')}.amazonaws.com" + url)
         when 'gcp'
           URI.parse("https://storage.googleapis.com" + url)
         # when 'azure'
         else
-          raise "Unknown cloud #{ENV['OPENC3_CLOUD']}"
+          raise "Unknown cloud #{ENV.fetch('OPENC3_CLOUD', nil)}"
         end
       else
         URI.parse($api_server.generate_url + url)

data/lib/openc3/script/suite_runner.rb

@@ -30,6 +30,12 @@ module OpenC3
     # the values stay consistent in one place.
     DEFAULT_METHOD = 'start'
     DEFAULT_OPTIONS = ['continueAfterError'].freeze
+    # The only SuiteRunner entry points a client may request
+    ALLOWED_METHODS = ['start', 'setup', 'teardown'].freeze
+    # Suite and Group are Ruby constant (class) names, optionally namespaced
+    CLASS_NAME_REGEX = /\A[A-Z]\w*(::[A-Z]\w*)*\z/
+    # Script is a Ruby method name on the Group
+    METHOD_NAME_REGEX = /\A[a-z_]\w*[?!]?\z/
 
     @@suites = []
     @@settings = {}
@@ -55,12 +61,32 @@ module OpenC3
       raise ArgumentError, "Script #{script} requires a Group" if script and not group
     end
 
+    # Validate that the raw (client supplied) suite_runner values are plain
+    # identifiers. These values are interpolated into the Ruby snippet the
+    # running script evaluates, so anything other than a bare class / method
+    # name must be rejected before it reaches the interpreter.
+    def self.validate_identifiers(suite:, group: nil, script: nil, method: nil)
+      unless suite.is_a?(String) and CLASS_NAME_REGEX.match?(suite)
+        raise ArgumentError, "Invalid Suite name: #{suite.inspect}"
+      end
+      if group && !(group.is_a?(String) and CLASS_NAME_REGEX.match?(group))
+        raise ArgumentError, "Invalid Group name: #{group.inspect}"
+      end
+      if script && !(script.is_a?(String) and METHOD_NAME_REGEX.match?(script))
+        raise ArgumentError, "Invalid Script name: #{script.inspect}"
+      end
+      if method && !ALLOWED_METHODS.include?(method.to_s)
+        raise ArgumentError, "Invalid method: #{method.inspect}"
+      end
+    end
+
     # Build the canonical, validated suite_runner hash from raw values,
     # applying defaults. Shared by openc3cli (constructing from CLI flags) and
     # the running script (normalizing a received hash before dispatch) so the
     # hash shape, defaults, and validation live in one place.
     def self.build_options(suite:, group: nil, script: nil, method: nil, options: nil)
       validate_options(group: group, script: script)
+      validate_identifiers(suite: suite, group: group, script: script, method: method)
       suite_runner = { 'suite' => suite }
       if group
         suite_runner['group'] = group

data/lib/openc3/script/telemetry.rb

@@ -40,9 +40,15 @@ module OpenC3
     # inject_tlm, set_tlm, override_tlm, and normalize_tlm are implemented here simply to add a puts
     # these methods modify the telemetry so the user should be notified in the Script Runner log messages
 
-    def inject_tlm(target_name, packet_name, item_hash = nil, type: :CONVERTED, stored: false, scope: $openc3_scope, token: $openc3_token)
-      puts "inject_tlm(\"#{target_name}\", \"#{packet_name}\", #{item_hash}, type: #{type}, stored: #{stored})"
-      $api_server.method_missing(:inject_tlm, target_name, packet_name, item_hash, type: type, stored: stored, scope: scope, token: token)
+    def inject_tlm(target_name, packet_name, item_hash = nil, type: :CONVERTED, stored: false, received_time: nil, scope: $openc3_scope, token: $openc3_token)
+      message = "inject_tlm(\"#{target_name}\", \"#{packet_name}\", #{item_hash}, type: #{type}, stored: #{stored}"
+      kwargs = { type: type, stored: stored, scope: scope, token: token }
+      unless received_time.nil?
+        message << ", received_time: #{received_time}"
+        kwargs[:received_time] = received_time
+      end
+      puts "#{message})"
+      $api_server.method_missing(:inject_tlm, target_name, packet_name, item_hash, **kwargs)
     end
 
     def set_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)