cosmos 4.2.4 → 4.5.0

data/spec/system/target_spec.rb

@@ -12,6 +12,7 @@ require 'spec_helper'
 require 'cosmos'
 require 'cosmos/system/target'
 require 'tempfile'
+require 'pathname'
 
 module Cosmos
 
@@ -167,8 +168,28 @@ module Cosmos
 
           # Initial require in target lib shouldn't be reported as error
           expect(Logger).to_not receive(:error)
-          Target.new("INST").process_file(tf.path)
+          target = Target.new("INST")
+          target.process_file(tf.path)
           expect { SystemFile.new }.to_not raise_error
+          expect(Pathname.new(target.requires[0]).absolute?).to be true
+          File.delete filename
+          tf.unlink
+        end
+
+        it "requires a file with absolute path" do
+          filename = File.join(Cosmos::USERPATH, 'abs_path.rb')
+          File.open(filename, 'w') do |file|
+            file.puts "class AbsPath"
+            file.puts "end"
+          end
+          tf = Tempfile.new('unittest')
+          tf.puts("REQUIRE #{File.expand_path(filename)}")
+          tf.close
+
+          # Initial require in target lib shouldn't be reported as error
+          expect(Logger).to_not receive(:error)
+          Target.new("INST").process_file(tf.path)
+          expect { AbsPath.new }.to_not raise_error
           File.delete filename
           tf.unlink
         end
@@ -200,6 +221,46 @@ module Cosmos
         end
       end
 
+      context "with TLM_UNIQUE_ID_MODE" do
+        it "takes no parameters" do
+          tf = Tempfile.new('unittest')
+          tf.puts("")
+          tf.close
+          tgt = Target.new("TGT")
+          tgt.process_file(tf.path)
+          expect(tgt.tlm_unique_id_mode).to eql false
+          tf.unlink
+
+          tf = Tempfile.new('unittest')
+          tf.puts("TLM_UNIQUE_ID_MODE")
+          tf.close
+          tgt = Target.new("TGT")
+          tgt.process_file(tf.path)
+          expect(tgt.tlm_unique_id_mode).to eql true
+          tf.unlink
+        end
+      end
+
+      context "with CMD_UNIQUE_ID_MODE" do
+        it "takes no parameters" do
+          tf = Tempfile.new('unittest')
+          tf.puts("")
+          tf.close
+          tgt = Target.new("TGT")
+          tgt.process_file(tf.path)
+          expect(tgt.cmd_unique_id_mode).to eql false
+          tf.unlink
+
+          tf = Tempfile.new('unittest')
+          tf.puts("CMD_UNIQUE_ID_MODE")
+          tf.close
+          tgt = Target.new("TGT")
+          tgt.process_file(tf.path)
+          expect(tgt.cmd_unique_id_mode).to eql true
+          tf.unlink
+        end
+      end
+
       context "with COMMANDS and TELEMETRY" do
         it "takes 1 parameters" do
           tf = Tempfile.new('unittest')

data/spec/tools/cmd_tlm_server/api_spec.rb

@@ -497,7 +497,7 @@ DOC
         # Each element in the results array contains:
         #   name, default, states, description, full units, units, required
         expect(result).to include ['TYPE',0,{"NORMAL"=>0,"SPECIAL"=>1},'Collect type',nil,nil,true,"UINT"]
-        expect(result).to include ['TEMP',0.0,nil,'Collect temperature','Celcius','C',false,"FLOAT"]
+        expect(result).to include ['TEMP',0.0,nil,'Collect temperature','Celsius','C',false,"FLOAT"]
       end
 
       it "returns array parameters for the command" do
@@ -910,28 +910,34 @@ DOC
         @api.inject_tlm("INST","HEALTH_STATUS",{TEMP1: 0, TEMP2: 0, TEMP3: 0, TEMP4: 0}, :RAW)
 
         vals = @api.get_tlm_packet("INST","HEALTH_STATUS")
