openc3 5.2.0 → 5.3.0

data/lib/openc3/operators/microservice_operator.rb

@@ -23,8 +23,10 @@
 require 'openc3'
 require 'openc3/models/microservice_model'
 require 'openc3/operators/operator'
+require 'openc3/utilities/secrets'
 require 'redis'
 require 'open3'
+require 'fileutils'
 
 module OpenC3
   # Creates new OperatorProcess objects based on querying the Redis key value store.
@@ -34,6 +36,7 @@ module OpenC3
       Logger.microservice_name = "MicroserviceOperator"
       super
 
+      @secrets = Secrets.getClient
       @microservices = {}
       @previous_microservices = {}
       @new_microservices = {}
@@ -53,6 +56,28 @@ module OpenC3
       env['OPENC3_MICROSERVICE_NAME'] = microservice_name
       container = microservice_config["container"]
       scope = microservice_name.split("__")[0]
+
+      # Setup secrets for microservice
+      secrets = microservice_config["secrets"]
+      if secrets
+        secrets.each do |type, secret_name, env_name_or_path|
+          secret_value = @secrets.get(secret_name, scope: scope)
+          if secret_value
+            case type
+            when 'ENV'
+              env[env_name_or_path] = secret_value
+            when 'FILE'
+              FileUtils.mkdir_p(File.dirname(env_name_or_path))
+              File.open(env_name_or_path, 'wb') do |file|
+                file.write(secret_value)
+              end
+            end
+          else
+            Logger.error("Microservice #{microservice_name} references unknown secret: #{secret_name}")
+          end
+        end
+      end
+
       return process_definition, work_dir, env, scope, container
     end
 

data/lib/openc3/script/api_shared.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/script/extract'
@@ -500,7 +500,20 @@ module OpenC3
     def load_utility(procedure_name)
       return start(procedure_name)
     end
-    alias require_utility load_utility
+    def require_utility(procedure_name)
+      @require_utility_cache ||= {}
+      if @require_utility_cache[procedure_name]
+        return false
+      else
+        @require_utility_cache[procedure_name] = true
+        begin
+          return start(procedure_name)
+        rescue LoadError
+          @require_utility_cache[procedure_name] = false
+          raise # reraise the error
+        end
+      end
+    end
 
     ###########################################################################
     # Private implementation details
@@ -714,6 +727,7 @@ module OpenC3
 
     def _openc3_script_wait_implementation(target_name, packet_name, item_name, value_type, timeout, polling_rate, exp_to_eval, scope: $openc3_scope, token: $openc3_token, &block)
       end_time = Time.now.sys + timeout
+      raise "Invalid comparison to non-ascii value" unless exp_to_eval.is_printable?
 
       while true
         work_start = Time.now.sys
@@ -792,6 +806,7 @@ module OpenC3
     # Wait on an expression to be true.
     def openc3_script_wait_implementation_expression(exp_to_eval, timeout, polling_rate, context, scope: $openc3_scope, token: $openc3_token)
       end_time = Time.now.sys + timeout
+      raise "Invalid comparison to non-ascii value" unless exp_to_eval.is_printable?
 
       while true
         work_start = Time.now.sys
@@ -828,6 +843,7 @@ module OpenC3
     end
 
     def check_eval(target_name, packet_name, item_name, comparison_to_eval, value, scope: $openc3_scope, token: $openc3_token)
+      raise "Invalid comparison to non-ascii value" unless comparison_to_eval.is_printable?
       string = "value " + comparison_to_eval
       check_str = "CHECK: #{_upcase(target_name, packet_name, item_name)} #{comparison_to_eval}"
       # Show user the check against a quoted string

data/lib/openc3/topics/interface_topic.rb

@@ -76,5 +76,21 @@ module OpenC3
       sleep 1 # Give some time for the interface to shutdown
       InterfaceTopic.clear_topics(InterfaceTopic.topics(interface, scope: scope))
     end
+
+    def interface_cmd(interface_name, cmd_name, *cmd_params, scope:)
+      data = {}
+      data['cmd_name'] = cmd_name
+      data['cmd_params'] = cmd_params
+      Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'interface_cmd' => JSON.generate(data, allow_nan: true) }, '*', 100)
+    end
+
+    def protocol_cmd(interface_name, cmd_name, *cmd_params, read_write: :READ_WRITE, index: -1, scope:)
+      data = {}
+      data['cmd_name'] = cmd_name
+      data['cmd_params'] = cmd_params
+      data['read_write'] = read_write.to_s.upcase
+      data['index'] = index
+      Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'protocol_cmd' => JSON.generate(data, allow_nan: true) }, '*', 100)
+    end
   end
 end

data/lib/openc3/topics/router_topic.rb

@@ -88,5 +88,21 @@ module OpenC3
       sleep 1 # Give some time for the interface to shutdown
       RouterTopic.clear_topics(RouterTopic.topics(router, scope: scope))
     end
