Module: PuppetLanguageServerSidecar

Defined in:
lib/puppet_languageserver_sidecar.rb,
lib/puppet-languageserver-sidecar/workspace.rb,
lib/puppet-languageserver-sidecar/cache/base.rb,
lib/puppet-languageserver-sidecar/cache/null.rb,
lib/puppet-languageserver-sidecar/facter_helper.rb,
lib/puppet-languageserver-sidecar/puppet_helper.rb,
lib/puppet-languageserver-sidecar/cache/filesystem.rb,
lib/puppet-languageserver-sidecar/puppet_parser_helper.rb,
lib/puppet-languageserver-sidecar/puppet_strings_helper.rb,
lib/puppet-languageserver-sidecar/sidecar_protocol_extensions.rb

Defined Under Namespace

Modules: Cache, FacterHelper, Protocol, PuppetHelper, PuppetParserHelper, PuppetStringsHelper, Workspace Classes: CommandLineParser, FileDocumentation, FileDocumentationCache

Constant Summary collapse

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 Method Summary collapse

Class Method Details

.configure_featureflags(flags) ⇒ Object 



30
31
32
 
# File 'lib/puppet_languageserver_sidecar.rb', line 30

def self.configure_featureflags(flags)
  @flags = flags
end

.execute(options) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/puppet_languageserver_sidecar.rb', line 240

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

.execute_and_output(options) ⇒ Object 



360
361
362
363
 
# File 'lib/puppet_languageserver_sidecar.rb', line 360

def self.execute_and_output(options)
  output(execute(options), options)
  nil
end

.featureflag?(flagname) ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
37
38
 
# File 'lib/puppet_languageserver_sidecar.rb', line 34

def self.featureflag?(flagname)
  return false if @flags.nil? || @flags.empty?

  @flags.include?(flagname)
end

.init_puppet_sidecar(options) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/puppet_languageserver_sidecar.rb', line 188

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

.inject_workspace_as_environment ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/puppet_languageserver_sidecar.rb', line 225

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

.inject_workspace_as_module ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/puppet_languageserver_sidecar.rb', line 212

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

.log_message(severity, message) ⇒ Object 



184
185
186
 
# File 'lib/puppet_languageserver_sidecar.rb', line 184

def self.log_message(severity, message)
  PuppetEditorServices.log_message(severity, message)
end

.output(result, options) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/puppet_languageserver_sidecar.rb', line 349

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

.require_gems(options) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/puppet_languageserver_sidecar.rb', line 40

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

.version ⇒ Object 



26
27
28
 
# File 'lib/puppet_languageserver_sidecar.rb', line 26

def self.version
  PuppetEditorServices.version
end