openc3 5.4.1 → 5.4.3.pre.beta0

data/lib/openc3/models/traefik_model.rb

@@ -0,0 +1,47 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# 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 file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/utilities/store'
+
+module OpenC3
+  class TraefikModel
+    def self.register_route(microservice_name:, port:, prefix:, priority: 20)
+      prefix = '/' + prefix unless prefix[0] == '/'
+      if ENV['KUBERNETES_SERVICE_HOST']
+        url = "http://#{microservice_name.gsub('__', '-')}:#{port}"
+      else
+        url = "http://openc3-operator:#{port}"
+      end
+      service_name = microservice_name
+      router_name = microservice_name
+      Store.set("traefik/http/services/#{service_name}/loadbalancer/servers/0/url", url)
+      Store.set("traefik/http/routers/#{router_name}/service", service_name)
+      Store.set("traefik/http/routers/#{router_name}/priority", priority)
+      Store.set("traefik/http/routers/#{router_name}/rule", "PathPrefix(`#{prefix}`)")
+    end
+
+    def self.unregister_route(microservice_name:)
+      service_name = microservice_name
+      router_name = microservice_name
+      Store.del("traefik/http/routers/#{router_name}/rule")
+      Store.del("traefik/http/routers/#{router_name}/priority")
+      Store.del("traefik/http/routers/#{router_name}/service")
+      Store.del("traefik/http/services/#{service_name}/loadbalancer/servers/0/url")
+    end
+  end
+end

data/lib/openc3/models/trigger_group_model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/model'
@@ -92,11 +92,10 @@ module OpenC3
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
-      valid_color = color =~ /(#*)([0-9,a-f,A-f]{6})/
+      valid_color = color =~ /[0-9,a-f,A-F]{6}/
       if valid_color.nil?
         raise TriggerGroupInputError.new "invalid color must be in hex format. #FF0000"
       end
-
       unless color.start_with?('#')
         color = "##{color}"
       end

data/lib/openc3/script/api_shared.rb

@@ -538,7 +538,7 @@ module OpenC3
       end
     end
 
-    def _check_process_args(args, function_name, scope: $openc3_scope, token: $openc3_token)
+    def _check_process_args(args, method_name, scope: $openc3_scope, token: $openc3_token)
       case args.length
       when 1
         target_name, packet_name, item_name, comparison_to_eval = extract_fields_from_check_text(args[0])
@@ -549,7 +549,7 @@ module OpenC3
         comparison_to_eval = args[3]
       else
         # Invalid number of arguments
-        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{function_name}()"
+        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{method_name}()"
       end
       return [target_name, packet_name, item_name, comparison_to_eval]
     end
@@ -679,17 +679,17 @@ module OpenC3
     # When testing an array with a tolerance, the expected value and tolerance
     # can both be supplied as either an array or a single value.  If a single
     # value is passed in, that value will be used for all array elements.
-    def array_tolerance_process_args(array_size, expected_value, tolerance, function_name, scope: $openc3_scope, token: $openc3_token)
+    def array_tolerance_process_args(array_size, expected_value, tolerance, method_name, scope: $openc3_scope, token: $openc3_token)
       if expected_value.is_a?(Array)
         if array_size != expected_value.size
-          raise "ERROR: Invalid array size for expected_value passed to #{function_name}()"
+          raise "ERROR: Invalid array size for expected_value passed to #{method_name}()"
         end
       else
         expected_value = Array.new(array_size, expected_value)
       end
       if tolerance.is_a?(Array)
         if array_size != tolerance.size
-          raise "ERROR: Invalid array size for tolerance passed to #{function_name}()"
+          raise "ERROR: Invalid array size for tolerance passed to #{method_name}()"
         end
       else
         tolerance = Array.new(array_size, tolerance)

data/lib/openc3/script/storage.rb

@@ -65,7 +65,7 @@ module OpenC3
 
       endpoint = "/openc3-api/storage/upload/#{upload_path}"
       result = _get_presigned_request(endpoint, scope: scope)
-      OpenC3::Logger.info "Writing #{upload_path} at #{result['url']}"
+      OpenC3::Logger.info "Writing #{upload_path}"
 
       # Try to put the file
       begin
@@ -104,11 +104,12 @@ module OpenC3
           if part == "targets_modified" and ENV['OPENC3_LOCAL_MODE']
             local_file = OpenC3::LocalMode.open_local_file(path, scope: scope)
             if local_file
+              OpenC3::Logger.info "Reading local #{scope}/#{path}"
               file = Tempfile.new('target', binmode: true)
               file.write(local_file.read)
               local_file.close
               file.rewind
-              return file if local_file
+              return file
             end
           end
 
@@ -133,7 +134,7 @@ module OpenC3
 
       endpoint = "/openc3-api/storage/download/#{scope}/#{path}"
       result = _get_presigned_request(endpoint, scope: scope)
-      OpenC3::Logger.info "Reading #{scope}/#{path} at #{result['url']}"
+      OpenC3::Logger.info "Reading #{scope}/#{path}"
 
       # Try to get the file
       uri = _get_uri(result['url'])

data/lib/openc3/script/telemetry.rb

@@ -16,6 +16,8 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+require 'openc3/script/extract'
+
 module OpenC3
   module Script
     private
@@ -39,5 +41,40 @@ module OpenC3
       end
       return id, packets
     end
+
+    # inject_tlm, set_tlm, override_tlm, and normalize_tlm are implemented here simply to add a puts
+    # these methods modify the telemetry so the user should be notified in the Script Runner log messages
+
+    def inject_tlm(target_name, packet_name, item_hash = nil, type: :CONVERTED, scope: $openc3_scope, token: $openc3_token)
+      puts "inject_tlm(\"#{target_name}\", \"#{packet_name}\", #{item_hash}, type: #{type})"
+      $api_server.method_missing(:inject_tlm, target_name, packet_name, item_hash, type: type, scope: scope, token: token)
+    end
+
+    def set_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)
+      if args.length == 1
+        puts "set_tlm(\"#{args.join('')}\", type: #{type})"
+      else
+        puts "set_tlm(\"#{args.join('", "')}\", type: #{type})"
+      end
+      $api_server.method_missing(:set_tlm, *args, type: type, scope: scope, token: token)
+    end
+
+    def override_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)
+      if args.length == 1
+        puts "override_tlm(\"#{args.join('')}\", type: #{type})"
+      else
+        puts "override_tlm(\"#{args.join('", "')}\", type: #{type})"
+      end
+      $api_server.method_missing(:override_tlm, *args, type: type, scope: scope, token: token)
+    end
+
+    def normalize_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)
+      if args.length == 1
+        puts "normalize_tlm(\"#{args.join('')}\", type: #{type})"
+      else
+        puts "normalize_tlm(\"#{args.join('", "')}\", type: #{type})"
+      end
+      $api_server.method_missing(:normalize_tlm, *args, type: type, scope: scope, token: token)
+    end
   end
 end

