cosmos 4.0.3 → 4.1.0

data/lib/cosmos/top_level.rb

@@ -169,9 +169,8 @@ module Cosmos
     return filename if File.exist? filename
 
     # Check relative to executing file
-    filename = Cosmos.path($0, 'config/data/' + name)
+    filename = Cosmos.path($0, ['config', 'data', name])
     return filename if File.exist? filename
-
     nil
   end
 
@@ -192,7 +191,7 @@ module Cosmos
     else
       current_dir = File.join(BASE_PWD, calling_file)
     end
-    while true
+    loop do
       test_path = File.join(current_dir, partial_path)
       if File.exist?(test_path)
         return test_path
@@ -298,13 +297,14 @@ module Cosmos
       thread = Thread.new do
         output, _ = Open3.capture2e(command)
         if !output.empty?
-          # Work around modalSession messages on Mac Mavericks
-          real_lines = 0
+          # Ignore modalSession messages on Mac Mavericks and Qt Untested Windows 10
+          new_output = ''
           output.each_line do |line|
-            real_lines += 1 if line !~ /modalSession/
+            new_output << line if line !~ /modalSession/ && line !~ /Untested Windows version 10.0/
           end
+          output = new_output
 
-          if real_lines > 0
+          if !output.empty?
             Logger.error output
             self.write_unexpected_file(output)
             if defined? ::Qt and $qApp
@@ -395,7 +395,7 @@ module Cosmos
   # @yieldparam file [File] The log file
   # @return [String|nil] The fully pathed log file name or nil if there was
   #   an error creating the log file.
-  def self.create_log_file(filename, log_dir)
+  def self.create_log_file(filename, log_dir = nil)
     log_file = nil
     Cosmos.set_working_dir do
       begin
@@ -403,31 +403,34 @@ module Cosmos
         # system.txt configuration file. If this has an error we won't be able
         # to determine the log path but we still want to write the log.
         log_dir = System.instance.paths['LOGS'] unless log_dir
-        log_file = File.join(log_dir,
-                             File.build_timestamped_filename([filename]))
         # Make sure the log directory exists
         raise unless File.exist?(log_dir)
-        log_file
       rescue Exception
-        # If not then we just build a file locally
-        if File.exist?('./outputs/logs')
-          log_file = File.join('./outputs/logs', File.build_timestamped_filename([filename]))
-        elsif File.exist?('./logs')
-          log_file = File.join('./logs', File.build_timestamped_filename([filename]))
-        else
-          log_file = File.build_timestamped_filename([filename])
-        end
+        log_dir = nil # Reset log dir since it failed above
+        # First check for ./logs
+        log_dir = './logs' if File.exist?('./logs')
+        # Prefer ./outputs/logs if it exists
+        log_dir = './outputs/logs' if File.exist?('./outputs/logs')
+        # If all else fails just use the local directory
+        log_dir = '.' unless log_dir
+      end
+      log_file = File.join(log_dir,
+                           File.build_timestamped_filename([filename]))
+      # Check for the log file existing. This could happen if this method gets
+      # called more than once in the same second.
+      if File.exist?(log_file)
+        sleep 1.01 # Sleep before rebuilding the timestamp to get something unique
+        log_file = File.join(log_dir,
+                             File.build_timestamped_filename([filename]))
       end
       begin
-        # Log exception to file, open the file in append mode in case we get
-        # multiple exceptions in the same second. That way we don't lose
-        # exceptions by overwritting the last exception file.
         COSMOS_MUTEX.synchronize do
           begin
-            file = File.open(log_file, 'a')
+            file = File.open(log_file, 'w')
             yield file
           ensure
             file.close unless file.closed?
+            File.chmod(0444, log_file) # Make file read only
           end
         end
       rescue Exception
@@ -738,8 +741,15 @@ module Cosmos
         Logger.info "Thread owner #{owner.class} does not support graceful_kill"
       end
       if thread.alive?
+        # If the thread dies after alive? but before backtrace, bt will be nil.
+        bt = thread.backtrace
+
         # Graceful failed
-        Logger.warn "Failed to gracefully kill thread:\n  Caller Backtrace:\n  #{caller().join("\n  ")}\n  \n  Thread Backtrace:\n  #{thread.backtrace.join("\n  ")}\n\n"
+        msg =  "Failed to gracefully kill thread:\n"
+        msg << "  Caller Backtrace:\n  #{caller().join("\n  ")}\n"
+        msg << "  \n  Thread Backtrace:\n  #{bt.join("\n  ")}\n" if bt
+        msg << "\n"
+        Logger.warn msg
         thread.kill
         end_time = Time.now.sys + hard_timeout
         while thread.alive? && ((end_time - Time.now.sys) > 0)

