cosmos 4.0.0 → 4.0.1

data/lib/cosmos/tools/tlm_viewer/widgets/canvasvalue_widget.rb

@@ -11,7 +11,6 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
   class CanvasvalueWidget
     include Widget
 
@@ -53,7 +52,7 @@ module Cosmos
       # This code uses the booleans set by the process_settings function and evaluates it to logically determine
       # if the item should be drawn on the canvas as "on" or "off".
       begin
-        @item_settings.each_with_index do |item,index|
+        @item_settings.each_with_index do |item, index|
           next if @values[index].to_f.nan? || @values[index].to_f.infinite?
           eval_string << " " << item[0].to_s << " (" << @values[index].to_s << " " << item[1].to_s << " " << item[2].to_s << ")"
         end
@@ -121,5 +120,4 @@ module Cosmos
       end
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/top_level.rb

@@ -345,6 +345,20 @@ module Cosmos
     thread
   end
 
+  # Runs a COSMOS tool
+  #
+  # @param tool_name [String] COSMOS tool to execute
+  # @param parameters [String] Parameters string to pass to the tool
+  def self.run_cosmos_tool(tool_name, parameters = '')
+    if Kernel.is_windows?
+      Cosmos.run_process("rubyw tools/#{tool_name} #{parameters}")
+    elsif Kernel.is_mac? and File.exist?("tools/mac/#{tool_name}.app")
+      Cosmos.run_process("open tools/mac/#{tool_name}.app --args #{parameters}")
+    else
+      Cosmos.run_process("ruby tools/#{tool_name} #{parameters}")
+    end
+  end
+
   # Runs an md5 sum over one or more files and returns the Digest::MD5 object.
   # Handles windows/unix new line differences but changes in whitespace will
   # change the md5 sum.

data/lib/cosmos/utilities/ruby_lex_utils.rb

@@ -186,7 +186,7 @@ class RubyLexUtils
   #   progress will be set as the processing progresses
   # @return [String] The text with all comments removed
   def remove_comments(text, progress_dialog = nil)
-    comments_removed = text
+    comments_removed = text.clone
     @lex.reinitialize
     @lex.exception_on_syntax_error = false
     @lex_io.string = text

data/lib/cosmos/version.rb

@@ -1,12 +1,12 @@
 # encoding: ascii-8bit
 
-COSMOS_VERSION = '4.0.0'
+COSMOS_VERSION = '4.0.1'
 module Cosmos
   module Version
     MAJOR = '4'
     MINOR = '0'
-    PATCH = '0'
-    BUILD = '5fd7539d1e07cb9a71388e9cd0ec60b97a0f625a'
+    PATCH = '1'
+    BUILD = '012697c6665f9dd1c47b86ed75b21c9bc928973f'
   end
-  VERSION = '4.0.0'
+  VERSION = '4.0.1'
 end

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

@@ -163,11 +163,11 @@ TELEMETRY INST PARAMS BIG_ENDIAN "Params set by SETPARAMS command"
   ITEM TIMESEC           48 32 UINT     "Seconds since epoch (January 1st, 1970, midnight)"
   ITEM TIMEUS            80 32 UINT     "Microseconds of second"
   ID_ITEM PKTID         112 16 UINT   1 "Packet id (The combination of CCSDS_APID and PACKET_ID identify the packet)"
-  MACRO_APPEND_START 5 1
-    APPEND_ITEM Value 16 UINT "Value setting"
+  <% 5.times do |i| %>
+    APPEND_ITEM VALUE<%= i %> 16 UINT "Value setting"
       STATE GOOD 0 GREEN
       STATE BAD 1 RED
-  MACRO_APPEND_END
+  <% end %>
   ITEM TIMESECONDS 0 0 DERIVED "Derived floating-point time since epoch in seconds"
     READ_CONVERSION unix_time_seconds_conversion.rb TIMESEC TIMEUS
     FORMAT_STRING '%0.6f'

