cosmos 4.3.0-java → 4.4.0-java

data/lib/cosmos/top_level.rb

@@ -11,7 +11,7 @@
 # This file contains top level functions in the Cosmos namespace
 
 require 'thread'
-require 'digest/md5'
+require 'digest'
 require 'open3'
 require 'cosmos/core_ext'
 require 'cosmos/version'
@@ -170,8 +170,12 @@ module Cosmos
     return filename if File.exist? filename
 
     # Check relative to executing file
-    filename = Cosmos.path($0, ['config', 'data', name])
-    return filename if File.exist? filename
+    begin # path raises so begin rescue it
+      filename = Cosmos.path($0, ['config', 'data', name])
+      return filename if File.exist? filename
+    rescue
+      # Couldn't find the file so return nil below
+    end
     nil
   end
 
@@ -240,6 +244,11 @@ module Cosmos
       rescue Exception
         # Oh well - we tried
       end
+      if exception.class == TypeError and exception.message =~ /Thread::Mutex/
+        original_backtrace = exception.backtrace
+        exception = exception.exception("Mutex exists in a packet.  Note: Packets must not be read during class initializers for Conversions, Limits Responses, etc.: #{exception}")
+        exception.set_backtrace(original_backtrace)
+      end
       self.handle_fatal_exception(exception)
     end
   end
@@ -373,24 +382,26 @@ module Cosmos
     end
   end
 
-  # Runs an md5 sum over one or more files and returns the Digest::MD5 object.
+  # Runs a hash algorithm over one or more files and returns the Digest object.
   # Handles windows/unix new line differences but changes in whitespace will
-  # change the md5 sum.
+  # change the hash sum.
   #
   # Usage:
-  #   digest = Cosmos.md5_files(files)
+  #   digest = Cosmos.hash_files(files, additional_data, hashing_algorithm)
   #   digest.digest # => the 16 bytes of digest
   #   digest.hexdigest # => the formatted string in hex
   #
-  # @param filenames [Array<String>] List of files to read and calculate a md5
+  # @param filenames [Array<String>] List of files to read and calculate a hashing
   #   sum on
-  # @param additional_data [String] Additional data to add to the md5 sum
-  # @return [Digest::MD5] The md5 sum
-  def self.md5_files(filenames, additional_data = nil)
-    digest = Digest::MD5.new
+  # @param additional_data [String] Additional data to add to the hashing sum
+  # @param hashing_algorithm [String] Hashing algorithm to use
+  # @return [Digest::<algorithm>] The hashing sum object
+  def self.hash_files(filenames, additional_data = nil, hashing_algorithm = 'MD5')
+    digest = Digest.const_get(hashing_algorithm).send('new')
+
     Cosmos.set_working_dir do
       filenames.each do |filename|
-        # Read the file's data and add to the running MD5 sum
+        # Read the file's data and add to the running hashing sum
         digest << File.read(filename).gsub(/\r/,'')
       end
     end

data/lib/cosmos/version.rb

@@ -1,12 +1,12 @@
 # encoding: ascii-8bit
 
-COSMOS_VERSION = '4.3.0'
+COSMOS_VERSION = '4.4.0'
 module Cosmos
   module Version
     MAJOR = '4'
-    MINOR = '3'
+    MINOR = '4'
     PATCH = '0'
-    BUILD = '3588276d89cb9d934e0e51ad8c6e2426fc5dafb5'
+    BUILD = '30bd354efce074e6684f2fb4f4df8dc12d2f3df5'
   end
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

data/spec/gui/utilities/script_module_gui_spec.rb

@@ -12,89 +12,70 @@ if RUBY_ENGINE == 'ruby'
   require 'spec_helper'
   require 'cosmos/gui/qt'
   require 'cosmos/script'
-  require 'cosmos/gui/utilities/script_module_gui'
+  require 'cosmos/script/scripting'
 
   module Cosmos
     describe Script do
