Merge pull request #75 from austb/hover_resource_expr_facts

Hover fixes for resources and facts

Author: austb

server/README.md

@@ -112,8 +112,13 @@ Usage: puppet-languageserver.rb [options]
         --debug=DEBUG                Output debug information.  Either specify a filename or 'STDOUT'.  Default is no debug output
     -s, --slow-start                 Delay starting the TCP Server until Puppet initialisation has completed.  Default is to start fast
     -h, --help                       Prints this help
-    -v, --version                    Prints the Langauge Server version```
+    -v, --version                    Prints the Langauge Server version
+```
 
 ## Why are there vendored gems and why only native ruby
 
 When used by VSCode this language server will be running using the Ruby runtime provided by Puppet Agent.  That means no native extensions and no bundler.  Also, only the gems provided by Puppet Agent would be available by default.  To work around this limitation all runtime dependencies should be re-vendored and then the load path modified appropriately.
+
+## Known Issues
+
+* [PUP-7668](https://tickets.puppetlabs.com/browse/PUP-7668) Due to incorrect offsets, hover documentation can be displayed when the user is not actually hovering over the resource that the documentation is for.

server/lib/puppet-languageserver/hover_provider.rb

@@ -6,25 +6,21 @@ def self.resolve(content, line_num, char_num)
 
       content = nil
       case item.class.to_s
+      when 'Puppet::Pops::Model::ResourceExpression'
+        content = get_resource_expression_content(item)
+      when 'Puppet::Pops::Model::LiteralString'
+        if item.eContainer.class == Puppet::Pops::Model::AccessExpression
+          expr = item.eContainer.left_expr.expr.value
+
+          content = get_hover_content_for_access_expression(item, expr)
+        elsif item.eContainer.class == Puppet::Pops::Model::ResourceBody
+          # We are hovering over the resource name
+          content = get_resource_expression_content(item.eContainer.eContainer)
+        end
       when 'Puppet::Pops::Model::VariableExpression'
         expr = item.expr.value
 
-        if expr == 'facts'
-          # We are dealing with the facts variable
-          # Just get the first part of the array and display that
-          if item.eContainer.eContents.length > 1
-            factname = item.eContainer.eContents[1].value
-            content = get_fact_content(factname)
-          end
-        elsif expr.start_with?('::') && expr.rindex(':') == 1
-          # We are dealing with a top local scope variable - Possible fact name
-          factname = expr.slice(2, expr.length - 2)
-          content = get_fact_content(factname)
-        else
-          # Could be a flatout fact name.  May not *shrugs*.  That method of access is deprecated
-          content = get_fact_content(expr)
-        end
-
+        content = get_hover_content_for_access_expression(item, expr)
       when 'Puppet::Pops::Model::QualifiedName'
         if !item.eContainer.nil? && item.eContainer.class.to_s == 'Puppet::Pops::Model::ResourceExpression'
           content = get_resource_expression_content(item.eContainer)
@@ -62,6 +58,27 @@ def self.resolve(content, line_num, char_num)
       end
     end
 
+    def self.get_hover_content_for_access_expression(item, expr)
+      if expr == 'facts'
+        # We are dealing with the facts variable
+        # Just get the first part of the array and display that
+        if item.eContainer.eContents.length > 1
+          factname = item.eContainer.eContents[1].value
+          content = get_fact_content(factname)
+        end
+      elsif expr.start_with?('::') && expr.rindex(':') == 1
+        # We are dealing with a top local scope variable - Possible fact name
+        factname = expr.slice(2, expr.length - 2)
+        content = get_fact_content(factname)
+      else
+        # Could be a flatout fact name.  May not *shrugs*.  That method of access is deprecated
+        content = get_fact_content(expr)
+      end
+
+      content
+    end
+
+
     # Content generation functions
     def self.get_fact_content(factname)
       return nil unless PuppetLanguageServer::FacterHelper.facts.key?(factname)

server/spec/integration/puppet-languageserver/hover_provider_spec.rb

@@ -65,7 +65,6 @@
         let(:char_num) { 10 }
 
         it 'should return resource description' do
-          pending('Not implemented')
           result = subject.resolve(content, line_num, char_num)
 
           expect(result['contents']).to start_with("**user** Resource\n")
@@ -77,7 +76,6 @@
         let(:char_num) { 1 }
 
         it 'should return resource description' do
-          pending('Not implemented')
           result = subject.resolve(content, line_num, char_num)
 
           expect(result['contents']).to start_with("**user** Resource\n")
@@ -175,7 +173,6 @@
         let(:char_num) { 22 }
 
         it 'should return fact information' do
-          pending('Not implemented')
           result = subject.resolve(content, line_num, char_num)
 
           expect(result['contents']).to start_with("**operatingsystem** Fact\n")
@@ -201,5 +198,40 @@
         end
       end
     end
+
+    context "Given a resource in an else block" do
+      let(:content) { <<-EOF
+class firewall {
+  if(true) {
+  } else {
+    service { 'service':
+      ensure    => running
+    }
+  }
+}
+    EOF
+      }
+
+      describe 'when cursor is hovering on else branch' do
+        let(:line_num) { 2 }
+        let(:char_num) { 6 }
+        it 'should not complete to service resource' do
+          pending("(PUP-7668) parser is assigning an incorrect offset")
+
+          result = subject.resolve(content, line_num, char_num)
+          expect(result['contents']).not_to start_with("**service** Resource\n")
+        end
+      end
+
+      describe 'when cursor is hovering on service resource' do
+        let(:line_num) { 3 }
+        let(:char_num) { 6 }
+        it 'should complete to service resource documentation' do
+          result = subject.resolve(content, line_num, char_num)
+
+          expect(result['contents']).to start_with("**service** Resource\n")
+        end
+      end
+    end
   end
 end