data/spec/install/config/targets/SYSTEM/cmd_tlm/meta_tlm.txt

@@ -0,0 +1,10 @@
+TELEMETRY SYSTEM META BIG_ENDIAN "System Meta Data Telemetry Packet"
+  APPEND_ID_ITEM PKTID 8 UINT 1 "Packet Id"
+  APPEND_ITEM CONFIG 256 STRING "Configuration Name"
+  APPEND_ITEM COSMOS_VERSION 240 STRING "COSMOS Version"
+    META READ_ONLY
+  APPEND_ITEM USER_VERSION 240 STRING "User Project Version"
+    META READ_ONLY
+  APPEND_ITEM RUBY_VERSION 240 STRING "Ruby Version"
+    META READ_ONLY
+  APPEND_ITEM OPERATOR_NAME 512 STRING "Operator Name"

data/spec/packets/commands_spec.rb

@@ -276,6 +276,16 @@ module Cosmos
         expect(cmd.raw).to eql true
         expect(cmd.read("ITEM2")).to eql 10
       end
+
+      it "resets the buffer size" do
+        packet = @cmd.packet('TGT1', 'PKT1')
+        packet.buffer = "\x00" * (packet.defined_length + 1)
+        expect(packet.length).to eql 5
+        items = {"ITEM2" => 10}
+        cmd = @cmd.build_cmd("TGT1","PKT1",items)
+        expect(cmd.read("ITEM2")).to eql 10
+        expect(cmd.length).to eql 4
+      end
     end
 
     describe "format" do

data/spec/packets/packet_spec.rb

@@ -501,6 +501,68 @@ module Cosmos
         expect(@p.read("ITEM2", :FORMATTED, "")).to eql ["1", "2", "3", "4", "5"]
         expect(@p.read("ITEM2", :WITH_UNITS, "")).to eql ["1 V", "2 V", "3 V", "4 V", "5 V"]
       end
+
+      context "with :DERIVED items" do
+        it "returns nil if no read_conversion defined" do
+          @p.append_item("item",0,:DERIVED)
+          i = @p.get_item("ITEM")
+          i.format_string = "0x%x"
+          i.states = {"TRUE"=>1, "FALSE"=>0}
+          i.units = "V"
+          expect(@p.read("ITEM", :RAW, "")).to be_nil
+          expect(@p.read_item(i, :RAW, "")).to be_nil
+        end
+
+        it "reads the RAW value" do
+          @p.append_item("item",0,:DERIVED)
+          i = @p.get_item("ITEM")
+          i.format_string = "0x%x"
+          i.states = {"TRUE"=>1, "FALSE"=>0}
+          i.units = "V"
+          i.read_conversion = GenericConversion.new("0")
+          expect(@p.read("ITEM", :RAW, "")).to eql 0
+          expect(@p.read_item(i, :RAW, "")).to eql 0
+          i.read_conversion = GenericConversion.new("1")
+          expect(@p.read("ITEM", :RAW, "")).to eql 1
+          expect(@p.read_item(i, :RAW, "")).to eql 1
+        end
+
+        it "reads the CONVERTED value" do
+          @p.append_item("item",0,:DERIVED)
+          i = @p.get_item("ITEM")
+          i.format_string = "0x%x"
+          i.states = {"TRUE"=>1, "FALSE"=>0}
+          i.units = "V"
+          i.read_conversion = GenericConversion.new("0")
+          expect(@p.read("ITEM", :CONVERTED, "")).to eql "FALSE"
+          expect(@p.read_item(i, :CONVERTED, "")).to eql "FALSE"
+          i.read_conversion = GenericConversion.new("1")
+          expect(@p.read("ITEM", :CONVERTED, "")).to eql "TRUE"
+          expect(@p.read_item(i, :CONVERTED, "")).to eql "TRUE"
+        end
+
+        it "reads the FORMATTED value" do
+          @p.append_item("item",0,:DERIVED)
+          i = @p.get_item("ITEM")
+          i.format_string = "0x%x"
+          i.states = {"TRUE"=>1, "FALSE"=>0}
+          i.units = "V"
+          i.read_conversion = GenericConversion.new("3")
+          expect(@p.read("ITEM", :FORMATTED, "")).to eql "0x3"
+          expect(@p.read_item(i, :FORMATTED, "")).to eql "0x3"
+        end
+
+        it "reads the WITH_UNITS value" do
+          @p.append_item("item",0,:DERIVED)
+          i = @p.get_item("ITEM")
+          i.format_string = "0x%x"
+          i.states = {"TRUE"=>1, "FALSE"=>0}
+          i.units = "V"
+          i.read_conversion = GenericConversion.new("3")
+          expect(@p.read("ITEM", :WITH_UNITS, "")).to eql "0x3 V"
+          expect(@p.read_item(i, :WITH_UNITS, "")).to eql "0x3 V"
+        end
+      end
     end
 
     describe "write and write_item" do