-        expect(vals[0][0]).to eql "RECEIVED_TIMESECONDS"
+        expect(vals[0][0]).to eql "PACKET_TIMESECONDS"
         expect(vals[0][1]).to be > 0
         expect(vals[0][2]).to be_nil
-        expect(vals[1][0]).to eql "RECEIVED_TIMEFORMATTED"
+        expect(vals[1][0]).to eql "PACKET_TIMEFORMATTED"
         expect(vals[1][1].split(' ')[0]).to eql Time.now.formatted.split(' ')[0]
         expect(vals[1][2]).to be_nil
-        expect(vals[2][0]).to eql "RECEIVED_COUNT"
+        expect(vals[2][0]).to eql "RECEIVED_TIMESECONDS"
         expect(vals[2][1]).to be > 0
         expect(vals[2][2]).to be_nil
+        expect(vals[3][0]).to eql "RECEIVED_TIMEFORMATTED"
+        expect(vals[3][1].split(' ')[0]).to eql Time.now.formatted.split(' ')[0]
+        expect(vals[3][2]).to be_nil
+        expect(vals[4][0]).to eql "RECEIVED_COUNT"
+        expect(vals[4][1]).to be > 0
+        expect(vals[4][2]).to be_nil
         # Spot check a few more
-        expect(vals[22][0]).to eql "TEMP1"
-        expect(vals[22][1]).to eql -100.0
-        expect(vals[22][2]).to eql :RED_LOW
-        expect(vals[23][0]).to eql "TEMP2"
-        expect(vals[23][1]).to eql -100.0
-        expect(vals[23][2]).to eql :RED_LOW
-        expect(vals[24][0]).to eql "TEMP3"
+        expect(vals[24][0]).to eql "TEMP1"
         expect(vals[24][1]).to eql -100.0
         expect(vals[24][2]).to eql :RED_LOW
-        expect(vals[25][0]).to eql "TEMP4"
+        expect(vals[25][0]).to eql "TEMP2"
         expect(vals[25][1]).to eql -100.0
         expect(vals[25][2]).to eql :RED_LOW
+        expect(vals[26][0]).to eql "TEMP3"
+        expect(vals[26][1]).to eql -100.0
+        expect(vals[26][2]).to eql :RED_LOW
+        expect(vals[27][0]).to eql "TEMP4"
+        expect(vals[27][1]).to eql -100.0
+        expect(vals[27][2]).to eql :RED_LOW
       end
     end
 
@@ -1067,16 +1073,18 @@ DOC
 
       it "returns all the items for a target/packet" do
         items = @api.get_tlm_item_list("INST","HEALTH_STATUS")
-        expect(items[0][0]).to eql "RECEIVED_TIMESECONDS"
-        expect(items[1][0]).to eql "RECEIVED_TIMEFORMATTED"
-        expect(items[2][0]).to eql "RECEIVED_COUNT"
+        expect(items[0][0]).to eql "PACKET_TIMESECONDS"
+        expect(items[1][0]).to eql "PACKET_TIMEFORMATTED"
+        expect(items[2][0]).to eql "RECEIVED_TIMESECONDS"
+        expect(items[3][0]).to eql "RECEIVED_TIMEFORMATTED"
+        expect(items[4][0]).to eql "RECEIVED_COUNT"
         # Spot check a few more
-        expect(items[22][0]).to eql "TEMP1"
-        expect(items[22][1]).to be_nil
-        expect(items[22][2]).to eql "Temperature #1"
-        expect(items[28][0]).to eql "COLLECT_TYPE"
-        expect(items[28][1]).to include("NORMAL"=>0, "SPECIAL"=>1)
-        expect(items[28][2]).to eql "Most recent collect type"
+        expect(items[24][0]).to eql "TEMP1"
+        expect(items[24][1]).to be_nil
+        expect(items[24][2]).to eql "Temperature #1"
+        expect(items[30][0]).to eql "COLLECT_TYPE"
+        expect(items[30][1]).to include("NORMAL"=>0, "SPECIAL"=>1)
+        expect(items[30][2]).to eql "Most recent collect type"
       end
     end
 

