Merge pull request #29 from glennsarti/gh-26-puppet-lint-in-control-repos

(GH-26) Refactor workspace detection for control repos and modules

Author: michaeltlombardi

lib/puppet-languageserver.rb

@@ -126,6 +126,9 @@ def self.init_puppet(options)
     log_message(:info, 'Initializing Puppet Helper Cache...')
     PuppetLanguageServer::PuppetHelper.configure_cache(options[:cache])
 
+    log_message(:debug, 'Initializing Document Store...')
+    PuppetLanguageServer::DocumentStore.initialize_store(options)
+
     log_message(:info, 'Initializing settings...')
     if options[:fast_start_langserver]
       Thread.new do

lib/puppet-languageserver/document_store.rb

@@ -51,5 +51,105 @@ def self.document_type(uri)
         :unknown
       end
     end
+
+    # Workspace management
+    WORKSPACE_CACHE_TTL_SECONDS = 60
+    def self.initialize_store(options = {})
+      @workspace_path = options[:workspace]
+      @workspace_info_cache = {
+        :expires => Time.new - 120
+      }
+    end
+
+    # This method is mainly used for testin. It expires the cache
+    def self.expire_store_information
+      @doc_mutex.synchronize do
+        @workspace_info_cache[:expires] = Time.new - 120
+      end
+    end
+
+    def self.store_root_path
+      store_details[:root_path]
+    end
+
+    def self.store_has_module_metadata?
+      store_details[:has_metadatajson]
+    end
+
+    def self.store_has_puppetfile?
+      store_details[:has_puppetfile]
+    end
+
+    # Given a path, locate a metadata.json or Puppetfile file to determine where the
+    # root of the module/control repo actually is
+    def self.find_root_path(path)
+      return nil if path.nil?
+      filepath = File.expand_path(path)
+
+      if dir_exist?(filepath)
+        directory = filepath
+      elsif file_exist?(filepath)
+        directory = File.dirname(filepath)
+      else
+        return nil
+      end
+
+      until directory.nil?
+        break if file_exist?(File.join(directory, 'metadata.json')) || file_exist?(File.join(directory, 'Puppetfile'))
+        parent = File.dirname(directory)
+        # If the parent is the same as the original, then we've reached the end of the path chain
+        if parent == directory
+          directory = nil
+        else
+          directory = parent
+        end
+      end
+
+      directory
+    end
+    private_class_method :find_root_path
+
+    def self.store_details
+      return @workspace_info_cache unless @workspace_info_cache[:never_expires] || @workspace_info_cache[:expires] < Time.new
+      # TTL has expired, time to calculate the document store details
+
+      new_cache = {
+        :root_path => nil,
+        :has_puppetfile => false,
+        :has_metadatajson => false
+      }
+      if @workspace_path.nil?
+        # If we have never been given a local workspace path on the command line then there is really no
+        # way to know where the module file system path is.  Therefore the root_path is nil and assume that
+        # puppetfile and metadata.json does not exist. And don't bother trying to re-evaluate
+        new_cache[:never_expires] = true
+      else
+        root_path = find_root_path(@workspace_path)
+        if root_path.nil?
+          new_cache[:root_path] = @workspace_path
+        else
+          new_cache[:root_path] = root_path
+          new_cache[:has_metadatajson] = file_exist?(File.join(root_path, 'metadata.json'))
+          new_cache[:has_puppetfile] = file_exist?(File.join(root_path, 'Puppetfile'))
+        end
+      end
+      new_cache[:expires] = Time.new + WORKSPACE_CACHE_TTL_SECONDS
+
+      @doc_mutex.synchronize do
+        @workspace_info_cache = new_cache
+      end
+      @workspace_info_cache
+    end
+    private_class_method :store_details
+
+    def self.file_exist?(path)
+      File.exist?(path) && !File.directory?(path)
+    end
+    private_class_method :file_exist?
+
+    def self.dir_exist?(path)
+      Dir.exist?(path)
+    end
+    private_class_method :dir_exist?
   end
 end

lib/puppet-languageserver/epp/validation_provider.rb

@@ -1,7 +1,7 @@
 module PuppetLanguageServer
   module Epp
     module ValidationProvider
-      def self.validate(content, _workspace, _max_problems = 100)
+      def self.validate(content, _max_problems = 100)
         result = []
         # TODO: Need to implement max_problems
         _problems = 0

lib/puppet-languageserver/manifest/validation_provider.rb

@@ -2,39 +2,15 @@
 module PuppetLanguageServer
   module Manifest
     module ValidationProvider
-      def self.find_module_root_from_path(path)
-        return nil if path.nil?
-
-        filepath = Pathname.new(path).expand_path
-        return nil unless filepath.exist?
-
-        if filepath.directory?
-          directory = filepath
-        else
-          directory = filepath.dirname
-        end
-
-        module_root = nil
-        directory.ascend do |p|
-          if p.join('metadata.json').exist?
-            module_root = p
-            break
-          end
-        end
-
-        module_root
-      end
-
       # Similar to 'validate' this will run puppet-lint and returns
       # the manifest with any fixes applied
       #
       # Returns:
       #  [ <Int> Number of problems fixed,
       #    <String> New Content
       #  ]
-      def self.fix_validate_errors(content, workspace)
-        # Find module root and attempt to build PuppetLint options
-        module_root = find_module_root_from_path(workspace)
+      def self.fix_validate_errors(content)
+        module_root = PuppetLanguageServer::DocumentStore.store_root_path
         linter_options = nil
         if module_root.nil?
           linter_options = PuppetLint::OptParser.build