data/spec/script/telemetry_spec.rb

@@ -161,12 +161,14 @@ module Cosmos
         unsubscribe_packet_data(id)
       end
 
-      it "subscribes and get limits events" do
-        id = subscribe_packet_data([["INST","HEALTH_STATUS"]])
-        CmdTlmServer.instance.post_packet(System.telemetry.packet("INST","HEALTH_STATUS"))
-        packet = get_packet(id, true)
-        expect(packet.target_name).to eql "INST"
-        expect(packet.packet_name).to eql "HEALTH_STATUS"
+      it "subscribes and gets packets" do
+        id = subscribe_packet_data([["SYSTEM","META"]])
+        inject_tlm("SYSTEM", "META")
+        packet = get_packet(id)
+        expect(packet.target_name).to eql "SYSTEM"
+        expect(packet.packet_name).to eql "META"
+        expect(packet.received_time).to be_within(1).of Time.now
+        expect(packet.received_count).to eql 1
         unsubscribe_packet_data(id)
       end
     end

data/spec/system/system_spec.rb

@@ -12,6 +12,7 @@ require 'spec_helper'
 require 'cosmos'
 require 'cosmos/system/system'
 require 'tempfile'
+require 'fileutils'
 
 module Cosmos
 
@@ -50,6 +51,143 @@ module Cosmos
         # Don't check the actual paths but just that they exist
         expect(System.paths.keys).to eql %w(LOGS TMP SAVED_CONFIG TABLES HANDBOOKS PROCEDURES SEQUENCES)
       end
