cosmos 3.9.2 → 4.0.0

data/lib/cosmos/streams/template_stream_protocol.rb

@@ -1,140 +0,0 @@
-# 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
-
-require 'cosmos/config/config_parser'
-require 'cosmos/streams/stream_protocol'
-require 'cosmos/streams/terminated_stream_protocol'
-require 'thread' # For Queue
-
-module Cosmos
-
-  class TemplateStreamProtocol < TerminatedStreamProtocol
-    def initialize(write_termination_characters,
-      read_termination_characters,
-      ignore_lines = 0,
-      initial_read_delay = nil,
-      response_lines = 1,
-      strip_read_termination = true,
-      discard_leading_bytes = 0,
-      sync_pattern = nil,
-      fill_sync_pattern = false)
-      super(write_termination_characters,
-            read_termination_characters,
-            strip_read_termination,
-            discard_leading_bytes,
-            sync_pattern,
-            fill_sync_pattern)
-      @response_template = nil
-      @response_packet = nil
-      @read_queue = Queue.new
-      @ignore_lines = ignore_lines.to_i
-      @response_lines = response_lines.to_i
-      @initial_read_delay = ConfigParser.handle_nil(initial_read_delay)
-      @initial_read_delay = @initial_read_delay.to_f if @initial_read_delay
-    end
-
-    def connect(stream)
-      # Empty the read queue
-      begin
-        @read_queue.pop(true) while @read_queue.length > 0
-      rescue
-      end
-
-      super(stream)
-
-      if @initial_read_delay
-        sleep(@initial_read_delay)
-        loop do
-          break if @stream.read_nonblock.length <= 0
-        end
-      end
-    end
-
-    def disconnect
-      super()
-      @read_queue << nil # Unblock the read queue in the interface thread
-    end
-
-    def read(use_queue = true)
-      if use_queue
-        return @read_queue.pop
-      else
-        return super()
-      end
-    end
-
-    # See StreamProtocol#pre_write_packet
-    def pre_write_packet(packet)
-      # First grab the response template and response packet (if there is one)
-      begin
-        @response_template = packet.read("RSP_TEMPLATE").strip
-        @response_packet = packet.read("RSP_PACKET").strip
-      rescue
-        # If there is no response template we set to nil
-        @response_template = nil
-        @response_packet = nil
-      end
-
-      # Grab the command template because that is all we eventually send
-      template = packet.read("CMD_TEMPLATE")
-      # Create a new empty packet to call super on
-      raw_packet = Packet.new(nil, nil)
-      raw_packet.buffer = template
-      # Call super to allow the super classes to massage the packet data
-      data = super(raw_packet)
-      # Scan the template for variables in brackets <VARIABLE>
-      # Read these values from the packet and substitute them in the template
-      template.scan(/<(.*?)>/).each do |variable|
-        data.gsub!("<#{variable[0]}>", packet.read(variable[0], :RAW).to_s)
-      end
-      data
-    end
-
-    def post_write_data(packet, data)
-      if @response_template && @response_packet
-        @ignore_lines.times do
-          read(false)
-        end
-        response_string = ''
-        @response_lines.times do
-          response = read(false)
-          raise "No response received" unless response
-          response_string << response.buffer
-        end
-
-        # Grab the response packet specified in the command
-        result_packet = System.telemetry.packet(@interface.target_names[0], @response_packet).clone
-        result_packet.received_time = nil
-
-        # Convert the response template into a Regexp
-        response_item_names = []
-        response_template = @response_template.clone
-        response_template_items = @response_template.scan(/<.*?>/)
-        response_template_items.each do |item|
-          response_item_names << item[1..-2]
-          response_template.gsub!(item, "(.*)")
-        end
-        response_regexp = Regexp.new(response_template)
-
-        # Scan the response for the variables in brackets <VARIABLE>
-        # Write the packet value with each of the values received
-        response_values = response_string.scan(response_regexp)[0]
-        raise "Unexpected response received: #{response_string}" if !response_values or (response_values.length != response_item_names.length)
-        response_values.each_with_index do |value, i|
-          result_packet.write(response_item_names[i], value)
-        end
-
-        @read_queue << result_packet
-      end
-    end
-
-  end # class TemplateStreamProtocol
-
-end # module Cosmos

data/lib/cosmos/streams/terminated_stream_protocol.rb

