openc3 5.0.7 → 5.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c4ca95f60633de6f38b56a72891bda7cdcdf0b902a16d52f6527966c213bab
-  data.tar.gz: 7ed07cc0014bd9ca27c57ff307cc879e385617339a6cb9b6c1fa891ab971a018
+  metadata.gz: 3a1e753382bf9c7d98b63dad72fed1aa08e3a234ce140327d0bbf07ed2a913dd
+  data.tar.gz: 4b61da453f0fc1c75b7ec5df06516970b1a0d3325425e15f550322a505e90883
 SHA512:
-  metadata.gz: bc5c9ff0457266a17d4bef4f89c40fc99b851d4fe87d1d40783db3bdd84bf2581244e0055bfd6c5db706a60f35f4073d3eb0f9c0659a88a736bdc185051535bc
-  data.tar.gz: fdc7c1552371c0555f0d67e30d8f31b9e966986224ecec2ab0c5705e60f8f2d4708782fb26776d359514c696ea6632f380526f7ba7a6dc34d382d32eab3f536b
+  metadata.gz: 3cfaad4b9103a68a6608d48513f1e1161df68325bfb0684d9dac6aebcc47af0e4c2a3225692dff08b7d28aa96ce33a3b7812928e0191620bffb08686fbe511d6
+  data.tar.gz: a385b3d5ac4524c8919adf9cc1050793c1ce5e30fb62c679a711b79f7523d3908301de23cfd97d426ec0c58ce1815d16047807802afb8530cbb1faf91392a444

data/bin/openc3cli

@@ -530,6 +530,9 @@ if not ARGV[0].nil? # argument(s) given
         if plugin["name"] =~ /tool-base/ and plugin["name"] !~ /enterprise/
           unload_plugin(plugin_name, scope: scope_name)
         end
+        if plugin["name"] =~ /tool-admin/ and plugin["name"] !~ /enterprise/
+          unload_plugin(plugin_name, scope: scope_name)
+        end
       end
     end
 
@@ -545,6 +548,10 @@ if not ARGV[0].nil? # argument(s) given
       end
     end
 
+  when 'destroyscope'
+    scope = OpenC3::ScopeModel.get_model(name: ARGV[1])
+    scope.destroy
+
   else # Unknown task
     print_usage()
     abort("Unknown task: #{ARGV[0]}")

data/data/config/command_modifiers.yaml

@@ -78,7 +78,7 @@ ARRAY_PARAMETER:
     - name: Name
       required: true
       description: Name of the parameter. Must be unique within the command.
-      values: \'
+      values: .*
     - name: Bit Offset
       required: true
       description: Bit offset into the command packet of the Most Significant Bit of this parameter.
@@ -95,7 +95,7 @@ APPEND_ARRAY_PARAMETER:
     - name: Name
       required: true
       description: Name of the parameter. Must be unique within the command.
-      values: '\D\S*'
+      values: .*
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
 SELECT_PARAMETER:
   modifiers:

data/data/config/tool.yaml

@@ -61,3 +61,11 @@ TOOL:
           required: true
           description: Whether or not the tool is shown.  TRUE or FALSE
           values: ["true", "false"]
+    POSITION:
+      summary: Position of the tool in the nav bar
+      description: Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed.
+      parameters:
+        - name: Position
+          required: true
+          description: Numerical position
+          values: \d+

data/data/config/widgets.yaml

@@ -909,6 +909,37 @@ LINEGRAPH:
     #   required: false
     #   description: The type of the value to display. Default is CONVERTED.
     #   values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+SPARKLINE:
+  summary: Displays a sparkline graph (no cursor, scale or legend) of a telemetry item
+  parameters:
+    - name: Target name
+      required: true
+      description: The target name
+      values: .+
+    - name: Packet name
+      required: true
+      description: The packet name
+      values: .+
+    - name: Item name
+      required: true
+      description: The item name
+      values: .+
+LABELSPARKLINE:
+  summary: Displays a LABEL widget to show the telemetry
+    item name followed by a SPARKLINE widget to graph the item
+  parameters:
+    - name: Target name
+      required: true
+      description: The target name
+      values: .+
+    - name: Packet name
+      required: true
+      description: The packet name
+      values: .+
+    - name: Item name
+      required: true
+      description: The item name
+      values: .+
 PROGRESSBAR:
   summary: Displays a progress bar that is useful for displaying percentages
   parmeters:

data/lib/openc3/models/cvt_model.rb

@@ -40,12 +40,12 @@ module OpenC3
 
     # Delete the current value table for a target
     def self.del(target_name:, packet_name:, scope:)