data/spec/tools/cmd_tlm_server/background_tasks_spec.rb

@@ -23,7 +23,7 @@ module Cosmos
           file.puts "require 'cosmos/tools/cmd_tlm_server/background_task'"
           file.puts "class MyBgTask#{i} < Cosmos::BackgroundTask"
           if i == 3
-            file.puts "  def call; raise 'Error'; end"
+            file.puts "  def call; puts 'BG#{i} START'; raise 'Error'; end"
           else
             file.puts "  def call; puts 'BG#{i} START'; @go = true; sleep 1 while @go; end"
           end
@@ -163,16 +163,24 @@ module Cosmos
           bt.start_all
           # 2 because the RSpec main thread plus the background task
           expect(running_threads.length).to eql(2)
+          expect(bt.instance_variable_get("@threads").length).to eq 1
+          expect(bt.instance_variable_get("@threads")[0].alive?).to eq true
           sleep 1.1 # Allow the thread to crash
           expect(running_threads.length).to eql(1)
-          expect(bt.instance_variable_get("@threads").length).to eq 1
-          expect(bt.instance_variable_get("@threads")[0].alive?).to eq false
+          expect(bt.instance_variable_get("@threads")[0]).to be_nil
+          expect(stdout.string).to match("unexpectedly died")
+        end
 
-          bt.stop_all
-          sleep 0.2
+        # Try to restart the task
+        capture_io do |stdout|
+          bt.start_all
+          # 2 because the RSpec main thread plus the background task
+          expect(running_threads.length).to eql(2)
+          expect(bt.instance_variable_get("@threads").length).to eq 1
+          expect(bt.instance_variable_get("@threads")[0].alive?).to eq true
+          sleep 1.1 # Allow the thread to crash
           expect(running_threads.length).to eql(1)
-          expect(bt.instance_variable_get("@threads").length).to eq 0
-
+          expect(bt.instance_variable_get("@threads")[0]).to be_nil
           expect(stdout.string).to match("unexpectedly died")
         end
         tf.unlink

data/spec/tools/cmd_tlm_server/cmd_tlm_server_config_spec.rb

@@ -435,6 +435,39 @@ module Cosmos
         end
       end
 
+      context "with LOG_STORED" do
+        it "complains about too many parameters" do
+          tf = Tempfile.new('unittest')
+          tf.puts "INTERFACE CTSSPEC_INT cts_config_test_interface.rb"
+          tf.puts 'LOG_STORED PacketLogWriter TRUE'
+          tf.close
+          expect { CmdTlmServerConfig.new(tf.path) }.to raise_error(ConfigParser::Error, /Too many parameters for LOG_STORED./)
+          tf.unlink
+        end
+
+        it "complains about unknown log writers" do
+          tf = Tempfile.new('unittest')
+          tf.puts "INTERFACE CTSSPEC_INT cts_config_test_interface.rb"
+          tf.puts 'LOG_STORED MyLogWriter'
+          tf.close
+          expect { CmdTlmServerConfig.new(tf.path) }.to raise_error(ConfigParser::Error, /Unknown packet log writer: MYLOGWRITER/)
+          tf.unlink
+        end
+
+        it "adds a packet log writer to the interface" do
+          tf = Tempfile.new('unittest')
+          tf.puts 'PACKET_LOG_WRITER MY_WRITER packet_log_writer.rb'
+          tf.puts "INTERFACE CTSSPEC_INT cts_config_test_interface.rb"
+          tf.puts 'LOG DEFAULT'
+          tf.puts 'LOG_STORED MY_WRITER'
+          tf.close
+          config = CmdTlmServerConfig.new(tf.path)
+          expect(config.interfaces['CTSSPEC_INT'].packet_log_writer_pairs.length).to eql 1
+          expect(config.interfaces['CTSSPEC_INT'].stored_packet_log_writer_pairs.length).to eql 1
+          tf.unlink
+        end
+      end
+
       context "with DONT_LOG" do
         it "complains about too many parameters" do
           tf = Tempfile.new('unittest')

