(GH-198) Use Puppetfile-resolver with Puppetfile Validation

Previously the Puppetfile validator only performed basic validation checks.
This commit updates the validation to now include doing a full module
dependency resolution based on the validation routines in Puppetfile-Resolver.

This commit also removes the R10K Puppetfile parsing and uses the parser
available in the Puppetfile-Resolver.

By default the resolver is enabled, but can be disabled by setting:

puppet.validate.resolvePuppetfiles: false

Author: glennsarti

lib/puppet-languageserver/language_client.rb

@@ -6,6 +6,7 @@ class LanguageClient
 
     # Client settings
     attr_reader :format_on_type
+    attr_reader :use_puppetfile_resolver
 
     def initialize(message_handler)
       @message_handler = message_handler
@@ -23,6 +24,7 @@ def initialize(message_handler)
 
       # Default settings
       @format_on_type = false
+      @use_puppetfile_resolver = true
     end
 
     def client_capability(*names)
@@ -55,6 +57,9 @@ def parse_lsp_configuration_settings!(settings = {})
         end
         @format_on_type = value
       end
+      # use puppetfile resolver
+      value = safe_hash_traverse(settings, 'puppet', 'validate', 'resolvePuppetfiles')
+      @use_puppetfile_resolver = to_boolean(value)
     end
 
     def capability_registrations(method)

lib/puppet-languageserver/message_handler.rb

@@ -257,7 +257,7 @@ def notification_textdocument_didopen(client_handler_id, json_rpc_message)
       content = json_rpc_message.params['textDocument']['text']
       doc_version = json_rpc_message.params['textDocument']['version']
       documents.set_document(file_uri, content, doc_version)
-      PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, client_handler_id)
+      enqueue_validation(file_uri, doc_version, client_handler_id)
     end
 
     def notification_textdocument_didclose(_, json_rpc_message)
@@ -272,7 +272,7 @@ def notification_textdocument_didchange(client_handler_id, json_rpc_message)
       content = json_rpc_message.params['contentChanges'][0]['text'] # TODO: Bad hardcoding zero
       doc_version = json_rpc_message.params['textDocument']['version']
       documents.set_document(file_uri, content, doc_version)
-      PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, client_handler_id)
+      enqueue_validation(file_uri, doc_version, client_handler_id)
     end
 
     def notification_textdocument_didsave(_, _json_rpc_message)
@@ -318,6 +318,18 @@ def unhandled_exception(error, options)
       super(error, options)
       PuppetLanguageServer::CrashDump.write_crash_file(error, nil, options)
     end
+
+    private
+
+    def enqueue_validation(file_uri, doc_version, client_handler_id)
+      options = {}
+      if documents.document_type(file_uri) == :puppetfile
+        options[:resolve_puppetfile] = language_client.use_puppetfile_resolver
+        options[:puppet_version]     = Puppet.version
+        options[:module_path]        = PuppetLanguageServer::PuppetHelper.module_path
+      end
+      PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, client_handler_id, options)
+    end
   end
 
   class DisabledMessageHandler < PuppetEditorServices::Handler::JsonRPC

lib/puppet-languageserver/providers.rb

@@ -9,13 +9,6 @@
   manifest/signature_provider
   manifest/validation_provider
   manifest/hover_provider
-  puppetfile/r10k/module/base
-  puppetfile/r10k/module/forge
-  puppetfile/r10k/module/invalid
-  puppetfile/r10k/module/local
-  puppetfile/r10k/module/git
-  puppetfile/r10k/module/svn
-  puppetfile/r10k/puppetfile
   puppetfile/validation_provider
 ].each do |lib|
   begin

lib/puppet-languageserver/puppet_helper.rb

@@ -28,6 +28,19 @@ def self.initialize_helper(options = {})
       sidecar_queue.cache = @inmemory_cache
     end
 
+    def self.module_path
+      return @module_path unless @module_path.nil?
+      # TODO: It would be nice if this wasn't using the whole puppet environment to calculate the modulepath directoties
+      # In the meantime memoize it. Currently you can't change the modulepath mid-process.
+      begin
+        env = Puppet.lookup(:environments).get!(Puppet.settings[:environment])
+      rescue Puppet::Environments::EnvironmentNotFound, StandardError
+        env = Puppet.lookup(:current_environment)
+      end
+      return [] if env.nil?
+      @module_path = env.modulepath
+    end
+
     # Node Graph
     def self.get_node_graph(content, local_workspace)
       with_temporary_file(content) do |filepath|