openc3 5.13.0 → 5.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70d4819352855e3fdb8b4c4d39331968e3e60af59beb0555743b42669d5b4b4a
-  data.tar.gz: c906a678c11f68b8751000875fe5cfdfdbbe98880e182edc572791246d625491
+  metadata.gz: 459b654a51a4d3b984681eb1b25165039e95d0a22c68e08973fc3539beee1b5c
+  data.tar.gz: cf6975c07ab38342228401d84a01f1ee672f4a74b7c2a697f2dc893aecfb4b3e
 SHA512:
-  metadata.gz: 2adcf16c91e84be3d1ef2b412ffc57eda1e7ed87e2d808519f9502c2cd937dcc06e766fad4f74b346daa0122a08745442decdbeb9185990206d7098c0331bf51
-  data.tar.gz: 413edafbcaebcb868c68f1e0ddfeadc4ef32e4950be652a2520858060efd2274d28e9f15f85d944ae48058c1c52cc72ad768f097f5a7830217ae71345869044d
+  metadata.gz: 8368bda2e80639021df632271a972a5a716a8db380eb23dd4375d3334d10ca3001a5a33d9017caeeff684804338d4ba36a2adc180d1656f843d20440560d47ab
+  data.tar.gz: 195a9f6a3e4dbbadb1ed219765f627e1dd3cf96f9fd14a21e7891ea24e5cef6847eefb644ae8cfcbd15a894a32f0c23fc10bf405b9b2c3011553411f14f58b42

data/Gemfile

@@ -7,11 +7,11 @@ gem 'ruby-termios', '>= 0.9' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw|cy
 gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
-gem 'rails', '~> 7.1.0'
 gem 'bootsnap', '>= 1.9.3', require: false
+gem 'mock_redis', '0.41'
 gem 'rack-cors', '~> 2.0'
-gem 'tzinfo-data'
+gem 'rails', '~> 7.1.0'
 gem 'rspec-rails', '~> 6.0'
 gem 'simplecov', '~> 0.20'
 gem 'simplecov-cobertura', '~> 2.1'
-gem 'mock_redis', '0.40'
+gem 'tzinfo-data'

data/bin/openc3cli

@@ -15,7 +15,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -232,7 +232,7 @@ def xtce_converter(args)
 
   begin
     option_parser.parse!(args)
-  rescue => err
+  rescue => e
     abort(option_parser.to_s)
   end
 
