cosmos 4.5.1 → 5.0.2

data/lib/cosmos/script/suite_results.rb

@@ -0,0 +1,196 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 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 Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
+
+module Cosmos
+  class SuiteResults
+    attr_accessor :metadata
+
+    def initialize
+      @report = nil
+      @context = nil
+      @start_time = nil
+      @stop_time = nil
+      @results = nil
+      @settings = nil
+      @metadata = nil
+    end
+
+    def start(test_type, test_suite_class, test_class = nil, test_case = nil, settings = nil)
+      @results = []
+      @start_time = Time.now.sys
+      @settings = settings
+      @report = []
+
+      if test_case
+        # Executing a single test case
+        @context = "#{test_suite_class.name}:#{test_class.name}:#{test_case} #{test_type}"
+      elsif test_class
+        # Executing an entire test
+        @context = "#{test_suite_class.name}:#{test_class.name} #{test_type}"
+      else
+        # Executing a test suite
+        @context = "#{test_suite_class.name} #{test_type}"
+      end
+
+      header()
+    end
+
+    # process_result can handle an array of CosmosTestResult objects
+    # or a single CosmosTestResult object
+    def process_result(results)
+      cosmos_lib = Regexp.new(File.join(Cosmos::PATH, 'lib'))
+      # If we were passed an array we concat it to the results global
+      if results.is_a? Array
+        @results.concat(results)
+      # A single result is appended and then turned into an array
+      else
+        @results << results
+        results = [results]
+      end
+      # Process all the results (may be just one)
+      results.each do |result|
+        self.puts("#{result.group}:#{result.script}:#{result.result}")
+        if result.message
+          result.message.each_line do |line|
+            if /[\x00-\x08\x0B-\x0C\x0E-\x1F\x7F-\xFF]/.match?(line)
+              line.chomp!
+              line = line.inspect.remove_quotes
+            end
+            @report << '  ' + line.strip
+          end
+        end
+        if result.exceptions
+          @report << "  Exceptions:"
+          result.exceptions.each_with_index do |error, index|
+            error.formatted().each_line do |line|
+              next if /in run_text/.match?(line)
+              next if /running_script.rb/.match?(line)
+              next if line&.match?(cosmos_lib)
+
+              if /[\x00-\x08\x0B-\x0C\x0E-\x1F\x7F-\xFF]/.match?(line)
+                line.chomp!
+                line = line.inspect.remove_quotes
+              end
+              @report << '    ' + line.strip
+            end
+            @report << '' if index != (result.exceptions.length - 1)
+          end
+        end
+      end
+    end
+
+    def complete
+      @stop_time = Time.now.sys
+      footer()
+    end
+
+    def report
+      @report.join("\n")
+    end
+
+    def header
+      @report << "--- Test Report ---"
+      # @report << ''
+      # if @metadata
+      #   begin
+      #     items = get_tlm_packet('SYSTEM', 'META')
+      #     @report << ''
+      #     @report << "Metadata:"
+      #     items.each do |item_name, item_value, _|
+      #       next if SetTlmDialog::IGNORED_ITEMS.include?(item_name)
+      #       @report << "#{item_name} = #{item_value}"
+      #     end
+      #   rescue DRb::DRbConnError
+      #     # Oh well
+      #   end
+      # end
+      if @settings
+        @report << ''
+        @report << "Settings:"
+        @settings.each { |setting_name, setting_value| @report << "#{setting_name} = #{setting_value}" }
+      end
+      @report << ''
+      @report << "Results:"
+      self.puts "Executing #{@context}"
+    end
+
+    def footer
+      self.puts "Completed #{@context}"
+
+      @report << ''
+      @report << "--- Test Summary ---"
+      @report << ''
+
+      pass_count = 0
+      skip_count = 0
+      fail_count = 0
+      stopped    = false
+      @results.each do |result|
+        if result.result == :PASS
+          pass_count += 1
+        elsif result.result == :SKIP
+          skip_count += 1
+        elsif result.result == :FAIL
+          fail_count += 1
+        end
+
+        if result.stopped
+          stopped = true
+        end
+      end
+      run_time = Time.format_seconds(@stop_time - @start_time)
+      run_time << " (#{@stop_time - @start_time} seconds)" if @stop_time - @start_time > 60
+      @report << "Run Time: #{run_time}"
+      @report << "Total Tests: #{@results.length}"
+      @report << "Pass: #{pass_count}"
+      @report << "Skip: #{skip_count}"
+      @report << "Fail: #{fail_count}"
+      @report << ''
+      if stopped
+        @report << '*** Test was stopped prematurely ***'
+        @report << ''
+      end
+    end
+
+    def write(string)
+      @report << Time.now.sys.formatted + ': ' + string
+    end
+
+    def puts(string)
+      @report << Time.now.sys.formatted + ': ' + string
+    end
+
+    # def collect_metadata(parent = nil)
+    #   success = true
+    #   if @metadata
+    #     Qt.execute_in_main_thread(true) do
+    #       begin
+    #         success = SetTlmDialog.execute(parent, 'Enter Test Metadata', 'Start Test', 'Cancel Test', 'SYSTEM', 'META')
+    #       rescue DRb::DRbConnError
+    #         success = false
+    #         Qt::MessageBox.critical(parent, 'Error', 'Error Connecting to Command and Telemetry Server')
+    #       rescue Exception => err
+    #         Cosmos.handle_fatal_exception(err)
+    #       end
+    #     end
+    #   end
+    #   success
+    # end
+  end
+end