data/lib/cosmos/utilities/csv.rb

@@ -51,13 +51,26 @@ module Cosmos
     # @return [Boolean] Single value converted to a boolean (true or false)
     def bool(item, index = 0)
       raise "#{item} not found" unless keys.include?(item)
-      case @hash[item][index].upcase
-      when 'TRUE'
-        true
-      when 'FALSE'
-        false
+      if Range === index
+        @hash[item][index].map do |x|
+          case x.upcase
+          when 'TRUE'
+            true
+          when 'FALSE'
+            false
+          else
+            raise "#{item} value of #{x} not boolean. Must be 'TRUE' 'or 'FALSE'."
+          end
+        end
       else
-        raise "#{item} value of #{@hash[item][index]} not boolean. Must be 'TRUE' 'or 'FALSE'."
+        case @hash[item][index].upcase
+        when 'TRUE'
+          true
+        when 'FALSE'
+          false
+        else
+          raise "#{item} value of #{@hash[item][index]} not boolean. Must be 'TRUE' 'or 'FALSE'."
+        end
       end
     end
     alias boolean bool
@@ -69,7 +82,11 @@ module Cosmos
     # @return [Integer] Single value converted to an integer
     def int(item, index = 0)
       raise "#{item} not found" unless keys.include?(item)
-      @hash[item][index].to_i
+      if Range === index
+        @hash[item][index].map {|x| x.to_i }
+      else
+        @hash[item][index].to_i
+      end
     end
     alias integer int
 
@@ -80,8 +97,42 @@ module Cosmos
     # @return [Float] Single value converted to a float
     def float(item, index = 0)
       raise "#{item} not found" unless keys.include?(item)
-      @hash[item][index].to_f
+      if Range === index
+        @hash[item][index].map {|x| x.to_f }
+      else
+        @hash[item][index].to_f
+      end
+    end
+
+    # Convenience method to access a value by key and convert it to a string
+    #
+    # @param item [String] Key to access the value
+    # @param index [Integer] Which value to return
+    # @return [String] Single value converted to a string
+    def string(item, index = 0)
+      raise "#{item} not found" unless keys.include?(item)
+      if Range === index
+        @hash[item][index].map {|x| x.to_s }
+      else
+        @hash[item][index].to_s
+      end
+    end
+    alias str string
+
+    # Convenience method to access a value by key and convert it to a symbol
+    #
+    # @param item [String] Key to access the value
+    # @param index [Integer] Which value to return
+    # @return [Symbol] Single value converted to a symbol
+    def symbol(item, index = 0)
+      raise "#{item} not found" unless keys.include?(item)
+      if Range === index
+        @hash[item][index].map {|x| x.intern }
+      else
+        @hash[item][index].intern
+      end
     end
+    alias sym symbol
 
     # Creates a copy of the CSV file passed into the constructor. The file will
     # be prefixed by the current date and time to create a unique filename.
@@ -131,6 +182,7 @@ module Cosmos
     # Closes the archive file created by #{CSV#create_archive}.
     def close_archive
       @archive.close
+      File.chmod(0444, @archive_file)
       @archive = nil
     end
   end

data/lib/cosmos/version.rb

@@ -1,12 +1,12 @@
 # encoding: ascii-8bit
 
-COSMOS_VERSION = '4.0.3'
+COSMOS_VERSION = '4.1.0'
 module Cosmos
   module Version
     MAJOR = '4'
-    MINOR = '0'
-    PATCH = '3'
-    BUILD = '04e4681c862983cb85d08e888a07efffb60b4fbb'
+    MINOR = '1'
+    PATCH = '0'
+    BUILD = '9731591f6e6dd90749a966e06a95d923b7f112ae'
   end
-  VERSION = '4.0.3'
+  VERSION = '4.1.0'
 end

data/spec/config/config_parser_spec.rb

@@ -67,8 +67,17 @@ module Cosmos
         tf.unlink
       end
 