-      after(:all) do
-        # Load the original scripting file over the script_module_gui
-        load 'cosmos/script/scripting.rb'
-      end
-
-      def stub_null_object(constant)
-        class_double(constant).tap do |double|
-          stub_const(constant, double)
-          allow(double).to receive(:new).and_return(double(constant).as_null_object)
-          yield double if block_given?
-        end
-      end
-
-      let!(:qt_module) do
-        class_double('Qt').as_stubbed_const(:transfer_nested_constants => true).tap do |double|
-          stub_const('Qt', double)
-          stub_const('Qt::WindowTitleHint', double)
-          stub_const('Qt::WindowSystemMenuHint', double)
-          allow(double).to receive(:execute_in_main_thread).and_yield
-          allow(double).to receive(:debug_level)
-        end
-        stub_null_object('Qt::Widget')
-        stub_null_object('Qt::Dialog') do |double|
-          instance = double("Qt::Dialog").as_null_object
-          allow(instance).to receive(:exec).and_return 1 # break the loop by returning 1
-          allow(double).to receive(:new).and_return(instance)
-        end
-        # Stub Accepted to be 1 to match the instance exec returning 1
-        stub_const('Qt::Dialog::Accepted', 1)
-        stub_null_object('Qt::VBoxLayout')
-        stub_null_object('Qt::HBoxLayout')
-        stub_null_object('Qt::Label')
-        stub_null_object('Qt::PushButton')
-      end
-
       describe "combo_box" do
-        it "should not modify the inputs" do
-          class_double('Cosmos::ComboboxChooser').as_stubbed_const.tap do |double|
-            chooser = double("ComboboxChooser").as_null_object
-            allow(chooser).to receive(:sel_command_callback=) do |args|
-              # Simulate the user clicking the TEST option in the combobox
-              args.call("TEST")
-            end
-            allow(double).to receive(:new).and_return(chooser)
+        it "should not modify the button inputs" do
+          expect(self).to receive(:gets) { ' ' }
+          capture_io do |stdout|
+            buttons = %w(THIS IS A TEST)
+            combo_box("Combo box test", *buttons)
+            expect(buttons).to eq %w(THIS IS A TEST)
+            expect(stdout.string).to match(/Combo box test/)
           end
+        end
 
-          buttons = %w(THIS IS A TEST)
-          combo_box("HI", *buttons)
-          expect(buttons).to eq %w(THIS IS A TEST)
+        it "should display details" do
+          expect(self).to receive(:gets) { ' ' }
+          capture_io do |stdout|
+            buttons = %w(THIS IS A TEST)
+            combo_box("HI", *buttons, details: 'These are the details')
+            expect(stdout.string).to match(/These are the details/)
+          end
         end
       end
 
       describe "message_box" do
         it "should not modify the inputs" do
-          class_double('Qt::MessageBox').as_stubbed_const.tap do |double|
-            msg_box = double("MessageBox").as_null_object
-            allow(msg_box).to receive_message_chain(:clickedButton, :text).and_return("TEST")
-            allow(double).to receive(:new).and_return(msg_box)
-            stub_const('Qt::MessageBox::AcceptRole', 1)
-            stub_const('Qt::MessageBox::RejectRole', 0)
+          expect(self).to receive(:gets) { ' ' }
+          capture_io do |stdout|
+            buttons = %w(THIS IS A TEST)
+            message_box("Message box test", *buttons)
+            expect(buttons).to eq %w(THIS IS A TEST)
+            expect(stdout.string).to match(/Message box test/)
           end
+        end
 
-          buttons = %w(THIS IS A TEST)
-          message_box("HI", *buttons)
-          expect(buttons).to eq %w(THIS IS A TEST)
+        it "should display details" do
+          expect(self).to receive(:gets) { ' ' }
+          capture_io do |stdout|
+            buttons = %w(THIS IS A TEST)
+            message_box("HI", *buttons, details: 'These are the details')
+            expect(stdout.string).to match(/These are the details/)
+          end
         end
       end
 
       describe "vertical_message_box" do
         it "should not modify the inputs" do
