(PUP-11981) Syntactically incorrect types cause nil in Puppet::InfoService::ClassInformationService

[AriaXLi]

This commit adds logic to validate class parameters are literal and provides a descriptive warning if parameter(s) are not literal, adds QualifiedReference and AccessExpression as a valid literal values & updates spec tests to check for more cases of invalid class parameters and any that broke as a result of the changes.

The logic to validate class parameters is done in internal_check_parameter_type_literal method where the appropriate literal method is called on each parameter. There are different literal methods for each literal object/type [1]. For example if the parameter is String type, then literal_LiteralString is called. If a parameter is found to be not literal, then a :not_literal will be thrown & warning message with the invalid class parameter and its type will be printed.

QualifiedReference is considered literal since it is a literal reference, however, there is a possibility it could be a faulty dangling reference that doesn't reference anything. AccessExpresions are anything with the Access Operator ([ ]) such as Optional[String] or Variant[Boolean, Float] [2]. Since these are valid class parameters, AccessExpressions are also considered literal.

The logic to add QualifiedReference & AccessExpression as valid literal values is done in the literal_QualifiedReference & literal_AccessExpression methods. The literal_AccessExpression method works by validating each key in the expression is literal. The literal_QualifiedReference method looks at o.value, similar to other existing literal methods like literal_LiteralString.

[1] http://puppet-on-the-edge.blogspot.com/2014/02/puppet-internals-polymorphic-dispatch.html
[2] https://github.com/puppetlabs/puppet-specifications/blob/master/language/expressions.md#assignment-operator

For more information on this issue, see #9140

[AriaXLi]

jenkins please test this

[AriaXLi]

jenkins please test this

Passed: https://jenkins-platform.delivery.puppetlabs.net/job/platform_puppet-agent-extra_puppet-agent-integration-suite_pr/2440/

[joshcooper]

@AriaXLi since this issue was originally encountered in the ClassInfoService, could you add a test to somewhere in

puppet/spec/unit/info_service_spec.rb

Lines 479 to 524 in 050c7b4

	it "produces expression string if a default value is not literal" do
	files = ['fee.pp'].map {|f| File.join(code_dir, f) }
	result = Puppet::InfoService.classes_per_environment({'production' => files })
	expect(result).to eq({
	"production"=>{
	"#{code_dir}/fee.pp"=>{:classes => [
	{:name=>"fee",
	:params=>[
	{:name=>"fee_a", :type=>"Integer", :default_source=>"1+1"}
	]},
	]}} # end production env
	})
	end
	it "produces source string for literals that are not pure json" do
	files = ['json_unsafe.pp'].map {|f| File.join(code_dir, f) }
	result = Puppet::InfoService.classes_per_environment({'production' => files })
	expect(result).to eq({
	"production"=>{
	"#{code_dir}/json_unsafe.pp" => {:classes => [
	{:name=>"json_unsafe",
	:params => [
	{:name => "arg1",
	:default_source => "/.*/" },
	{:name => "arg2",
	:default_source => "default" },
	{:name => "arg3",
	:default_source => "{1 => 1}" }
	]}
	]}} # end production env
	})
	end
	it "produces no type entry if type is not given" do
	files = ['fum.pp'].map {|f| File.join(code_dir, f) }
	result = Puppet::InfoService.classes_per_environment({'production' => files })
	expect(result).to eq({
	"production"=>{
	"#{code_dir}/fum.pp"=>{:classes => [
	{:name=>"fum",
	:params=>[
	{:name=>"fum_a" }
	]},
	]}} # end production env
	})
	end

for non-literal class parameters?

[joshcooper]

@AriaXLi could you backport this and 8992763 to 7.x?