@@ -52,13 +28,12 @@ def self.fix_validate_errors(content, workspace)
         [problems_fixed, linter.manifest]
       end
 
-      def self.validate(content, workspace, _max_problems = 100)
+      def self.validate(content, _max_problems = 100)
         result = []
         # TODO: Need to implement max_problems
         problems = 0
 
-        # Find module root and attempt to build PuppetLint options
-        module_root = find_module_root_from_path(workspace)
+        module_root = PuppetLanguageServer::DocumentStore.store_root_path
         linter_options = nil
         if module_root.nil?
           linter_options = PuppetLint::OptParser.build

lib/puppet-languageserver/message_router.rb

@@ -2,9 +2,7 @@ module PuppetLanguageServer
   class MessageRouter
     attr_accessor :json_rpc_handler
 
-    def initialize(options = {})
-      options = {} if options.nil?
-      @workspace = options[:workspace]
+    def initialize(_options = {})
     end
 
     def documents
@@ -90,7 +88,7 @@ def receive_request(request)
 
           case documents.document_type(file_uri)
           when :manifest
-            changes, new_content = PuppetLanguageServer::Manifest::ValidationProvider.fix_validate_errors(content, @workspace)
+            changes, new_content = PuppetLanguageServer::Manifest::ValidationProvider.fix_validate_errors(content)
           else
             raise "Unable to fixDiagnosticErrors on #{file_uri}"
           end
@@ -194,7 +192,7 @@ def receive_notification(method, params)
         content = params['textDocument']['text']
         doc_version = params['textDocument']['version']
         documents.set_document(file_uri, content, doc_version)
-        PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, @workspace, @json_rpc_handler)
+        PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, @json_rpc_handler)
 
       when 'textDocument/didClose'
         PuppetLanguageServer.log_message(:info, 'Received textDocument/didClose notification.')
@@ -207,7 +205,7 @@ def receive_notification(method, params)
         content = params['contentChanges'][0]['text'] # TODO: Bad hardcoding zero
         doc_version = params['textDocument']['version']
         documents.set_document(file_uri, content, doc_version)
-        PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, @workspace, @json_rpc_handler)
+        PuppetLanguageServer::ValidationQueue.enqueue(file_uri, doc_version, @json_rpc_handler)
 
       when 'textDocument/didSave'
         PuppetLanguageServer.log_message(:info, 'Received textDocument/didSave notification.')

lib/puppet-languageserver/validation_queue.rb

@@ -11,7 +11,7 @@ module ValidationQueue
     @queue_thread = nil
 
     # Enqueue a file to be validated
-    def self.enqueue(file_uri, doc_version, workspace, connection_object)
+    def self.enqueue(file_uri, doc_version, connection_object)
       document_type = PuppetLanguageServer::DocumentStore.document_type(file_uri)
 
       unless %i[manifest epp puppetfile].include?(document_type)
@@ -27,7 +27,6 @@ def self.enqueue(file_uri, doc_version, workspace, connection_object)
           'file_uri'          => file_uri,
           'doc_version'       => doc_version,
           'document_type'     => document_type,
-          'workspace'         => workspace,
           'connection_object' => connection_object
         }
       end
@@ -47,11 +46,11 @@ def self.enqueue(file_uri, doc_version, workspace, connection_object)
     end
 
     # Synchronously validate a file
-    def self.validate_sync(file_uri, doc_version, workspace, connection_object)
+    def self.validate_sync(file_uri, doc_version, connection_object)
       document_type = PuppetLanguageServer::DocumentStore.document_type(file_uri)
       content = documents.document(file_uri, doc_version)
       return nil if content.nil?
-      result = validate(document_type, content, workspace)
+      result = validate(document_type, content)
 
       # Send the response
       connection_object.reply_diagnostics(file_uri, result)
@@ -79,15 +78,15 @@ def self.reset_queue(initial_state = [])
     end
 
     # Validate a document
-    def self.validate(document_type, content, workspace)
+    def self.validate(document_type, content)
       # Perform validation
       case document_type
       when :manifest
-        PuppetLanguageServer::Manifest::ValidationProvider.validate(content, workspace)
+        PuppetLanguageServer::Manifest::ValidationProvider.validate(content)
       when :epp
-        PuppetLanguageServer::Epp::ValidationProvider.validate(content, workspace)
+        PuppetLanguageServer::Epp::ValidationProvider.validate(content)
       when :puppetfile
-        PuppetLanguageServer::Puppetfile::ValidationProvider.validate(content, workspace)
+        PuppetLanguageServer::Puppetfile::ValidationProvider.validate(content)
       else
         []
       end
@@ -109,7 +108,6 @@ def self.worker
         doc_version       = work_item['doc_version']
         connection_object = work_item['connection_object']
         document_type     = work_item['document_type']
-        workspace         = work_item['workspace']
 
         # Check if the document is the latest version
         content = documents.document(file_uri, doc_version)
@@ -119,7 +117,7 @@ def self.worker
         end
 
         # Perform validation
-        result = validate(document_type, content, workspace)
+        result = validate(document_type, content)
 
         # Check if the document is still latest version
         current_version = documents.document_version(file_uri)

spec/languageserver/fixtures/control_repos/valid/Puppetfile

@@ -0,0 +1,4 @@
+forge 'https://forge.puppetlabs.com/'
+
+# Modules from the Puppet Forge
+mod 'puppetlabs-stdlib',          '1.0.0'