@@ -1,85 +0,0 @@
-# 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
-
-require 'cosmos/config/config_parser'
-require 'cosmos/streams/stream_protocol'
-
-module Cosmos
-
-  # This StreamProtocol delineates packets using termination characters at
-  # the end of the stream.
-  class TerminatedStreamProtocol < StreamProtocol
-
-    # @param write_termination_characters [String] The characters to write to
-    #   the stream after writing the Packet buffer. Must be given as a
-    #   hexadecimal string such as '0xABCD'.
-    # @param read_termination_characters [String] The characters at the end of
-    #   the stream which delineate the end of a Packet. Must be given as a
-    #   hexadecimal string such as '0xABCD'.
-    # @param strip_read_termination [Boolean] Whether to remove the
-    #   read_termination_characters before turning the stream data into a
-    #   Packet.
-    # @param discard_leading_bytes (see StreamProtocol#initialize)
-    # @param sync_pattern (see StreamProtocol#initialize)
-    # @param fill_sync_pattern (see StreamProtocol#initialize)
-    def initialize(write_termination_characters,
-                   read_termination_characters,
-                   strip_read_termination = true,
-                   discard_leading_bytes = 0,
-                   sync_pattern = nil,
-                   fill_sync_pattern = false)
-      @write_termination_characters = write_termination_characters.hex_to_byte_string
-      @read_termination_characters = read_termination_characters.hex_to_byte_string
-      @strip_read_termination = ConfigParser.handle_true_false(strip_read_termination)
-
-      super(discard_leading_bytes, sync_pattern, fill_sync_pattern)
-    end
-
-    # See StreamProtocol#pre_write_packet
-    def pre_write_packet(packet)
-      data = super(packet)
-      raise "Packet contains termination characters!" if data.index(@write_termination_characters)
-
-      data = data.clone # Don't want to modify the actual packet buffer with the termination characters
-      @write_termination_characters.each_byte do |byte|
-        data << byte
-      end
-      data
-    end
-
-    protected
-
-    def reduce_to_single_packet
-      while true
-        index = @data.index(@read_termination_characters)
-
-        # Reduce to packet data and setup current_data for next packet
-        if index
-          if index > 0
-            if @strip_read_termination
-              packet_data = @data[0..(index - 1)]
-            else
-              packet_data = @data[0..(index + @read_termination_characters.length - 1)]
-            end
-          else
-            packet_data = ''
-          end
-          @data.replace(@data[(index + @read_termination_characters.length)..-1])
-          return packet_data
-        else
-          read_and_handle_timeout()
-          return nil if @data.length <= 0
-        end
-      end
-    end
-
-  end # class TerminatedStreamProtocol
-
-end # module Cosmos

data/spec/install/config/targets/COSMOS/cmd_tlm/cosmos_server_cmds.txt

@@ -1,41 +0,0 @@
-COMMAND COSMOS STARTLOGGING BIG_ENDIAN "Starts logging both commands and telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "COSMOS Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "COSMOS Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "COSMOS Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to start logging on - ALL starts logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-  
-COMMAND COSMOS STARTCMDLOG BIG_ENDIAN "Starts logging commands for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "COSMOS Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 3 3 3 "COSMOS Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "COSMOS Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to start logging on - ALL starts logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND COSMOS STARTTLMLOG BIG_ENDIAN "Starts logging telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "COSMOS Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 4 4 4 "COSMOS Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "COSMOS Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to start logging on - ALL starts logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-  
-COMMAND COSMOS STOPLOGGING BIG_ENDIAN "Stops logging both commands and telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "COSMOS Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 5 5 5 "COSMOS Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "COSMOS Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to stop logging on - ALL stops logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND COSMOS STOPCMDLOG BIG_ENDIAN "Stops logging commands for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "COSMOS Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 6 6 6 "COSMOS Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "COSMOS Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to stop logging on - ALL stops logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND COSMOS STOPTLMLOG BIG_ENDIAN "Stops logging telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "COSMOS Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 7 7 7 "COSMOS Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "COSMOS Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to stop logging on - ALL stops logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"

data/spec/install/config/targets/COSMOS/cmd_tlm/cosmos_server_tlm.txt

@@ -1,15 +0,0 @@
-TELEMETRY COSMOS VERSION BIG_ENDIAN "COSMOS version information"
-  APPEND_ID_ITEM PKT_ID 8 UINT 1 "Packet ID"
-  APPEND_ITEM COSMOS 240 STRING "COSMOS version"
-  APPEND_ITEM RUBY   240 STRING "Ruby version"
-  APPEND_ITEM CTDB   240 STRING "Command Telemetry Database Version"
-  APPEND_ITEM USER   240 STRING "User Version"
-
-TELEMETRY COSMOS LIMITS_CHANGE BIG_ENDIAN "COSMOS limits change"
-  APPEND_ID_ITEM PKT_ID 8 UINT 2 "Packet ID"
-  APPEND_ITEM TARGET 240 STRING "Target name"
-  APPEND_ITEM PACKET 240 STRING "Packet name"
-  APPEND_ITEM ITEM 240 STRING "Item that changed limits state"
-  APPEND_ITEM OLD_STATE 240 STRING "The old limit state"
-  APPEND_ITEM NEW_STATE 240 STRING "The new limit state"
- 

