cosmos 4.5.0 → 5.0.2.pre.beta2

data/lib/cosmos/script/calendar.rb

@@ -0,0 +1,62 @@
+# 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/extract'
+
+module Cosmos
+  module Script
+    include Extract
+
+    private
+
+    # Sets the metadata value for a target
+    #
+    # @param target [String] Target to set metadata on
+    # @return The result of the method call.
+    def get_metadata(target)
+      endpoint = "/cosmos-api/metadata/_get/#{target}"
+      response = $api_server.request('get', endpoint)
+      return nil if response.nil? || response.code != 200
+      return JSON.parse(response.body)
+    end
+
+    # Sets the metadata value for a target
+    #
+    # @param target [String] Target to set metadata on
+    # @param metadata [Hash<Symbol, Variable>] A hash of metadata
+    # @param color [String] Events color to show on Calendar tool
+    # @param start (optional) [String] Metadata time value if nil will default to current time
+    # @return The result of the method call.
+    def set_metadata(target, metadata, color: nil, start: nil)
+      color = color.nil? ? '#003784' : color
+      data = {:color => color, :metadata => metadata, :target => target}
+      data[:start] = start unless start.nil?
+      response = $api_server.request('post', '/cosmos-api/metadata', data: data, json: true)
+      return nil if response.nil? || response.code != 201
+      return JSON.parse(response.body)
+    end
+
+    # Requests the metadata from the user for a target
+    #
+    def input_metadata(*args, **kwargs)
+      rasie StandardError "can only be used in script-runner"
+    end
+
+  end
+end

data/lib/cosmos/script/commands.rb

@@ -1,17 +1,64 @@
 # 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 'cosmos/packets/packet'
+require 'cosmos/script/extract'
 
 module Cosmos
   module Script
+    include Extract
+
     private
 
+    # Format the command like it appears in a script
+    def _cmd_string(target_name, cmd_name, cmd_params, raw)
+      output_string = $disconnect ? 'DISCONNECT: ' : ''
+      if raw
+        output_string += 'cmd_raw("'
+      else
+        output_string += 'cmd("'
+      end
+      output_string += target_name + ' ' + cmd_name
+      if cmd_params.nil? or cmd_params.empty?
+        output_string << '")'
+      else
+        params = []
+        cmd_params.each do |key, value|
+          next if Packet::RESERVED_ITEM_NAMES.include?(key)
+
+          if value.is_a?(String)
+            value = value.convert_to_value.to_s
+            if value.length > 256
+              value = value[0..255] + "...'"
+            end
+            value.tr!('"', "'")
+          elsif value.is_a?(Array)
+            value = "[#{value.join(", ")}]"
+          end
+          params << "#{key} #{value}"
+        end
+        params = params.join(", ")
+        output_string += ' with ' + params + '")'
+      end
+      output_string
+    end
+
     # Log any warnings about disabling checks and log the command itself
     # NOTE: This is a helper method and should not be called directly
     def _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
@@ -21,7 +68,34 @@ module Cosmos
       if no_hazardous
         Logger.warn "Command #{target_name} #{cmd_name} being sent ignoring hazardous warnings"
       end
-      Logger.info System.commands.build_cmd_output_string(target_name, cmd_name, cmd_params, raw)
+      Logger.info _cmd_string(target_name, cmd_name, cmd_params, raw)
+    end
+
+    def _cmd_disconnect(cmd, raw, no_range, no_hazardous, *args)
+      case args.length
+      when 1
+        target_name, cmd_name, cmd_params = extract_fields_from_cmd_text(args[0])
+      when 2, 3
+        target_name = args[0]
+        cmd_name    = args[1]
+        if args.length == 2
+          cmd_params = {}
+        else
+          cmd_params = args[2]
+        end
+      else
+        # Invalid number of arguments
+        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{cmd}()"
+      end
+      # Get the command and validate the parameters
+      command = $api_server.get_command(target_name, cmd_name)
+      cmd_params.each do |param_name, param_value|
+        param = command['items'].find { |item| item['name'] == param_name }
+        unless param
+          raise "Packet item '#{target_name} #{cmd_name} #{param_name}' does not exist"
+        end
+      end
+      _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
     end
 
     # Send the command and log the results