data/lib/cosmos/script/suite_runner.rb

@@ -0,0 +1,217 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 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 Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
+
+require 'cosmos/script/suite'
+require 'cosmos/script/suite_results'
+require 'cosmos/tools/test_runner/test'
+
+module Cosmos
+  # Placeholder for all Groups discovered without assigned Suites
+  class UnassignedSuite < Suite
+  end
+
+  class SuiteRunner
+    @@suites = []
+    @@settings = {}
+    @@suite_results = nil
+
+    def self.settings
+      @@settings
+    end
+
+    def self.settings=(settings)
+      @@settings = settings
+    end
+
+    def self.suite_results
+      @@suite_results
+    end
+
+    def self.execute(result_string, suite_class, group_class = nil, script = nil)
+      @@suite_results = SuiteResults.new
+      @@suites.each do |suite|
+        if suite.class == suite_class
+          @@suite_results.start(result_string, suite_class, group_class, script, @@settings)
+          loop do
+            yield(suite)
+            break if not @@settings['Loop'] or (ScriptStatus.instance.fail_count > 0 and @@settings['Break Loop On Error'])
+          end
+          break
+        end
+      end
+    end
+
+    def self.start(suite_class, group_class = nil, script = nil)
+      result = []
+      execute('', suite_class, group_class, script) do |suite|
+        if script
+          result = suite.run_script(group_class, script)
+          @@suite_results.process_result(result)
+          raise StopScript if (result.exceptions and Group.abort_on_exception) or result.stopped
+        elsif group_class
+          suite.run_group(group_class) { |current_result| @@suite_results.process_result(current_result); raise StopScript if current_result.stopped }
+        else
+          suite.run { |current_result| @@suite_results.process_result(current_result); raise StopScript if current_result.stopped }
+        end
+      end
+    end
+
+    def self.setup(suite_class, group_class = nil)
+      execute('Manual Setup', suite_class, group_class) do |suite|
+        if group_class
+          result = suite.run_group_setup(group_class)
+        else
+          result = suite.run_setup
+        end
+        if result
+          @@suite_results.process_result(result)
+          raise StopScript if result.stopped
+        end
+      end
+    end
+
+    def self.teardown(suite_class, group_class = nil)
+      execute('Manual Teardown', suite_class, group_class) do |suite|
+        if group_class
+          result = suite.run_group_teardown(group_class)
+        else
+          result = suite.run_teardown
+        end
+        if result
+          @@suite_results.process_result(result)
+          raise StopScript if result.stopped
+        end
+      end
+    end
+
+    # Convert the OpenStruct structure to a simple hash
+    # TODO: Maybe just use hashes right from the beginning?
+    def self.open_struct_to_hash(object)
+      hash = object.to_h
+      hash.each do |key1, val1|
+        if val1.is_a?(Hash)
+          val1.each do |key2, val2|
+            if val2.is_a?(OpenStruct)
+              hash[key1][key2] = val2.to_h
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Build list of Suites and Groups
+    def self.build_suites
+      @@suites = []
+      # @@suites = @@suites.select { |my_suite| my_suite.name == 'CustomSuite' }
+      suites = {}
+      groups = []
+      ObjectSpace.each_object(Class) do |object|
+        # If we inherit from Suite but aren't the deprecated TestSuite
+        if object < Suite && object != TestSuite
+          # Ensure they didn't override name for some reason
+          if object.instance_methods(false).include?(:name)
+            raise FatalError.new("#{object} redefined the 'name' method. Delete the 'name' method and try again.")
+          end
+
+          # ObjectSpace.each_object appears to yield objects in the reverse
+          # order that they were parsed by the interpreter so push each
+          # Suite object to the front of the array to order as encountered
+          @@suites.unshift(object.new)
+        end
+        # If we inherit from Group but aren't the deprecated Test
+        if object < Group && object != Test
+          # Ensure they didn't override self.name for some reason
+          if object.methods(false).include?(:name)
+            raise FatalError.new("#{object} redefined the 'self.name' method. Delete the 'self.name' method and try again.")
+          end
+
+          groups << object
+        end
+      end
+      # Raise error if no suites or groups
+      if @@suites.empty? || groups.empty?
+        return "No Suite or no Group classes found"
+      end
+
+      # Create Suite for unassigned Groups
+      @@suites.each do |suite|
+        groups_to_delete = []
+        groups.each { |group| groups_to_delete << group if suite.scripts[group] }
+        groups_to_delete.each { |group| groups.delete(group) }
+      end
+      if groups.empty?
+        @@suites = @@suites.select { |suite| suite.class != UnassignedSuite }
+      else
+        unassigned_suite = @@suites.select { |suite| suite.class == UnassignedSuite }[0]
+        groups.each { |group| unassigned_suite.add_group(group) }
+      end
+
+      @@suites.each do |suite|
+        cur_suite = OpenStruct.new(:setup => false, :teardown => false, :groups => {})
+        cur_suite.setup = true if suite.class.method_defined?(:setup)
+        cur_suite.teardown = true if suite.class.method_defined?(:teardown)
+
+        suite.plans.each do |type, group_class, script|
+          case type
+          when :GROUP
+            cur_suite.groups[group_class.name] ||=
+              OpenStruct.new(:setup => false, :teardown => false, :scripts => [])
+            cur_suite.groups[group_class.name].scripts.concat(group_class.scripts)
+            cur_suite.groups[group_class.name].scripts.uniq!
+            cur_suite.groups[group_class.name].setup = true if group_class.method_defined?(:setup)
+            cur_suite.groups[group_class.name].teardown = true if group_class.method_defined?(:teardown)
+          when :SCRIPT
+            cur_suite.groups[group_class.name] ||=
+              OpenStruct.new(:setup => false, :teardown => false, :scripts => [])
+            # Explicitly check for this method and raise an error if it does not exist
+            if group_class.method_defined?(script.intern)
+              cur_suite.groups[group_class.name].scripts << script
+              cur_suite.groups[group_class.name].scripts.uniq!
+            else
+              raise "#{group_class} does not have a #{script} method defined."
+            end
+            cur_suite.groups[group_class.name].setup = true if group_class.method_defined?(:setup)
+            cur_suite.groups[group_class.name].teardown = true if group_class.method_defined?(:teardown)
+          when :GROUP_SETUP
+            cur_suite.groups[group_class.name] ||=
+              OpenStruct.new(:setup => false, :teardown => false, :scripts => [])
+            # Explicitly check for the setup method and raise an error if it does not exist
+            if group_class.method_defined?(:setup)
+              cur_suite.groups[group_class.name].setup = true
+            else
+              raise "#{group_class} does not have a setup method defined."
+            end
+          when :GROUP_TEARDOWN
+            cur_suite.groups[group_class.name] ||=
+              OpenStruct.new(:setup => false, :teardown => false, :scripts => [])
+            # Explicitly check for the teardown method and raise an error if it does not exist
+            if group_class.method_defined?(:teardown)
+              cur_suite.groups[group_class.name].teardown = true
+            else
+              raise "#{group_class} does not have a teardown method defined."
+            end
+          end
+        end
+        suites[suite.name.split('::')[-1]] = open_struct_to_hash(cur_suite) unless suite.name == 'CustomSuite'
+      end
+      return suites
+    end
+  end
+end