data/lib/openc3/top_level.rb

@@ -461,22 +461,7 @@ module OpenC3
 
   # @param filename [String] Name of the file to open in the web browser
   def self.open_in_web_browser(filename)
-    if filename
-      if Kernel.is_windows?
-        self.run_process("cmd /c \"start \"\" \"#{filename.gsub('/', '\\')}\"\"")
-      elsif Kernel.is_mac?
-        self.run_process("open -a Safari \"#{filename}\"")
-      else
-        which_firefox = `which firefox`.chomp
-        if which_firefox =~ /Command not found/i or which_firefox =~ /no .* in/i
-          raise "Firefox not found"
-        else
-          system_call = "#{which_firefox} \"#{filename}\""
-        end
-
-        self.run_process(system_call)
-      end
-    end
+    puts "open_in_web_browser is DEPRECATED"
   end
 
   # Temporarily set the working directory during a block

data/lib/openc3/utilities/authorization.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/auth_model'
@@ -42,7 +42,9 @@ rescue LoadError
 
         if $openc3_authorize
           raise AuthError.new("Token is required") unless token
-          raise AuthError.new("Token is invalid for '#{permission}' permission") unless OpenC3::AuthModel.verify(token, permission: permission)
+          unless OpenC3::AuthModel.verify(token, permission: permission)
+            raise AuthError.new("Current role is invalid for '#{permission}' permission")
+          end
         end
       end
 

data/lib/openc3/utilities/aws_bucket.rb

@@ -119,6 +119,8 @@ module OpenC3
       end
       # Array of objects with key and size methods
       result
+    rescue Aws::S3::Errors::NoSuchBucket => error
+      raise NotFound, "Bucket '#{bucket}' does not exist."
     end
 
     # Lists the files under a specified path
@@ -164,6 +166,8 @@ module OpenC3
         token = resp.next_continuation_token
       end
       result
+    rescue Aws::S3::Errors::NoSuchBucket => error
+      raise NotFound, "Bucket '#{bucket}' does not exist."
     end
 
     # put_object fires off the request to store but does not confirm

data/lib/openc3/utilities/bucket.rb

@@ -21,6 +21,10 @@ ENV['OPENC3_CLOUD'] ||= 'local'
 # Interface class implemented by each cloud provider: AWS, GCS, Azure
 module OpenC3
   class Bucket
