openc3 5.20.0 → 6.0.0

data/lib/openc3/interfaces/mqtt_stream_interface.rb

@@ -16,14 +16,20 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+# You can quickly setup an unauthenticated MQTT server in Docker with
+# docker run -it -p 1883:1883 eclipse-mosquitto:2.0.15 mosquitto -c /mosquitto-no-auth.conf
+# You can also test against encrypted and authenticated servers at https://test.mosquitto.org/
+
 require 'openc3/interfaces/stream_interface'
 require 'openc3/streams/mqtt_stream'
+require 'openc3/config/config_parser'
 
 module OpenC3
   class MqttStreamInterface < StreamInterface
     # @param hostname [String] MQTT server to connect to
     # @param port [Integer] MQTT port
-    # @param ssl [Boolean] Use SSL true/false
+    # @param write_topic [String] MQTT publish topic
+    # @param read_topic [String] MQTT receive topic
     def initialize(hostname, port = 1883, ssl = false, write_topic = nil, read_topic = nil, protocol_type = nil, *protocol_args)
       super(protocol_type, protocol_args)
       @hostname = hostname
@@ -31,6 +37,7 @@ module OpenC3
       @ssl = ConfigParser.handle_true_false(ssl)
       @write_topic = ConfigParser.handle_nil(write_topic)
       @read_topic = ConfigParser.handle_nil(read_topic)
+      @ack_timeout = 5.0
       @username = nil
       @password = nil
       @cert = nil
@@ -47,7 +54,7 @@ module OpenC3
 
     # Creates a new {SerialStream} using the parameters passed in the constructor
     def connect
-      @stream = MqttStream.new(@hostname, @port, @ssl, @write_topic, @read_topic)
+      @stream = MqttStream.new(@hostname, @port, @ssl, @write_topic, @read_topic, @ack_timeout)
       @stream.username = @username if @username
       @stream.password = @password if @password
       @stream.cert = @cert if @cert
@@ -66,14 +73,22 @@ module OpenC3
     def set_option(option_name, option_values)
       super(option_name, option_values)
       case option_name.upcase
+      when 'ACK_TIMEOUT'
+        @ack_timeout = Float(option_values[0])
       when 'USERNAME'
         @username = option_values[0]
       when 'PASSWORD'
         @password = option_values[0]
       when 'CERT'
-        @cert = option_values[0]
+        # CERT must be given as a file
+        @cert = Tempfile.new('cert')
+        @cert.write(option_values[0])
+        @cert.close
       when 'KEY'
-        @key = option_values[0]
+        # KEY must be given as a file
+        @key = Tempfile.new('key')
+        @key.write(option_values[0])
+        @key.close
       when 'CA_FILE'
         # CA_FILE must be given as a file
         @ca_file = Tempfile.new('ca_file')

data/lib/openc3/interfaces/protocols/crc_protocol.rb

@@ -121,6 +121,13 @@ module OpenC3
 
       @bit_size = bit_size.to_i
       case @bit_size
+      when 8
+        @pack = (@endianness == :BIG_ENDIAN) ? 'n' : 'v'
+        if args.empty?
+          @crc = Crc8.new
+        else
+          @crc = Crc8.new(*args)
+        end
       when 16
         @pack = (@endianness == :BIG_ENDIAN) ? 'n' : 'v'
         if args.empty?

data/lib/openc3/interfaces/serial_interface.rb

@@ -98,6 +98,7 @@ module OpenC3
 
     # Supported Options
     # FLOW_CONTROL - Flow control method NONE or RTSCTS. Defaults to NONE
+    # DATA_BITS - Number of data bits 5, 6, 7, or 8. Defaults to 8
     def set_option(option_name, option_values)
       super(option_name, option_values)
       case option_name.upcase

data/lib/openc3/interfaces.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -25,15 +25,13 @@ module OpenC3
   autoload(:HttpClientInterface, 'openc3/interfaces/http_client_interface.rb')
   autoload(:HttpServerInterface, 'openc3/interfaces/http_server_interface.rb')
   autoload(:MqttInterface, 'openc3/interfaces/mqtt_interface.rb')