data/lib/cosmos/script.rb

@@ -1,9 +1,21 @@
 # encoding: ascii-8bit
 
-# Enforce not allowing this file to be included within CmdTlmServer
-if $0 =~ /CmdTlmServer/ or $0 =~ /Replay/
-  raise "cosmos/script must not be required by any code used in the CmdTlmServer or Replay applications"
-end
+# Copyright 2022 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 Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'cosmos/script/script'
 include Cosmos::Script

data/lib/cosmos/streams/serial_stream.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'thread' # For Mutex
 require 'cosmos/streams/stream'
@@ -35,10 +44,8 @@ module Cosmos
     #   complete. Pass nil to create no timeout. The {SerialDriver} will
     #   continously try to read data until it has received data or an error
     #   occurs.
-    # @param flow_control [Symbol] Currently supported :NONE, :RTSCTS (default :NONE)
+    # @param flow_control [Symbol] Currently supported :NONE and :RTSCTS (default :NONE)
     # @param data_bits [Integer] Number of data bits (default 8)
-    # @param struct [Array] Array of arrays of fields and values to set in the
-    #   Windows DCB or POSIX structure
     def initialize(write_port_name,
                    read_port_name,
                    baud_rate,
@@ -47,8 +54,7 @@ module Cosmos
                    write_timeout,
                    read_timeout,
                    flow_control = :NONE,
-                   data_bits = 8,
-                   struct = [])
+                   data_bits = 8)
       super()
 
       # The SerialDriver class will validate the parameters
@@ -72,8 +78,7 @@ module Cosmos
                                               @write_timeout,
                                               @read_timeout,
                                               @flow_control,
