(GH-98) Add test for function loading and puppet fixtures

This commit adds tests for loading functions with errors.  This commit adds the
required file structure and fixture setting for a custom puppet environment.
This is needed to isolate the spec test fixtures from a potentially
misconfigured local puppet agent environment.  Resulting in possible false
negative and positive test results.

Author: glennsarti

server/spec/fixtures/cache/facts.d/.gitkeep

@@ -0,0 +1,10 @@
+require 'a_bad_gem_that_does_not_exist'
+
+module Puppet::Parser::Functions
+  newfunction(:bad_file, :type => :rvalue, :doc => <<-EOS
+Function that will fail loading
+    EOS
+  ) do |arguments|
+    # Do nothing
+  end
+end

server/spec/fixtures/cache/lib/facter/.gitkeep

@@ -0,0 +1,9 @@
+module Puppet::Parser::Functions
+  newfunction(:bad_function, :type => :rvalue, :doc => <<-EOS
+Function that will fail loading
+    EOS
+  ) do |arguments|
+
+    require 'a_bad_gem_that_does_not_exist'
+  end
+end

server/spec/fixtures/cache/lib/puppet/parser/functions/badfile.rb

@@ -0,0 +1,41 @@
+#
+# concat.rb
+#
+
+module Puppet::Parser::Functions
+  newfunction(:concat, :type => :rvalue, :doc => <<-EOS
+Appends the contents of multiple arrays into array 1.
+
+*Example:*
+
+    concat(['1','2','3'],['4','5','6'],['7','8','9'])
+
+Would result in:
+
+  ['1','2','3','4','5','6','7','8','9']
+    EOS
+  ) do |arguments|
+
+    # Check that more than 2 arguments have been given ...
+    raise(Puppet::ParseError, "concat(): Wrong number of arguments " +
+      "given (#{arguments.size} for < 2)") if arguments.size < 2
+
+    a = arguments[0]
+
+    # Check that the first parameter is an array
+    unless a.is_a?(Array)
+      raise(Puppet::ParseError, 'concat(): Requires array to work with')
+    end
+
+    result = a
+    arguments.shift
+
+    arguments.each do |x|
+      result = result + (x.is_a?(Array) ? x : [x])
+    end
+
+    return result
+  end
+end
+
+# vim: set ts=2 sw=2 et :

server/spec/fixtures/cache/lib/puppet/parser/functions/badfunction.rb

@@ -0,0 +1,7 @@
+# Text fixture puppet.conf which redirects all Puppet configuration into the
+# fixtures directory
+[main]
+environment = test-fixtures
+environmentpath = $codedir/environments
+codedir = $vardir/..
+logdir = $vardir/../logdir

server/spec/fixtures/cache/lib/puppet/parser/functions/concat.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'puppet_helper' do
+  let(:subject) { PuppetLanguageServer::PuppetHelper }
+
+  # The concat function is loaded from the fixtures/cache/lib/puppet/parser/functions/concat.rb file
+  # The bad_function function is loaded from the fixtures/cache/lib/puppet/parser/functions/badfunction.rb file
+  # The bad_file function is loaded from the fixtures/cache/lib/puppet/parser/functions/badfile.rb file
+
+  let(:good_function)       { 'concat' } # A valid function that works
+  let(:bad_function)        { 'bad_function' } # A function that has an error inside the function code
+  let(:unloadable_function) { 'bad_file' } # A function that cannot be loaded
+
+  describe '#function_names' do
+    it 'should list functions which do not error' do
+      expect(subject.function_names).to include(good_function)
+    end
+    it 'should list functions which error inside the function code' do
+      expect(subject.function_names).to include(bad_function)
+    end
+    it 'should not list functions which error during loading' do
+      expect(subject.function_names).to_not include(unloadable_function)
+    end
+  end
+
+  describe '#function' do
+    it 'should get details about functions which do not error' do
+      result = subject.function(good_function)
+
+      expect(result).to include(:name)
+      expect(result).to include(:type)
+    end
+    it 'should get details about functions which error inside the function code' do
+      result = subject.function(bad_function)
+
+      expect(result).to include(:name)
+      expect(result).to include(:type)
+    end
+    it 'should not get details about functions which error during loading' do
+      result = subject.function(unloadable_function)
+
+      expect(result).to be_nil
+    end
+  end
+end

server/spec/fixtures/confdir/puppet.conf

@@ -6,10 +6,16 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..','vendor','puppet-lint','lib'))
 
 require 'puppet-languageserver'
-PuppetLanguageServer::init_puppet(PuppetLanguageServer::CommandLineParser.parse([]))
+fixtures_dir = File.join(File.dirname(__FILE__),'fixtures')
 
-# Custom RSpec Matchers
+# Currently there is no way to re-initialize the puppet loader so for the moment
+# all tests must run off the single puppet config settings instead of per example setting
+server_options = PuppetLanguageServer::CommandLineParser.parse([])
+server_options[:puppet_settings] = ['--vardir',File.join(fixtures_dir,'cache'),
+                                    '--confdir',File.join(fixtures_dir,'confdir')]
+PuppetLanguageServer::init_puppet(server_options)
 
+# Custom RSpec Matchers
 RSpec::Matchers.define :be_completion_item_with_type do |value|
   value = [value] unless value.is_a?(Array)
 
@@ -19,4 +25,3 @@
     "be a Completion Item with a data type in the list of #{value}"
   end
 end
-