+  autoload(:MqttStreamInterface, 'openc3/interfaces/mqtt_stream_interface.rb')
   autoload(:StreamInterface, 'openc3/interfaces/stream_interface.rb')
   autoload(:SerialInterface, 'openc3/interfaces/serial_interface.rb')
   autoload(:SimulatedTargetInterface, 'openc3/interfaces/simulated_target_interface.rb')
   autoload(:TcpipClientInterface, 'openc3/interfaces/tcpip_client_interface.rb')
   autoload(:TcpipServerInterface, 'openc3/interfaces/tcpip_server_interface.rb')
   autoload(:UdpInterface, 'openc3/interfaces/udp_interface.rb')
-  autoload(:LincInterface, 'openc3/interfaces/linc_interface.rb')
-  autoload(:LincHandshakeCommand, 'openc3/interfaces/linc_interface.rb')
-  autoload(:LincHandshake, 'openc3/interfaces/linc_interface.rb')
 
   autoload(:Protocol, 'openc3/interfaces/protocols/protocol.rb')
   autoload(:BurstProtocol, 'openc3/interfaces/protocols/burst_protocol.rb')

data/lib/openc3/microservices/multi_microservice.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3 Inc.
+# Copyright 2024 OpenC3 Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -36,8 +36,8 @@ module OpenC3
             end
           end
           raise "Could not determine class filename from '#{cmd_line}'" unless filename
-          OpenC3.set_working_dir(@work_dir) do
-            require_relative filename
+          OpenC3.set_working_dir(microservice_model.work_dir) do
+            require File.join(microservice_model.work_dir, filename)
           end
           klass = filename.filename_to_class_name.to_class
           klass.run(microservice_model.name)

data/lib/openc3/migrations/20241208080000_no_critical_cmd.rb

@@ -0,0 +1,31 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/microservice_model'
+
+module OpenC3
+  class NoCriticalCmd < Migration
+    begin
+      require 'openc3-enterprise/models/cmd_authority_model'
+      require 'openc3-enterprise/models/critical_cmd_model'
+      BASE = false
+    rescue LoadError
+      BASE = true
+    end
+
+    def self.run
+      ScopeModel.get_all_models(scope: nil).each do |scope, scope_model|
+        model = MicroserviceModel.get_model(name: "#{scope}__CRITICALCMD__#{scope}", scope: scope)
+        if BASE # Only remove the critical command model if we're not enterprise
+          model.destroy if model
+        else
+          model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+          model.update
+        end
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::NoCriticalCmd.run
+end

data/lib/openc3/migrations/20241208080001_no_trigger_group.rb

@@ -0,0 +1,46 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/microservice_model'
+
+module OpenC3
+  class NoTriggerGroups < Migration
+    begin
+      require 'openc3-enterprise/models/cmd_authority_model'
+      require 'openc3-enterprise/models/critical_cmd_model'
+      BASE = false
+    rescue LoadError
+      BASE = true
+    end
+
+    def self.run
+      MicroserviceModel.get_all_models(scope: 'DEFAULT').each do |microservice_name, microservice_model|
+        if microservice_name =~ /__TRIGGER_GROUP__/
+          if BASE
+            # Only remove the trigger group microservice if we're not enterprise
+            microservice_model.destroy
+          else
+            # Need to update working dir for Enterprise
+            microservice_model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+            microservice_model.update
+          end
+        end
+
+        if microservice_name =~ /__OPENC3__REACTION/
+          # Need to update working dir for Enterprise
+          microservice_model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+          microservice_model.update
+        end
+
+        if microservice_name =~ /__TIMELINE__/
+          # Need to update working dir for Enterprise
+          microservice_model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+          microservice_model.update
+        end
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::NoTriggerGroups.run
+end

data/lib/openc3/models/interface_model.rb