+
+      context "initializing SYSTEM META" do
+        before(:all) do
+          FileUtils.mv(File.join(@config_targets, 'SYSTEM', 'cmd_tlm', 'meta_tlm.txt'), Dir.pwd)
+        end
+        after(:all) do
+          FileUtils.mv(File.join(Dir.pwd, 'meta_tlm.txt'), File.join(@config_targets, 'SYSTEM', 'cmd_tlm'))
+        end
+
+        it "initializes the SYSTEM META with no definitions" do
+          tlm = System.telemetry.packet("SYSTEM", "META")
+          expect(tlm.read("PKTID")).to_not be_nil
+          expect(tlm.read("CONFIG")).to_not be_nil
+          expect(tlm.read("COSMOS_VERSION")).to_not be_nil
+          expect(tlm.read("RUBY_VERSION")).to_not be_nil
+          expect(tlm.read("USER_VERSION")).to_not be_nil
+          cmd = System.commands.packet("SYSTEM", "META")
+          expect(cmd.read("PKTID")).to eql tlm.read("PKTID")
+          expect(cmd.read("CONFIG")).to eql tlm.read("CONFIG")
+          expect(cmd.read("COSMOS_VERSION")).to eql tlm.read("COSMOS_VERSION")
+          expect(cmd.read("RUBY_VERSION")).to eql tlm.read("RUBY_VERSION")
+          expect(cmd.read("USER_VERSION")).to eql tlm.read("USER_VERSION")
+        end
+
+        it "defaults badly defined TELEMETRY SYSTEM META" do
+          file = File.open(File.join(@config_targets, 'SYSTEM', 'cmd_tlm', 'meta_tlm.txt'), 'w')
+          file.puts "TELEMETRY SYSTEM META BIG_ENDIAN"
+          file.puts "APPEND_ID_ITEM PKTID 8 UINT 1"
+          file.puts "APPEND_ITEM CONFIG 256 STRING"
+          file.puts "APPEND_ITEM COSMOS_VERSION 240 STRING"
+          file.puts "APPEND_ITEM USER_VERSION 240 STRING"
+          file.puts "APPEND_ITEM RUBY_VERSION 200 STRING" # Error in the RUBY_VERSION length
+          file.close
+
+          expect(Logger).to receive(:error) do |msg|
+            expect(msg).to eql "SYSTEM META not defined correctly due to RUBY_VERSION incorrect - defaulting"
+          end
+          tf = Tempfile.new('unittest')
+          tf.puts("AUTO_DECLARE_TARGETS")
+          tf.close
+          System.class_variable_set(:@@instance, nil)
+          System.new(tf.path)
+          tlm = System.telemetry.packet("SYSTEM", "META")
+          expect(tlm.read("PKTID")).to_not be_nil
+          expect(tlm.read("CONFIG")).to_not be_nil
+          expect(tlm.read("COSMOS_VERSION")).to_not be_nil
+          expect(tlm.get_item("COSMOS_VERSION").bit_size).to eql(240)
+          expect(tlm.read("RUBY_VERSION")).to_not be_nil
+          expect(tlm.read("USER_VERSION")).to_not be_nil
+          cmd = System.commands.packet("SYSTEM", "META")
+          expect(cmd.read("PKTID")).to eql tlm.read("PKTID")
+          expect(cmd.read("CONFIG")).to eql tlm.read("CONFIG")
+          expect(cmd.read("COSMOS_VERSION")).to eql tlm.read("COSMOS_VERSION")
+          expect(cmd.read("RUBY_VERSION")).to eql tlm.read("RUBY_VERSION")
+          expect(cmd.read("USER_VERSION")).to eql tlm.read("USER_VERSION")
+          tf.unlink
+        end
+
+        it "doesn't allow COMMAND SYSTEM META definitions" do
+          file = File.open(File.join(@config_targets, 'SYSTEM', 'cmd_tlm', 'meta_tlm.txt'), 'w')
+          file.puts "TELEMETRY SYSTEM META BIG_ENDIAN"
+          file.puts "APPEND_ID_ITEM PKTID 8 UINT 1"
+          file.puts "APPEND_ITEM CONFIG 256 STRING"
+          file.puts "APPEND_ITEM COSMOS_VERSION 240 STRING"
+          file.puts "APPEND_ITEM USER_VERSION 240 STRING"
+          file.puts "APPEND_ITEM RUBY_VERSION 240 STRING"
+          file.puts "APPEND_ITEM TEST 512 STRING ''"
+          # The command system meta definition is correct but not allowed
+          file.puts "COMMAND SYSTEM META BIG_ENDIAN"
+          file.puts "APPEND_ID_PARAMETER PKTID 8 UINT 1 1 1"
+          file.puts "APPEND_PARAMETER CONFIG 256 STRING ''"
+          file.puts "APPEND_PARAMETER COSMOS_VERSION 240 STRING ''"
+          file.puts "APPEND_PARAMETER USER_VERSION 240 STRING ''"
+          file.puts "APPEND_PARAMETER RUBY_VERSION 240 STRING ''"
+          file.puts "APPEND_PARAMETER TEST 512 STRING ''"
+          file.close
+
+          expect(Logger).to receive(:error) do |msg|
+            expect(msg).to eql "SYSTEM META not defined correctly due to COMMAND SYSTEM META defined - defaulting"
+          end
+          tf = Tempfile.new('unittest')
+          tf.puts("AUTO_DECLARE_TARGETS")
+          tf.close
+          System.class_variable_set(:@@instance, nil)
+          System.new(tf.path)
+          tlm = System.telemetry.packet("SYSTEM", "META")
+          expect(tlm.read("PKTID")).to_not be_nil
+          expect(tlm.read("CONFIG")).to_not be_nil
+          expect(tlm.read("COSMOS_VERSION")).to_not be_nil
+          expect(tlm.get_item("COSMOS_VERSION").bit_size).to eql(240)
+          expect(tlm.read("RUBY_VERSION")).to_not be_nil
+          expect(tlm.read("USER_VERSION")).to_not be_nil
+          expect(tlm.items.keys.include?("TEST")).to be false
+          cmd = System.commands.packet("SYSTEM", "META")
+          expect(cmd.read("PKTID")).to eql tlm.read("PKTID")
+          expect(cmd.read("CONFIG")).to eql tlm.read("CONFIG")
+          expect(cmd.read("COSMOS_VERSION")).to eql tlm.read("COSMOS_VERSION")
+          expect(cmd.read("RUBY_VERSION")).to eql tlm.read("RUBY_VERSION")
+          expect(cmd.read("USER_VERSION")).to eql tlm.read("USER_VERSION")
+          expect(cmd.items.keys.include?("TEST")).to be false
+          tf.unlink
+        end
+
+        it "defines COMMAND SYSTEM META based on TELEMETRY" do
+          file = File.open(File.join(@config_targets, 'SYSTEM', 'cmd_tlm', 'meta_tlm.txt'), 'w')
+          file.puts "TELEMETRY SYSTEM META BIG_ENDIAN"
+          file.puts "APPEND_ID_ITEM PKTID 8 UINT 1"
+          file.puts "APPEND_ITEM CONFIG 256 STRING"
+          file.puts "APPEND_ITEM COSMOS_VERSION 240 STRING"
+          file.puts "APPEND_ITEM USER_VERSION 240 STRING"
+          file.puts "APPEND_ITEM RUBY_VERSION 240 STRING"
+          file.puts "APPEND_ITEM TEST 240 STRING"
+          file.close
+
+          expect(Logger).to_not receive(:error)
+          tf = Tempfile.new('unittest')
+          tf.puts("AUTO_DECLARE_TARGETS")
+          tf.close
+          System.class_variable_set(:@@instance, nil)
+          System.new(tf.path)
+          tlm = System.telemetry.packet("SYSTEM", "META")
+          expect(tlm.read("PKTID")).to_not be_nil
+          expect(tlm.read("CONFIG")).to_not be_nil
+          expect(tlm.read("COSMOS_VERSION")).to_not be_nil
+          expect(tlm.read("RUBY_VERSION")).to_not be_nil
+          expect(tlm.read("USER_VERSION")).to_not be_nil
+          expect(tlm.read("TEST")).to_not be_nil
+          cmd = System.commands.packet("SYSTEM", "META")
+          expect(cmd.read("PKTID")).to eql tlm.read("PKTID")
+          expect(cmd.read("CONFIG")).to eql tlm.read("CONFIG")
+          expect(cmd.read("COSMOS_VERSION")).to eql tlm.read("COSMOS_VERSION")
+          expect(cmd.read("RUBY_VERSION")).to eql tlm.read("RUBY_VERSION")
+          expect(cmd.read("USER_VERSION")).to eql tlm.read("USER_VERSION")
+          expect(cmd.read("TEST")).to eql tlm.read("TEST")
+          tf.unlink
+        end
+      end
     end
 
     describe "System.commands" do