+      it "requires ERB partials begin with an underscore" do
+        tf = Tempfile.new('unittest')
+        tf.puts "<%= render 'partial.txt' %>"
+        tf.close
+
+        expect { @cp.parse_file(tf.path) }.to raise_error(ConfigParser::Error, /must begin with an underscore/)
+        tf.unlink
+      end
+
       it "supports ERB partials via render" do
-        tf2 = Tempfile.new('partial.txt')
+        tf2 = Tempfile.new('_partial.txt')
         tf2.puts '<% if output %>'
         tf2.puts 'KEYWORD <%= id %> <%= desc %>'
         tf2.puts '<% end %>'

data/spec/core_ext/socket_spec.rb

@@ -25,8 +25,10 @@ describe Socket do
 
   describe "lookup_hostname_from_ip" do
     it "returns the hostname for the ip address" do
-      ipaddr = Resolv.getaddress "localhost"
-      expect(Socket.lookup_hostname_from_ip(ipaddr)).to match "localhost"
+      if !ENV['APPVEYOR']
+        ipaddr = Resolv.getaddress "localhost"
+        expect(Socket.lookup_hostname_from_ip(ipaddr)).to match "localhost"
+      end
     end
   end
 end

data/spec/gui/utilities/script_module_gui_spec.rb

@@ -0,0 +1,102 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+if RUBY_ENGINE == 'ruby'
+  require 'spec_helper'
+  require 'cosmos/gui/qt'
+  require 'cosmos/script'
+  require 'cosmos/gui/utilities/script_module_gui'
+
+  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)
+          end
+
+          buttons = %w(THIS IS A TEST)
+          answer = combo_box("HI", *buttons)
+          expect(buttons).to eq %w(THIS IS A TEST)
+        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)
+          end
+
+          buttons = %w(THIS IS A TEST)
+          answer = message_box("HI", *buttons)
+          expect(buttons).to eq %w(THIS IS A TEST)
+        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)
+          end
+
+          buttons = %w(THIS IS A TEST)
+          answer = vertical_message_box("HI", *buttons)
+          expect(buttons).to eq %w(THIS IS A TEST)
+        end
+      end
+    end
+  end
+end

data/spec/install/config/data/data.txt

@@ -0,0 +1 @@
+# This is data

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

@@ -89,6 +89,8 @@ COMMAND INST ARYCMD BIG_ENDIAN "Command with array parameter"
   PARAMETER    CCSDSLENGTH    32  16  UINT  0 65535   0 "CCSDS primary header packet length"
   ID_PARAMETER PKTID          48  16  UINT  0 65535   6 "Packet id"
   ARRAY_PARAMETER ARRAY       64  64  FLOAT 640 "Array parameter"
+  APPEND_ARRAY_PARAMETER ARRAY2 32 UINT 320 "Array parameter"
+    FORMAT_STRING "0x%0X"
 
 COMMAND INST SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panels"
   PARAMETER    CCSDSVER        0   3  UINT  0     0   0 "CCSDS primary header version number"

data/spec/interfaces/cmd_tlm_server_interface_spec.rb

@@ -32,8 +32,7 @@ module Cosmos
       allow_any_instance_of(Interface).to receive(:connected?).and_return(true)
       allow_any_instance_of(Interface).to receive(:disconnect)
       @cts = CmdTlmServer.new
-      @cts.start
-      sleep 0.1
+      sleep 1
       @ctsi = CmdTlmServerInterface.new
     end
 

data/spec/interfaces/protocols/template_protocol_spec.rb

@@ -173,7 +173,7 @@ module Cosmos
         @interface.write(packet)
       end
 
-      it "processes responses" do
+      it "processes responses with no ID fields" do
         rsp_pkt = Packet.new('TGT', 'READ_VOLTAGE')
         rsp_pkt.append_item("VOLTAGE", 16, :UINT)
         allow(System).to receive_message_chain(:telemetry, :packet).and_return(rsp_pkt)
@@ -199,7 +199,77 @@ module Cosmos
         @interface.write(packet)
         sleep 0.55
         expect($write_buffer).to eql("SOUR:VOLT 11, (@1)\xAB\xCD")