@@ -31,18 +105,20 @@ module Cosmos
       no_range = cmd.include?('no_range') || cmd.include?('no_checks')
       no_hazardous = cmd.include?('no_hazardous') || cmd.include?('no_checks')
 
-      begin
-        target_name, cmd_name, cmd_params = $cmd_tlm_server.method_missing(cmd, *args)
-        _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
-      rescue HazardousError => e
-        ok_to_proceed = prompt_for_hazardous(e.target_name,
-                                             e.cmd_name,
-                                             e.hazardous_description)
-        if ok_to_proceed
-          target_name, cmd_name, cmd_params = $cmd_tlm_server.method_missing(cmd_no_hazardous, *args)
+      if $disconnect
+        _cmd_disconnect(cmd, raw, no_range, no_hazardous, *args)
+      else
+        begin
+          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd, *args)
           _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
-        else
-          retry unless prompt_for_script_abort()
+        rescue HazardousError => e
+          ok_to_proceed = prompt_for_hazardous(e.target_name, e.cmd_name, e.hazardous_description)
+          if ok_to_proceed
+            target_name, cmd_name, cmd_params = $api_server.method_missing(cmd_no_hazardous, *args)
+            _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
+          else
+            retry unless prompt_for_script_abort()
+          end
         end
       end
     end
@@ -119,44 +195,16 @@ module Cosmos
       _cmd('cmd_raw_no_checks', nil, *args)
     end
 
-    # Sends raw data through an interface
-    def send_raw(interface_name, data)
-      return $cmd_tlm_server.send_raw(interface_name, data)
-    end
-
     # Sends raw data through an interface from a file
     def send_raw_file(interface_name, filename)
       data = nil
-      File.open(filename, 'rb') {|file| data = file.read}
-      return $cmd_tlm_server.send_raw(interface_name, data)
-    end
-
-    # Returns all the target commands as an array of arrays listing the command
-    # name and description.
-    def get_cmd_list(target_name)
-      return $cmd_tlm_server.get_cmd_list(target_name)
-    end
-
-    # Returns all the parameters for given command as an array of arrays
-    # containing the parameter name, default value, states, description, units
-    # full name, units abbreviation, and whether it is required.
-    def get_cmd_param_list(target_name, cmd_name)
-      return $cmd_tlm_server.get_cmd_param_list(target_name, cmd_name)
-    end
-
-    # Returns whether a command is hazardous (true or false)
-    def get_cmd_hazardous(target_name, cmd_name, cmd_params = {})
-      return $cmd_tlm_server.get_cmd_hazardous(target_name, cmd_name, cmd_params)
-    end
-
-    # Returns a value from the specified command
-    def get_cmd_value(target_name, command_name, parameter_name, value_type = :CONVERTED)
-      return $cmd_tlm_server.get_cmd_value(target_name, command_name, parameter_name, value_type)
+      File.open(filename, 'rb') { |file| data = file.read }
+      $api_server.send_raw(interface_name, data)
     end
 
     # Returns the time the most recent command was sent
     def get_cmd_time(target_name = nil, command_name = nil)
-      results = $cmd_tlm_server.get_cmd_time(target_name, command_name)
+      results = $api_server.get_cmd_time(target_name, command_name)
       if Array === results
         if results[2] and results[3]
           results[2] = Time.at(results[2], results[3]).sys
@@ -165,13 +213,5 @@ module Cosmos
       end
       results
     end
-
-    # Returns the buffer from the most recent specified command
-    def get_cmd_buffer(target_name, command_name)
-      return $cmd_tlm_server.get_cmd_buffer(target_name, command_name)
-    end
-
-  end # module Script
-
-end # module Cosmos
-
+  end
+end

data/lib/cosmos/script/exceptions.rb

@@ -0,0 +1,29 @@
+# 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
+  # Error raised by the API when a check fails
+  class CheckError < StandardError; end
+
+  # Error raised by the API when a script should be stopped
+  class StopScript < StandardError; end
+
+  # Error raised by the API when a case should be skipped
+  class SkipScript < StandardError; end
+end