+
+    def router_cmd(router_name, cmd_name, *cmd_params, scope:)
+      data = {}
+      data['cmd_name'] = cmd_name
+      data['cmd_params'] = cmd_params
+      Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'router_cmd' => JSON.generate(data, allow_nan: true) }, '*', 100)
+    end
+
+    def protocol_cmd(router_name, cmd_name, *cmd_params, read_write: :READ_WRITE, index: -1, scope:)
+      data = {}
+      data['cmd_name'] = cmd_name
+      data['cmd_params'] = cmd_params
+      data['read_write'] = read_write.to_s.upcase
+      data['index'] = index
+      Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'protocol_cmd' => JSON.generate(data, allow_nan: true) }, '*', 100)
+    end
   end
 end

data/lib/openc3/utilities/redis_secrets.rb

@@ -0,0 +1,46 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 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/models/secret_model'
+require 'openc3/utilities/secrets'
+
+module OpenC3
+  class RedisSecrets < Secrets
+    def keys(scope:)
+      SecretModel.names(scope: scope)
+    end
+
+    def get(key, scope:)
+      data = SecretModel.get(name: key, scope: scope)
+      if data
+        return data['value']
+      else
+        return nil
+      end
+    end
+
+    def set(key, value, scope:)
+      SecretModel.set( {name: key, value: value.to_s }, scope: scope)
+    end
+
+    def delete(key, scope:)
+      model = SecretModel.get_model(name: key, scope: scope)
+      model.destroy if model
+    end
+  end
+end

data/lib/openc3/utilities/secrets.rb

@@ -0,0 +1,63 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 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.
+
+ENV['OPENC3_SECRET_BACKEND'] ||= 'redis'
+
+module OpenC3
+  class Secrets
+    def initialize
+      @local_secrets = {}
+    end
+
+    def self.getClient
+      raise 'OPENC3_SECRET_BACKEND environment variable is required' unless ENV['OPENC3_SECRET_BACKEND']
+      secrets_class = ENV['OPENC3_SECRET_BACKEND'].capitalize + 'Secrets'
+      klass = OpenC3.require_class('openc3/utilities/' + secrets_class.class_name_to_filename)
+      klass.new
+    end
+
+    def keys(scope:)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    def get(key, scope:)
+      return @local_secrets[key]
+    end
+
+    def set(key, value, scope:)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    def delete(key, scope:)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    def setup(secrets)
+      secrets.each do |type, key, data|
+        case type
+        when 'ENV'
+          @local_secrets[key] = ENV[data]
+        when 'FILE'
+          @local_secrets[key] = File.read(data)
+        else
+          raise "Unknown secret type: #{type}"
+        end
+      end
+    end
+  end
+end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.2.0'
+OPENC3_VERSION = '5.3.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '2'
+    MINOR = '3'
     PATCH = '0'
     OTHER = ''
-    BUILD = '49c62512b75f45a8cbfc20a6fb5ed114bab35e23'
+    BUILD = 'a6b9f9a0eb9a17783ffe1e614a1da309128de52d'
   end
-  VERSION = '5.2.0'
-  GEM_VERSION = '5.2.0'
+  VERSION = '5.3.0'
+  GEM_VERSION = '5.3.0'
 end

data/templates/plugin-template/README.md

@@ -1,10 +1,10 @@
-# OpenC3 Configuration
+# OpenC3 COSMOS Plugin
 
 See the [OpenC3](https://openc3.com) documentation for all things OpenC3.
 
 ## Building the plugin
 
-1. <Path to OpenC3 installation>\openc3.bat openc3 rake VERSION=X.Y.Z
+1. <Path to COSMOS installation>\openc3.bat cli rake build VERSION=X.Y.Z
    - VERSION is required
    - gem file will be built locally
 
@@ -12,4 +12,5 @@ See the [OpenC3](https://openc3.com) documentation for all things OpenC3.
 
 1. Go to localhost:2900/tools/admin
 1. Click the paperclip icon and choose your plugin.gem file
-1. Click Upload
+1. Fill out plugin parameters
+1. Click Install

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -333,6 +333,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -768,6 +782,7 @@ files:
 - lib/openc3/interfaces.rb
 - lib/openc3/interfaces/interface.rb
 - lib/openc3/interfaces/linc_interface.rb
+- lib/openc3/interfaces/mqtt_interface.rb
 - lib/openc3/interfaces/protocols/burst_protocol.rb
 - lib/openc3/interfaces/protocols/crc_protocol.rb
 - lib/openc3/interfaces/protocols/fixed_protocol.rb
@@ -849,6 +864,7 @@ files:
 - lib/openc3/models/router_model.rb
 - lib/openc3/models/router_status_model.rb
 - lib/openc3/models/scope_model.rb
+- lib/openc3/models/secret_model.rb
 - lib/openc3/models/settings_model.rb
 - lib/openc3/models/sorted_model.rb
 - lib/openc3/models/stash_model.rb
@@ -951,8 +967,10 @@ files:
 - lib/openc3/utilities/open_telemetry.rb
 - lib/openc3/utilities/process_manager.rb
 - lib/openc3/utilities/quaternion.rb
+- lib/openc3/utilities/redis_secrets.rb
 - lib/openc3/utilities/ruby_lex_utils.rb
 - lib/openc3/utilities/s3_autoload.rb
+- lib/openc3/utilities/secrets.rb
 - lib/openc3/utilities/simulated_target.rb
 - lib/openc3/utilities/sleeper.rb
 - lib/openc3/utilities/store.rb