@@ -348,10 +348,13 @@ def update_plugin(plugin_file_path, plugin_name, variables: nil, plugin_txt_line
     else
       puts "No changes detected - Exiting without change"
     end
-  rescue => error
-    puts error.formatted
-    plugin_model.restore if plugin_model.destroyed?
-    raise error
+  rescue => e
+    puts e.formatted
+    if plugin_model.destroyed?
+      plugin_model.restore
+      # Local mode files should still be good because restore will now reuse the old name
+    end
+    raise e
   end
 end
 
@@ -408,8 +411,8 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
         scope_model = OpenC3::ScopeModel.new(name: scope, scope: scope)
         scope_model.create
         scope_model.deploy(".", {})
-      rescue => err
-        abort("Error creating scope: #{scope}: #{err.formatted}")
+      rescue => e
+        abort("Error creating scope: #{scope}: #{e.formatted}")
       end
     end
 
@@ -467,8 +470,8 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
         plugin_hash = OpenC3::PluginModel.install_phase2(plugin_hash, scope: scope)
         OpenC3::LocalMode.update_local_plugin(plugin_file_path, plugin_hash, scope: scope)
       end
-    rescue => error
-      abort("Error installing plugin: #{scope}: #{plugin_file_path}\n#{error.message}")
+    rescue => e
+      abort("Error installing plugin: #{scope}: #{plugin_file_path}\n#{e.message}")
     end
   else
     # Outside Cluster
@@ -496,8 +499,8 @@ def unload_plugin(plugin_name, scope:)
       plugin_model.destroy
       OpenC3::LocalMode.remove_local_plugin(plugin_name, scope: scope)
       OpenC3::Logger.info("PluginModel destroyed: #{plugin_name}", scope: scope)
-    rescue => err
-      abort("Error uninstalling plugin: #{scope}: #{plugin_name}: #{err.formatted}")
+    rescue => e
+      abort("Error uninstalling plugin: #{scope}: #{plugin_name}: #{e.formatted}")
     end
   else
     # Outside Cluster
@@ -618,7 +621,7 @@ def run_bridge(filename, params)
       raise "Invalid variable passed to bridgegem (syntax name=value): #{param}"
     end
   end
-  bridge = OpenC3::Bridge.new(filename, variables)
+  OpenC3::Bridge.new(filename, variables)
   begin
     while true
       sleep(1)
@@ -731,7 +734,7 @@ if not ARGV[0].nil? # argument(s) given
   when 'removebase'
     # Used to remove tool base to better support enterprise upgrade
     scopes = OpenC3::ScopeModel.all
-    scopes.each do |scope_name, scope|
+    scopes.each do |scope_name, _scope|
       plugins = OpenC3::PluginModel.all(scope: scope_name)
       plugins.each do |plugin_name, plugin|
         if plugin["name"] =~ /tool-base/ and plugin["name"] !~ /enterprise/
@@ -746,7 +749,7 @@ if not ARGV[0].nil? # argument(s) given
   when 'removeenterprise'
     # Used to remove enterprise plugins to better support downgrade
     scopes = OpenC3::ScopeModel.all
-    scopes.each do |scope_name, scope|
+    scopes.each do |scope_name, _scope|
       plugins = OpenC3::PluginModel.all(scope: scope_name)
       plugins.each do |plugin_name, plugin|
         if plugin["name"] =~ /enterprise/

data/data/config/command_modifiers.yaml

@@ -192,4 +192,56 @@ TEMPLATE_FILE:
       required: true
       description: The relative path to the template file. Filename should generally start with an underscore.
       values: .+
-  since: 5.0.10
+  since: 5.0.10
+RESPONSE:
+  summary: Indicates the expected telemetry packet response to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of telemetry response packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of telemetry response packet
+      values: .+
+  since: 5.14.0
+ERROR_RESPONSE:
+  summary: Indicates the expected telemetry packet error response to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of telemetry error response packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of telemetry error response packet
+      values: .+
+  since: 5.14.0
+RELATED_ITEM:
+  summary: Defines a related telemetry item to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of related telemetry item
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of related telemetry item
+      values: .+
+    - name: Item Name
+      required: true
+      description: Item Name of related telemetry item
+      values: .+
+  since: 5.14.0
+SCREEN:
+  summary: Defines a related telemetry screen to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of related telemetry screen
+      values: .+
+    - name: Screen Name
+      required: true
+      description: Screen Name of related telemetry screen
+      values: .+
+  since: 5.14.0

data/lib/openc3/accessors/accessor.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3, Inc.
+# Copyright 2023 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -16,6 +16,8 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+require 'json'
+
 module OpenC3
   class Accessor
     attr_accessor :packet
@@ -52,27 +54,37 @@ module OpenC3
       return @args
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return 'ASCII-8BIT'.freeze
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return true
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return false
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
 
-    def self.read_item(item, buffer)
+    def self.read_item(_item, _buffer)
       raise "Must be defined by subclass"
     end
 
-    def self.write_item(item, value, buffer)
+    def self.write_item(_item, _value, _buffer)
       raise "Must be defined by subclass"
     end
 
@@ -92,33 +104,34 @@ module OpenC3
     end
 
     def self.convert_to_type(value, item)
-      data_type = item.data_type
-      if (data_type == :STRING) || (data_type == :BLOCK)
-        #######################################
-        # Handle :STRING and :BLOCK data types
-        #######################################
-        value = value.to_s
-
-      elsif (data_type == :INT) || (data_type == :UINT)
-        ###################################
-        # Handle :INT data type
-        ###################################
-        value = Integer(value)
-
-      elsif data_type == :FLOAT
-        ##########################
-        # Handle :FLOAT data type
-        ##########################
-        value = Float(value)
-
+      case item.data_type
+      when :OBJECT
+        # Do nothing for complex object types
+      when :STRING, :BLOCK
+        if item.array_size
+          value = JSON.parse(value) if value.is_a? String
+          value =  value.map { |v| v.to_s }
+        else
+          value = value.to_s
+        end
+      when :UINT, :INT
+        if item.array_size
+          value = JSON.parse(value) if value.is_a? String
+          value = value.map { |v| Integer(v) }
+        else
+          value = Integer(value)
+        end
+      when :FLOAT
+        if item.array_size
+          value = JSON.parse(value) if value.is_a? String
+          value = value.map { |v| Float(v) }
+        else
+          value = Float(value)
+        end
       else
-        ############################
-        # Handle Unknown data types
-        ############################
-
-        raise(ArgumentError, "data_type #{data_type} is not recognized")
+        raise(ArgumentError, "data_type #{item.data_type} is not recognized")
       end
       return value
     end
   end
-end
+end

data/lib/openc3/accessors/binary_accessor.rb

@@ -1229,19 +1229,29 @@ module OpenC3
       values
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return 'ASCII-8BIT'.freeze
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return true
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return false
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end # class BinaryAccessor

data/lib/openc3/accessors/form_accessor.rb

@@ -59,19 +59,29 @@ module OpenC3
       return value
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return nil
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return false
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return true
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end

data/lib/openc3/accessors/http_accessor.rb

@@ -121,18 +121,56 @@ module OpenC3
       return value
     end
 
+    def read_items(items, buffer)
+      result = {}
+      body_items = []
+      items.each do |item|
+        if item.name[0..4] == 'HTTP_'
+          result[item.name] = read_item(item, buffer)
+        else
+          body_items << item
+        end
+      end
+      body_result = @body_accessor.read_items(body_items, buffer)
+      result.merge!(body_result) # Merge Body accessor read items with HTTP_ items
+      return result
+    end
+
+    def write_items(items, values, buffer)
+      body_items = []
+      items.each_with_index do |item, index|
+        if item.name[0..4] == 'HTTP_'
+          write_item(item, values[index], buffer)
+        else
+          body_items << item
+        end
+      end
+      @body_accessor.write_items(body_items, values, buffer)
+      return values
+    end
+
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return @body_accessor.enforce_encoding
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return @body_accessor.enforce_length
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return @body_accessor.enforce_short_buffer_allowed
     end
 
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
     def enforce_derived_write_conversion(item)
       case item.name
       when 'HTTP_STATUS', 'HTTP_PATH', 'HTTP_METHOD', 'HTTP_PACKET', 'HTTP_ERROR_PACKET', /^HTTP_QUERY_/, /^HTTP_HEADER_/

data/lib/openc3/accessors/json_accessor.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3, Inc.
+# Copyright 2023 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -24,7 +24,8 @@ module OpenC3
   class JsonAccessor < Accessor
     def self.read_item(item, buffer)
       return nil if item.data_type == :DERIVED
-      return JsonPath.on(buffer, item.key).first
+      value = JsonPath.on(buffer, item.key).first
+      return convert_to_type(value, item)
     end
 
     def self.write_item(item, value, buffer)
@@ -123,6 +124,7 @@ module OpenC3
           raise "Unsupported key/token: #{item.key} - #{token}"
         end
       end
+      value = convert_to_type(value, item)
       if parent_node
         parent_node[parent_key] = value
       else
@@ -131,19 +133,29 @@ module OpenC3
       return decoded
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return nil
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return false
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return true
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end

data/lib/openc3/accessors/template_accessor.rb

@@ -0,0 +1,150 @@
+# encoding: ascii-8bit
+
+# Copyright 2024 OpenC3, Inc.
+# 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.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/accessors/accessor'
+
+module OpenC3
+  class TemplateAccessor < Accessor
+    def initialize(packet, left_char = '<', right_char = '>')
+      super(packet)
+      @left_char = left_char
+      @right_char = right_char
+      @configured = false
+    end
+
+    def configure
+      return if @configured
+
+      escaped_left_char = @left_char
+      escaped_left_char = "\\#{@left_char}" if @left_char == '('
+      escaped_right_char = @right_char
+      escaped_right_char = "\\#{@right_char}" if @right_char == ')'
+
+      # Convert the template into a Regexp for reading each item
+      template = @packet.template.dup
+      template_items = template.scan(Regexp.new("#{escaped_left_char}.*?#{escaped_right_char}"))
+      escaped_read_template = template
+      if @left_char != '('
+        escaped_read_template = escaped_read_template.gsub('(', '\(')
+      end
+      if @right_char != ')'
+        escaped_read_template = escaped_read_template.gsub(')', '\)')
+      end
+
+      @item_keys = []
+      template_items.each do |item|
+        @item_keys << item[1..-2]
+        escaped_read_template.gsub!(item, "(.*)")
+      end
+      @read_regexp = Regexp.new(escaped_read_template)
+
+      @configured = true
+    end
+
+    def read_item(item, buffer)
+      return nil if item.data_type == :DERIVED
+      configure()
+
+      # Scan the response for all the variables in brackets <VARIABLE>
+      values = buffer.scan(@read_regexp)[0]
+      if !values || (values.length != @item_keys.length)
+        raise "Unexpected number of items found in buffer: #{values ? values.length : 0}, Expected: #{@item_keys.length}"
+      else
+        values.each_with_index do |value, i|
+          item_key = @item_keys[i]
+          if item_key == item.key
+            return Accessor.convert_to_type(value, item)
+          end
+        end
+      end
+
+      raise "Response does not include key #{item.key}: #{buffer}"
+    end
+
+    def read_items(items, buffer)
+      result = {}
+      configure()
+
+      # Scan the response for all the variables in brackets <VARIABLE>
+      values = buffer.scan(@read_regexp)[0]
+      if !values || (values.length != @item_keys.length)
+        raise "Unexpected number of items found in buffer: #{values ? values.length : 0}, Expected: #{@item_keys.length}"
+      else
+        items.each do |item|
+          if item.data_type == :DERIVED
+            result[item.name] = nil
+            next
+          end
+          index = @item_keys.index(item.key)
+          if index
+            result[item.name] = Accessor.convert_to_type(values[index], item)
+          else
+            raise "Unknown item with key #{item.key} requested"
+          end
+        end
+      end
+
+      return result
+    end
+
+    def write_item(item, value, buffer)
+      return nil if item.data_type == :DERIVED
+      configure()
+
+      success = buffer.gsub!("#{@left_char}#{item.key}#{@right_char}", value.to_s)
+      raise "Key #{item.key} not found in template" unless success
+      return value
+    end
+
+    def write_items(items, values, buffer)
+      configure()
+      items.each_with_index do |item, index|
+        next if item.data_type == :DERIVED
+        success = buffer.gsub!("#{@left_char}#{item.key}#{@right_char}", values[index].to_s)
+        raise "Key #{item.key} not found in template" unless success
+      end
+      return values
+    end
+
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
+    def enforce_encoding
+      return nil
+    end
+
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
+    def enforce_length
+      return false
+    end
+
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
+    def enforce_short_buffer_allowed
+      return true
+    end
+
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
+      return true
+    end
+  end
+end

data/lib/openc3/accessors/xml_accessor.rb

@@ -68,19 +68,29 @@ module OpenC3
       doc.to_xml
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return nil
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return false
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return true
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end

data/lib/openc3/accessors.rb

@@ -25,4 +25,5 @@ module OpenC3
   autoload(:HttpAccessor, 'openc3/accessors/http_accessor.rb')
   autoload(:JsonAccessor, 'openc3/accessors/json_accessor.rb')
   autoload(:XmlAccessor, 'openc3/accessors/xml_accessor.rb')
+  autoload(:TemplateAccessor, 'openc3/accessors/template_accessor.rb')
 end