-          stub_null_object('Qt::PushButton') do |double|
-            instance = double("Qt::PushButton").as_null_object
-            allow(instance).to receive(:connect).and_yield
-            allow(double).to receive(:new).and_return(instance)
+          expect(self).to receive(:gets) { ' ' }
+          capture_io do |stdout|
+            buttons = %w(THIS IS A TEST)
+            vertical_message_box("Vertical message box test", *buttons)
+            expect(buttons).to eq %w(THIS IS A TEST)
+            expect(stdout.string).to match(/Vertical message box test/)
           end
+        end
 
-          buttons = %w(THIS IS A TEST)
-          vertical_message_box("HI", *buttons)
-          expect(buttons).to eq %w(THIS IS A TEST)
+        it "should display details" do
+          expect(self).to receive(:gets) { ' ' }
+          capture_io do |stdout|
+            buttons = %w(THIS IS A TEST)
+            vertical_message_box("HI", *buttons, details: 'These are the details')
+            expect(stdout.string).to match(/These are the details/)
+          end
         end
       end
     end

data/spec/install/config/targets/INST/cmd_tlm/inst_cmds.txt

@@ -15,7 +15,7 @@ COMMAND INST COLLECT BIG_ENDIAN "Starts a collect on the instrument"
   PARAMETER    OPCODE        112   8  UINT 0x0 0xFF 0xAB "Collect opcode"
     FORMAT_STRING "0x%0X"
   PARAMETER    TEMP          120  32  FLOAT 0.0 25.0 0.0 "Collect temperature"
-    UNITS Celcius C
+    UNITS Celsius C
 
 COMMAND INST ABORT BIG_ENDIAN "Aborts a collect on the instrument"
   PARAMETER    CCSDSVER        0   3  UINT  0     0   0 "CCSDS primary header version number"

data/spec/install/config/targets/INST/cmd_tlm/inst_tlm.txt

@@ -21,28 +21,28 @@ TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Health and status from the instrument"
   ITEM TEMP1            144 16 UINT     "Temperature #1"
     POLY_READ_CONVERSION  -100.0 0.00305
     POLY_WRITE_CONVERSION 32768.885246 327.86885
-    UNITS CELCIUS C
+    UNITS CELSIUS C
     FORMAT_STRING "%0.3f"
     LIMITS DEFAULT 1 ENABLED -80.0 -70.0 60.0 80.0 -20.0 20.0
     LIMITS TVAC 1     ENABLED -80.0 -30.0 30.0 80.0
   ITEM TEMP2            160 16 UINT     "Temperature #2"
     POLY_READ_CONVERSION -100.0 0.00305
     POLY_WRITE_CONVERSION 32768.885246 327.86885
-    UNITS CELCIUS C
+    UNITS CELSIUS C
     FORMAT_STRING "%0.3f"
     LIMITS DEFAULT 1 ENABLED -60.0 -55.0 30.0 35.0
     LIMITS TVAC 1 ENABLED -60.0 20.0 30.0 35.0
   ITEM TEMP3            176 16 UINT     "Temperature #3"
     POLY_READ_CONVERSION -100.0 0.00305
     POLY_WRITE_CONVERSION 32768.885246 327.86885
-    UNITS CELCIUS C
+    UNITS CELSIUS C
     FORMAT_STRING "%0.3f"
     LIMITS DEFAULT 1 ENABLED -25.0 -10.0 50.0 55.0
     LIMITS TVAC 1 ENABLED -15.0 -10.0 20.0 30.0
   ITEM TEMP4            192 16 UINT     "Temperature #4"
     POLY_READ_CONVERSION -100.0 0.00305
     POLY_WRITE_CONVERSION 32768.885246 327.86885
-    UNITS CELCIUS C
+    UNITS CELSIUS C
     FORMAT_STRING "%0.3f"
     LIMITS DEFAULT 1 ENABLED -80.0 -70.0 60.0 80.0
   ARRAY_ITEM ARY              208 8 UINT 80 "Array data"
@@ -52,7 +52,7 @@ TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Health and status from the instrument"
     STATE NORMAL  0
     STATE SPECIAL 1
   APPEND_ARRAY_ITEM ARY2      64 FLOAT 640 "Double array"
-    UNITS CELCIUS C
+    UNITS CELSIUS C
   APPEND_ITEM ASCIICMD 2048 STRING "Most recent ASCIICMD string"
     STATE "NOOP" "NOOP"
     STATE "FIRE LASER" "FIRE LASER"