data/lib/cosmos/script/extract.rb

@@ -1,29 +1,43 @@
 # 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
+require 'cosmos/utilities/store'
 
+module Cosmos
   module Extract
-    SCANNING_REGULAR_EXPRESSION = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | (?:\[(?:[^\\\[\]]|\\.)*\]) | \S+ }x #"
+    SCANNING_REGULAR_EXPRESSION = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | (?:\[(?:[^\\\[\]]|\\.)*\]) | \S+ }x # "
 
     private
 
     def add_cmd_parameter(keyword, value, packet, cmd_params)
       quotes_removed = value.remove_quotes
-      begin
-        type = packet.items[keyword].data_type
-      rescue
-        type = nil
-      end
       if value == quotes_removed
-        if (type == :STRING or type == :BLOCK) and value.upcase.start_with?("0X")
+        type = nil
+        if packet['items']
+          packet['items'].each do |parameter|
+            if parameter['name'] == keyword
+              type = parameter['data_type']
+              break
+            end
+          end
+        end
+        if (type == 'STRING' or type == 'BLOCK') and value.upcase.start_with?("0X")
           cmd_params[keyword] = value.hex_to_byte_string
         else
           cmd_params[keyword] = value.convert_to_value
@@ -33,7 +47,7 @@ module Cosmos
       end
     end
 
-    def extract_fields_from_cmd_text(text)
+    def extract_fields_from_cmd_text(text, scope: $cosmos_scope)
       split_string = text.split(/\s+with\s+/i, 2)
       raise "ERROR: text must not be empty" if split_string.length == 0
       raise "ERROR: 'with' must be followed by parameters : #{text}" if (split_string.length == 1 and text =~ /\s*with\s*/i) or (split_string.length == 2 and split_string[1].empty?)
@@ -42,14 +56,16 @@ module Cosmos
       first_half = split_string[0].split
       raise "ERROR: Both Target Name and Command Name must be given : #{text}" if first_half.length < 2
       raise "ERROR: Only Target Name and Command Name must be given before 'with' : #{text}" if first_half.length > 2
+
       target_name = first_half[0]
       cmd_name = first_half[1]
       cmd_params = {}
 
       begin
-        packet = System.commands.packet(target_name, cmd_name).clone
+        # Returns the packet JSON representation
+        packet = TargetModel.packet(target_name, cmd_name, type: :CMD, scope: scope)
       rescue
-        packet = nil
+        packet = {}
       end
 
       if split_string.length == 2
@@ -95,6 +111,7 @@ module Cosmos
     def extract_fields_from_tlm_text(text)
       split_string = text.split
       raise "ERROR: Telemetry Item must be specified as 'TargetName PacketName ItemName' : #{text}" if split_string.length != 3
+
       target_name = split_string[0]
       packet_name = split_string[1]
       item_name = split_string[2]
@@ -110,8 +127,10 @@ module Cosmos
       # set_tlm("TGT PKT ITEM ='new item'")
       split_string = text.split('=')
       raise error_msg if split_string.length < 2 || split_string[1].strip.empty?
+
       split_string = split_string[0].strip.split << split_string[1..-1].join('=').strip
       raise error_msg if split_string.length != 4 # Ensure tgt,pkt,item,value
+
       target_name = split_string[0]
       packet_name = split_string[1]
       item_name = split_string[2]
@@ -123,19 +142,20 @@ module Cosmos
     def extract_fields_from_check_text(text)
       split_string = text.split
       raise "ERROR: Check improperly specified: #{text}" if split_string.length < 3
+
       target_name = split_string[0]
       packet_name = split_string[1]
       item_name = split_string[2]
       comparison_to_eval = nil
       return [target_name, packet_name, item_name, comparison_to_eval] if split_string.length == 3
       raise "ERROR: Check improperly specified: #{text}" if split_string.length < 4