+    # Raised when the underlying bucket does not exist
+    class NotFound < RuntimeError
+    end
+
     def self.getClient
       raise 'OPENC3_CLOUD environment variable is required' unless ENV['OPENC3_CLOUD']
       # Base is AwsBucket which works with MINIO, Enterprise implements additional

data/lib/openc3/utilities/process_manager.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/operators/operator'
@@ -52,7 +52,7 @@ module OpenC3
 
   # Spawns short lived processes and ensures they complete
   class ProcessManager
-    MONITOR_CYCLE_SECONDS = 10
+    MONITOR_CYCLE_SECONDS = 5
     CLEANUP_CYCLE_SECONDS = 600
 
     @@instance = nil
@@ -68,6 +68,7 @@ module OpenC3
         begin
           monitor()
         rescue => err
+          Logger.error("ProcessManager unexpectedly died\n#{err.formatted}", scope: 'DEFAULT')
           raise "ProcessManager unexpectedly died\n#{err.formatted}"
         end
       end
@@ -111,10 +112,10 @@ module OpenC3
         end
         processes_to_delete.each do |process|
           if process.status.state == "Complete"
-            Logger.info "Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}"
+            Logger.info("Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}", scope: process.scope)
           else
-            Logger.error "Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}"
-            Logger.error "Process Output:\n#{process.status.output}"
+            Logger.error("Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}", scope: process.scope)
+            Logger.error("Process Output:\n#{process.status.output}", scope: process.scope)
           end
 
           @processes.delete(process)

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.4.1'
+OPENC3_VERSION = '5.4.3-beta0'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '4'
-    PATCH = '1'
-    OTHER = ''
-    BUILD = 'b347f2b134ad7f7ea4ae0f57c7b53c5acde4b648'
+    PATCH = '3'
+    OTHER = 'pre.beta0'
+    BUILD = '3eeed1efa129ce27f14bffc2b6bab4428a20c500'
   end
-  VERSION = '5.4.1'
-  GEM_VERSION = '5.4.1'
+  VERSION = '5.4.3-beta0'
+  GEM_VERSION = '5.4.3.pre.beta0'
 end

data/lib/openc3.rb

@@ -22,6 +22,9 @@
 
 # This file sets up using the OpenC3 framework
 
+# Improve DNS (especially on Alpine)
+require 'resolv-replace'
+
 # Set default encodings
 saved_verbose = $VERBOSE; $VERBOSE = nil
 Encoding.default_external = Encoding::ASCII_8BIT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.4.1
+  version: 5.4.3.pre.beta0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -669,7 +669,6 @@ files:
 - data/config/_interfaces.yaml
 - data/config/_items.yaml
 - data/config/_params.yaml
-- data/config/cmd_tlm_server.yaml
 - data/config/command.yaml
 - data/config/command_modifiers.yaml
 - data/config/command_telemetry.yaml
@@ -872,6 +871,7 @@ files:
 - lib/openc3/models/timeline_model.rb
 - lib/openc3/models/tool_config_model.rb
 - lib/openc3/models/tool_model.rb
+- lib/openc3/models/traefik_model.rb
 - lib/openc3/models/trigger_group_model.rb
 - lib/openc3/models/trigger_model.rb
 - lib/openc3/models/widget_model.rb
@@ -925,7 +925,6 @@ files:
 - lib/openc3/system/system_config.rb
 - lib/openc3/system/target.rb
 - lib/openc3/tools/cmd_tlm_server/api.rb
-- lib/openc3/tools/cmd_tlm_server/cmd_tlm_server_config.rb
 - lib/openc3/tools/cmd_tlm_server/interface_thread.rb
 - lib/openc3/tools/table_manager/table.rb
 - lib/openc3/tools/table_manager/table_config.rb
@@ -1012,9 +1011,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.14
 signing_key:

data/data/config/cmd_tlm_server.yaml