data/spec/install/yaml_docs_spec.rb

@@ -0,0 +1,112 @@
+
+require 'spec_helper'
+require 'find'
+require 'cosmos/system'
+require 'cosmos/config/meta_config_parser'
+
+module Cosmos
+  describe Cosmos do
+    # These are not expected to be documented as they are deprecated
+    DEPRECATED = %w(MACRO_APPEND_START MACRO_APPEND_END ROUTER_LOG_RAW IGNORE REQUIRE_UTILITY)
+    # These source keywords are ignored in the YAML
+    EXCEPTIONS = %w(LAUNCH LAUNCH_TERMINAL LAUNCH_GEM CONVERTED RAW FORMATTED WITH_UNITS NONE)
+    EXCEPTIONS.concat(%w(MINUTE HOUR DAY AVG MIN MAX STDDEV AGING CRC OVERRIDE))
+    # These are not documented because OpenGL is not officially a tool
+    OPENGL = %w(STL_FILE TEXTURE_MAPPED_SPHERE TIP_TEXT POSITION ROTATION_X ROTATION_Y ROTATION_Z)
+    OPENGL.concat(%w(ZOOM ORIENTATION CENTER BOUNDS))
+
+    def get_src_keywords
+      @src_keywords = []
+      path = File.expand_path(File.join(File.dirname(__FILE__), "../../lib/**/*.rb"))
+      Dir[path].each do |filename|
+        data = File.read(filename)
+        part = nil
+        if data.include?('parser.parse_file')
+          part = data.split('parser.parse_file')[1..-1].join
+        elsif data.include?('handle_keyword(parser, keyword, parameters)')
+          part = data.split('handle_keyword(parser, keyword, parameters)')[1..-1].join
+        end
+        if part
+          part.split("\n").each do |line|
+            if match = line.match(/when (.*)/)
+              line = match.captures[0]
+              line.split(',').each do |item|
+                item.strip!
+                if (item[0] == "'" || item[0] == '"') && (item[-1] == "'" || item[-1] == '"')
+                  @src_keywords << item[1..-2]
+                end
+              end
+            end
+          end
+        end
+      end
+
+      # All the widgets are referenced in screen definitions
+      path = File.expand_path(File.join(File.dirname(__FILE__), "../../lib/cosmos/tools/tlm_viewer/widgets/*_widget.rb"))
+      Dir[path].each do |filename|
+        @src_keywords << filename.split('/')[-1].split('_widget.rb')[0].upcase
+      end
+      # Remove the base classes
+      @src_keywords -= %w(CANVASVALUE LAYOUT MULTI)
+      # Add specific keyword(s) that we want to document
+      @src_keywords.concat(%w(NAMED_WIDGET))
+
+      # All the protocols are referenced as keywords in INTERFACES
+      path = File.expand_path(File.join(File.dirname(__FILE__), "../../lib/cosmos/interfaces/protocols/*_protocol.rb"))
+      Dir[path].each do |filename|
+        @src_keywords << filename.split('/')[-1].split('_protocol.rb')[0].upcase
+      end
+
+      # Remove things we don't document
+      @src_keywords.uniq!
+      @src_keywords -= (DEPRECATED + EXCEPTIONS + OPENGL)
+
+      #puts "Total source keywords: #{@src_keywords.length}"
+      expect(@src_keywords.length > 100) # Sanity check
+    end
+
+    def process_meta(yaml_keywords, meta)
+      meta.each do |keyword, data|
+        next unless keyword.is_a?(String) && keyword.upcase == keyword
+        next if keyword == 'UNKNOWN' # Ignore the UNKNOWN placeholder
+
+        if data['modifiers']
+          process_meta(yaml_keywords, data['modifiers'])
+        end
+        yaml_keywords << keyword
+      end
+    end
+
+    def get_yaml_keywords
+      @yaml_keywords = []
+      path = File.expand_path(File.join(File.dirname(__FILE__), "../../data/config/*.yaml"))
+      Dir[path].each do |filename|
+        meta = Cosmos::MetaConfigParser.load(filename)
+        process_meta(@yaml_keywords, meta)
+      end
+      #puts "Total yaml keywords: #{@yaml_keywords.length}"
+      expect(@yaml_keywords.length > 100) # Sanity check
+    end
+
+    before(:all) do
+      get_src_keywords()
+      get_yaml_keywords()
+    end
+
+    it "should document all source keywords" do
+      undocumented = []
+      @src_keywords.each do |keyword|
+        undocumented << keyword unless @yaml_keywords.include?(keyword)
+      end
+      expect(undocumented).to be_empty, "Following source keywords not in YAML: #{undocumented}"
+    end
+
+    it "should not have extra keywords" do
+      extra = []
+      @yaml_keywords.each do |keyword|
+        extra << keyword unless @src_keywords.include?(keyword)
+      end
+      expect(extra).to be_empty, "Following YAML keywords not in source: #{extra}"
+    end
+  end
+end