data/spec/tools/cmd_tlm_server/commanding_spec.rb

@@ -67,7 +67,7 @@ module Cosmos
         expect(interfaces.all["MY_INT"].packet_log_writer_pairs[0].cmd_log_writer).to receive(:write)
 
         # Grab an existing packet
-        pkt = System.commands.packet('SYSTEM','STARTLOGGING')
+        pkt = System.commands.packet('SYSTEM','STARTLOGGING').clone
 
         count = System.targets['SYSTEM'].cmd_cnt
         cmd.send_command_to_target('SYSTEM', pkt)
@@ -77,6 +77,30 @@ module Cosmos
         tf.unlink
       end
 
+      it "sends already identified stored commands" do
+        tf = Tempfile.new('unittest')
+        tf.puts 'PACKET_LOG_WRITER MY_WRITER packet_log_writer.rb'
+        tf.puts 'INTERFACE MY_INT interface.rb'
+        tf.puts '  LOG_STORED MY_WRITER'
+        tf.close
+        config = CmdTlmServerConfig.new(tf.path)
+        cmd = Commanding.new(config)
+        interfaces = Interfaces.new(config)
+        interfaces.map_target("SYSTEM","MY_INT")
+        expect(interfaces.all["MY_INT"]).to receive(:write)
+        expect(interfaces.all["MY_INT"].stored_packet_log_writer_pairs[0].cmd_log_writer).to receive(:write)
+
+        # Grab an existing packet
+        pkt = System.commands.packet('SYSTEM','STARTLOGGING').clone
+        pkt.stored = true
+
+        count = System.targets['SYSTEM'].cmd_cnt
+        cmd.send_command_to_target('SYSTEM', pkt)
+        # Verify the SYSTEM STARTLOGGING packet has been updated
+        expect(System.commands.packet("SYSTEM","STARTLOGGING").buffer).to eql pkt.buffer
+        expect(System.targets['SYSTEM'].cmd_cnt).to eq count + 1
+        tf.unlink
+      end
 
       it "logs unknown commands" do
         Logger.level = Logger::DEBUG

data/spec/tools/cmd_tlm_server/interface_thread_spec.rb

@@ -41,6 +41,7 @@ module Cosmos
 
       allow(System).to receive_message_chain(:telemetry,:identify!).and_return(nil)
       allow(System).to receive_message_chain(:telemetry,:update!).and_return(@packet)
+      allow(System).to receive_message_chain(:telemetry,:identify_and_define_packet).and_return(@packet)
       targets = {'TGT'=>Target.new('TGT')}
       allow(System).to receive(:targets).and_return(targets)
     end
@@ -298,6 +299,20 @@ module Cosmos
         expect(running_threads.length).to eql(1)
       end
 
+      it "handles stored packet log writers" do
+        writer = double("LogWriter")
+        allow(writer).to receive_message_chain(:tlm_log_writer,:write)
+        @interface.stored_packet_log_writer_pairs = [writer]
+        @packet.stored = true
+        thread = InterfaceThread.new(@interface)
+        thread.start
+        sleep 0.1
+        expect(running_threads.length).to eql(2)
+        thread.stop
+        sleep 0.2
+        expect(running_threads.length).to eql(1)
+      end
+
     end
   end
 end

data/spec/tools/cmd_tlm_server/router_thread_spec.rb

@@ -20,7 +20,7 @@ module Cosmos
     before(:each) do
       @packet = Packet.new('TGT','PKT')
       @packet.buffer = "\x01\x02"
-
+      System.instance.instance_variable_set(:@allow_router_commanding, true)
       @interface = Interface.new
       # Interface#connected? implemented in each test case
       allow(@interface).to receive(:connect)