-        expect(read_result.read("VOLTAGE")).to eq 10
+      end
+
+      it "sets the response ID to the defined ID value" do
+        rsp_pkt = Packet.new('TGT', 'READ_VOLTAGE')
+        rsp_pkt.append_item("PKT_ID", 16, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 1) # ID == 1
+        rsp_pkt.append_item("VOLTAGE", 16, :UINT)
+        allow(System).to receive_message_chain(:telemetry, :packet).and_return(rsp_pkt)
+        @interface.instance_variable_set(:@stream, TemplateStream.new)
+        @interface.add_protocol(TemplateProtocol, %w(0xABCD 0xABCD 0 nil 1 true 0 nil false nil nil), :READ_WRITE)
+        @interface.target_names = ['TGT']
+        packet = Packet.new('TGT', 'CMD')
+        packet.append_item("CMD_ID", 16, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 1) # ID == 1
+        packet.get_item("CMD_ID").default = 1
+        packet.append_item("VOLTAGE", 16, :UINT)
+        packet.get_item("VOLTAGE").default = 11
+        packet.append_item("CHANNEL", 16, :UINT)
+        packet.get_item("CHANNEL").default = 1
+        packet.append_item("CMD_TEMPLATE", 1024, :STRING)
+        packet.get_item("CMD_TEMPLATE").default = "SOUR:VOLT <VOLTAGE>, (@<CHANNEL>)"
+        packet.append_item("RSP_TEMPLATE", 1024, :STRING)
+        packet.get_item("RSP_TEMPLATE").default = "<VOLTAGE>"
+        packet.append_item("RSP_PACKET", 1024, :STRING)
+        packet.get_item("RSP_PACKET").default = "READ_VOLTAGE"
+        packet.restore_defaults
+        @interface.connect
+        read_result = nil
+        $read_buffer = "\x31\x30\xAB\xCD" # ASCII 31, 30 is '10'
+        Thread.new { sleep(0.5); read_result = @interface.read }
+        @interface.write(packet)
+        sleep 0.55
+        expect($write_buffer).to eql("SOUR:VOLT 11, (@1)\xAB\xCD")
+        expect(read_result.read("PKT_ID")).to eql(1) # Result ID set to the defined value
+      end
+
+      it "handles multiple response IDs" do
+        rsp_pkt = Packet.new('TGT', 'READ_VOLTAGE')
+        rsp_pkt.append_item("APID", 16, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 10) # ID == 10
+        rsp_pkt.append_item("PKTID", 16, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 20) # ID == 20
+        rsp_pkt.append_item("VOLTAGE", 16, :UINT)
+        allow(System).to receive_message_chain(:telemetry, :packet).and_return(rsp_pkt)
+        @interface.instance_variable_set(:@stream, TemplateStream.new)
+        @interface.add_protocol(TemplateProtocol, %w(0xABCD 0xABCD 0 nil 1 true 0 nil false nil nil), :READ_WRITE)
+        @interface.target_names = ['TGT']
+        packet = Packet.new('TGT', 'CMD')
+        packet.append_item("APID", 16, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 1) # ID == 1
+        packet.get_item("APID").default = 1
+        packet.append_item("PKTID", 16, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 2) # ID == 2
+        packet.get_item("PKTID").default = 2
+        packet.append_item("VOLTAGE", 16, :UINT)
+        packet.get_item("VOLTAGE").default = 11
+        packet.append_item("CHANNEL", 16, :UINT)
+        packet.get_item("CHANNEL").default = 1
+        packet.append_item("CMD_TEMPLATE", 1024, :STRING)
+        packet.get_item("CMD_TEMPLATE").default = "SOUR:VOLT <VOLTAGE>, (@<CHANNEL>)"
+        packet.append_item("RSP_TEMPLATE", 1024, :STRING)
+        packet.get_item("RSP_TEMPLATE").default = "<VOLTAGE>"
+        packet.append_item("RSP_PACKET", 1024, :STRING)
+        packet.get_item("RSP_PACKET").default = "READ_VOLTAGE"
+        packet.restore_defaults
+        # Explicitly write in values to the ID items different than the defaults
+        packet.write("APID", 10)
+        packet.write("PKTID", 20)
+        @interface.connect
+        read_result = nil
+        $read_buffer = "\x31\x30\xAB\xCD" # ASCII 31, 30 is '10'
+        Thread.new { sleep(0.5); read_result = @interface.read }
+        @interface.write(packet)
+        sleep 0.55
+        expect($write_buffer).to eql("SOUR:VOLT 11, (@1)\xAB\xCD")
+        expect(read_result.read("APID")).to eql(10) # ID item set to the defined value
+        expect(read_result.read("PKTID")).to eql(20) # ID item set to the defined value
       end
 
       it "handles templates with more values than the response" do