@@ -1,136 +0,0 @@
----
-TITLE:
-  summary: Sets the Command and Telemetry Server window title
-  parameters:
-  - name: Text
-    required: true
-    description: Text to put in the title of the Command and Telemetry Server window
-    values: .+
-PACKET_LOG_WRITER:
-  summary: Declare a packet log writer
-  description: Packet log writer is used to declare a packet log writer class and
-    give it a name which can be referenced by an interface. This is required if you
-    want interfaces to have their own dedicated log writers or want to combine
-    various interfaces into a single log file. By default, OpenC3 logs all data
-    on all interfaces into a single command log and a single telemetry log.
-    This keyword can also be used if you want to declare a different log file class
-    to create log files.
-  warning: You should NOT override the default without consulting a OpenC3 expert
-    as this may break the ability to successfully read and write log files.
-  example: |
-    PACKET_LOG_WRITER DEFAULT packet_log_writer.rb # Default
-    # The default logger filename will be <DATE>_openc3tlm.bin and will create a new log every 1MB
-    PACKET_LOG_WRITER DEFAULT packet_log_writer.rb openc3 true nil 1000000
-    # Create a logger named OPENC3_LOG which creates a new log every 5 min (600s)
-    PACKET_LOG_WRITER OPENC3_LOG packet_log_writer.rb openc3 true 600
-  parameters:
-    - name: Log Writer Name
-      required: true
-      description: The name of the log writer as reference by other cmd_tlm_server keywords.
-        This name also appears in the Logging tab on the Command and Telemetry Server.
-      values: .+
-    - name: Filename
-      required: true
-      description: Ruby file to use when instantiating a new log writer
-      values: '.+\.rb'
-    - name: Parameters
-      required: false
-      description: Optional parameters to pass to the log writer class when instantiating it.
-AUTO_INTERFACE_TARGETS:
-  summary: Automatically use each target's cmd_tlm_server.txt file to define the interface
-  description: Look for a cmd_tlm_server.txt file at the top level
-    of each target directory and use this file to configure the interface for that target.
-    This is a good way of keeping the knowledge of how to interface to a target
-    within that target. However, if you use substitute target names (by using DECLARE_TARGET)
-    or use different IP addresses then this will not work and you'll have to use the
-    INTERFACE_TARGET or INTERFACE keyword.
-INTERFACE_TARGET:
-  summary: Load the specified target's cmd_tlm_server.txt configuration file
-  example: |
-    INTERFACE_TARGET OPENC3 # Look in the OPENC3 target directory for cmd_tlm_server.txt
-    INTERFACE_TARGET OPENC3 config.txt # Look in the OPENC3 target directory for config.txt
-  parameters:
-    - name: Target Name
-      required: true
-      description: Name of the target
-      values: .+
-    - name: Configuration File
-      required: false
-      description: Configuration filename which contains the interface configuration.
-        Defaults to 'cmd_tlm_server.txt'.
-      values: .+
-INTERFACE:
-  modifiers:
-    <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
-  summary: Defines a connection to a physical target
-  description: Interfaces are what OpenC3 uses to talk to a particular piece
-    of hardware. Interfaces require a Ruby file which implements all the interface
-    methods necessary to talk to the hardware. OpenC3 defines many built in interfaces
-    or you can define your own as long as it implements the interface protocol.
-  parameters:
-    - name: Interface Name
-      required: true
-      description: Name of the interface. This name will appear in the
-        Interfaces tab of the Server and is also referenced by other keywords.
-        The OpenC3 convention is to name interfaces after their targets with
-        '_INT' appended to the name, e.g. INST_INT for the INST target.
-      values: \D\S*
-    - name: Filename
-      required: true
-      description: Ruby file to use when instantiating the interface.
-      values:
-        <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
-      documentation: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
-        documentation for more details.
-ROUTER:
-  modifiers:
-    ROUTE:
-      summary: Map an interface to a router
-      description: Once an interface has been mapped to a router, all its received telemetry
-        will be sent out through the router.
-      parameters:
-        - name: Interface
-          required: true
-          description: Name of the interface
-          values: .+
-    <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
-  summary: Create an interface which reverses cmd/tlm data
-  description: Router creates an interface which receives command packets from
-    their remote targets and send them out their interfaces. They receive telemetry
-    packets from their interfaces and send them to their remote targets. This allows
-    routers to be intermediaries between an external client and an actual device.
-  parameters:
-    - name: Name
-      required: true
-      description: Name of the router
-      values: .+
-    - name: Filename
-      required: true
-      description: Ruby file to use when instantiating the interface.
-      values:
-        <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
-      documentation: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
-        documentation for more details.
-COLLECT_METADATA:
-  summary: Prompts the user for meta data when starting the Command and Telemetry Server
-BACKGROUND_TASK:
-  modifiers:
-    STOPPED:
-      summary: Indicate the background task should not be automatically started
-  summary: Create a background task in the Command and Telemetry Server
-  description: The Server instantiates the class which must inherit from BackgroundTask
-    and then calls the call() method which the class must implement. The call() method
-    is only called once so if your background task is supposed to live on while the
-    Server is running, you must implement your code in a loop with a sleep to not
-    use all the CPU.
-  example: BACKGROUND_TASK example_background_task.rb
-  parameters:
-    - name: Filename
-      required: true
-      description: Ruby file which contains the background task implementation.
-        Must inherit from BackgroundTask and implement the call method.
-      values: '.+\.rb'
-    - name: Optional Arguments
-      required: false
-      description: Optional arguments to the background task constructor
-      values: .+