-      EphemeralStore.hdel("#{scope}__tlm__#{target_name}", packet_name)
+      Store.hdel("#{scope}__tlm__#{target_name}", packet_name)
     end
 
     # Set the current value table for a target, packet
     def self.set(hash, target_name:, packet_name:, scope:)
-      EphemeralStore.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
+      Store.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
     end
 
     # Set an item in the current value table
@@ -62,9 +62,9 @@ module OpenC3
       else
         raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
       end
-      hash = JSON.parse(EphemeralStore.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
+      hash = JSON.parse(Store.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
       hash[field] = value
-      EphemeralStore.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
+      Store.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
     end
 
     # Get an item from the current value table
@@ -86,7 +86,7 @@ module OpenC3
       else
         raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
       end
-      hash = JSON.parse(EphemeralStore.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
+      hash = JSON.parse(Store.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
       hash.values_at(*types).each do |result|
         return result if result
       end
@@ -106,7 +106,7 @@ module OpenC3
 
       lookups.each do |target_packet_key, target_name, packet_name, packet_values|
         unless packet_lookup[target_packet_key]
-          packet = EphemeralStore.hget("#{scope}__tlm__#{target_name}", packet_name)
+          packet = Store.hget("#{scope}__tlm__#{target_name}", packet_name)
           raise "Packet '#{target_name} #{packet_name}' does not exist" unless packet
           packet_lookup[target_packet_key] = JSON.parse(packet, :allow_nan => true, :create_additions => true)
         end

data/lib/openc3/models/plugin_model.rb

@@ -267,11 +267,13 @@ module OpenC3
 
     # Undeploy all models associated with this plugin
     def undeploy
+      microservice_count = 0
       MicroserviceModel.find_all_by_plugin(plugin: @name, scope: @scope).each do |name, model_instance|
         model_instance.destroy
+        microservice_count += 1
       end
       # Wait for the operator to wake up and remove the microservice processes
-      sleep 12 # Cycle time 5s times 2 plus 2s wait for soft stop and then hard stop
+      sleep 12 if microservice_count > 0 # Cycle time 5s times 2 plus 2s wait for soft stop and then hard stop
       # Remove all the other models now that the processes have stopped
       # Save TargetModel for last as it has the most to cleanup
       [InterfaceModel, RouterModel, ToolModel, WidgetModel, TargetModel].each do |model|

data/lib/openc3/models/scope_model.rb

@@ -40,10 +40,47 @@ module OpenC3
       super(PRIMARY_KEY)
     end
 
+    def self.from_json(json, scope: nil)
+      json = JSON.parse(json, :allow_nan => true, :create_additions => true) if String === json
+      raise "json data is nil" if json.nil?
+
+      json.transform_keys!(&:to_sym)
+      self.new(**json, scope: scope)
+    end
+
+    def self.get_model(name:, scope: nil)
+      json = get(name: name)
+      if json
+        return from_json(json)
+      else
+        return nil
+      end
+    end
+
     def initialize(name:, updated_at: nil, scope: nil)
       super(PRIMARY_KEY, name: name, scope: name, updated_at: updated_at)
     end
 
+    def create(update: false, force: false)
+      # Ensure there are no "." in the scope name - prevents gems accidently becoming scope names
+      raise "Invalid scope name: #{@name}" if @name !~ /^[a-zA-Z0-9_-]+$/
+      @name = @name.upcase
+      super(update: update, force: force)
+    end
+
+    def destroy
+      if @name != 'DEFAULT'
+        # Remove all the plugins for this scope
+        plugins = PluginModel.get_all_models(scope: @name)
+        plugins.each do |plugin_name, plugin|
+          plugin.destroy
+        end
+        super()
+      else
+        raise "DEFAULT scope cannot be destroyed"
+      end
+    end
+
     def as_json(*a)
       { 'name' => @name,
         'updated_at' => @updated_at }
@@ -51,9 +88,12 @@ module OpenC3
 
     def deploy(gem_path, variables)
       seed_database()
-
       ConfigTopic.initialize_stream(@scope)
 
+      # Create UNKNOWN target for display of unknown data
+      model = TargetModel.new(name: "UNKNOWN", scope: @scope)
+      model.create
+
       # OpenC3 Log Microservice
       microservice_name = "#{@scope}__OPENC3__LOG"
       microservice = MicroserviceModel.new(

data/lib/openc3/models/tool_model.rb

@@ -203,6 +203,9 @@ module OpenC3
       when 'SHOWN'
         parser.verify_num_parameters(1, 1, "SHOWN <true/false>")
         @shown = ConfigParser.handle_true_false(parameters[0])
+      when 'POSITION'
+        parser.verify_num_parameters(1, 1, "POSITION <value>")
+        @position = parameters[0].to_i
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Tool: #{keyword} #{parameters.join(" ")}")
       end

data/lib/openc3/operators/microservice_operator.rb

@@ -90,7 +90,7 @@ module OpenC3
         @new_microservices.each do |microservice_name, microservice_config|
           cmd_array, work_dir, env, scope, container = convert_microservice_to_process_definition(microservice_name, microservice_config)
           if cmd_array
-            process = OperatorProcess.new(cmd_array, work_dir: work_dir, env: env, scope: scope, container: container)
+            process = OperatorProcess.new(cmd_array, work_dir: work_dir, env: env, scope: scope, container: container, config: microservice_config)
             @new_processes[microservice_name] = process
             @processes[microservice_name] = process
           end
@@ -108,7 +108,7 @@ module OpenC3
               @changed_processes[microservice_name] = process
             else # TODO: How is this even possible?
               Logger.error("Changed microservice #{microservice_name} does not exist. Creating new...", scope: scope)
-              process = OperatorProcess.new(cmd_array, work_dir: work_dir, env: env, scope: scope, container: container)
+              process = OperatorProcess.new(cmd_array, work_dir: work_dir, env: env, scope: scope, container: container, config: microservice_config)
               @new_processes[microservice_name] = process
               @processes[microservice_name] = process
             end

data/lib/openc3/operators/operator.rb

@@ -35,7 +35,8 @@ module OpenC3
       # Perform any setup steps necessary
     end
 
-    def initialize(process_definition, work_dir: '/openc3/lib/openc3/microservices', temp_dir: nil, env: {}, scope:, container: nil) # container is not used, it's just here for Enterprise
+    # container is not used, it's just here for Enterprise
+    def initialize(process_definition, work_dir: '/openc3/lib/openc3/microservices', temp_dir: nil, env: {}, scope:, container: nil, config: nil)
       @process = nil
       @process_definition = process_definition
       @work_dir = work_dir
@@ -43,12 +44,26 @@ module OpenC3
       @new_temp_dir = temp_dir
       @env = env
       @scope = scope
+      # @config only used in start to help print a better Logger message
+      @config = config
     end
 
     def start
       @temp_dir = @new_temp_dir
       @new_temp_dir = nil
-      Logger.info("Starting: #{@process_definition.join(' ')}", scope: @scope)
+
+      # In ProcessManager processes, the process_definition is the actual thing run
+      # e.g. OpenC3::ProcessManager.instance.spawn(["ruby", "/openc3/bin/openc3cli", "load", ...])
+      # However, if the MicroserviceOperator is spawning the proceses it sets
+      # process_definition = ["ruby", "plugin_microservice.rb"]
+      # which then calls exec(*@config["cmd"]) to actually run
+      # So check if the @config['cmd'] is defined to give the user more info in the log
+      cmd = @process_definition.join(' ')
+      if @config && @config['cmd']
+        cmd = @config['cmd'].join(' ')
+      end
+      Logger.info("Starting: #{cmd}", scope: @scope)
+
       @process = ChildProcess.build(*@process_definition)
       # This lets the ChildProcess use the parent IO ... but it breaks unit tests
       # @process.io.inherit!

data/lib/openc3/utilities/s3.rb

@@ -22,6 +22,22 @@ require 'openc3/models/reducer_model'
 
 module OpenC3
   class S3Utilities
+    def self.put_object_and_check(params = {})
+      rubys3_client = Aws::S3::Client.new
+      rubys3_client.put_object(params)
+      # polls in a loop, sleeping between attempts
+      rubys3_client.wait_until(:object_exists,
+        {
+          bucket: params[:bucket],
+          key: params[:key]
+        },
+        {
+          max_attempts: 30,
+          delay: 0.1, # seconds
+        }
+      )
+    end
+
     def self.list_files_before_time(bucket, prefix, time)
       rubys3_client = Aws::S3::Client.new
       oldest_list = []

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.0.7'
+OPENC3_VERSION = '5.0.8'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '0'
-    PATCH = '7'
+    PATCH = '8'
     OTHER = ''
-    BUILD = 'be957bd6e3c30c2e535b9ee8dfbeffe75c720874'
+    BUILD = '8dc96d0ce9d272e063d9d806f848803b7d5c61ed'
   end
-  VERSION = '5.0.7'
-  GEM_VERSION = '5.0.7'
+  VERSION = '5.0.8'
+  GEM_VERSION = '5.0.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.0.7
+  version: 5.0.8
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +185,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: matrix
   requirement: !ruby/object:Gem::Requirement
@@ -311,14 +311,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement