(GH-26) Add integration tests for caching of workspace information

This commit adds integeration tests for the caching mechanism used in the
workspace.

Author: glennsarti

lib/puppet-languageserver/document_store.rb

@@ -61,6 +61,13 @@ def self.initialize_store(options = {})
       }
     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
@@ -89,7 +96,7 @@ def self.find_root_path(path)
 
       root_path = nil
       directory.ascend do |p|
-        if p.join('metadata.json').exist? || p.join('Puppetfile').exist?
+        if file_exist?(p.join('metadata.json')) || file_exist?(p.join('Puppetfile'))
           root_path = p.to_s
           break
         end
@@ -119,8 +126,8 @@ def self.store_details
           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'))
+          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
@@ -131,5 +138,10 @@ def self.store_details
       @workspace_info_cache
     end
     private_class_method :store_details
+
+    def self.file_exist?(path)
+      File.exist?(path)
+    end
+    private_class_method :file_exist?
   end
 end

spec/languageserver/integration/puppet-languageserver/document_store_spec.rb

@@ -45,6 +45,31 @@
     end
   end
 
+  RSpec.shared_examples 'a cached workspace' do
+    it 'should cache the information' do
+      expect(subject).to receive(:file_exist?).at_least(:once)
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      # Subsequent calls should be cached
+      expect(subject).to receive(:file_exist?).exactly(0).times
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+    end
+
+    it 'should recache the information when the cache expires' do
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      # Expire the cache
+      PuppetLanguageServer::DocumentStore.expire_store_information
+      expect(subject).to receive(:file_exist?).at_least(:once)
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      # Subsequent calls should be cached
+      expect(subject).to receive(:file_exist?).exactly(0).times
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+    end
+  end
+
   # Empty or missing workspace
   context 'given a workspace option which is nil' do
     let(:server_options) { {} }
@@ -54,6 +79,24 @@
     end
 
     it_should_behave_like 'an empty workspace', nil
+
+    it 'should cache the information' do
+      expect(subject).to receive(:file_exist?).exactly(0).times
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+    end
+
+    it 'should not recache the information when the cache expires' do
+      expect(subject).to receive(:file_exist?).exactly(0).times
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      PuppetLanguageServer::DocumentStore.expire_store_information
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+      result = PuppetLanguageServer::DocumentStore.store_root_path
+    end
   end
 
   context 'given a workspace option with a missing directory' do
@@ -77,6 +120,7 @@
     end
 
     it_should_behave_like 'a puppetfile workspace', expected_root
+    it_should_behave_like 'a cached workspace'
   end
 
   context 'given a workspace option which has a parent directory with a puppetfile' do
@@ -90,6 +134,7 @@
     end
 
     it_should_behave_like 'a puppetfile workspace', expected_root
+    it_should_behave_like 'a cached workspace'
   end
 
   # Module metadata style workspaces
@@ -103,6 +148,7 @@
     end
 
     it_should_behave_like 'a metadata.json workspace', expected_root
+    it_should_behave_like 'a cached workspace'
   end
 
   context 'given a workspace option which has a parent directory with metadata.json' do
@@ -116,5 +162,6 @@
     end
 
     it_should_behave_like 'a metadata.json workspace', expected_root
+    it_should_behave_like 'a cached workspace'
   end
 end