data/spec/install/config/targets/COSMOS/screens/limits_change.txt

@@ -1,20 +0,0 @@
-SCREEN AUTO AUTO 0.5
-
-VERTICAL
-
-  TITLE "COSMOS Limits Change"
-  SETTING BACKCOLOR 162 181 205
-  SETTING TEXTCOLOR black
-
-  LABELVALUE COSMOS LIMITS_CHANGE RECEIVED_TIMESECONDS WITH_UNITS 30
-  LABELVALUE COSMOS LIMITS_CHANGE RECEIVED_TIMEFORMATTED WITH_UNITS 30
-  LABELVALUE COSMOS LIMITS_CHANGE RECEIVED_COUNT WITH_UNITS 30
-  LABELVALUE COSMOS LIMITS_CHANGE pkt_id WITH_UNITS 30
-  LABELVALUE COSMOS LIMITS_CHANGE target WITH_UNITS 30
-  LABELVALUE COSMOS limits_change PACKET WITH_UNITS 30
-  LABELVALUE COSMOS limits_change ITEM WITH_UNITS 30
-  LABELVALUE cosmos LIMITS_CHANGE OLD_STATE WITH_UNITS 30
-  LABELVALUE cosmos LIMITS_CHANGE NEW_STATE WITH_UNITS 30
-END
-
-

data/spec/install/config/targets/COSMOS/screens/version.txt

@@ -1,19 +0,0 @@
-SCREEN AUTO AUTO 0.5
-
-VERTICAL
-
-  TITLE "COSMOS Version"
-  SETTING BACKCOLOR 162 181 205
-  SETTING TEXTCOLOR black
-
-  LABELVALUE COSMOS VERSION RECEIVED_TIMESECONDS WITH_UNITS 30
-  LABELVALUE COSMOS VERSION RECEIVED_TIMEFORMATTED WITH_UNITS 30
-  LABELVALUE COSMOS VERSION RECEIVED_COUNT WITH_UNITS 30
-  LABELVALUE COSMOS VERSION PKT_ID WITH_UNITS 30
-  LABELVALUE COSMOS VERSION COSMOS WITH_UNITS 30
-  LABELVALUE COSMOS VERSION RUBY WITH_UNITS 30
-  LABELVALUE COSMOS VERSION CTDB WITH_UNITS 30
-  LABELVALUE COSMOS VERSION USER WITH_UNITS 30
-END
-
-

data/spec/install/config/targets/COSMOS/target.txt

@@ -1,5 +0,0 @@
-# Ignored Parameters
-# IGNORE_PARAMETER parameter_name
-IGNORE_PARAMETER SYNC
-IGNORE_PARAMETER OPCODE
-IGNORE_PARAMETER LENGTH

data/spec/install/config/targets/META/cmd_tlm/meta_cmd.txt

@@ -1,4 +0,0 @@
-COMMAND META DATA BIG_ENDIAN "Metadata"
-  APPEND_PARAMETER VERSION 1024 STRING '' "Version Metadata"
-  APPEND_PARAMETER NUMBER 32 UINT 0 0 0 "Number Metadata"
-    WRITE_CONVERSION new_packet_log_conversion.rb

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

@@ -1,4 +0,0 @@
-TELEMETRY META DATA BIG_ENDIAN "Metadata"
-  APPEND_ITEM VERSION 1024 STRING "Version Metadata"
-  APPEND_ITEM NUMBER 32 UINT "Number Metadata"
-    WRITE_CONVERSION new_packet_log_conversion.rb

data/spec/install/userpath.txt

@@ -1 +0,0 @@
-DO NOT DELETE THIS FILE!  It is used by cosmos.rb to build the ::Cosmos::USERPATH directory.

data/spec/interfaces/stream_interface_spec.rb