+
       split_string = text.split(/ /) # Split on regex spaces to preserve spaces in comparison
       index = split_string.rindex(item_name)
       comparison_to_eval = split_string[(index + 1)..(split_string.length - 1)].join(" ")
       raise "ERROR: Use '==' instead of '=': #{text}" if split_string[3] == '='
+
       return [target_name, packet_name, item_name, comparison_to_eval]
     end
-
-  end # module Extract
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/script/limits.rb

@@ -1,98 +1,39 @@
 # 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
-
   module Script
     private
 
-    def get_out_of_limits
-      result = $cmd_tlm_server.get_out_of_limits
-      result.each do |entry|
-        entry[3] = entry[3].to_s.intern if entry[3]
-      end
-      result
-    end
-
-    def get_overall_limits_state(ignored_items = nil)
-      return $cmd_tlm_server.get_overall_limits_state(ignored_items).to_s.intern
-    end
-
-    def limits_enabled?(*args)
-      return $cmd_tlm_server.limits_enabled?(*args)
-    end
-
-    def enable_limits(*args)
-      return $cmd_tlm_server.enable_limits(*args)
-    end
-
-    def disable_limits(*args)
-      return $cmd_tlm_server.disable_limits(*args)
-    end
-
-    def get_stale(with_limits_only = false, target_name = nil)
-      return $cmd_tlm_server.get_stale(with_limits_only, target_name)
-    end
-
-    def get_limits(target_name, packet_name, item_name, limits_set = nil)
-      results = $cmd_tlm_server.get_limits(target_name, packet_name, item_name, limits_set)
-      results[0] = results[0].to_s.intern if results[0]
-      return results
-    end
-
-    def set_limits(target_name, packet_name, item_name, red_low, yellow_low, yellow_high, red_high, green_low = nil, green_high = nil, limits_set = :CUSTOM, persistence = nil, enabled = true)
-      results = $cmd_tlm_server.set_limits(target_name, packet_name, item_name, red_low, yellow_low, yellow_high, red_high, green_low, green_high, limits_set, persistence, enabled)
-      results[0] = results[0].to_s.intern if results[0]
-      return results
-    end
-
-    def get_limits_groups
-      return $cmd_tlm_server.get_limits_groups
-    end
-
-    def enable_limits_group(group_name)
-      return $cmd_tlm_server.enable_limits_group(group_name)
-    end
-
-    def disable_limits_group(group_name)
-      return $cmd_tlm_server.disable_limits_group(group_name)
-    end
-
-    def get_limits_sets
-      result = $cmd_tlm_server.get_limits_sets
-      result.each_with_index do |limits_set, index|
-        result[index] = limits_set.to_s.intern
+    # Define all the modification methods such that we can disconnect them
+    %i(enable_limits disable_limits set_limits enable_limits_group disable_limits_group set_limits_set).each do |method_name|
+      define_method(method_name) do |*args|
+        if $disconnect
+          Logger.info "DISCONNECT: #{method_name}(#{args}) ignored"
+        else
+          $api_server.public_send(method_name, *args)
+        end
       end
-      return result
     end
 
-    def set_limits_set(limits_set)
-      return $cmd_tlm_server.set_limits_set(limits_set)
-    end
-
-    def get_limits_set
-      result = $cmd_tlm_server.get_limits_set
-      # Limits sets are always represented as symbols
-      result.to_s.intern
-    end
-
-    def subscribe_limits_events(queue_size = CmdTlmServer::DEFAULT_LIMITS_EVENT_QUEUE_SIZE)
-      return $cmd_tlm_server.subscribe_limits_events(queue_size)
-    end
-
-    def unsubscribe_limits_events(id)
-      return $cmd_tlm_server.unsubscribe_limits_events(id)
-    end
-
-    def get_limits_event(id, non_block = false)
-      result = $cmd_tlm_server.get_limits_event(id, non_block)
+    def get_limits_events(offset = nil, count: 100)
+      result = $api_server.get_limits_events(offset, count: count)
       if result
         result[0] = result[0].to_s.intern
         if result[0] == :LIMITS_CHANGE
@@ -114,7 +55,5 @@ module Cosmos
       end
       result
     end
-
   end
 end
-