(GH-26) Refactor workspace detection

Previously the --local-workspace option was mostly ignored in the puppetfile
validation.  However this has caused problems when validating inside control
repositories which do not have a metadata.json file (instead it's Puppetfile).
This commit refactors the workspace detection out of the puppetfile validation
and moves it into the Document Store.

This commit also adds a simple timed based caching mechanism to reduce File IO
as it can be exercised vigourously when users are typing and validation is
occuring very often.  An arbitrary value of 60 seconds was chosen the TTL of the
cache.  This means that after 60 seconds the workspace will be re-evaluated to
make sure the user is still in a module (metadata.json) or control repo
(Puppetfile).

Author: glennsarti

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,85 @@ 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
+
+    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 = Pathname.new(path).expand_path
+      return nil unless filepath.exist?
+
+      if filepath.directory?
+        directory = filepath
+      else
+        directory = filepath.dirname
+      end
+
+      root_path = nil
+      directory.ascend do |p|
+        if p.join('metadata.json').exist? || p.join('Puppetfile').exist?
+          root_path = p.to_s
+          break
+        end
+      end
+
+      root_path
+    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
   end
 end

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'

spec/languageserver/fixtures/control_repos/valid/data/.gitkeep

@@ -0,0 +1,9 @@
+{
+  "name": "testfixture-valid",
+  "version": "0.1.0",
+  "author": "testfixture",
+  "summary": "Skeleton module test fixture",
+  "license": "Apache-2.0",
+  "source": "http://localhost",
+  "dependencies": []
+}

spec/languageserver/fixtures/control_repos/valid/site/profile/.gitkeep

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe 'PuppetLanguageServer::DocumentStore' do
+  let(:subject) { PuppetLanguageServer::DocumentStore }
+
+  RSpec.shared_examples 'an empty workspace' do |expected_root_path|
+    it 'should return the workspace directory for the root_path' do
+      expect(PuppetLanguageServer::DocumentStore.store_root_path).to eq(expected_root_path)
+    end
+
+    it 'should not find module metadata' do
+      expect(PuppetLanguageServer::DocumentStore.store_has_module_metadata?).to be false
+    end
+
+    it 'should not find puppetfile' do
+      expect(PuppetLanguageServer::DocumentStore.store_has_puppetfile?).to be false
+    end
+  end
+
+  RSpec.shared_examples 'a puppetfile workspace' do |expected_root_path|
+    it 'should return the control repo root for the root_path' do
+      expect(PuppetLanguageServer::DocumentStore.store_root_path).to eq(expected_root_path)
+    end
+
+    it 'should not find module metadata' do
+      expect(PuppetLanguageServer::DocumentStore.store_has_module_metadata?).to be false
+    end
+
+    it 'should find puppetfile' do
+      expect(PuppetLanguageServer::DocumentStore.store_has_puppetfile?).to be true
+    end
+  end
+
+  RSpec.shared_examples 'a metadata.json workspace' do |expected_root_path|
+    it 'should return the control repo root for the root_path' do
+      expect(PuppetLanguageServer::DocumentStore.store_root_path).to eq(expected_root_path)
+    end
+
+    it 'should find module metadata' do
+      expect(PuppetLanguageServer::DocumentStore.store_has_module_metadata?).to be true
+    end
+
+    it 'should not find puppetfile' do
+      expect(PuppetLanguageServer::DocumentStore.store_has_puppetfile?).to be false
+    end
+  end
+
+  # Empty or missing workspace
+  context 'given a workspace option which is nil' do
+    let(:server_options) { {} }
+
+    before(:each) do
+      PuppetLanguageServer::DocumentStore.initialize_store(server_options)
+    end
+
+    it_should_behave_like 'an empty workspace', nil
+  end
+
+  context 'given a workspace option with a missing directory' do
+    let(:server_options) { { :workspace => '/a/directory/which/does/not/exist' } }
+
+    before(:each) do
+      PuppetLanguageServer::DocumentStore.initialize_store(server_options)
+    end
+
+    it_should_behave_like 'an empty workspace', '/a/directory/which/does/not/exist'
+  end
+
+  # Puppetfile style workspaces
+  context 'given a workspace option with a puppetfile' do
+    expected_root = File.join($fixtures_dir, 'control_repos', 'valid')
+
+    let(:server_options) { { :workspace => expected_root } }
+
+    before(:each) do
+      PuppetLanguageServer::DocumentStore.initialize_store(server_options)
+    end
+
+    it_should_behave_like 'a puppetfile workspace', expected_root
+  end
+
+  context 'given a workspace option which has a parent directory with a puppetfile' do
+    expected_root = File.join($fixtures_dir, 'control_repos', 'valid')
+    deep_path = File.join(expected_root, 'site', 'profile')
+
+    let(:server_options) { { :workspace => deep_path } }
+
+    before(:each) do
+      PuppetLanguageServer::DocumentStore.initialize_store(server_options)
+    end
+
+    it_should_behave_like 'a puppetfile workspace', expected_root
+  end
+
+  # Module metadata style workspaces
+  context 'given a workspace option with metadata.json' do
+    expected_root = File.join($fixtures_dir, 'module_sources', 'valid')
+
+    let(:server_options) { { :workspace => expected_root } }
+
+    before(:each) do
+      PuppetLanguageServer::DocumentStore.initialize_store(server_options)
+    end
+
+    it_should_behave_like 'a metadata.json workspace', expected_root
+  end
+
+  context 'given a workspace option which has a parent directory with metadata.json' do
+    expected_root = File.join($fixtures_dir, 'module_sources', 'valid')
+    deep_path = File.join(expected_root, 'manifests')
+
+    let(:server_options) { { :workspace => deep_path } }
+
+    before(:each) do
+      PuppetLanguageServer::DocumentStore.initialize_store(server_options)
+    end
+
+    it_should_behave_like 'a metadata.json workspace', expected_root
+  end
+end