@@ -50,6 +50,7 @@ module OpenC3
     attr_accessor :work_dir
     attr_accessor :ports
     attr_accessor :prefix
+    attr_accessor :shard
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -121,6 +122,7 @@ module OpenC3
       env: {},
       container: nil,
       prefix: nil,
+      shard: 0,
       scope:
     )
       if self.class._get_type == 'INTERFACE'
@@ -158,6 +160,7 @@ module OpenC3
       @env = env
       @container = container
       @prefix = prefix
+      @shard = shard.to_i # to_i to handle nil
       @secrets = secrets
     end
 
@@ -222,6 +225,7 @@ module OpenC3
         'env' => @env,
         'container' => @container,
         'prefix' => @prefix,
+        'shard' => @shard,
         'updated_at' => @updated_at
       }
     end
@@ -297,9 +301,7 @@ module OpenC3
           # Option Name, Secret Name
           @secret_options << [parameters[3], parameters[1]]
         end
-        if ConfigParser.handle_nil(parameters[4])
-          @secrets[-1] << parameters[4]
-        end
+        @secrets[-1] << ConfigParser.handle_nil(parameters[4])
 
       when 'ENV'
         parser.verify_num_parameters(2, 2, "#{keyword} <Key> <Value>")
@@ -341,6 +343,9 @@ module OpenC3
         parser.verify_num_parameters(1, 1, "#{keyword} <Route Prefix>")
         @prefix = parameters[0]
 
+      when 'SHARD'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Shard Number Starting from 0>")
+        @shard = Integer(parameters[0])
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Interface/Router: #{keyword} #{parameters.join(" ")}")
 
@@ -365,6 +370,7 @@ module OpenC3
         needs_dependencies: @needs_dependencies,
         secrets: @secrets,
         prefix: @prefix,
+        shard: @shard,
         scope: @scope
       )
       unless validate_only

data/lib/openc3/models/microservice_model.rb

@@ -44,6 +44,7 @@ module OpenC3
     attr_accessor :prefix
     attr_accessor :disable_erb
     attr_accessor :ignore_changes
+    attr_accessor :shard
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -105,6 +106,7 @@ module OpenC3
       prefix: nil,
       disable_erb: nil,
       ignore_changes: nil,
+      shard: 0,
       scope:
     )
       parts = name.split("__")
@@ -131,6 +133,7 @@ module OpenC3
       @prefix = prefix
       @disable_erb = disable_erb
       @ignore_changes = ignore_changes
+      @shard = shard.to_i # to_i to handle nil
       @bucket = Bucket.getClient()
     end
 
@@ -153,7 +156,8 @@ module OpenC3
         'secrets' => @secrets.as_json(*a),
         'prefix' => @prefix,
         'disable_erb' => @disable_erb,
-        'ignore_changes' => @ignore_changes
+        'ignore_changes' => @ignore_changes,
+        'shard' => @shard,
       }
     end
 
@@ -215,6 +219,9 @@ module OpenC3
         if parameters
           @disable_erb.concat(parameters)
         end
+      when 'SHARD'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Shard Number Starting from 0>")
+        @shard = Integer(parameters[0])
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
       end

data/lib/openc3/models/plugin_model.rb

@@ -200,7 +200,12 @@ module OpenC3
           end
           unless validate_only
             Logger.info "Installing python packages from requirements.txt with pypi_url=#{pypi_url}"
-            puts `/openc3/bin/pipinstall --no-warn-script-location -i #{pypi_url} -r #{File.join(gem_path, 'requirements.txt')}`
+            if ENV['PIP_ENABLE_TRUSTED_HOST'].nil?
+              pip_args = "--no-warn-script-location -i #{pypi_url} -r #{File.join(gem_path, 'requirements.txt')}"
+            else
+              pip_args = "--no-warn-script-location -i #{pypi_url} --trusted-host #{URI.parse(pypi_url).host} -r #{File.join(gem_path, 'requirements.txt')}"
+            end
+            puts `/openc3/bin/pipinstall #{pip_args}`
           end
           needs_dependencies = true
         end

