cosmos 3.8.3 → 3.9.1

data/lib/cosmos/io/json_drb_object.rb

@@ -99,9 +99,9 @@ module Cosmos
             next if was_first_try
           end
           return handle_response(response)
-        end # loop
-      end # @mutex.synchronize
-    end # def method_missing
+        end
+      end
+    end
 
     private
 

data/lib/cosmos/io/raw_logger.rb

@@ -27,7 +27,7 @@ module Cosmos
     # @return [Boolean] Is logging enabled?
     attr_reader :logging_enabled
 
-    # @retuen [String] Original name passed to raw logger
+    # @return [String] Original name passed to raw logger
     attr_reader :orig_name
 
     # The allowable log types
@@ -41,12 +41,8 @@ module Cosmos
     #    name of the corresponding interface
     # @param log_type [Symbol] The type of log to create. Must be :READ
     #   or :WRITE.
-    # @param cycle_time [Integer] The amount of time in seconds before creating
-    #   a new log file. This can be combined with cycle_size but is better used
-    #   independently.
-    # @param cycle_size [Integer] The size in bytes before creating a new log
-    #   file. This can be combined with cycle_time but is better used
-    #   independently.
+    # @param logging_enabled [Boolean] Whether to enable raw logging
+    # @param cycle_size [Integer] The size in bytes before creating a new log file.
     # @param log_directory [String] The directory to store the log files.
     #   Passing nil will use the system default 'LOGS' directory.
     def initialize(
@@ -75,7 +71,7 @@ module Cosmos
     end
 
     # Set the raw logger name
-    # @param name [String] new name
+    # @param log_name [String] new name
     def name=(log_name)
       @orig_name = log_name
       @log_name = (log_name.to_s.downcase + '_raw_' + @log_type.to_s.downcase + '_' + self.object_id.to_s).freeze

data/lib/cosmos/io/tcpip_server.rb

@@ -500,7 +500,7 @@ module Cosmos
             indexes_to_delete.each do |index_to_delete|
               @write_stream_protocols.delete_at(index_to_delete)
             end
-          end # @connection_mutex.synchronize
+          end # connection_mutex.synchronize
 
           # Sleep until we receive a packet or for 100ms
           @write_mutex.synchronize do
@@ -544,7 +544,7 @@ module Cosmos
           indexes_to_delete.each do |index_to_delete|
             @write_stream_protocols.delete_at(index_to_delete)
           end
-        end # @connection_mutex.synchronize
+        end # connection_mutex.synchronize
       end
     end
 

data/lib/cosmos/packets/binary_accessor.rb

@@ -542,7 +542,7 @@ module Cosmos
     # Adjusts the packed array to be the given number of bytes
     #
     # @param num_bytes [Integer] The desired number of bytes
-    # @param packet [Array] The packed data buffer
+    # @param packed [Array] The packed data buffer
     def self.adjust_packed_size(num_bytes, packed)
       difference = num_bytes - packed.length
       if difference > 0

data/lib/cosmos/packets/limits.rb

@@ -56,7 +56,7 @@ module Cosmos
       return items
     end
 
-    # @ignored_items [Array of Arrays] Items to ignore from the consideration
+    # @param ignored_items [Array<Array<String, String, String>>] Items to ignore from the consideration
     # @return [Symbol] The overall limits state for the system
     def overall_limits_state(ignored_items = nil)
       overall = :GREEN
@@ -260,8 +260,5 @@ module Cosmos
       end
       return false
     end
-
-  end # class Limits
-
+  end
 end
-

data/lib/cosmos/packets/packet.rb

@@ -556,7 +556,7 @@ module Cosmos
     # Restore all items in the packet to their default value
     #
     # @param buffer [String] Raw buffer of binary data
-    # @param skip_items_names [Array] Array of item names to skip
+    # @param skip_item_names [Array] Array of item names to skip
     def restore_defaults(buffer = @buffer, skip_item_names = nil)
       upcase_skip_item_names = skip_item_names.map(&:upcase) if skip_item_names
       @sorted_items.each do |item|

data/lib/cosmos/packets/packet_config.rb

@@ -91,7 +91,7 @@ module Cosmos
     # knowledge of the commands, telemetry, and limits groups.
     #
     # @param filename [String] The name of the configuration file
-    # @param target_name [String] The target name
+    # @param process_target_name [String] The target name
     def process_file(filename, process_target_name)
       # Handle .xtce files
       if File.extname(filename).to_s.downcase == ".xtce"
@@ -220,8 +220,12 @@ module Cosmos
       finish_packet()
 
       # Remove abstract
-      @commands[@current_target_name].delete_if {|packet_name, packet| packet.abstract}
-      @telemetry[@current_target_name].delete_if {|packet_name, packet| packet.abstract}
+      if @commands[@current_target_name]
+        @commands[@current_target_name].delete_if {|packet_name, packet| packet.abstract}
+      end
+      if @telemetry[@current_target_name]
+        @telemetry[@current_target_name].delete_if {|packet_name, packet| packet.abstract}
+      end
 
       # Reverse order of packets for the target so ids work correctly
       reverse_packet_order(@current_target_name, @commands)
@@ -554,17 +558,19 @@ module Cosmos
     end
 
     def reverse_packet_order(target_name, cmd_or_tlm_hash)
-      packets = []
-      names_to_remove = []
-      cmd_or_tlm_hash[target_name].each do |packet_name, packet|
-        packets << packet
-        names_to_remove << packet_name
-      end
-      cmd_or_tlm_hash[target_name].length.times do |i|
-        cmd_or_tlm_hash[target_name].delete(names_to_remove[i])
-      end
-      packets.reverse.each do |packet|
-        cmd_or_tlm_hash[target_name][packet.packet_name] = packet
+      if cmd_or_tlm_hash[target_name]
+        packets = []
+        names_to_remove = []
+        cmd_or_tlm_hash[target_name].each do |packet_name, packet|
+          packets << packet
+          names_to_remove << packet_name
+        end
+        cmd_or_tlm_hash[target_name].length.times do |i|
+          cmd_or_tlm_hash[target_name].delete(names_to_remove[i])
+        end
+        packets.reverse.each do |packet|
+          cmd_or_tlm_hash[target_name][packet.packet_name] = packet
+        end
       end
     end
 
@@ -636,16 +642,45 @@ module Cosmos
         end
 
       when 'ByteOrderList'
+        byte_list = []
         xtce_recurse_element(element, depth + 1) do |element, depth|
           if element.name == 'Byte'
-            if element['byteSignificance'] and element['byteSignificance'].to_i == 0
-              @current_type.endianness = :LITTLE_ENDIAN
+            if element['byteSignificance']
+              byte_list << element['byteSignificance'].to_i
             end
-            false
-          else
-            true
           end
+          true
         end
+        if byte_list[0] == 0
+          # Little endian will always start with 0 - Its ok if a single byte item is marked little endian
+          @current_type.endianness = :LITTLE_ENDIAN
+        end
+
+        # Verify ordering of byte list is supported
+        if byte_list[0] >= byte_list[-1]
+          ordered_byte_list = byte_list.reverse
+        else
+          ordered_byte_list = byte_list.clone
+        end
+        if ordered_byte_list[0] != 0
+          msg = "Invalid ByteOrderList detected: #{byte_list.join(", ")}"
+          Logger.instance.warn msg
+          @warnings << msg
+        else
+          previous_byte = nil
+          ordered_byte_list.each do |byte|
+            if previous_byte
+              if byte - previous_byte != 1
+                msg = "Invalid ByteOrderList detected: #{byte_list.join(", ")}"
+                Logger.instance.warn msg
+                @warnings << msg
+                break
+              end
+            end
+            previous_byte = byte
+          end
+        end
+
         return false # Already recursed
 
       when "SizeInBits"

data/lib/cosmos/packets/parsers/packet_item_parser.rb

@@ -195,8 +195,14 @@ module Cosmos
       if keyword.include?("ARRAY")
         usage << "INT/UINT/FLOAT/STRING/BLOCK> "
       else
+        begin
+          data_type = get_data_type()
+        rescue
+          # If the data type could not be determined set something
+          data_type == :INT
+        end
         # STRING and BLOCK types do not have min or max values
-        if get_data_type() == :STRING || get_data_type() == :BLOCK
+        if data_type == :STRING || data_type == :BLOCK
           usage << "STRING/BLOCK> "
         else
           usage << "INT/UINT/FLOAT> <MIN VALUE> <MAX VALUE> "

data/lib/cosmos/script/scripting.rb

@@ -23,11 +23,10 @@ module Cosmos
     end
 
     def status_bar(message)
-      if defined? ScriptRunner
-        script_runner = nil
-        ObjectSpace.each_object {|object| if ScriptRunner === object then script_runner = object; break; end}
-        script_runner.script_set_status(message) if script_runner
-      end
+      script_runner = ObjectSpace.find(ScriptRunner) if defined? ScriptRunner
+      script_runner.script_set_status(message) if script_runner
+      test_runner = ObjectSpace.find(TestRunner) if defined? TestRunner
+      test_runner.script_set_status(message) if test_runner
     end
 
     def ask_string(question, blank_or_default = false, password = false)

data/lib/cosmos/system/system.rb

@@ -176,7 +176,7 @@ module Cosmos
 
     # Change the system limits set
     #
-    # @param [Symbol] The name of the limits set. :DEFAULT is always an option
+    # @param limits_set [Symbol] The name of the limits set. :DEFAULT is always an option
     #   but limits sets are user defined
     def limits_set=(limits_set)
       load_packets() unless @config
@@ -197,6 +197,7 @@ module Cosmos
       self.instance.limits_set = limits_set
     end
 
+    # @param filename [String] System configuration file to parse
     # @return [System] The System singleton
     def self.instance(filename = nil)
       return @@instance if @@instance

data/lib/cosmos/system/target.rb

@@ -192,6 +192,10 @@ module Cosmos
         Dir[File.join(dir, 'cmd_tlm', '**', '*.txt')].each do |filename|
           cmd_tlm_files << filename
         end
+        # Grab All *.xtce files in the cmd_tlm folder and subfolders
+        Dir[File.join(dir, 'cmd_tlm', '**', '*.xtce')].each do |filename|
+          cmd_tlm_files << filename
+        end
       end
       cmd_tlm_files.sort!
     end

data/lib/cosmos/tools/cmd_tlm_server/background_task.rb

@@ -16,15 +16,25 @@ module Cosmos
   class BackgroundTask
     include Api
 
+    # @return [Integer] The number of background tasks created
+    @@count = 0
+
+    # @return [String] Name of the background task
     attr_accessor :name
+    # @return [Thread] Ruby thread running the task
     attr_accessor :thread
+    # @return [String] Status message to display in the CTS
     attr_accessor :status
+    # @return [Boolean] Whether the task is initially stopped when the CTS starts
+    attr_accessor :stopped
 
     # Constructor
     def initialize
-      @name = nil
+      @@count += 1
+      @name = "Background Task #{@@count}"
       @thread = nil
-      @status = nil
+      @status = ''
+      @stopped = false
     end
 
     # Subclasses should override the call method which is called once by
@@ -40,7 +50,5 @@ module Cosmos
     def stop
       # Nothing to do by default
     end
-
-  end # class BackgroundTask
-
+  end
 end

data/lib/cosmos/tools/cmd_tlm_server/background_tasks.rb

@@ -11,7 +11,6 @@
 require 'cosmos/tools/cmd_tlm_server/cmd_tlm_server_config'
 
 module Cosmos
-
   # Manages starting and stopping all the background tasks which
   # were discovered when parsing the configuration file.
   class BackgroundTasks
@@ -22,37 +21,50 @@ module Cosmos
       @threads = []
     end
 
-    # Start background tasks by creating a new Ruby thread for each and then
-    # calling their 'call' method once.
-    def start
-      @config.background_tasks.each do |background_task|
-        new_thread = Thread.new do
-          background_task.thread = Thread.current
-          begin
-            background_task.call
-          rescue Exception => err
-            Logger.error "Background Task thread unexpectedly died"
-            Cosmos.handle_fatal_exception(err)
-          end
-        end
-        @threads << new_thread
+    # Start all background tasks by creating a new Ruby thread for each and then
+    # calling their 'call' method once. Tasks which have stopped set to true
+    # are not started and must be started by calling #start.
+    def start_all
+      (0...all.length).each do |index|
+        start(index) unless @config.background_tasks[index].stopped
       end
     end
 
-    # Stop background tasks by calling their stop method and then killing their
-    # Ruby threads.
-    def stop
-      @config.background_tasks.each do |background_task|
+    # Start an individual background task by creating a new Ruby thread and then
+    # calling the 'call' method once.
+    # @param index [Integer] Which background task to start
+    def start(index)
+      @threads[index] = Thread.new do
+        @config.background_tasks[index].thread = Thread.current
         begin
-          background_task.stop
-        rescue
-          # Ignore any errors because we're about to kill the thread anyway
+          @config.background_tasks[index].call
+        rescue Exception => err
+          Logger.error "Background Task '#{@config.background_tasks[index].name}' unexpectedly died"
+          Cosmos.handle_fatal_exception(err)
         end
       end
-      @threads.each {|thread| Cosmos.kill_thread(self, thread)}
+    end
+
+    # Stop all background tasks by calling their stop method and then killing
+    # their Ruby thread.
+    def stop_all
+      (0...all.length).each { |index| stop(index) }
       @threads = []
     end
 
+    # Stop background task by calling their stop method and then killing their
+    # Ruby thread.
+    # @param index [Integer] Which background task to stop
+    def stop(index)
+      begin
+        @config.background_tasks[index].stop
+      rescue
+        # Ignore any errors because we're about to kill the thread anyway
+      end
+      Cosmos.kill_thread(self, @threads[index])
+      @threads[index] = nil
+    end
+
     # Return the array of background tasks
     def all
       @config.background_tasks
@@ -61,7 +73,5 @@ module Cosmos
     def graceful_kill
       # This method is just here to remove warnings - background_task.stop should kill the thread
     end
-
-  end # class BackgroundTasks
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/cmd_tlm_server/cmd_tlm_server.rb

@@ -190,7 +190,7 @@ module Cosmos
       System.telemetry.limits_change_callback = method(:limits_change_callback)
       @interfaces.start
       @routers.start
-      @background_tasks.start
+      @background_tasks.start_all
 
       # Start staleness monitor thread
       @sleeper = Sleeper.new
@@ -221,7 +221,7 @@ module Cosmos
       # Shutdown staleness monitor thread
       Cosmos.kill_thread(self, @staleness_monitor_thread)
 
-      @background_tasks.stop
+      @background_tasks.stop_all
       @routers.stop
       @interfaces.stop
       @packet_logging.shutdown
@@ -431,6 +431,10 @@ module Cosmos
         raise ArgumentError, "packets must be nested array: [['TGT','PKT'],...]"
       end
 
+      unless queue_size.is_a? Integer and queue_size > 0
+        raise ArgumentError, "Invalid queue size for subscribe_packet_data: #{queue_size}"
+      end
+
       id = nil
       upcase_packets = []
 

data/lib/cosmos/tools/cmd_tlm_server/cmd_tlm_server_config.rb

@@ -15,7 +15,6 @@ require 'cosmos/packet_logs'
 require 'cosmos/io/raw_logger_pair'
 
 module Cosmos
-
   # Reads an ascii file that defines the configuration settings used to
   # configure the Command/Telemetry Server.
   class CmdTlmServerConfig
@@ -245,6 +244,11 @@ module Cosmos
               @background_tasks << background_task.new
             end
 
+          when 'STOPPED'
+            parser.verify_num_parameters(0, 0, "#{keyword}")
+            raise parser.error("No BACKGROUND_TASK defined") if @background_tasks.empty?
+            @background_tasks[-1].stopped = true
+
           # TODO: Deprecate COLLECT_META_DATA
           when 'COLLECT_METADATA', 'COLLECT_META_DATA'
             parser.verify_num_parameters(2, 2, "#{keyword} <Metadata Target Name> <Metadata Packet Name>")
@@ -259,7 +263,5 @@ module Cosmos
         end  # loop
       end
     end
-
-  end # class CmdTlmServerConfig
-
-end # module Cosmos
+  end
+end