-                                              @data_bits,
-                                              struct)
+                                              @data_bits)
       else
         @write_serial_port = nil
       end
@@ -88,8 +93,7 @@ module Cosmos
                                                @write_timeout,
                                                @read_timeout,
                                                @flow_control,
-                                               @data_bits,
-                                               struct)
+                                               @data_bits)
         end
       else
         @read_serial_port = nil
@@ -109,6 +113,7 @@ module Cosmos
     # @return [String] Returns a binary string of data from the serial port
     def read
       raise "Attempt to read from write only stream" unless @read_serial_port
+
       # No read mutex is needed because reads happen serially
       @read_serial_port.read
     end
@@ -116,6 +121,7 @@ module Cosmos
     # @return [String] Returns a binary string of data from the serial port without blocking
     def read_nonblock
       raise "Attempt to read from write only stream" unless @read_serial_port
+
       # No read mutex is needed because reads happen serially
       @read_serial_port.read_nonblock
     end
@@ -123,6 +129,7 @@ module Cosmos
     # @param data [String] A binary string of data to write to the serial port
     def write(data)
       raise "Attempt to write to read only stream" unless @write_serial_port
+
       @write_mutex.synchronize do
         @write_serial_port.write(data)
       end
@@ -156,5 +163,5 @@ module Cosmos
         @connected = false
       end
     end
-  end
-end
+  end # class SerialStream
+end # module Cosmos

data/lib/cosmos/streams/stream.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 module Cosmos
   # Class that implments the following methods: read, write(data),

data/lib/cosmos/streams/tcpip_client_stream.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'socket'
 require 'thread' # For Mutex
@@ -15,12 +24,10 @@ require 'cosmos/streams/tcpip_socket_stream'
 require 'cosmos/config/config_parser'
 
 module Cosmos
-
   # Data {Stream} which reads and writes to TCPIP sockets. This class creates
   # the actual sockets based on the constructor parameters. The rest of the
   # interface is implemented by the super class {TcpipSocketStream}.
   class TcpipClientStream < TcpipSocketStream
-
     # @param hostname [String] The host to connect to
     # @param write_port [Integer|nil] The port to write. Pass nil to make this
     #   a read only stream.
@@ -30,7 +37,7 @@ module Cosmos
     # @param read_timeout (see TcpipSocketStream#initialize)
     def initialize(hostname, write_port, read_port, write_timeout, read_timeout, connect_timeout = 5.0)
       @hostname = hostname
-      if (@hostname.to_s.upcase == 'LOCALHOST')
+      if @hostname.to_s.upcase == 'LOCALHOST'
         @hostname = '127.0.0.1'
       end
       @write_port = ConfigParser.handle_nil(write_port)
@@ -44,7 +51,7 @@ module Cosmos
         @write_addr = Socket.pack_sockaddr_in(@write_port, @hostname) if @write_port
         @read_addr = Socket.pack_sockaddr_in(@read_port, @hostname) if @read_port
       rescue => error
-        if error.message =~ /getaddrinfo/
+        if /getaddrinfo/.match?(error.message)
           raise "Invalid hostname: #{@hostname}"
         else
           raise error
@@ -83,31 +90,27 @@ module Cosmos
     protected
 
     def connect_nonblock(socket, addr)
+      socket.connect_nonblock(addr)
+    rescue IO::WaitWritable
       begin
-        socket.connect_nonblock(addr)
-      rescue IO::WaitWritable
+        _, sockets, _ = IO.select(nil, [socket], nil, @connect_timeout) # wait 3-way handshake completion
+      rescue IOError, Errno::ENOTSOCK
+        raise "Connect canceled"
+      end
+      if sockets and !sockets.empty?
         begin
-          _, sockets, _ = IO.select(nil, [socket], nil, @connect_timeout) # wait 3-way handshake completion
+          socket.connect_nonblock(addr) # check connection failure
         rescue IOError, Errno::ENOTSOCK
           raise "Connect canceled"
+        rescue Errno::EINPROGRESS
+          retry
+        rescue Errno::EISCONN, Errno::EALREADY
         end
-        if sockets and !sockets.empty?
-          begin
-            socket.connect_nonblock(addr) # check connection failure
-          rescue IOError, Errno::ENOTSOCK
-            raise "Connect canceled"
-          rescue Errno::EINPROGRESS
-            retry
-          rescue Errno::EISCONN, Errno::EALREADY
-          end
-        else
-          raise "Connect timeout"
-        end
-      rescue IOError, Errno::ENOTSOCK
-        raise "Connect canceled"
+      else
+        raise "Connect timeout"
       end
+    rescue IOError, Errno::ENOTSOCK
+      raise "Connect canceled"
     end
-
   end # class TcpipClientStream
-
 end # module Cosmos