data/lib/openc3/models/python_package_model.rb

@@ -92,7 +92,12 @@ module OpenC3
         end
       end
       Logger.info "Installing python package: #{name_or_path}"
-      result = OpenC3::ProcessManager.instance.spawn(["/openc3/bin/pipinstall", "--no-warn-script-location", "-i", pypi_url, package_file_path], "package_install", package_filename, Time.now + 3600.0, scope: scope)
+      if ENV['PIP_ENABLE_TRUSTED_HOST'].nil?
+        pip_args = ["--no-warn-script-location", "-i", pypi_url, package_file_path]
+      else
+        pip_args = ["--no-warn-script-location", "-i", pypi_url, "--trusted-host", URI.parse(pypi_url).host, package_file_path]
+      end
+      result = OpenC3::ProcessManager.instance.spawn(["/openc3/bin/pipinstall"] + pip_args, "package_install", package_filename, Time.now + 3600.0, scope: scope)
       return result.name
     end
 

data/lib/openc3/models/reaction_model.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -81,8 +81,8 @@ module OpenC3
       model.undeploy()
     end
 
-    attr_reader :name, :scope, :snooze, :triggers, :actions, :enabled, :triggerLevel, :snoozed_until
-    attr_accessor :username
+    attr_reader :name, :scope, :snooze, :triggers, :actions, :enabled, :trigger_level, :snoozed_until
+    attr_accessor :username, :shard
 
     def initialize(
       name:,
@@ -90,27 +90,29 @@ module OpenC3
       snooze:,
       actions:,
       triggers:,
-      triggerLevel:,
+      trigger_level:,
       enabled: true,
       snoozed_until: nil,
       username: nil,
+      shard: 0,
       updated_at: nil
     )
       super("#{scope}#{PRIMARY_KEY}", name: name, scope: scope)
       @microservice_name = "#{scope}__OPENC3__REACTION"
       @enabled = enabled
       @snoozed_until = snoozed_until
-      @triggerLevel = validate_level(triggerLevel)
+      @trigger_level = validate_level(trigger_level)
       @snooze = validate_snooze(snooze)
       @actions = validate_actions(actions)
       @triggers = validate_triggers(triggers)
       @username = username
+      @shard = shard.to_i # to_i to handle nil
       @updated_at = updated_at
     end
 
     # Modifiers for the reaction_controller update action
-    def triggerLevel=(triggerLevel)
-      @triggerLevel = validate_level(triggerLevel)
+    def trigger_level=(trigger_level)
+      @trigger_level = validate_level(trigger_level)
     end
     def snooze=(snooze)
       @snooze = validate_snooze(snooze)
@@ -127,7 +129,7 @@ module OpenC3
       when 'EDGE', 'LEVEL'
         return level
       else
-        raise ReactionInputError.new "invalid triggerLevel, must be EDGE or LEVEL: #{level}"
+        raise ReactionInputError.new "invalid trigger level, must be EDGE or LEVEL: #{level}"
       end
     end
 
@@ -257,12 +259,13 @@ module OpenC3
         'name' => @name,
         'scope' => @scope,
         'enabled' => @enabled,
-        'triggerLevel' => @triggerLevel,
+        'trigger_level' => @trigger_level,
         'snooze' => @snooze,
         'snoozed_until' => @snoozed_until,
         'triggers' => @triggers,
         'actions' => @actions,
         'username' => @username,
+        'shard' => @shard,
         'updated_at' => @updated_at
       }
     end
@@ -290,11 +293,12 @@ module OpenC3
         name: @microservice_name,
         folder_name: nil,
         cmd: ['ruby', 'reaction_microservice.rb', @microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: '/openc3-enterprise/lib/openc3-enterprise/microservices',
         options: [],
         topics: topics,
         target_names: [],
         plugin: nil,
+        shard: @shard,
         scope: @scope
       )
       microservice.create