@@ -642,6 +780,60 @@ module Cosmos
         end
       end
 
+      context "with META_INIT" do
+        it "takes 1 parameters" do
+          tf = Tempfile.new('unittest')
+          tf.puts("META_INIT")
+          tf.close
+          expect { System.instance.process_file(tf.path) }.to raise_error(ConfigParser::Error, /Not enough parameters for META_INIT./)
+          tf.unlink
+
+          tf = Tempfile.new('unittest')
+          tf.puts("META_INIT 1 2")
+          tf.close
+          expect { System.instance.process_file(tf.path) }.to raise_error(ConfigParser::Error, /Too many parameters for META_INIT./)
+          tf.unlink
+        end
+
+        it "populates the SYSTEM META packet with the file" do
+          FileUtils.rm_rf @config_targets
+          FileUtils.mkdir_p(File.join(@config_targets, 'SYSTEM', 'cmd_tlm'))
+          file = File.open(File.join(@config_targets, 'SYSTEM', 'cmd_tlm', 'meta_tlm.txt'), 'w')
+          file.puts "TELEMETRY SYSTEM META BIG_ENDIAN"
+          file.puts "APPEND_ID_ITEM PKTID 8 UINT 1"
+          file.puts "APPEND_ITEM CONFIG 256 STRING"
+          file.puts "APPEND_ITEM COSMOS_VERSION 240 STRING"
+          file.puts "APPEND_ITEM USER_VERSION 240 STRING"
+          file.puts "APPEND_ITEM RUBY_VERSION 240 STRING"
+          file.puts "APPEND_ITEM TEST 512 STRING"
+          file.puts "APPEND_ITEM ID 32 UINT"
+          file.close
+
+          meta = Tempfile.new('meta')
+          meta.puts("USER_VERSION 4.5")
+          meta.puts("TEST hello")
+          meta.puts("ID 123456789")
+          meta.close
+          tf = Tempfile.new('unittest')
+          tf.puts("AUTO_DECLARE_TARGETS")
+          tf.puts("META_INIT #{meta.path}")
+          tf.close
+          System.class_variable_set(:@@instance, nil)
+          System.new(tf.path)
+          tlm = System.telemetry.packet("SYSTEM", "META")
+          expect(tlm.read("USER_VERSION")).to eql '4.5'
+          expect(tlm.read("TEST")).to eql 'hello'
+          expect(tlm.read("ID")).to eql 123456789
+          cmd = System.commands.packet("SYSTEM", "META")
+          expect(cmd.read("USER_VERSION")).to eql tlm.read("USER_VERSION")
+          expect(cmd.read("TEST")).to eql tlm.read("TEST")
+          expect(cmd.read("ID")).to eql tlm.read("ID")
+          tf.unlink
+          meta.unlink
+          FileUtils.rm_rf(File.join(@config_targets, 'SYSTEM'))
+        end
+      end
+
       context "with ADD_MD5_FILE" do
         it "takes 1 parameters" do
           tf = Tempfile.new('unittest')