@@ -32,7 +32,7 @@ module Cosmos
     end
 
     describe "handle_packet" do
-      it "handles disconnectd interfaces" do
+      it "handles disconnected interfaces" do
         allow(@interface).to receive(:connected?).and_return(false)
         @interface.interfaces = [@interface]
         thread = RouterThread.new(@interface)
@@ -148,4 +148,3 @@ module Cosmos
     end
   end
 end
-

data/spec/top_level/top_level_spec.rb

@@ -111,8 +111,8 @@ module Cosmos
       expect(filename).to eql File.join(Cosmos::PATH,'data','about.txt')
     end
 
-    it "complains if the file is not found" do
-      expect { Cosmos.data_path('nope.txt') }.to raise_error(/Could not find path/)
+    it "returns nil if the file is not found" do
+      expect(Cosmos.data_path('nope.txt')).to be_nil
     end
   end
 
@@ -171,6 +171,19 @@ module Cosmos
       Cosmos.cleanup_exceptions()
     end
 
+    it "rescues marshal dump errors in a Packet with a Mutex" do
+      capture_io do |stdout|
+        system_exit_count = $system_exit_count
+        pkt = Packet.new("TGT","PKT")
+        pkt.append_item("ITEM", 16, :UINT)
+        pkt.read_all
+        Cosmos.marshal_dump('marshal_test', pkt)
+        expect($system_exit_count).to be > system_exit_count
+        expect(stdout.string).to match("Mutex exists in a packet")
+      end
+      Cosmos.cleanup_exceptions()
+    end
+
     it "rescues marshal load errors" do
       # Attempt to load something that doesn't exist
       expect(Cosmos.marshal_load('blah')).to be_nil
@@ -222,18 +235,29 @@ module Cosmos
     end
   end
 
-  describe "md5_files" do
-    it "calculates a MD5 sum across files" do
+  describe "hash_files" do
+    it "calculates a hashing sum across files in md5 mode" do
       File.open(File.join(Cosmos::USERPATH,'test1.txt'),'w') {|f| f.puts "test1" }
       File.open(File.join(Cosmos::USERPATH,'test2.txt'),'w') {|f| f.puts "test2" }
-      digest = Cosmos.md5_files(["test1.txt", "test2.txt"])
+      digest = Cosmos.hash_files(["test1.txt", "test2.txt"])
       expect(digest.digest.length).to be 16
       expect(digest.hexdigest).to eql 'e51dfbea83de9c7e6b49560089d8a170'
       File.delete(File.join(Cosmos::USERPATH, 'test1.txt'))
       File.delete(File.join(Cosmos::USERPATH, 'test2.txt'))
     end
+
+    it "calculates a hashing sum across files in sha256 mode" do
+      File.open(File.join(Cosmos::USERPATH,'test1.txt'),'w') {|f| f.puts "test1" }
+      File.open(File.join(Cosmos::USERPATH,'test2.txt'),'w') {|f| f.puts "test2" }
+      digest = Cosmos.hash_files(["test1.txt", "test2.txt"], nil, 'SHA256')
+      expect(digest.digest.length).to be 32
+      expect(digest.hexdigest).to eql '49789e7c809eb38ea34864b00e2cfd68825e0c07cd7b7d0c6fe2642ac87a919c'
+      File.delete(File.join(Cosmos::USERPATH, 'test1.txt'))
+      File.delete(File.join(Cosmos::USERPATH, 'test2.txt'))
+    end
   end
 
+
   describe "create_log_file" do
     it "creates a log file in System LOGS" do
       filename1 = Cosmos.create_log_file('test')

data/spec/utilities/message_log_spec.rb

@@ -70,9 +70,12 @@ module Cosmos
         log = MessageLog.new('TEST')
         log.start
         log.stop
-        Cosmos.set_working_dir do
-          expect(File.stat(log.filename).writable?).to be false
-          File.delete log.filename
+        if Kernel.is_windows? or Process.uid != 0
+          # writable? is always true for root, so skip this check
+          Cosmos.set_working_dir do
+            expect(File.stat(log.filename).writable?).to be false
+            File.delete log.filename
+          end
         end
       end
     end

