rspec-openhab-scripting 1.0.0

data/lib/rspec/openhab/karaf.rb

@@ -0,0 +1,733 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "jruby"
+require "set"
+require "shellwords"
+require "time"
+
+require_relative "jruby"
+require_relative "shell"
+
+module RSpec
+  module OpenHAB
+    class Karaf
+      class ScriptExtensionManagerWrapper
+        def initialize(manager)
+          @manager = manager
+        end
+
+        def get(type)
+          @manager.get(type, "jruby")
+        end
+      end
+      private_constant :ScriptExtensionManagerWrapper
+
+      attr_reader :path
+      attr_accessor :include_bindings, :include_jsondb, :private_confdir, :use_root_instance
+
+      def initialize(path = nil)
+        @path = path
+        @include_bindings = true
+        @include_jsondb = true
+        @private_confdir = false
+        @use_root_instance = false
+      end
+
+      def launch
+        raise ArgumentError, "Path must be supplied if use_root_instance is false" unless path || use_root_instance
+
+        @path = oh_home if use_root_instance
+
+        load_boot_jars
+        set_env
+        set_java_properties
+        set_java_properties_from_env
+        unless use_root_instance
+          redirect_instances
+          create_instance
+        end
+        start_instance
+      end
+
+      private
+
+      # create a private instances configuration
+      def redirect_instances
+        # this is normally done directly in bin/karaf with a -D JAVA_OPT
+        orig_instances = "#{java.lang.System.get_property("karaf.data")}/tmp/instances"
+
+        instances_path = "#{path}/instances"
+        java.lang.System.set_property("karaf.instances", instances_path)
+        FileUtils.mkdir_p(instances_path)
+
+        new_instance_properties = "#{instances_path}/instance.properties"
+        return if File.exist?(new_instance_properties) && File.stat(new_instance_properties).size != 0
+
+        FileUtils.cp("#{orig_instances}/instance.properties", new_instance_properties)
+      end
+
+      def create_instance
+        find_karaf_instance_jar
+        # OSGI isn't up yet, so have to create the service directly
+        service = org.apache.karaf.instance.core.internal.InstanceServiceImpl.new
+        settings = org.apache.karaf.instance.core.InstanceSettings.new(0, 0, 0, path, nil, nil, nil)
+        root_instance = service.instances.find(&:root?)
+        raise ArgumentError "No root instance found to clone... has OpenHAB run yet?" unless root_instance
+
+        return if service.get_instance("rspec")
+
+        service.clone_instance(root_instance.name, "rspec", settings, false)
+      ensure
+        extra_loaders = ::JRuby.runtime.instance_config.extra_loaders
+        loader = extra_loaders.find { |l| l.class_loader == @karaf_instance_loader }
+        extra_loaders.remove(loader)
+      end
+
+      def start_instance
+        unless use_root_instance
+          # these are all from karaf.instances's startup code with
+          # the exception of not having data be a subdir
+          java.lang.System.set_property("karaf.base", path)
+          java.lang.System.set_property("karaf.data", path)
+          java.lang.System.set_property("karaf.etc", "#{path}/etc")
+          java.lang.System.set_property("karaf.log", "#{path}/logs")
+          java.lang.System.set_property("java.io.tmpdir", "#{path}/tmp")
+          java.lang.System.set_property("karaf.startLocalConsole", "false")
+          java.lang.System.set_property("karaf.startRemoteShell", "false")
+          # set in bin/setenv to OPENHAB_USERDATA; need to move it
+          java.lang.System.set_property("felix.cm.dir", felix_cm)
+          # not handled by karaf instances
+          java.lang.System.set_property("openhab.userdata", path)
+          java.lang.System.set_property("openhab.logdir", "#{path}/logs")
+        end
+        cleanup_instance
+        # we don't need a shutdown socket
+        java.lang.System.set_property("karaf.shutdown.port", "-1")
+        # ensure we're not logging to stdout
+        java.util.logging.LogManager.log_manager.reset
+
+        # launch it! (don't use Main.main; it will wait for it to be
+        # shut down externally)
+        @all_bundles_continue = nil
+        @class_loaders = Set.new
+        @main = org.apache.karaf.main.Main.new([])
+        launch_karaf
+        at_exit do
+          @main.destroy
+          # OSGi/OpenHAB leave a ton of threads around. Kill ourselves ASAP
+          code = if $!.nil? || ($!.is_a?(SystemExit) && $!.success?)
+                   0
+                 elsif $!.is_a?(SystemExit)
+                   $!.status
+                 else
+                   puts $!.inspect
+                   1
+                 end
+          exit!(code)
+        end
+
+        set_up_bundle_listener
+        wait_for_start
+        set_jruby_script_presets
+        @main
+      end
+
+      def launch_karaf
+        # we need to access internals, since we're reproducing much of Main.launch
+        klass = org.apache.karaf.main.Main
+        klass.field_accessor :classLoader, :activatorManager
+        klass.field_writer :framework
+        klass.field_reader :LOG
+        org.apache.karaf.main.ConfigProperties.field_reader :props, :defaultBundleStartlevel, :karafEtc,
+                                                            :defaultStartLevel
+        klass.class_eval do
+          def send_private(method_name, *args)
+            method_name = method_name.to_s
+            method = self.class.java_class.declared_methods.find { |m| m.name == method_name }
+            method.accessible = true
+            method.invoke(self, *args)
+          end
+
+          def launch_simple
+            self.config = org.apache.karaf.main.ConfigProperties.new
+            config.perform_init
+            log4j_config_path = "#{java.lang.System.get_property("karaf.etc")}/org.ops4j.pax.logging.cfg"
+            org.apache.karaf.main.util.BootstrapLogManager.set_properties(config.props, log4j_config_path)
+            org.apache.karaf.main.util.BootstrapLogManager.configure_logger(self.class.LOG)
+
+            bundle_dirs = send_private(:getBundleRepos)
+            resolver = org.apache.karaf.main.util.SimpleMavenResolver.new(bundle_dirs)
+            self.classLoader = send_private(:createClassLoader, resolver)
+            factory = send_private(:loadFrameworkFactory, classLoader)
+            self.framework = factory.new_framework(config.props)
+
+            send_private(:setLogger)
+
+            framework.init
+            framework.start
+
+            sl = framework.adapt(org.osgi.framework.startlevel.FrameworkStartLevel.java_class)
+            sl.initial_bundle_start_level = config.defaultBundleStartlevel
+
+            if framework.bundle_context.bundles.length == 1
+              self.class.LOG.info("Installing and starting initial bundles")
+              startup_props_file = java.io.File.new(config.karafEtc, self.class::STARTUP_PROPERTIES_FILE_NAME)
+              bundles = read_bundles_from_startup_properties(startup_props_file)
+              send_private(:installAndStartBundles, resolver, framework.bundle_context, bundles)
+              self.class.LOG.info("All initial bundles installed and set to start")
+            end
+
+            server_info = org.apache.karaf.main.ServerInfoImpl.new(args, config)
+            framework.bundle_context.register_service(org.apache.karaf.info.ServerInfo.java_class, server_info, nil)
+
+            self.activatorManager = org.apache.karaf.main.KarafActivatorManager.new(classLoader, framework)
+
+            # let the caller register services now that the framework is up,
+            # but nothing is running yet
+            yield framework.bundle_context
+
+            set_start_level(config.defaultStartLevel)
+          end
+        end
+
+        @main.launch_simple do
+          # hook up the OSGI class loader manually
+          add_class_loader(@main.framework)
+
+          @framework = @main.framework
+          @bundle_context = @main.framework.bundle_context
+
+          # prevent entirely blocked bundles from starting at all
+          @main.framework.bundle_context.bundles.each do |b|
+            sl = b.adapt(org.osgi.framework.startlevel.BundleStartLevel.java_class)
+            if (start_level = START_LEVEL_OVERRIDES[b.symbolic_name])
+              sl.start_level = start_level
+            end
+            sl.start_level = @main.config.defaultStartLevel + 1 if blocked_bundle?(b)
+          end
+
+          prune_startlevels
+
+          set_up_service_listener
+          # replace event infrastructure with synchronous versions
+          wait_for_service("org.osgi.service.event.EventAdmin") do |service|
+            next if defined?(OpenHAB::Core::Mocks::EventAdmin) && service.is_a?(OpenHAB::Core::Mocks::EventAdmin)
+
+            require "rspec/openhab/core/mocks/event_admin"
+            ea = OpenHAB::Core::Mocks::EventAdmin.new(@bundle_context)
+            bundle = org.osgi.framework.FrameworkUtil.get_bundle(service.class)
+            # we need to register it as if from the regular eventadmin bundle so other bundles
+            # can properly find it
+            bundle.bundle_context.register_service(
+              org.osgi.service.event.EventAdmin.java_class,
+              ea,
+              java.util.Hashtable.new(org.osgi.framework.Constants::SERVICE_RANKING => 1.to_java(:int))
+            )
+          end
+          wait_for_service("org.apache.karaf.features.FeaturesService") do |fs|
+            require "rspec/openhab/core/mocks/bundle_install_support"
+            fs.class.field_reader :installSupport
+            field = fs.class.java_class.get_declared_field("installSupport")
+            field.accessible = true
+            field.set(fs, OpenHAB::Core::Mocks::BundleInstallSupport.new(fs.installSupport, self))
+          end
+          wait_for_service("org.osgi.service.cm.ConfigurationAdmin") do |ca|
+            cfg = ca.get_configuration("org.openhab.addons", nil)
+            props = cfg.properties || java.util.Hashtable.new
+            # remove all non-binding addons
+            props.remove("misc")
+            props.remove("package")
+            props.remove("persistence")
+            props.remove("transformation")
+            props.remove("ui")
+            props.remove("binding") unless include_bindings
+            # except we need jrubyscripting
+            props.put("automation", "jrubyscripting")
+            cfg.update(props)
+
+            # configure persistence to use the mock service
+            cfg = ca.get_configuration("org.openhab.persistence", nil)
+            props = cfg.properties || java.util.Hashtable.new
+            props.put("default", "default")
+            cfg.update(props)
+          end
+          wait_for_service("org.openhab.core.automation.RuleManager") do |re|
+            require "rspec/openhab/core/mocks/synchronous_executor"
+            # overwrite thCallbacks to one that will spy to remove threading
+            field = re.class.java_class.declared_field :thCallbacks
+            field.accessible = true
+            field.set(re, Core::Mocks::CallbacksMap.new)
+            re.class.field_accessor :executor
+            re.executor = Core::Mocks::SynchronousExecutor.instance
+          end
+        end
+      end
+
+      # entire bundle trees that are allowed to be installed,
+      # but not started
+      BLOCKED_BUNDLE_TREES = %w[
+        org.apache.karaf.jaas
+        org.apache.sshd
+        org.eclipse.jetty
+        org.ops4j.pax.web
+        org.openhab.automation
+        org.openhab.binding
+        org.openhab.core.io
+        org.openhab.io
+        org.openhab.transform
+      ].freeze
+      private_constant :BLOCKED_BUNDLE_TREES
+
+      ALLOWED_BUNDLES = %w[
+        org.openhab.automation.jrubyscripting
+        org.openhab.core.io.monitor
+      ].freeze
+      private_constant :ALLOWED_BUNDLES
+
+      BLOCKED_COMPONENTS = {
+        "org.openhab.core" => %w[
+          org.openhab.core.addon.AddonEventFactory
+          org.openhab.core.binding.BindingInfoRegistry
+          org.openhab.core.binding.i18n.BindingI18nLocalizationService
+          org.openhab.core.internal.auth.ManagedUserProvider
+          org.openhab.core.internal.auth.UserRegistryImpl
+        ].freeze,
+        "org.openhab.core.automation.module.script.rulesupport" => %w[
+          org.openhab.core.automation.module.script.rulesupport.internal.loader.DefaultScriptFileWatcher
+        ].freeze,
+        "org.openhab.core.config.core" => %w[
+          org.openhab.core.config.core.internal.i18n.I18nConfigOptionsProvider
+          org.openhab.core.config.core.status.ConfigStatusService
+          org.openhab.core.config.core.status.events.ConfigStatusEventFactory
+        ],
+        "org.openhab.core.model.script" => %w[
+          org.openhab.core.model.script.internal.RuleHumanLanguageInterpreter
+          org.openhab.core.model.script.internal.engine.action.VoiceActionService
+          org.openhab.core.model.script.jvmmodel.ScriptItemRefresher
+        ].freeze,
+        "org.openhab.core.thing" => %w[
+          org.openhab.core.thing.internal.console.FirmwareUpdateConsoleCommandExtension
+        ],
+        # the following bundles are blocked completely from starting
+        "org.apache.felix.fileinstall" => nil,
+        "org.apache.karaf.http.core" => nil,
+        "org.apache.karaf.features.command" => nil,
+        "org.apache.karaf.shell.commands" => nil,
+        "org.apache.karaf.shell.core" => nil,
+        "org.apache.karaf.shell.ssh" => nil,
+        "org.openhab.core.audio" => nil,
+        "org.openhab.core.automation.module.media" => nil,
+        "org.openhab.core.config.discovery" => nil,
+        "org.openhab.core.model.lsp" => nil,
+        "org.openhab.core.model.rule.runtime" => nil,
+        "org.openhab.core.model.rule" => nil,
+        "org.openhab.core.model.sitemap.runtime" => nil,
+        "org.openhab.core.voice" => nil
+      }.freeze
+      private_constant :BLOCKED_COMPONENTS
+
+      START_LEVEL_OVERRIDES = {
+      }.freeze
+      private_constant :START_LEVEL_OVERRIDES
+
+      def set_up_bundle_listener
+        @thing_type_tracker = @config_description_tracker = nil
+        wait_for_service("org.openhab.core.thing.binding.ThingTypeProvider",
+                         filter: "(openhab.scope=core.xml.thing)") do |ttp|
+          ttp.class.field_reader :thingTypeTracker
+          @thing_type_tracker = ttp.thingTypeTracker
+          @thing_type_tracker.class.field_reader :openState
+          org.openhab.core.config.xml.osgi.XmlDocumentBundleTracker::OpenState.field_reader :OPENED
+          opened = org.openhab.core.config.xml.osgi.XmlDocumentBundleTracker::OpenState.OPENED
+          sleep until @thing_type_tracker.openState == opened
+          @bundle_context.bundles.each do |bundle|
+            @thing_type_tracker.adding_bundle(bundle, nil)
+          end
+        end
+        wait_for_service("org.openhab.core.config.core.ConfigDescriptionProvider",
+                         filter: "(openhab.scope=core.xml.config)") do |cdp|
+          cdp.class.field_reader :configDescriptionTracker
+          @config_description_tracker = cdp.configDescriptionTracker
+          @config_description_tracker.class.field_reader :openState
+          org.openhab.core.config.xml.osgi.XmlDocumentBundleTracker::OpenState.field_reader :OPENED
+          opened = org.openhab.core.config.xml.osgi.XmlDocumentBundleTracker::OpenState.OPENED
+          sleep until @config_description_tracker.openState == opened
+          @bundle_context.bundles.each do |bundle|
+            @config_description_tracker.adding_bundle(bundle, nil)
+          end
+        end
+        wait_for_service("org.osgi.service.component.runtime.ServiceComponentRuntime") { |scr| @scr = scr }
+        @bundle_context.add_bundle_listener do |event|
+          bundle = event.bundle
+          bundle_name = bundle.symbolic_name
+          sl = bundle.adapt(org.osgi.framework.startlevel.BundleStartLevel.java_class)
+          if (start_level = START_LEVEL_OVERRIDES[bundle_name])
+            sl.start_level = start_level
+          end
+          sl.start_level = @main.config.defaultStartLevel + 1 if blocked_bundle?(bundle)
+
+          if event.type == org.osgi.framework.BundleEvent::RESOLVED
+            @thing_type_tracker&.adding_bundle(event.bundle, nil)
+            @config_description_tracker&.adding_bundle(event.bundle, nil)
+          end
+          next unless event.type == org.osgi.framework.BundleEvent::STARTED
+
+          # just in case
+          raise "blocked bundle #{bundle.symbolic_name} started!" if blocked_bundle?(bundle)
+
+          add_class_loader(bundle)
+
+          # as soon as we _can_ do this, do it
+          link_osgi if bundle.get_resource("org/slf4j/LoggerFactory.class")
+
+          if @all_bundles_continue && all_bundles_started?
+            @all_bundles_continue.call
+            @all_bundles_continue = nil
+          end
+
+          if bundle_name == "org.openhab.core"
+            require "rspec/openhab/core/mocks/synchronous_executor"
+
+            org.openhab.core.common.ThreadPoolManager.field_accessor :pools
+            org.openhab.core.common.ThreadPoolManager.pools = Core::Mocks::SynchronousExecutorMap.instance
+          end
+          if bundle_name == "org.openhab.core.thing"
+            require "rspec/openhab/core/mocks/bundle_resolver"
+            bundle.bundle_context.register_service(
+              org.openhab.core.util.BundleResolver.java_class,
+              Core::Mocks::BundleResolver.instance,
+              java.util.Hashtable.new(org.osgi.framework.Constants::SERVICE_RANKING => 1.to_java(:int))
+            )
+
+            require "rspec/openhab/core/mocks/thing_handler"
+            thf = Core::Mocks::ThingHandlerFactory.instance
+            bundle = org.osgi.framework.FrameworkUtil.get_bundle(org.openhab.core.thing.Thing)
+            Core::Mocks::BundleResolver.instance.register_class(thf.class, bundle)
+            bundle.bundle_context.register_service(org.openhab.core.thing.binding.ThingHandlerFactory.java_class, thf,
+                                                   nil)
+          end
+          if bundle_name == "org.openhab.core.automation"
+            org.openhab.core.automation.internal.TriggerHandlerCallbackImpl.field_accessor :executor
+          end
+
+          next unless BLOCKED_COMPONENTS.key?(bundle_name)
+
+          components = BLOCKED_COMPONENTS[bundle_name]
+          dtos = if components.nil?
+                   @scr.get_component_description_dt_os(bundle)
+                 else
+                   Array(components).map { |component| @scr.get_component_description_dto(bundle, component) }
+                 end.compact
+          dtos.each do |dto|
+            @scr.disable_component(dto) if @scr.component_enabled?(dto)
+          end
+        rescue Exception => e
+          puts e.inspect
+          puts e.backtrace
+        end
+        @bundle_context.bundles.each do |bundle|
+          next unless bundle.symbolic_name.start_with?("org.openhab.core")
+
+          add_class_loader(bundle)
+        end
+      end
+
+      def set_up_service_listener
+        @awaiting_services = {}
+        @bundle_context.add_service_listener do |event|
+          next unless event.type == org.osgi.framework.ServiceEvent::REGISTERED
+
+          ref = event.service_reference
+          service = nil
+
+          ref.get_property(org.osgi.framework.Constants::OBJECTCLASS).each do |klass|
+            next unless @awaiting_services.key?(klass)
+
+            @awaiting_services[klass].each do |(block, filter)|
+              service ||= @bundle_context.get_service(ref)
+              next if filter && !filter.match(ref)
+
+              service ||= @bundle_context.get_service(ref)
+              break unless service
+
+              bundle = org.osgi.framework.FrameworkUtil.get_bundle(service.class)
+              add_class_loader(bundle) if bundle
+              block.call(service)
+            end
+          end
+        rescue Exception => e
+          puts e.inspect
+          puts e.backtrace
+        end
+      end
+
+      def add_class_loader(bundle)
+        return if @class_loaders.include?(bundle.symbolic_name)
+
+        @class_loaders << bundle.symbolic_name
+        ::JRuby.runtime.instance_config.add_loader(JRuby::OSGiBundleClassLoader.new(bundle))
+      end
+
+      def wait_for_service(service_name, filter: nil, &block)
+        if defined?(::OpenHAB::Core::OSGI) &&
+           (services = ::OpenHAB::Core::OSGI.services(service_name, filter: filter))
+          services.each(&block)
+        end
+
+        waiters = @awaiting_services[service_name] ||= []
+        waiters << [block, filter && @bundle_context.create_filter(filter)]
+      end
+
+      def wait_for_start
+        wait do |continue|
+          @all_bundles_continue = continue
+          next continue.call if all_bundles_started?
+        end
+      end
+
+      def all_bundles_started?
+        has_core = false
+        result = @bundle_context.bundles.all? do |b|
+          has_core = true if b.symbolic_name == "org.openhab.core"
+          b.state == org.osgi.framework.Bundle::ACTIVE ||
+            blocked_bundle?(b)
+        end
+
+        result && has_core
+      end
+
+      def blocked_bundle?(bundle)
+        return false if ALLOWED_BUNDLES.include?(bundle.symbolic_name)
+
+        BLOCKED_COMPONENTS.fetch(bundle.symbolic_name, false).nil? ||
+          BLOCKED_BUNDLE_TREES.any? { |tree| bundle.symbolic_name.start_with?(tree) } ||
+          bundle.fragment?
+      end
+
+      def wait
+        mutex = Mutex.new
+        cond = ConditionVariable.new
+        skip_wait = false
+
+        continue = lambda do
+          # if continue was called synchronously, we can just return
+          next skip_wait = true if mutex.owned?
+
+          mutex.synchronize { cond.signal }
+        end
+        mutex.synchronize do
+          yield continue
+          cond.wait(mutex) unless skip_wait
+        end
+      end
+
+      def link_osgi
+        ::OpenHAB::Core::OSGI.instance_variable_set(:@bundle, @framework) if require "openhab/core/osgi"
+      end
+
+      # import global variables and constants that openhab-scripting gem expects,
+      # since we're going to be running it in this same VM
+      def set_jruby_script_presets
+        wait_for_service("org.openhab.core.automation.module.script.internal.ScriptExtensionManager") do |sem|
+          # since we're not created by the ScriptEngineManager, this never gets set; manually set it
+          $se = $scriptExtension = ScriptExtensionManagerWrapper.new(sem)
+          scope_values = sem.find_default_presets("rspec")
+          scope_values = scope_values.entry_set
+          jrubyscripting = ::OpenHAB::Core::OSGI.services(
+            "org.openhab.core.automation.module.script.ScriptEngineFactory",
+            filter: "(service.pid=org.openhab.automation.jrubyscripting)"
+          ).first
+
+          %w[mapInstancePresets mapGlobalPresets].each do |method_name|
+            method = jrubyscripting.class.java_class.get_declared_method(method_name, java.util.Map::Entry.java_class)
+
+            method.accessible = true
+            scope_values = scope_values.map { |e| method.invoke(nil, e) }
+          end
+
+          scope_values.each do |entry|
+            key = entry.key
+            value = entry.value
+            # convert Java classes to Ruby classes
+            value = value.ruby_class if value.is_a?(java.lang.Class) # rubocop:disable Lint/UselessAssignment
+            # constants need to go into the global namespace
+            key = "::#{key}" if ("A".."Z").cover?(key[0])
+            eval("#{key} = value unless defined?(#{key})", nil, __FILE__, __LINE__) # rubocop:disable Security/Eval
+          end
+        end
+      end
+
+      # instance isn't part of the boot jars, but we need access to it
+      # before we boot karaf in order to create the clone, so we have to
+      # find it manually
+      def find_karaf_instance_jar
+        resolver = org.apache.karaf.main.util.SimpleMavenResolver.new([java.io.File.new("#{oh_runtime}/system")])
+        slf4j_version = find_maven_jar_version("org.ops4j.pax.logging", "pax-logging-api")
+        slf4j = resolver.resolve(java.net.URI.new("mvn:org.ops4j.pax.logging/pax-logging-api/#{slf4j_version}"))
+        karaf_version = find_jar_version("#{oh_runtime}/lib/boot", "org.apache.karaf.main")
+        karaf_instance = resolver.resolve(
+          java.net.URI.new(
+            "mvn:org.apache.karaf.instance/org.apache.karaf.instance.core/#{karaf_version}"
+          )
+        )
+        @karaf_instance_loader = java.net.URLClassLoader.new(
+          [slf4j.to_url, karaf_instance.to_url].to_java(java.net.URL), ::JRuby.runtime.jruby_class_loader
+        )
+        ::JRuby.runtime.instance_config.add_loader(@karaf_instance_loader)
+      end
+
+      def find_maven_jar_version(group, bundle)
+        Dir["#{oh_runtime}/system/#{group.tr(".", "/")}/#{bundle}/*"].map { |version| version.split("/").last }.max
+      end
+
+      def find_jar_version(path, bundle)
+        prefix = "#{path}/#{bundle}-"
+        Dir["#{prefix}*.jar"].map { |jar| jar.split("-", 2).last[0...-4] }.max
+      end
+
+      def load_boot_jars
+        (Dir["#{oh_runtime}/lib/boot/*.jar"] +
+        Dir["#{oh_runtime}/lib/endorsed/*.jar"] +
+        Dir["#{oh_runtime}/lib/jdk9plus/*.jar"]).each do |jar|
+          require jar
+        end
+      end
+
+      def set_env
+        ENV["DIRNAME"] = "#{oh_runtime}/bin"
+        ENV["KARAF_HOME"] = oh_runtime
+        if private_confdir
+          ENV["OPENHAB_CONF"] = "#{path}/conf"
+          FileUtils.mkdir_p([
+                              "#{path}/conf/items",
+                              "#{path}/conf/things",
+                              "#{path}/conf/scripts",
+                              "#{path}/conf/rules",
+                              "#{path}/conf/persistence",
+                              "#{path}/conf/sitemaps",
+                              "#{path}/conf/transform"
+                            ])
+        end
+        Shell.source_env_from("#{oh_runtime}/bin/setenv")
+      end
+
+      def set_java_properties
+        [ENV.fetch("JAVA_OPTS", nil), ENV.fetch("EXTRA_JAVA_OPTS", nil)].compact.each do |java_opts|
+          Shellwords.split(java_opts).each do |arg|
+            next unless arg.start_with?("-D")
+
+            k, v = arg[2..].split("=", 2)
+            java.lang.System.set_property(k, v)
+          end
+        end
+      end
+
+      # we can't set Java ENV directly, so we have to try and set some things
+      # as system properties
+      def set_java_properties_from_env
+        ENV.each do |(k, v)|
+          next unless k.match?(/^(?:KARAF|OPENHAB)_/)
+
+          prop = k.downcase.tr("_", ".")
+          next unless java.lang.System.get_property(prop).nil?
+
+          java.lang.System.set_property(prop, v)
+        end
+      end
+
+      def oh_home
+        @oh_home ||= ENV.fetch("OPENHAB_HOME", "/usr/share/openhab")
+      end
+
+      def oh_runtime
+        @oh_runtime ||= ENV.fetch("OPENHAB_RUNTIME", "#{oh_home}/runtime")
+      end
+
+      def oh_conf
+        @oh_conf ||= ENV.fetch("OPENHAB_CONF")
+      end
+
+      def oh_userdata
+        @oh_userdata ||= java.lang.System.get_property("openhab.userdata")
+      end
+
+      def felix_cm
+        @felix_cm ||= use_root_instance ? ENV.fetch("OPENHAB_USERDATA") : "#{path}/config"
+      end
+
+      def cleanup_instance
+        cleanup_clone
+        minimize_installed_features
+      end
+
+      def cleanup_clone
+        FileUtils.rm_rf(["#{oh_userdata}/cache",
+                         "#{oh_userdata}/jsondb/backup",
+                         "#{oh_userdata}/marketplace",
+                         "#{oh_userdata}/logs/*",
+                         "#{oh_userdata}/tmp/*",
+                         "#{oh_userdata}/jsondb/org.openhab.marketplace.json",
+                         "#{oh_userdata}/jsondb/org.openhab.jsonaddonservice.json",
+                         "#{felix_cm}/org/openhab/jsonaddonservice.config"])
+        FileUtils.rm_rf("#{oh_userdata}/jsondb") unless include_jsondb
+      end
+
+      def prune_startlevels
+        config_file = java.lang.System.get_property("openhab.servicecfg")
+        return unless File.exist?(config_file)
+
+        startlevels = File.read(config_file)
+        startlevels.sub!(",rules:refresh,rules:dslprovider", "")
+
+        target_file = "#{oh_userdata}/etc/services.cfg"
+        target_file_contents = File.read(target_file) if File.exist?(target_file)
+        File.write(target_file, startlevels) unless target_file_contents == startlevels
+        java.lang.System.set_property("openhab.servicecfg", target_file)
+      end
+
+      def minimize_installed_features
+        # cuts down openhab-runtime-base significantly, makes sure
+        # openhab-runtime-ui doesn't get installed (from profile.cfg),
+        # double-makes-sure no addons get installed, and marks several
+        # bundles to not actually start, even though they must still be
+        # installed to meet dependencies
+        version = find_maven_jar_version("org.openhab.core.bundles", "org.openhab.core")
+        File.write("#{oh_userdata}/etc/org.apache.karaf.features.xml", <<~XML)
+          <?xml version="1.0" encoding="UTF-8"?>
+          <featuresProcessing xmlns="http://karaf.apache.org/xmlns/features-processing/v1.0.0" xmlns:f="http://karaf.apache.org/xmlns/features/v1.6.0">
+              <blacklistedFeatures>
+                <feature>openhab-runtime-ui</feature>
+                <feature>openhab-core-ui*</feature>
+                <feature>openhab-misc-*</feature>
+                <feature>openhab-persistence-*</feature>
+                <feature>openhab-package-standard</feature>
+                <feature>openhab-ui-*</feature>
+                <feature>openhab-voice-*</feature>
+              </blacklistedFeatures>
+              <featureReplacements>
+                <replacement mode="replace">
+                  <feature name="openhab-runtime-base" version="#{version.sub("-", ".")}">
+                    <f:feature>openhab-core-base</f:feature>
+                    <f:feature>openhab-core-automation-module-script</f:feature>
+                    <f:feature>openhab-core-automation-module-script-rulesupport</f:feature>
+                    <f:feature>openhab-core-automation-module-media</f:feature>
+                    <f:feature>openhab-core-model-item</f:feature>
+                    <f:feature>openhab-core-model-persistence</f:feature>
+                    <f:feature>openhab-core-model-rule</f:feature>
+                    <f:feature>openhab-core-model-script</f:feature>
+                    <f:feature>openhab-core-model-sitemap</f:feature>
+                    <f:feature>openhab-core-model-thing</f:feature>
+                    <f:feature>openhab-core-storage-json</f:feature>
+                    <f:feature>openhab-automation-jrubyscripting</f:feature>
+                    <f:feature>openhab-transport-http</f:feature>
+                    <f:bundle>mvn:org.openhab.core.bundles/org.openhab.core.karaf/#{version}</f:bundle>
+                  </feature>
+                </replacement>
+              </featureReplacements>
+          </featuresProcessing>
+        XML
+      end
+    end
+  end
+end