data/spec/interfaces/protocols/fixed_protocol_spec.rb

@@ -90,6 +90,7 @@ module Cosmos
       end
 
       it "reads telemetry data from the stream" do
+        target = System.targets['SYSTEM']
         @interface.add_protocol(FixedProtocol, [1], :READ_WRITE)
         @interface.instance_variable_set(:@stream, FixedStream.new)
         @interface.target_names = ['SYSTEM']
@@ -103,6 +104,7 @@ module Cosmos
         expect(packet.received_time.to_f).to be_within(0.1).of(Time.now.to_f)
         expect(packet.target_name).to eql 'SYSTEM'
         expect(packet.packet_name).to eql 'LIMITS_CHANGE'
+        target.tlm_unique_id_mode = true
         $index = 1
         packet = @interface.read
         expect(packet.received_time.to_f).to be_within(0.1).of(Time.now.to_f)
@@ -113,30 +115,39 @@ module Cosmos
         expect(packet.received_time.to_f).to be_within(0.1).of(Time.now.to_f)
         expect(packet.target_name).to eql 'SYSTEM'
         expect(packet.packet_name).to eql 'LIMITS_CHANGE'
+        target.tlm_unique_id_mode = false
       end
 
       it "reads command data from the stream" do
-        $index = 0
+        target = System.targets['SYSTEM']
+        packet = System.commands.packet("SYSTEM", "STARTLOGGING")
+        packet.restore_defaults
+        $buffer = packet.buffer.clone
         class FixedStream2 < Stream
           def connect; end
           def connected?; true; end
           def read
-            case $index
-            when 0
-              $index += 1
-              "\x1A\xCF\xFC\x1D\x00\x00\x00\x02"
-            else
-              "\x00\x00\x00\x00\x00\x00\x00\x00"
-            end
+            # Prepend a matching sync pattern to test the discard
+            "\x1A\xCF\xFC\x1D\x55\x55" << $buffer
           end
         end
-        @interface.add_protocol(FixedProtocol, [8, 0, '0x1ACFFC1D', false], :READ_WRITE)
+        # Require 8 bytes, discard 6 leading bytes, use 0x1ACFFC1D sync, telemetry = false (command)
+        @interface.add_protocol(FixedProtocol, [8, 6, '0x1ACFFC1D', false], :READ_WRITE)
         @interface.instance_variable_set(:@stream, FixedStream2.new)
         @interface.target_names = ['SYSTEM']
+        target.cmd_unique_id_mode = false
         packet = @interface.read
         expect(packet.received_time.to_f).to be_within(0.01).of(Time.now.to_f)
         expect(packet.target_name).to eql 'SYSTEM'
         expect(packet.packet_name).to eql 'STARTLOGGING'
+        expect(packet.buffer).to eql $buffer
+        target.cmd_unique_id_mode = true
+        packet = @interface.read
+        expect(packet.received_time.to_f).to be_within(0.01).of(Time.now.to_f)
+        expect(packet.target_name).to eql 'SYSTEM'
+        expect(packet.packet_name).to eql 'STARTLOGGING'        
+        expect(packet.buffer).to eql $buffer
+        target.cmd_unique_id_mode = false
       end
     end
   end