@@ -1,157 +0,0 @@
-# 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
-
-require 'spec_helper'
-require 'cosmos/interfaces/stream_interface'
-
-module Cosmos
-
-  describe StreamInterface do
-    before(:each) do
-      @file = File.join(File.dirname(__FILE__),'..','..','lib','test_stream_protocol.rb')
-    end
-
-    after(:each) do
-      File.delete(@file) if File.exist?(@file)
-    end
-
-    describe "initialize" do
-      it "complains if the stream protocol doesn't exist" do
-        File.delete(@file) if File.exist?(@file)
-        expect { StreamInterface.new("test") }.to raise_error(/Unable to require test_stream_protocol.rb/)
-        expect { StreamInterface.new("test") }.to raise_error(/Ensure test_stream_protocol.rb is in the COSMOS lib directory./)
-      end
-
-      it "complains if the stream protocol has a bug" do
-        File.open(@file, 'w') {|file| file.puts "blah" }
-        expect { StreamInterface.new("test") }.to raise_error(/Unable to require test_stream_protocol.rb/)
-      end
-    end
-
-    describe "connect" do
-      it "raises an exception" do
-        si = StreamInterface.new("burst")
-        expect { si.connect }.to raise_error("Interface connect method not implemented")
-      end
-    end
-
-    describe "connected?, disconnect, bytes_read, bytes_written" do
-      it "defers to the stream protocol" do
-        File.open(@file, 'w') do |file|
-          file.puts "class TestStreamProtocol"
-          file.puts "attr_accessor :bytes_read, :bytes_written"
-          file.puts "def interface=(i); i; end"
-          file.puts "def connected?; 1; end"
-          file.puts "def disconnect; 2; end"
-          file.puts "end"
-        end
-        # Ensure we reload since TestStreamProtocol is used throughout
-        load @file
-
-        si = StreamInterface.new("test")
-        expect(si.connected?).to eql 1
-        expect(si.disconnect).to eql 2
-        si.bytes_read = 10
-        expect(si.bytes_read).to eql 10
-        si.bytes_written = 20
-        expect(si.bytes_written).to eql 20
-      end
-    end
-
-    describe "read" do
-      it "reads from the stream interface and count the packet" do
-        File.open(@file, 'w') do |file|
-          file.puts "class TestStreamProtocol"
-          file.puts "def interface=(i); i; end"
-          file.puts "def read; 1; end"
-          file.puts "end"
-        end
-        # Ensure we reload since TestStreamProtocol is used throughout
-        load @file
-
-        si = StreamInterface.new("test")
-        expect(si.read).to eql 1
-        expect(si.read_count).to eql 1
-      end
-    end
-
-    describe "write, write_raw" do
-      it "complains if the stream interface isn't connected" do
-        File.open(@file, 'w') do |file|
-          file.puts "class TestStreamProtocol"
-          file.puts "def interface=(i); i; end"
-          file.puts "def connected?; false; end"
-          file.puts "end"
-        end
-        # Ensure we reload since TestStreamProtocol is used throughout
-        load @file
-
-        si = StreamInterface.new("test")
-        expect { si.write(nil) }.to raise_error(/Interface not connected/)
-        expect { si.write_raw(nil) }.to raise_error(/Interface not connected/)
-      end
-
-      it "disconnects after write errors" do
-        $disconnect = false
-        File.open(@file, 'w') do |file|
-          file.puts "class TestStreamProtocol"
-          file.puts "def interface=(i); i; end"
-          file.puts "def connected?; true; end"
-          file.puts "def disconnect; $disconnect = true; end"
-          file.puts "def write(p); raise 'ERROR'; end"
-          file.puts "def write_raw(p); raise 'ERROR'; end"
-          file.puts "end"
-        end
-        # Ensure we reload since TestStreamProtocol is used throughout
-        load @file
-
-        expect($disconnect).to be false
-        si = StreamInterface.new("test")
-        begin
-          si.write(nil)
-        rescue
-        end
-        expect(si.write_count).to eql 0
-        expect($disconnect).to be true
-
-        $disconnect = false
-        expect($disconnect).to be false
-        si = StreamInterface.new("test")
-        begin
-          si.write_raw(nil)
-        rescue
-        end
-        expect(si.write_count).to eql 0
-        expect($disconnect).to be true
-      end
-
-      it "writes to the stream interface and count the packet" do
-        File.open(@file, 'w') do |file|
-          file.puts "class TestStreamProtocol"
-          file.puts "def interface=(i); i; end"
-          file.puts "def connected?; true; end"
-          file.puts "def write(p); p; end"
-          file.puts "def write_raw(p); p; end"
-          file.puts "end"
-        end
-        # Ensure we reload since TestStreamProtocol is used throughout
-        load @file
-
-        si = StreamInterface.new("test")
-        si.write(nil)
-        expect(si.write_count).to eql 1
-        si.write_raw(nil)
-        expect(si.write_count).to eql 2
-      end
-    end
-
-  end
-end
-