data/spec/system/target_spec.rb

@@ -132,13 +132,13 @@ module Cosmos
         end
 
         it "requires the file in the target lib directory over system lib" do
-          filename = File.join(Cosmos::USERPATH, 'config', 'targets', 'INST', 'lib', 'tgt_file.rb')
-          File.open(filename, 'w') do |file|
+          filename1 = File.join(Cosmos::USERPATH, 'config', 'targets', 'INST', 'lib', 'tgt_file.rb')
+          File.open(filename1, 'w') do |file|
             file.puts "class TgtLibFile"
             file.puts "end"
           end
-          filename = File.join(Cosmos::USERPATH, 'lib', 'tgt_file.rb')
-          File.open(filename, 'w') do |file|
+          filename2 = File.join(Cosmos::USERPATH, 'lib', 'tgt_file.rb')
+          File.open(filename2, 'w') do |file|
             file.puts "class SystemLibFile"
             file.puts "end"
           end
@@ -150,7 +150,8 @@ module Cosmos
           expect { TgtLibFile.new }.to_not raise_error
           expect(Object.const_defined?('TgtLibFile')).to be true
           expect(Object.const_defined?('SystemLibFile')).to be false
-          File.delete filename
+          File.delete filename1
+          File.delete filename2
           tf.unlink
         end