(maint) Add tests for workspace symbols

Previously the workspace symbols method was added but there were not tests. This
commit adds unit tests.

Author: glennsarti

spec/languageserver/spec_helper.rb

@@ -55,8 +55,9 @@ def add_random_basepuppetobject_values!(value)
   value
 end
 
-def random_sidecar_puppet_class
+def random_sidecar_puppet_class(key = nil)
   result = add_random_basepuppetobject_values!(PuppetLanguageServer::Sidecar::Protocol::PuppetClass.new())
+  result.key = key unless key.nil?
   result.doc = 'doc' + rand(1000).to_s
   result.parameters = {
     "attr_name1" => { :type => "Optional[String]", :doc => 'attr_doc1' },
@@ -65,8 +66,9 @@ def random_sidecar_puppet_class
   result
 end
 
-def random_sidecar_puppet_function
+def random_sidecar_puppet_function(key = nil)
   result = add_random_basepuppetobject_values!(PuppetLanguageServer::Sidecar::Protocol::PuppetFunction.new())
+  result.key = key unless key.nil?
   result.doc = 'doc' + rand(1000).to_s
   result.function_version = rand(1) + 3
   result.signatures << random_sidecar_puppet_function_signature
@@ -96,8 +98,9 @@ def random_sidecar_puppet_function_signature_parameter
   result
 end
 
-def random_sidecar_puppet_type
+def random_sidecar_puppet_type(key = nil)
   result = add_random_basepuppetobject_values!(PuppetLanguageServer::Sidecar::Protocol::PuppetType.new())
+  result.key = key unless key.nil?
   result.doc = 'doc' + rand(1000).to_s
   result.attributes = {
     :attr_name1 => { :type => :attr_type, :doc => 'attr_doc1', :required? => false, :isnamevar? => true },

spec/languageserver/unit/puppet-languageserver/manifest/document_symbol_provider_spec.rb

@@ -22,9 +22,56 @@
   end
 end
 
+RSpec::Matchers.define :be_symbol_information do |name, kind|
+  match do |actual|
+    actual.name == name &&
+    actual.kind == kind
+  end
+
+  failure_message do |actual|
+    "expected that symbol called '#{actual.name}' of type '#{actual.kind}' would be " +
+      "a symbol called '#{name}', of type '#{kind}'"
+  end
+
+  description do
+    "be a document symbol called '#{name}' of type #{kind} located at #{start_line}, #{start_char}, #{end_line}, #{end_char}"
+  end
+end
+
 describe 'PuppetLanguageServer::Manifest::DocumentSymbolProvider' do
   let(:subject) { PuppetLanguageServer::Manifest::DocumentSymbolProvider }
 
+  describe '#workspace_symbols' do
+    let(:cache) { PuppetLanguageServer::PuppetHelper::Cache.new }
+
+    before(:each) do
+      # Add test objects
+      origin = :default
+      cache.import_sidecar_list!([random_sidecar_puppet_class(:class1)], :class, origin)
+      cache.import_sidecar_list!([random_sidecar_puppet_function(:func1)], :function, origin)
+      cache.import_sidecar_list!([random_sidecar_puppet_type(:type1)], :type, origin)
+    end
+
+    it 'should emit all known objects for an empty query' do
+      result = subject.workspace_symbols(nil, cache)
+
+      expect(result[0]).to be_symbol_information('class1', LSP::SymbolKind::CLASS)
+      expect(result[1]).to be_symbol_information('func1', LSP::SymbolKind::FUNCTION)
+      expect(result[2]).to be_symbol_information('type1', LSP::SymbolKind::METHOD)
+
+      all_cache_names = []
+      cache.all_objects { |key, _| all_cache_names << key.to_s }
+      expect(result.count).to eq(all_cache_names.count)
+    end
+
+    it 'should only emit objects that match a simple text query' do
+      result = subject.workspace_symbols('func', cache)
+
+      expect(result.count).to eq(1)
+      expect(result[0]).to be_symbol_information('func1', LSP::SymbolKind::FUNCTION)
+    end
+  end
+
   context 'with Puppet 4.0 and below', :if => Gem::Version.new(Puppet.version) < Gem::Version.new('5.0.0') do
     describe '#extract_document_symbols' do
       it 'should always return an empty array' do