openvox-editor-services 3.0.0

data/lib/puppet_editor_services/version.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PuppetEditorServices
+  PUPPETEDITORSERVICESVERSION = '3.0.0' unless defined? PUPPETEDITORSERVICESVERSION
+
+  # @api public
+  #
+  # @return [String] containing the editor services version, e.g. "0.4.0"
+  def self.version
+    return @editor_services_version if @editor_services_version
+
+    version_file = File.join(File.dirname(__FILE__), 'VERSION')
+    version = read_version_file(version_file)
+
+    @editor_services_version = version.nil? ? PUPPETEDITORSERVICESVERSION : version
+  end
+
+  # Sets the editor services version
+  # Typically only used in testing
+  #
+  # @return [void]
+  #
+  # @api private
+  def self.version=(version)
+    @editor_services_version = version
+  end
+
+  # @api private
+  #
+  # @return [String] the version -- for example: "0.4.0" or nil if the VERSION
+  #   file does not exist.
+  def self.read_version_file(path)
+    File.read(path).chomp if File.exist?(path)
+  end
+  private_class_method :read_version_file
+end

data/lib/puppet_editor_services.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+%w[
+  logging
+  version
+].each do |lib|
+  require "puppet_editor_services/#{lib}"
+end

data/lib/puppet_languageserver.rb

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+
+begin
+  original_verbose = $VERBOSE
+  $VERBOSE = nil
+
+  require 'puppet_editor_services'
+  require 'openvox_runtime'
+  require 'openfact_runtime'
+  require 'optparse'
+  require 'logger'
+ensure
+  $VERBOSE = original_verbose
+end
+
+module PuppetLanguageServer
+  def self.version
+    PuppetEditorServices.version
+  end
+
+  # Whether the language server is actually in a state that can be used.
+  # Typically this is false when a catastrophic error occurs during startup e.g. Puppet is missing.
+  #
+  # @return [Bool] Whether the language server is actually in a state that can be used
+  def self.active?
+    @server_is_active
+  end
+
+  def self.static_data_dir
+    @static_data_dir ||= File.expand_path(File.join(__dir__, 'puppet-languageserver', 'static_data'))
+  end
+
+  def self.configure_featureflags(flags)
+    @flags = flags
+  end
+
+  def self.featureflag?(flagname)
+    return false if @flags.nil? || @flags.empty?
+
+    @flags.include?(flagname)
+  end
+
+  def self.require_gems(options)
+    original_verbose = $VERBOSE
+    $VERBOSE = nil
+    @server_is_active = false
+
+    # Use a specific OpenVox Gem version if requested.
+    if options[:puppet_version].nil?
+      OpenVoxRuntime.activate!
+    else
+      available_openvox_gems = OpenVoxRuntime.available_versions
+      if available_openvox_gems.include?(options[:puppet_version])
+        OpenVoxRuntime.activate!(options[:puppet_version])
+      else
+        log_message(:warn, "Unable to use OpenVox version #{options[:puppet_version]}, as only the following versions are available [#{available_openvox_gems.join(', ')}]")
+        OpenVoxRuntime.activate!
+      end
+    end
+
+    # These libraries do not require the puppet gem and required for the
+    # server to respond to clients.
+    %w[
+      client_session_state
+      crash_dump
+      message_handler
+      server_capabilities
+    ].each do |lib|
+      require "puppet-languageserver/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-languageserver', lib))
+    end
+
+    begin
+      require 'lsp/lsp'
+      OpenFactRuntime.activate!
+    rescue LoadError => e
+      log_message(:error, "Error while loading a critical gem: #{e} #{e.backtrace}")
+      return
+    end
+
+    # These libraries require the puppet and LSP gems.
+    %w[
+      sidecar_protocol
+      global_queues
+      puppet_lexer_helper
+      puppet_parser_helper
+      puppet_helper
+      facter_helper
+      uri_helper
+      puppet_monkey_patches
+      providers
+    ].each do |lib|
+      require "puppet-languageserver/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-languageserver', lib))
+    end
+
+    # Validate the feature flags
+    unless options[:flags].nil? || options[:flags].empty?
+      flags = options[:flags]
+      log_message(:debug, "Detected feature flags [#{flags.join(', ')}]")
+
+      configure_featureflags(flags)
+    end
+
+    @server_is_active = true
+  ensure
+    $VERBOSE = original_verbose
+  end
+
+  class CommandLineParser
+    def self.parse(options)
+      # Set defaults here
+      args = {
+        connection_timeout: 10,
+        debug: nil,
+        disable_sidecar_cache: false,
+        fast_start_langserver: true,
+        flags: [],
+        ipaddress: 'localhost',
+        port: nil,
+        puppet_version: nil,
+        puppet_settings: [],
+        preload_puppet: true,
+        stdio: false,
+        stop_on_client_exit: true,
+        workspace: nil
+      }
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: puppet-languageserver.rb [options]'
+
+        opts.on('-pPORT', '--port=PORT', 'TCP Port to listen on.  Default is random port') do |port|
+          args[:port] = port.to_i
+        end
+
+        opts.on('-ipADDRESS', '--ip=ADDRESS', "IP Address to listen on (0.0.0.0 for all interfaces).  Default is #{args[:ipaddress]}") do |ipaddress|
+          args[:ipaddress] = ipaddress
+        end
+
+        opts.on('-c', '--no-stop', 'Do not stop the language server once a client disconnects.  Default is to stop') do |_misc|
+          args[:stop_on_client_exit] = false
+        end
+
+        opts.on('-tTIMEOUT', '--timeout=TIMEOUT', "Stop the language server if a client does not connection within TIMEOUT seconds.  A value of zero will not timeout.  Default is #{args[:connection_timeout]} seconds") do |timeout|
+          args[:connection_timeout] = timeout.to_i
+        end
+
+        opts.on('-d', '--no-preload', '** DEPRECATED ** Do not preload Puppet information when the language server starts.  Default is to preload') do |_misc|
+          puts '** WARNING ** Using "--no-preload" may cause Puppet Type loading to be incomplete.'
+          args[:preload_puppet] = false
+        end
+
+        opts.on('--debug=DEBUG', "Output debug information.  Either specify a filename or 'STDOUT'.  Default is no debug output") do |debug|
+          args[:debug] = debug
+        end
+
+        opts.on('-s', '--slow-start', '** DEPRECATED ** Delay starting the Language Server until Puppet initialisation has completed.  Default is to start fast') do |_misc|
+          args[:fast_start_langserver] = false
+        end
+
+        opts.on('--stdio', 'Runs the server in stdio mode, without a TCP listener') do |_misc|
+          args[:stdio] = true
+        end
+
+        opts.on('--enable-file-cache', '** DEPRECATED ** Enables the file system cache for Puppet Objects (types, class etc.)') do |_misc|
+        end
+
+        # These options are normally passed through to the Sidecar
+        opts.on('--[no-]cache', 'Enable or disable all caching inside the sidecar. By default caching is enabled.') do |cache|
+          args[:disable_sidecar_cache] = !cache
+        end
+
+        opts.on('--feature-flags=FLAGS', Array, 'A list of comma delimited feature flags') do |flags|
+          args[:flags] = flags
+        end
+
+        opts.on('--puppet-settings=TEXT', Array, 'Comma delimited list of settings to pass into Puppet e.g. --vardir,/opt/test-fixture') do |text|
+          args[:puppet_settings] = text
+        end
+
+        opts.on('--openvox-version=TEXT', '--puppet-version=TEXT', String, 'The version of the OpenVox Gem to use (defaults to latest version if not specified or unavailable)') do |text|
+          args[:puppet_version] = text
+        end
+
+        opts.on('--local-workspace=PATH', '** DEPRECATED ** The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path.') do |_path|
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+
+        opts.on('-v', '--version', 'Prints the Langauge Server version') do
+          puts PuppetLanguageServer.version
+          exit
+        end
+      end
+
+      opt_parser.parse!(options.dup)
+      args
+    end
+  end
+
+  def self.log_message(severity, message)
+    PuppetEditorServices.log_message(severity, message)
+  end
+
+  def self.init_puppet(options)
+    PuppetEditorServices.init_logging(options)
+    log_message(:info, "Language Server is v#{PuppetEditorServices.version}")
+    log_message(:debug, 'Loading gems...')
+    require_gems(options)
+    return unless active?
+
+    log_message(:info, "Using OpenVox gem v#{OpenVoxRuntime.gem_version} (Puppet API v#{Puppet.version})")
+    log_message(:info, "Using OpenFact gem v#{OpenFactRuntime.gem_version} (Facter API v#{Facter.version})")
+
+    raise("Detected OpenVox #{Puppet.version} however the Language Server requires OpenVox 8.0 and above") if Gem::Version.new(Puppet.version) < Gem::Version.new('8.0.0')
+
+    log_message(:debug, "Detected additional puppet settings #{options[:puppet_settings]}")
+    options[:puppet_settings].nil? ? Puppet.initialize_settings : Puppet.initialize_settings(options[:puppet_settings])
+
+    log_message(:info, 'Initializing settings...')
+
+    # Remove all other logging destinations except for ours
+    Puppet::Util::Log.destinations.clear
+    Puppet::Util::Log.newdestination('null_logger')
+
+    true
+  end
+
+  def self.rpc_server(options)
+    log_message(:info, 'Starting RPC Server...')
+    options[:servicename] = 'LANGUAGE SERVER'
+
+    require 'puppet_editor_services/protocol/json_rpc'
+
+    server_options = options
+    protocol_options = { class: PuppetEditorServices::Protocol::JsonRPC }.merge(options)
+    handler_options = { class: PuppetLanguageServer::MessageHandler }.merge(options)
+
+    unless active?
+      handler_options[:class] = PuppetLanguageServer::DisabledMessageHandler
+      log_message(:info, 'Configured the Language Server to use the Disabled Message Router')
+    end
+
+    if options[:stdio]
+      log_message(:debug, 'Using STDIO Server')
+      require 'puppet_editor_services/server/stdio'
+      server = ::PuppetEditorServices::Server::Stdio.new(server_options, protocol_options, handler_options)
+      trap('INT') { server.stop }
+    else
+      log_message(:debug, 'Using TCP Server')
+      require 'puppet_editor_services/server/tcp'
+      # TODO: Add max threads?
+      server = ::PuppetEditorServices::Server::Tcp.new(server_options, protocol_options, handler_options)
+      trap('INT') { server.stop_services(true) }
+    end
+    server.start
+
+    log_message(:info, 'Language Server exited.')
+  end
+end