data/tasks/gemfile_stats.rake

@@ -11,33 +11,42 @@
 desc 'Create a picture of gemfile downloads'
 task :gemfile_stats do
   require 'gems'
-  require 'gruff'
+  require 'win32ole'
 
   def get_latest_gem_data
     gem_data = []
+    # This is the only API call to Rubygems
     versions = Gems.versions 'cosmos'
     versions.each do |version|
       version_no = version['number']
+      next if version_no.split('.')[0] < '3' # anything before 3 is another gem
       month = version['built_at'].split('-')[0..1].join('-')
-      gem_data << [month, version_no, Gems.total_downloads("cosmos",version_no)[:version_downloads]] if version_no.split('.')[0] >= '3' # anything before 3 is another gem
+      downloads = version['downloads_count'].to_i
+      if gem_data.length > 0 && gem_data[-1][1] == version_no
+        gem_data[-1][2] += downloads
+      else
+        gem_data << [month, version_no, downloads]
+      end
     end
     gem_data
   end
 
   # This is useful for testing to prevent server round trips
-  #File.open("gemdata.marshall", 'w') {|file| file.write(Marshal.dump(get_latest_gem_data)) }
+  # Simply comment out this line when working on the formatting below (after first running once)
+  File.open("gemdata.marshall", 'w') {|file| file.write(Marshal.dump(get_latest_gem_data())) }
   gem_data = Marshal.load(File.read("gemdata.marshall"))
 
-  #gem_data = get_latest_gem_data()
   # Convert all the date text into Ruby Dates
   gem_data.map! {|x| [Date.strptime(x[0], "%Y-%m"), x[1], x[2]]}
   # Sort first by date and then version number
   gem_data.sort_by! {|x| [x[0], x[1]] }
 
-  g = Gruff::StackedArea.new
-  g.title = 'COSMOS Downloads'
+  excel = WIN32OLE.new('excel.application')
+  excel.visible = true
+  book = excel.Workbooks.Add
+  sheet = book.Worksheets(1)
 
-  # Build up date labels on the bottom of the graph
+  # Build up date labels
   labels = {} # Must be hash with integer keys and label value
   index = 0
   start_date = gem_data[0][0]
@@ -66,14 +75,29 @@ task :gemfile_stats do
     end
   end
 
-  # Reduce the number of labels due to overlap
-  labels.each do |i, label|
-    labels[i] = '' if i % 2 == 0
+  # Put dates in rows as there are more dates than there are releases
+  # Force the date column to be text
+  sheet.Columns(1).NumberFormat = "\@"
+  labels.values.each_with_index do |val, x|
+    sheet.Cells((x+2), 1).Value = val
   end
-  g.labels = labels
-  g.marker_font_size = 12
+
+  col = 2
   dataset.each do |version, data|
-    g.data(version, data)
+    # Set the version (e.g. 3.0) in the top row
+    sheet.Cells(1, col).Value = version
+    # The download values by date appear below the version in the same column
+    data.each_with_index do |val, x|
+      sheet.Cells((x+2), col).Value = val
+    end
+    col += 1
   end
-  g.write('cosmos_downloads.png')
+  # Excel column name lookup, 4 sets of alphabets gives us 104 versions to work with
+  letters = ('A'..'Z').to_a.concat(('AA'..'AZ').to_a).concat(('BA'..'BZ').to_a).concat(('CA'..'CZ').to_a)
+  chart = book.Charts.Add
+  chart.Name = "COSMOS Downloads"
+  chart.SetSourceData(sheet.Range("A1:#{letters[dataset.length]}#{labels.length+1}"))
+  chart.HasTitle = true
+  chart.ChartTitle.Characters.Text = "COSMOS Downloads"
+  chart.ChartType = 76 # AreaStacked
 end