data/lib/puppet_languageserver_sidecar.rb

@@ -0,0 +1,364 @@
+# frozen_string_literal: true
+
+begin
+  original_verbose = $VERBOSE
+  $VERBOSE = nil
+
+  require 'puppet_editor_services'
+  require 'openvox_runtime'
+  require 'openfact_runtime'
+  require 'optparse'
+  require 'logger'
+  require 'json'
+
+  %w[
+    sidecar_protocol
+  ].each do |lib|
+    require "puppet-languageserver/#{lib}"
+  rescue LoadError
+    require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-languageserver', lib))
+  end
+ensure
+  $VERBOSE = original_verbose
+end
+
+module PuppetLanguageServerSidecar
+  def self.version
+    PuppetEditorServices.version
+  end
+
+  def self.configure_featureflags(flags)
+    @flags = flags
+  end
+
+  def self.featureflag?(flagname)
+    return false if @flags.nil? || @flags.empty?
+
+    @flags.include?(flagname)
+  end
+
+  def self.require_gems(options)
+    original_verbose = $VERBOSE
+    $VERBOSE = nil
+
+    # Use a specific OpenVox Gem version if requested.
+    if options[:puppet_version].nil?
+      OpenVoxRuntime.activate!
+    else
+      available_openvox_gems = OpenVoxRuntime.available_versions
+      if available_openvox_gems.include?(options[:puppet_version])
+        OpenVoxRuntime.activate!(options[:puppet_version])
+      else
+        log_message(:warn, "Unable to use OpenVox version #{options[:puppet_version]}, as only the following versions are available [#{available_openvox_gems.join(', ')}]")
+        OpenVoxRuntime.activate!
+      end
+    end
+    OpenFactRuntime.activate!
+
+    # Validate the feature flags
+    unless options[:flags].nil? || options[:flags].empty?
+      flags = options[:flags]
+      log_message(:debug, "Detected feature flags [#{options[:flags].join(', ')}]")
+
+      configure_featureflags(flags)
+    end
+
+    require_list = %w[
+      cache/base
+      cache/null
+      cache/filesystem
+      puppet_parser_helper
+      sidecar_protocol_extensions
+      workspace
+      facter_helper
+      puppet_helper
+      puppet_monkey_patches
+      puppet_strings_helper
+    ]
+
+    require_list.each do |lib|
+      require "puppet-languageserver-sidecar/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-languageserver-sidecar', lib))
+    end
+  ensure
+    $VERBOSE = original_verbose
+  end
+
+  ACTION_LIST = %w[
+    noop
+    default_aggregate
+    default_classes
+    default_datatypes
+    default_functions
+    default_types
+    node_graph
+    resource_list
+    workspace_aggregate
+    workspace_classes
+    workspace_datatypes
+    workspace_functions
+    workspace_types
+    facts
+  ].freeze
+
+  class CommandLineParser
+    def self.parse(options)
+      # Set defaults here
+      args = {
+        action: nil,
+        action_parameters: PuppetLanguageServer::Sidecar::Protocol::ActionParams.new,
+        debug: nil,
+        disable_cache: false,
+        flags: [],
+        output: nil,
+        puppet_settings: [],
+        puppet_version: nil,
+        workspace: nil
+      }
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: puppet-languageserver-sidecar.rb [options]'
+
+        opts.on('-a', '--action=NAME', ACTION_LIST, "The action for the sidecar to take. Expected #{ACTION_LIST}") do |name|
+          args[:action] = name
+        end
+
+        opts.on('-c', '--action-parameters=JSON', 'JSON Encoded string containing the parameters for the sidecar action') do |json_string|
+          ap = PuppetLanguageServer::Sidecar::Protocol::ActionParams.new
+          begin
+            ap.from_json!(json_string)
+            args[:action_parameters] = ap
+          rescue StandardError => e
+            raise "Unable to parse the action parameters: #{e}"
+          end
+        end
+
+        opts.on('-w', '--local-workspace=PATH', 'The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path') do |path|
+          args[:workspace] = path
+        end
+
+        opts.on('-o', '--output=PATH', 'The file to save the output from the sidecar. Default is output to STDOUT') do |path|
+          args[:output] = path
+        end
+
+        opts.on('-p', '--puppet-settings=TEXT', Array, 'Comma delimited list of settings to pass into Puppet e.g. --vardir,/opt/test-fixture') do |text|
+          args[:puppet_settings] = text
+        end
+
+        opts.on('--openvox-version=TEXT', '--puppet-version=TEXT', String, 'The version of the OpenVox Gem to use (defaults to latest version if not specified or unavailable)') do |text|
+          args[:puppet_version] = text
+        end
+
+        opts.on('-f', '--feature-flags=FLAGS', Array, 'A list of comma delimited feature flags to pass the the sidecar') do |flags|
+          args[:flags] = flags
+        end
+
+        opts.on('-n', '--[no-]cache', 'Enable or disable all caching inside the sidecar. By default caching is enabled.') do |cache|
+          args[:disable_cache] = !cache
+        end
+
+        opts.on('--debug=DEBUG', "Output debug information.  Either specify a filename or 'STDOUT'. Default is no debug output") do |debug|
+          args[:debug] = debug
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+
+        opts.on('-v', '--version', 'Prints the Langauge Server version') do
+          puts PuppetLanguageServerSidecar.version
+          exit
+        end
+      end
+
+      opt_parser.parse!(options.dup)
+
+      raise('The action parameter is mandatory') if args[:action].nil?
+
+      args
+    end
+  end
+
+  def self.log_message(severity, message)
+    PuppetEditorServices.log_message(severity, message)
+  end
+
+  def self.init_puppet_sidecar(options)
+    PuppetEditorServices.init_logging(options)
+    log_message(:info, "Language Server Sidecar is v#{PuppetLanguageServerSidecar.version}")
+    log_message(:debug, 'Loading gems...')
+    require_gems(options)
+    log_message(:info, "Using OpenVox gem v#{OpenVoxRuntime.gem_version} (Puppet API v#{Puppet.version})")
+    log_message(:info, "Using OpenFact gem v#{OpenFactRuntime.gem_version} (Facter API v#{Facter.version})")
+
+    raise("Detected OpenVox #{Puppet.version} however the Language Server Sidecar requires OpenVox 8.0 and above") if Gem::Version.new(Puppet.version) < Gem::Version.new('8.0.0')
+
+    log_message(:debug, "Detected additional puppet settings #{options[:puppet_settings]}")
+    options[:puppet_settings].nil? ? Puppet.initialize_settings : Puppet.initialize_settings(options[:puppet_settings])
+
+    PuppetLanguageServerSidecar::Workspace.detect_workspace(options[:workspace])
+    log_message(:debug, 'Detected Module Metadata in the workspace') if PuppetLanguageServerSidecar::Workspace.has_module_metadata?
+    log_message(:debug, 'Detected Environment Config in the workspace') if PuppetLanguageServerSidecar::Workspace.has_environmentconf?
+
+    # Remove all other logging destinations except for ours
+    Puppet::Util::Log.destinations.clear
+    Puppet::Util::Log.newdestination('null_logger')
+
+    true
+  end
+
+  def self.inject_workspace_as_module
+    return false unless PuppetLanguageServerSidecar::Workspace.has_module_metadata?
+
+    %w[puppet_modulepath_monkey_patches].each do |lib|
+      require "puppet-languageserver-sidecar/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-languageserver-sidecar', lib))
+    end
+
+    log_message(:debug, 'Injected the workspace into the module loader')
+    true
+  end
+
+  def self.inject_workspace_as_environment
+    return false unless PuppetLanguageServerSidecar::Workspace.has_environmentconf?
+
+    Puppet.settings[:environment] = PuppetLanguageServerSidecar::PuppetHelper::SIDECAR_PUPPET_ENVIRONMENT
+
+    %w[puppet_environment_monkey_patches].each do |lib|
+      require "puppet-languageserver-sidecar/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-languageserver-sidecar', lib))
+    end
+
+    log_message(:debug, 'Injected the workspace into the environment loader')
+    true
+  end
+
+  def self.execute(options)
+    unless Gem::Version.new(Puppet.version) >= Gem::Version.new('5.0.0')
+      log_message(:error, 'Only Puppet Version 5.0 and above is supported.')
+      return []
+    end
+
+    log_message(:debug, "Executing #{options[:action]} action")
+    case options[:action].downcase
+    when 'noop'
+      []
+
+    when 'default_aggregate'
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache, object_types: PuppetLanguageServerSidecar::PuppetHelper.available_documentation_types)
+
+    when 'default_classes'
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache, object_types: [:class]).classes
+
+    when 'default_datatypes'
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache, object_types: [:datatype]).datatypes
+
+    when 'default_functions'
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache, object_types: [:function]).functions
+
+    when 'default_types'
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache, object_types: [:type]).types
+
+    when 'node_graph'
+      inject_workspace_as_module || inject_workspace_as_environment
+      result = PuppetLanguageServerSidecar::Protocol::PuppetNodeGraph.new
+      if options[:action_parameters]['source'].nil?
+        log_message(:error, 'Missing source action parameter')
+        return result.set_error('Missing source action parameter')
+      end
+      begin
+        manifest = File.open(options[:action_parameters]['source'], 'r:UTF-8') { |f| f.read }
+        PuppetLanguageServerSidecar::PuppetParserHelper.compile_node_graph(manifest)
+      rescue StandardError => e
+        log_message(:error, "Unable to compile the manifest. #{e}")
+        result.set_error("Unable to compile the manifest. #{e}")
+      end
+
+    when 'resource_list'
+      inject_workspace_as_module || inject_workspace_as_environment
+      typename = options[:action_parameters]['typename']
+      title = options[:action_parameters]['title']
+      if typename.nil?
+        log_message(:error, 'Missing typename action paramater')
+        return []
+      end
+      PuppetLanguageServerSidecar::PuppetHelper.get_puppet_resource(typename, title)
+
+    when 'workspace_aggregate'
+      return nil unless inject_workspace_as_module || inject_workspace_as_environment
+
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache,
+                                                                            object_types: PuppetLanguageServerSidecar::PuppetHelper.available_documentation_types,
+                                                                            root_path: PuppetLanguageServerSidecar::Workspace.root_path)
+
+    when 'workspace_classes'
+      return nil unless inject_workspace_as_module || inject_workspace_as_environment
+
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache,
+                                                                            object_types: [:class],
+                                                                            root_path: PuppetLanguageServerSidecar::Workspace.root_path).classes
+
+    when 'workspace_datatypes'
+      return nil unless inject_workspace_as_module || inject_workspace_as_environment
+
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache,
+                                                                            object_types: [:datatype],
+                                                                            root_path: PuppetLanguageServerSidecar::Workspace.root_path).datatypes
+
+    when 'workspace_functions'
+      return nil unless inject_workspace_as_module || inject_workspace_as_environment
+
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache,
+                                                                            object_types: [:function],
+                                                                            root_path: PuppetLanguageServerSidecar::Workspace.root_path).functions
+
+    when 'workspace_types'
+      return nil unless inject_workspace_as_module || inject_workspace_as_environment
+
+      cache = options[:disable_cache] ? PuppetLanguageServerSidecar::Cache::Null.new : PuppetLanguageServerSidecar::Cache::FileSystem.new
+      PuppetLanguageServerSidecar::PuppetHelper.retrieve_via_puppet_strings(cache,
+                                                                            object_types: [:type],
+                                                                            root_path: PuppetLanguageServerSidecar::Workspace.root_path).types
+
+    when 'facts'
+      # Can't cache for facts
+      cache = PuppetLanguageServerSidecar::Cache::Null.new
+      # Inject the workspace etc. if present
+      injected = inject_workspace_as_module
+      inject_workspace_as_environment unless injected
+      PuppetLanguageServerSidecar::FacterHelper.retrieve_facts(cache)
+
+    else
+      log_message(:error, "Unknown action #{options[:action]}. Expected one of #{ACTION_LIST}")
+    end
+  end
+
+  def self.output(result, options)
+    if options[:output].nil? || options[:output].empty?
+      $stdout.binmode
+      $stdout.write(result.to_json)
+    else
+      File.open(options[:output], 'wb:UTF-8') do |f|
+        f.write result.to_json
+      end
+    end
+  end
+
+  def self.execute_and_output(options)
+    output(execute(options), options)
+    nil
+  end
+end