Class: Puppet::Pops::Validation::Checker4_0 Private

Inherits:
Evaluator::LiteralEvaluator show all
Includes:
Evaluator::ExternalSyntaxSupport
Defined in:
lib/puppet/pops/validation/checker4_0.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A Validator validates a model.

Validation is performed on each model element in isolation. Each method should validate the model element’s state but not validate its referenced/contained elements except to check their validity in their respective role. The intent is to drive the validation with a tree iterator that visits all elements in a model.

TODO: Add validation of multiplicities - this is a general validation that can be checked for all

Model objects via their metamodel. (I.e an extra call to multiplicity check in polymorph check).
This is however mostly valuable when validating model to model transformations, and is therefore T.B.D

Direct Known Subclasses

TasksChecker

Constant Summary collapse

RESERVED_TYPE_NAMES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  'type' => true,
  'any' => true,
  'unit' => true,
  'scalar' => true,
  'boolean' => true,
  'numeric' => true,
  'integer' => true,
  'float' => true,
  'collection' => true,
  'array' => true,
  'hash' => true,
  'tuple' => true,
  'struct' => true,
  'variant' => true,
  'optional' => true,
  'enum' => true,
  'regexp' => true,
  'pattern' => true,
  'runtime' => true,
  'init' => true,
  'object' => true,
  'sensitive' => true,
  'semver' => true,
  'semverrange' => true,
  'string' => true,
  'timestamp' => true,
  'timespan' => true,
  'typeset' => true,
}
FUTURE_RESERVED_WORDS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  'plan' => true
}
NO_NAMESPACE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

:no_namespace
NO_PATH =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

:no_path
BAD_MODULE_FILE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

:bad_module_file
RESERVED_PARAMETERS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  'name' => true,
  'title' => true,
}

Constants inherited from Evaluator::LiteralEvaluator

Evaluator::LiteralEvaluator::COMMA_SEPARATOR

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Evaluator::ExternalSyntaxSupport

#assert_external_syntax, #checker_for_syntax, #lookup_keys_for_syntax

Methods inherited from Evaluator::LiteralEvaluator

#literal, #literal_ConcatenatedString, #literal_Factory, #literal_LiteralBoolean, #literal_LiteralDefault, #literal_LiteralHash, #literal_LiteralList, #literal_LiteralNumber, #literal_LiteralRegularExpression, #literal_LiteralString, #literal_LiteralUndef, #literal_Object, #literal_Program, #literal_QualifiedName

Constructor Details

#initialize(diagnostics_producer) ⇒ Checker4_0

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes the validator with a diagnostics producer. This object must respond to ‘:will_accept?` and `:accept`.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 33

def initialize(diagnostics_producer)
  super()
  @@rvalue_visitor      ||= Visitor.new(nil, "rvalue", 0, 0)
  @@hostname_visitor    ||= Visitor.new(nil, "hostname", 1, 2)
  @@assignment_visitor  ||= Visitor.new(nil, "assign", 0, 1)
  @@query_visitor       ||= Visitor.new(nil, "query", 0, 0)
  @@relation_visitor    ||= Visitor.new(nil, "relation", 0, 0)
  @@idem_visitor        ||= Visitor.new(nil, "idem", 0, 0)

  @check_visitor = self.class.check_visitor
  @acceptor = diagnostics_producer

  # Use null migration checker unless given in context
  @migration_checker = (Puppet.lookup(:migration_checker) { Migration::MigrationChecker.new() })
end

Instance Attribute Details

#acceptor ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



21
22
23
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 21

def acceptor
  @acceptor
end

#migration_checker ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



22
23
24
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 22

def migration_checker
  @migration_checker
end

Class Method Details

.check_visitor ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



24
25
26
27
28
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 24

def self.check_visitor
  # Class instance variable rather than Class variable because methods visited
  # may be overridden in subclass
  @check_visitor ||= Visitor.new(nil, 'check', 0, 0)
end

Instance Method Details

#assign(o, via_index = false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks the LHS of an assignment (is it assignable?). If args is true, assignment via index is checked.



124
125
126
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 124

def assign(o, via_index = false)
  @@assignment_visitor.visit_this_1(self, o, via_index)
end

#assign_AccessExpression(o, via_index) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



165
166
167
168
169
170
171
172
173
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 165

def assign_AccessExpression(o, via_index)
  # Are indexed assignments allowed at all ? $x[x] = '...'
  if acceptor.will_accept? Issues::ILLEGAL_INDEXED_ASSIGNMENT
    acceptor.accept(Issues::ILLEGAL_INDEXED_ASSIGNMENT, o)
  else
    # Then the left expression must be assignable-via-index
    assign(o.left_expr, true)
  end
end

#assign_LiteralList(o, via_index) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



175
176
177
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 175

def assign_LiteralList(o, via_index)
  o.values.each {|x| assign(x) }
end

#assign_Object(o, via_index) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



179
180
181
182
183
184
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 179

def assign_Object(o, via_index)
  # Can not assign to anything else (differentiate if this is via index or not)
  # i.e. 10 = 'hello' vs. 10['x'] = 'hello' (the root is reported as being in error in both cases)
  #
  acceptor.accept(via_index ? Issues::ILLEGAL_ASSIGNMENT_VIA_INDEX : Issues::ILLEGAL_ASSIGNMENT, o)
end

#assign_VariableExpression(o, via_index) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

—ASSIGNMENT CHECKS



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 149

def assign_VariableExpression(o, via_index)
  varname_string = varname_to_s(o.expr)
  if varname_string =~ Patterns::NUMERIC_VAR_NAME
    acceptor.accept(Issues::ILLEGAL_NUMERIC_ASSIGNMENT, o, :varname => varname_string)
  end
  # Can not assign to something in another namespace (i.e. a '::' in the name is not legal)
  if acceptor.will_accept? Issues::CROSS_SCOPE_ASSIGNMENT
    if varname_string =~ /::/
      acceptor.accept(Issues::CROSS_SCOPE_ASSIGNMENT, o, :name => varname_string)
    end
  end

  # TODO: Could scan for reassignment of the same variable if done earlier in the same container
  #       Or if assigning to a parameter (more work).
end

#check(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Performs regular validity check



66
67
68
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 66

def check(o)
  @check_visitor.visit_this_0(self, o)
end

#check_AccessExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



195
196
197
198
199
200
201
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 195

def check_AccessExpression(o)
  # Only min range is checked, all other checks are RT checks as they depend on the resulting type
  # of the LHS.
  if o.keys.size < 1
    acceptor.accept(Issues::MISSING_INDEX, o)
  end
end

#check_AssignmentExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 203

def check_AssignmentExpression(o)
  case o.operator
  when '='
    assign(o.left_expr)
    rvalue(o.right_expr)
  when '+=', '-='
    acceptor.accept(Issues::APPENDS_DELETES_NO_LONGER_SUPPORTED, o, {:operator => o.operator})
  else
    acceptor.accept(Issues::UNSUPPORTED_OPERATOR, o, {:operator => o.operator})
  end
end

#check_AttributeOperation(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks that operation with :+> is contained in a ResourceOverride or Collector.

Parent of an AttributeOperation can be one of:

  • CollectExpression

  • ResourceOverride

  • ResourceBody (ILLEGAL this is a regular resource expression)

  • ResourceDefaults (ILLEGAL)



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 223

def check_AttributeOperation(o)
  if o.operator == '+>'
    # Append operator use is constrained
    p = container
    unless p.is_a?(Model::CollectExpression) || p.is_a?(Model::ResourceOverrideExpression)
      acceptor.accept(Issues::ILLEGAL_ATTRIBUTE_APPEND, o, {:name=>o.attribute_name, :parent=>p})
    end
  end
  rvalue(o.value_expr)
end

#check_AttributesOperation(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 234

def check_AttributesOperation(o)
  # Append operator use is constrained
  p = container
  case p
  when Model::AbstractResource
  when Model::CollectExpression
  else
    # protect against just testing a snippet that has no parent, error message will be a bit strange
    # but it is not for a real program.
    parent2 = p.nil? ? o : container(-2)
    unless parent2.is_a?(Model::AbstractResource)
      acceptor.accept(Issues::UNSUPPORTED_OPERATOR_IN_CONTEXT, parent2, :operator=>'* =>')
    end
  end
  rvalue(o.expr)
end

#check_BinaryExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



251
252
253
254
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 251

def check_BinaryExpression(o)
  rvalue(o.left_expr)
  rvalue(o.right_expr)
end

#check_BlockExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 265

def check_BlockExpression(o)
  if resource_without_title?(o)
    acceptor.accept(Issues::RESOURCE_WITHOUT_TITLE, o, :name => o.statements[0].value)
  else
    o.statements[0..-2].each do |statement|
      if idem(statement)
        acceptor.accept(Issues::IDEM_EXPRESSION_NOT_LAST, statement)
        break # only flag the first
      end
    end
  end
end

#check_CallNamedFunctionExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 278

def check_CallNamedFunctionExpression(o)
  functor = o.functor_expr
  if functor.is_a?(Model::QualifiedReference) ||
    functor.is_a?(Model::AccessExpression) && functor.left_expr.is_a?(Model::QualifiedReference)
    # ok (a call to a type)
    return nil
  end
  case functor
  when Model::QualifiedName
    # ok
    nil
  when Model::RenderStringExpression
    # helpful to point out this easy to make Epp error
    acceptor.accept(Issues::ILLEGAL_EPP_PARAMETERS, o)
  else
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.functor_expr, {:feature=>'function name', :container => o})
  end
end

#check_CaseExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 319

def check_CaseExpression(o)
  rvalue(o.test)
  # There can only be one LiteralDefault case option value
  found_default = false
  o.options.each do |option|
    option.values.each do |value|
      if value.is_a?(Model::LiteralDefault)
        # Flag the second default as 'unreachable'
        acceptor.accept(Issues::DUPLICATE_DEFAULT, value, :container => o) if found_default
        found_default = true
      end
    end
  end
end

#check_CaseOption(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



334
335
336
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 334

def check_CaseOption(o)
  o.values.each { |v| rvalue(v) }
end

#check_CollectExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



338
339
340
341
342
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 338

def check_CollectExpression(o)
  unless o.type_expr.is_a? Model::QualifiedReference
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.type_expr, :feature=> 'type name', :container => o)
  end
end

#check_EppExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



297
298
299
300
301
302
303
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 297

def check_EppExpression(o)
  p = container
  if p.is_a?(Model::LambdaExpression)
    internal_check_no_capture(p, o)
    internal_check_parameter_name_uniqueness(p)
  end
end

#check_Factory(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



191
192
193
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 191

def check_Factory(o)
  check(o.model)
end

#check_FunctionDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



460
461
462
463
464
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 460

def check_FunctionDefinition(o)
  check_NamedDefinition(o)
  internal_check_return_type(o)
  internal_check_parameter_name_uniqueness(o)
end

#check_HeredocExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



305
306
307
308
309
310
311
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 305

def check_HeredocExpression(o)
  # Only syntax check static text in heredoc during validation - dynamic text is validated by the evaluator.
  expr = o.text_expr
  if expr.is_a?(Model::LiteralString)
    assert_external_syntax(nil, expr.value, o.syntax, o.text_expr)
  end
end

#check_HostClassDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



466
467
468
469
470
471
472
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 466

def check_HostClassDefinition(o)
  check_NamedDefinition(o)
  internal_check_no_capture(o)
  internal_check_parameter_name_uniqueness(o)
  internal_check_reserved_params(o)
  internal_check_no_idem_last(o)
end

#check_IfExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



684
685
686
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 684

def check_IfExpression(o)
  rvalue(o.test)
end

#check_KeyedEntry(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



688
689
690
691
692
693
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 688

def check_KeyedEntry(o)
  rvalue(o.key)
  rvalue(o.value)
  # In case there are additional things to forbid than non-rvalues
  # acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.key, :feature => 'hash key', :container => container)
end

#check_LambdaExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



695
696
697
698
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 695

def check_LambdaExpression(o)
  internal_check_capture_last(o)
  internal_check_return_type(o)
end

#check_LiteralHash(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



711
712
713
714
715
716
717
718
719
720
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 711

def check_LiteralHash(o)
  # the keys of a literal hash may be non-literal expressions. They cannot be checked.
  unique = Set.new
  o.entries.each do |entry|
    catch(:not_literal) do
      literal_key = literal(entry.key)
      acceptor.accept(Issues::DUPLICATE_KEY, entry, {:key => literal_key}) if unique.add?(literal_key).nil?
    end
  end
end

#check_LiteralInteger(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



704
705
706
707
708
709
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 704

def check_LiteralInteger(o)
  v = o.value
  if v < MIN_INTEGER || v > MAX_INTEGER
    acceptor.accept(Issues::NUMERIC_OVERFLOW, o, {:value => v})
  end
end

#check_LiteralList(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



700
701
702
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 700

def check_LiteralList(o)
  o.values.each {|v| rvalue(v) }
end

#check_MethodCallExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



313
314
315
316
317
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 313

def check_MethodCallExpression(o)
  unless o.functor_expr.is_a? Model::QualifiedName
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.functor_expr, :feature => 'function name', :container => o)
  end
end

#check_NamedAccessExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Only used for function names, grammar should not be able to produce something faulty, but check anyway if model is created programmatically (it will fail in transformation to AST for sure).



346
347
348
349
350
351
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 346

def check_NamedAccessExpression(o)
  name = o.right_expr
  unless name.is_a? Model::QualifiedName
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, name, :feature=> 'function name', :container => container)
  end
end

#check_NamedDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

for ‘class’, ‘define’, and function



389
390
391
392
393
394
395
396
397
398
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 389

def check_NamedDefinition(o)
  top(o)
  if o.name !~ Patterns::CLASSREF_DECL
    acceptor.accept(Issues::ILLEGAL_DEFINITION_NAME, o, {:name=>o.name})
  end

  internal_check_file_namespace(o)
  internal_check_reserved_type_name(o, o.name)
  internal_check_future_reserved_word(o, o.name)
end

#check_NodeDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 722

def check_NodeDefinition(o)
  # Check that hostnames are valid hostnames (or regular expressions)
  hostname(o.host_matches, o)
  top(o)
  violator = ends_with_idem(o.body)
  if violator
    acceptor.accept(Issues::IDEM_NOT_ALLOWED_LAST, violator, {:container => o}) unless resource_without_title?(violator)
  end
  unless o.parent.nil?
    acceptor.accept(Issues::ILLEGAL_NODE_INHERITANCE, o.parent)
  end
end

#check_Object(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

—CHECKS



188
189
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 188

def check_Object(o)
end

#check_Parameter(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 764

def check_Parameter(o)
  if o.name =~ /^(?:0x)?[0-9]+$/
    acceptor.accept(Issues::ILLEGAL_NUMERIC_PARAMETER, o, :name => o.name)
  end

  unless o.name =~ Patterns::PARAM_NAME
    acceptor.accept(Issues::ILLEGAL_PARAM_NAME, o, :name => o.name)
  end
  return unless o.value

  internal_check_illegal_assignment(o.value)
end

#check_QualifiedName(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

No checking takes place - all expressions using a QualifiedName need to check. This because the rules are slightly different depending on the container (A variable allows a numeric start, but not other names). This means that (if the lexer/parser so chooses) a QualifiedName can be anything when it represents a Bare Word and evaluates to a String.



740
741
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 740

def check_QualifiedName(o)
end

#check_QualifiedReference(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks that the value is a valid UpperCaseWord (a CLASSREF), and optionally if it contains a hypen. DOH: QualifiedReferences are created with LOWER CASE NAMES at parse time



745
746
747
748
749
750
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 745

def check_QualifiedReference(o)
  # Is this a valid qualified name?
  if o.cased_value !~ Patterns::CLASSREF_EXT
    acceptor.accept(Issues::ILLEGAL_CLASSREF, o, {:name=>o.cased_value})
  end
end

#check_QueryExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



752
753
754
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 752

def check_QueryExpression(o)
  query(o.expr) if o.expr  # is optional
end

#check_RelationshipExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

relationship_side: resource

| resourceref
| collection
| variable
| quotedtext
| selector
| casestatement
| hasharrayaccesses



796
797
798
799
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 796

def check_RelationshipExpression(o)
  relation(o.left_expr)
  relation(o.right_expr)
end

#check_ReservedWord(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



837
838
839
840
841
842
843
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 837

def check_ReservedWord(o)
  if o.future
    acceptor.accept(Issues::FUTURE_RESERVED_WORD, o, :word => o.word)
  else
    acceptor.accept(Issues::RESERVED_WORD, o, :word => o.word)
  end
end

#check_ResourceBody(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 812

def check_ResourceBody(o)
  seenUnfolding = false
  o.operations.each do |ao|
    if ao.is_a?(Model::AttributesOperation)
      if seenUnfolding
        acceptor.accept(Issues::MULTIPLE_ATTRIBUTES_UNFOLD, ao)
      else
        seenUnfolding = true
      end
    end
  end
end

#check_ResourceDefaultsExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



825
826
827
828
829
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 825

def check_ResourceDefaultsExpression(o)
  if o.form != 'regular'
    acceptor.accept(Issues::NOT_VIRTUALIZEABLE, o)
  end
end

#check_ResourceExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



801
802
803
804
805
806
807
808
809
810
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 801

def check_ResourceExpression(o)
  # The expression for type name cannot be statically checked - this is instead done at runtime
  # to enable better error message of the result of the expression rather than the static instruction.
  # (This can be revised as there are static constructs that are illegal, but require updating many
  # tests that expect the detailed reporting).
  type_name_expr = o.type_name
  if o.form && o.form != 'regular' && type_name_expr.is_a?(Model::QualifiedName) && type_name_expr.value == 'class'
    acceptor.accept(Issues::CLASS_NOT_VIRTUALIZABLE, o)
  end
end

#check_ResourceOverrideExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



831
832
833
834
835
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 831

def check_ResourceOverrideExpression(o)
  if o.form != 'regular'
    acceptor.accept(Issues::NOT_VIRTUALIZEABLE, o)
  end
end

#check_ResourceTypeDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



474
475
476
477
478
479
480
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 474

def check_ResourceTypeDefinition(o)
  check_NamedDefinition(o)
  internal_check_no_capture(o)
  internal_check_parameter_name_uniqueness(o)
  internal_check_reserved_params(o)
  internal_check_no_idem_last(o)
end

#check_SelectorEntry(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



855
856
857
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 855

def check_SelectorEntry(o)
  rvalue(o.matching_expr)
end

#check_SelectorExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



845
846
847
848
849
850
851
852
853
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 845

def check_SelectorExpression(o)
  rvalue(o.left_expr)
  # There can only be one LiteralDefault case option value
  defaults = o.selectors.select {|v| v.matching_expr.is_a?(Model::LiteralDefault) }
  unless defaults.size <= 1
    # Flag the second default as 'unreachable'
    acceptor.accept(Issues::DUPLICATE_DEFAULT, defaults[1].matching_expr, :container => o)
  end
end

#check_TypeAlias(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



400
401
402
403
404
405
406
407
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 400

def check_TypeAlias(o)
  top(o)
  if o.name !~ Patterns::CLASSREF_EXT_DECL
    acceptor.accept(Issues::ILLEGAL_DEFINITION_NAME, o, {:name=>o.name})
  end
  internal_check_reserved_type_name(o, o.name)
  internal_check_type_ref(o, o.type_expr)
end

#check_TypeDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



453
454
455
456
457
458
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 453

def check_TypeDefinition(o)
  top(o)
  internal_check_reserved_type_name(o, o.name)
  # TODO: Check TypeDefinition body. For now, just error out
  acceptor.accept(Issues::UNSUPPORTED_EXPRESSION, o)
end

#check_TypeMapping(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 409

def check_TypeMapping(o)
  top(o)
  lhs = o.type_expr
  lhs_type = 0 # Not Runtime
  if lhs.is_a?(Model::AccessExpression)
    left = lhs.left_expr
    if left.is_a?(Model::QualifiedReference) && left.cased_value == 'Runtime'
      lhs_type = 1 # Runtime
      keys = lhs.keys

      # Must be a literal string or pattern replacement
      lhs_type = 2 if keys.size == 2 && pattern_with_replacement?(keys[1])
    end
  end

  if lhs_type == 0
    # This is not a TypeMapping. Something other than Runtime[] on LHS
    acceptor.accept(Issues::UNSUPPORTED_EXPRESSION, o)
  else
    rhs = o.mapping_expr
    if pattern_with_replacement?(rhs)
      acceptor.accept(Issues::ILLEGAL_SINGLE_TYPE_MAPPING, o) if lhs_type == 1
    elsif type_ref?(rhs)
      acceptor.accept(Issues::ILLEGAL_REGEXP_TYPE_MAPPING, o) if lhs_type == 2
    else
      acceptor.accept(lhs_type == 1 ? Issues::ILLEGAL_SINGLE_TYPE_MAPPING : Issues::ILLEGAL_REGEXP_TYPE_MAPPING, o)
    end
  end
end

#check_UnaryExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



859
860
861
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 859

def check_UnaryExpression(o)
  rvalue(o.expr)
end

#check_UnlessExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



863
864
865
866
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 863

def check_UnlessExpression(o)
  rvalue(o.test)
  # TODO: Unless may not have an else part that is an IfExpression (grammar denies this though)
end

#check_VariableExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks that variable is either strictly 0, or a non 0 starting decimal number, or a valid VAR_NAME



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 869

def check_VariableExpression(o)
  # The expression must be a qualified name or an integer
  name_expr = o.expr
  return if name_expr.is_a?(Model::LiteralInteger)
  if !name_expr.is_a?(Model::QualifiedName)
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o, :feature => 'name', :container => o)
  else
    # name must be either a decimal string value, or a valid NAME
    name = o.expr.value
    if name[0,1] =~ /[0-9]/
      unless name =~ Patterns::NUMERIC_VAR_NAME
        acceptor.accept(Issues::ILLEGAL_NUMERIC_VAR_NAME, o, :name => name)
      end
    else
      unless name =~ Patterns::VAR_NAME
        acceptor.accept(Issues::ILLEGAL_VAR_NAME, o, :name => name)
      end
    end
  end
end

#container(index = -1)) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



61
62
63
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 61

def container(index = -1)
  @path[index]
end

#dir_to_names(relative_path) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 638

def dir_to_names(relative_path)
  # Downcasing here because check is case-insensitive
  path_components = relative_path.to_s.downcase.split(File::SEPARATOR)

  # Example definition dir: manifests in this path:
  # <module name>/manifests/<module subdir>/<classfile>.pp
  dir = path_components[1]

  # How can we get this result?
  # If it is not an initial manifest, it must come from a module,
  # and from the manifests dir there.  This may never get used...
  return BAD_MODULE_FILE unless dir == 'manifests' || dir == 'functions' || dir == 'types' || dir == 'plans'

  names = path_components[2 .. -2] # Directories inside module
  names.unshift(path_components[0]) # Name of the module itself

  # Do not include name of module init file at top level of module
  # e.g. <module name>/manifests/init.pp
  filename = path_components[-1]
  if !(path_components.length == 3 && filename == 'init.pp')
    names.push(filename[0 .. -4]) # Remove .pp from filename
  end

  names
end

#ends_with_idem(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the last expression in a block, or the expression, if that expression is idem



138
139
140
141
142
143
144
145
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 138

def ends_with_idem(o)
  if o.is_a?(Model::BlockExpression)
    last = o.statements[-1]
    idem(last) ? last : nil
  else
    idem(o) ? o : nil
  end
end

#hostname(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Performs check if this is a vaid hostname expression

Parameters:

  • single_feature_name (String, nil) —

    the name of a single valued hostname feature of the value’s container. e.g. ‘parent’



72
73
74
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 72

def hostname(o, semantic)
  @@hostname_visitor.visit_this_1(self, o, semantic)
end

#hostname_Array(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Transforms Array of host matching expressions into a (Ruby) array of AST::HostName



893
894
895
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 893

def hostname_Array(o, semantic)
  o.each {|x| hostname(x, semantic) }
end

#hostname_ConcatenatedString(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 911

def hostname_ConcatenatedString(o, semantic)
  # Puppet 3.1. only accepts a concatenated string without interpolated expressions
  the_expr = o.segments.index {|s| s.is_a?(Model::TextExpression) }
  if the_expr
    acceptor.accept(Issues::ILLEGAL_HOSTNAME_INTERPOLATION, o.segments[the_expr].expr)
  elsif o.segments.size() != 1
    # corner case, bad model, concatenation of several plain strings
    acceptor.accept(Issues::ILLEGAL_HOSTNAME_INTERPOLATION, o)
  else
    # corner case, may be ok, but lexer may have replaced with plain string, this is
    # here if it does not
    hostname_String(o.segments[0], o.segments[0])
  end
end

#hostname_LiteralDefault(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



938
939
940
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 938

def hostname_LiteralDefault(o, semantic)
  # always ok
end

#hostname_LiteralNumber(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



934
935
936
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 934

def hostname_LiteralNumber(o, semantic)
  # always ok
end

#hostname_LiteralRegularExpression(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



942
943
944
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 942

def hostname_LiteralRegularExpression(o, semantic)
  # always ok
end

#hostname_LiteralValue(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



907
908
909
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 907

def hostname_LiteralValue(o, semantic)
  hostname_String(o.value.to_s, o)
end

#hostname_Object(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



946
947
948
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 946

def hostname_Object(o, semantic)
  acceptor.accept(Issues::ILLEGAL_EXPRESSION, o, {:feature => 'hostname', :container => semantic})
end

#hostname_QualifiedName(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



926
927
928
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 926

def hostname_QualifiedName(o, semantic)
  hostname_String(o.value.to_s, o)
end

#hostname_QualifiedReference(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



930
931
932
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 930

def hostname_QualifiedReference(o, semantic)
  hostname_String(o.value.to_s, o)
end

#hostname_String(o, semantic) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



897
898
899
900
901
902
903
904
905
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 897

def hostname_String(o, semantic)
  # The 3.x checker only checks for illegal characters - if matching /[^-\w.]/ the name is invalid,
  # but this allows pathological names like "a..b......c", "----"
  # TODO: Investigate if more illegal hostnames should be flagged.
  #
  if o =~ Patterns::ILLEGAL_HOSTNAME_CHARS
    acceptor.accept(Issues::ILLEGAL_HOSTNAME_CHARS, semantic, :hostname => o)
  end
end

#idem(o) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks if the expression has side effect (‘idem’ is latin for ‘the same’, here meaning that the evaluation state is known to be unchanged after the expression has been evaluated). The result is not 100% authoritative for negative answers since analysis of function behavior is not possible.

Returns:

  • (Boolean) —

    true if expression is known to have no effect on evaluation state



133
134
135
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 133

def idem(o)
  @@idem_visitor.visit_this_0(self, o)
end

#idem_AccessExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1035
1036
1037
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1035

def idem_AccessExpression(o)
  true
end

#idem_ApplyExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An apply expression exists purely for the side effect of applying a catalog somewhere, so it always has side effects



1100
1101
1102
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1100

def idem_ApplyExpression(o)
  false
end

#idem_AssignmentExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1052
1053
1054
1055
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1052

def idem_AssignmentExpression(o)
  # Always side effect
  false
end

#idem_BinaryExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1039
1040
1041
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1039

def idem_BinaryExpression(o)
  true
end

#idem_BlockExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1075
1076
1077
1078
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1075

def idem_BlockExpression(o)
  # productive if there is at least one productive expression
  ! o.statements.any? {|expr| !idem(expr) }
end

#idem_CaseExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Case expression is idem, if test, and all options are idem



1109
1110
1111
1112
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1109

def idem_CaseExpression(o)
  return false if !idem(o.test)
  ! o.options.any? {|opt| !idem(opt) }
end

#idem_CaseOption(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An option is idem if values and the then_expression are idem



1115
1116
1117
1118
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1115

def idem_CaseOption(o)
  return false if o.values.any? { |value| !idem(value) }
  idem(o.then_expr)
end

#idem_ConcatenatedString(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns true even though there may be interpolated expressions that have side effect. Report as idem anyway, as it is very bad design to evaluate an interpolated string for its side effect only.



1083
1084
1085
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1083

def idem_ConcatenatedString(o)
  true
end

#idem_Factory(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1031
1032
1033
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1031

def idem_Factory(o)
  idem(o.model)
end

#idem_HeredocExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Heredoc is just a string, but may contain interpolated string (which may have side effects). This is still bad design and should be reported as idem.



1089
1090
1091
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1089

def idem_HeredocExpression(o)
  true
end

#idem_IfExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1104
1105
1106
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1104

def idem_IfExpression(o)
  [o.test, o.then_expr, o.else_expr].all? {|e| idem(e) }
end

#idem_Literal(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1019
1020
1021
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1019

def idem_Literal(o)
  true
end

#idem_LiteralHash(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1027
1028
1029
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1027

def idem_LiteralHash(o)
  true
end

#idem_LiteralList(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1023
1024
1025
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1023

def idem_LiteralList(o)
  true
end

#idem_MatchExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1043
1044
1045
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1043

def idem_MatchExpression(o)
  false # can have side effect of setting $n match variables
end

#idem_NilClass(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1015
1016
1017
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1015

def idem_NilClass(o)
  true
end

#idem_Nop(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1011
1012
1013
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1011

def idem_Nop(o)
  true
end

#idem_Object(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

–IDEM CHECK



1007
1008
1009
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1007

def idem_Object(o)
  false
end

#idem_ParenthesizedExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Allow (no-effect parentheses) to be used around a productive expression



1063
1064
1065
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1063

def idem_ParenthesizedExpression(o)
  idem(o.expr)
end

#idem_RelationshipExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1047
1048
1049
1050
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1047

def idem_RelationshipExpression(o)
  # Always side effect
  false
end

#idem_RenderExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1067
1068
1069
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1067

def idem_RenderExpression(o)
  false
end

#idem_RenderStringExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1071
1072
1073
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1071

def idem_RenderStringExpression(o)
  false
end

#idem_SelectorExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

May technically have side effects inside the Selector, but this is bad design - treat as idem



1094
1095
1096
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1094

def idem_SelectorExpression(o)
  true
end

#idem_UnaryExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Handles UnaryMinusExpression, NotExpression, VariableExpression



1058
1059
1060
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1058

def idem_UnaryExpression(o)
  true
end

#initial_manifest?(path, manifest_setting) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


610
611
612
613
614
615
616
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 610

def initial_manifest?(path, manifest_setting)
  return false if manifest_setting.nil? || manifest_setting == :no_manifest

  string_path = path.to_s

  string_path == manifest_setting || string_path.start_with?(manifest_setting)
end

#internal_check_capture_last(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



503
504
505
506
507
508
509
510
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 503

def internal_check_capture_last(o)
  accepted_index = o.parameters.size() -1
  o.parameters.each_with_index do |p, index|
    if p.captures_rest && index != accepted_index
      acceptor.accept(Issues::CAPTURES_REST_NOT_LAST, p, {:param_name => p.name})
    end
  end
end

#internal_check_file_namespace(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 536

def internal_check_file_namespace(o)
  file = o.locator.file
  return if file.nil? || file == '' #e.g. puppet apply -e '...'

  file_namespace = namespace_for_file(file)
  return if file_namespace == NO_NAMESPACE

  # Downcasing here because check is case-insensitive
  if file_namespace == BAD_MODULE_FILE || !o.name.downcase.start_with?(file_namespace)
    acceptor.accept(Issues::ILLEGAL_DEFINITION_LOCATION, o, {:name => o.name, :file => file})
  end
end

#internal_check_future_reserved_word(o, name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



526
527
528
529
530
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 526

def internal_check_future_reserved_word(o, name)
  if FUTURE_RESERVED_WORDS[name]
    acceptor.accept(Issues::FUTURE_RESERVED_WORD, o, {:word => name})
  end
end

#internal_check_illegal_assignment(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



777
778
779
780
781
782
783
784
785
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 777

def internal_check_illegal_assignment(o)
  if o.is_a?(Model::AssignmentExpression)
    acceptor.accept(Issues::ILLEGAL_ASSIGNMENT_CONTEXT, o)
  else
    # recursively check all contents unless it's a lambda expression. A lambda may contain
    # local assignments
    o._pcore_contents {|model| internal_check_illegal_assignment(model) } unless o.is_a?(Model::LambdaExpression)
  end
end

#internal_check_no_capture(o, container = o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



512
513
514
515
516
517
518
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 512

def internal_check_no_capture(o, container = o)
  o.parameters.each do |p|
    if p.captures_rest
      acceptor.accept(Issues::CAPTURES_REST_NOT_SUPPORTED, p, {:container => container, :param_name => p.name})
    end
  end
end

#internal_check_no_idem_last(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



496
497
498
499
500
501
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 496

def internal_check_no_idem_last(o)
  violator = ends_with_idem(o.body)
  if violator
    acceptor.accept(Issues::IDEM_NOT_ALLOWED_LAST, violator, {:container => o}) unless resource_without_title?(violator)
  end
end

#internal_check_parameter_name_uniqueness(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



677
678
679
680
681
682
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 677

def internal_check_parameter_name_uniqueness(o)
  unique = Set.new
  o.parameters.each do |p|
    acceptor.accept(Issues::DUPLICATE_PARAMETER, p, {:param_name => p.name}) unless unique.add?(p.name)
  end
end

#internal_check_reserved_params(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



669
670
671
672
673
674
675
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 669

def internal_check_reserved_params(o)
  o.parameters.each do |p|
    if RESERVED_PARAMETERS[p.name]
      acceptor.accept(Issues::RESERVED_PARAMETER, p, {:container => o, :param_name => p.name})
    end
  end
end

#internal_check_reserved_type_name(o, name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



520
521
522
523
524
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 520

def internal_check_reserved_type_name(o, name)
  if RESERVED_TYPE_NAMES[name]
    acceptor.accept(Issues::RESERVED_TYPE_NAME, o, {:name => name})
  end
end

#internal_check_return_type(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



482
483
484
485
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 482

def internal_check_return_type(o)
  r = o.return_type
  internal_check_type_ref(o, r) unless r.nil?
end

#internal_check_top_construct_in_module(prog) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 549

def internal_check_top_construct_in_module(prog)
  return unless prog.is_a?(Model::Program) && !prog.body.nil?

  #Check that this is a module autoloaded file
  file = prog.locator.file
  return if file.nil?
  return if namespace_for_file(file) == NO_NAMESPACE

  body = prog.body
  return if prog.body.is_a?(Model::Nop) #Ignore empty or comment-only files

  if(body.is_a?(Model::BlockExpression))
    body.statements.each { |s| acceptor.accept(Issues::ILLEGAL_TOP_CONSTRUCT_LOCATION, s) unless valid_top_construct?(s) }
  else
    acceptor.accept(Issues::ILLEGAL_TOP_CONSTRUCT_LOCATION, body) unless valid_top_construct?(body)
  end
end

#internal_check_type_ref(o, r) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



487
488
489
490
491
492
493
494
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 487

def internal_check_type_ref(o, r)
  n = r.is_a?(Model::AccessExpression) ? r.left_expr : r
  if n.is_a? Model::QualifiedReference
    internal_check_future_reserved_word(r, n.value)
  else
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, r, :feature => 'a type reference', :container => o)
  end
end

#namespace_for_file(file) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 582

def namespace_for_file(file)
  env = Puppet.lookup(:current_environment)
  return NO_NAMESPACE if env.nil?

  adapter = Puppet::Util::FileNamespaceAdapter.adapt(env)

  file_namespace = adapter.file_to_namespace[file]
  return file_namespace unless file_namespace.nil? # No cache entry, so we do the calculation

  path = Pathname.new(file)

  return adapter.file_to_namespace[file] = NO_NAMESPACE if path.extname != ".pp"

  path = path.expand_path

  return adapter.file_to_namespace[file] = NO_NAMESPACE if initial_manifest?(path, env.manifest)

  #All auto-loaded files from modules come from a module search path dir
  relative_path = get_module_relative_path(path, env.full_modulepath)

  return adapter.file_to_namespace[file] = NO_NAMESPACE if relative_path == NO_PATH

  #If a file comes from a module, but isn't in the right place, always error
  names = dir_to_names(relative_path)

  return adapter.file_to_namespace[file] = (names == BAD_MODULE_FILE ? BAD_MODULE_FILE : names.join("::").freeze)
end

#pattern_with_replacement?(o) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


439
440
441
442
443
444
445
446
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 439

def pattern_with_replacement?(o)
  if o.is_a?(Model::LiteralList)
    v = o.values
    v.size == 2 && v[0].is_a?(Model::LiteralRegularExpression) && v[1].is_a?(Model::LiteralString)
  else
    false
  end
end

#query(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Performs check if this is valid as a query



77
78
79
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 77

def query(o)
  @@query_visitor.visit_this_0(self, o)
end

#query_BooleanExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Allows AND, OR, and checks if left/right are allowed in query.



964
965
966
967
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 964

def query_BooleanExpression(o)
  query o.left_expr
  query o.right_expr
end

#query_ComparisonExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Puppet AST only allows == and !=



959
960
961
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 959

def query_ComparisonExpression(o)
  acceptor.accept(Issues::ILLEGAL_QUERY_EXPRESSION, o) unless ['==', '!='].include? o.operator
end

#query_LiteralBoolean(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



981
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 981

def query_LiteralBoolean(o); end

#query_LiteralNumber(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



977
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 977

def query_LiteralNumber(o); end

#query_LiteralString(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



979
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 979

def query_LiteralString(o); end

#query_Object(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Anything not explicitly allowed is flagged as error.



953
954
955
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 953

def query_Object(o)
  acceptor.accept(Issues::ILLEGAL_QUERY_EXPRESSION, o)
end

#query_ParenthesizedExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



969
970
971
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 969

def query_ParenthesizedExpression(o)
  query(o.expr)
end

#query_QualifiedName(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



975
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 975

def query_QualifiedName(o); end

#query_VariableExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



973
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 973

def query_VariableExpression(o); end

#relation(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Performs check if this is valid as a relationship side



82
83
84
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 82

def relation(o)
  @@relation_visitor.visit_this_0(self, o)
end

#relation_CollectExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



760
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 760

def relation_CollectExpression(o); end

#relation_Object(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



756
757
758
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 756

def relation_Object(o)
  rvalue(o)
end

#relation_RelationshipExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



762
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 762

def relation_RelationshipExpression(o); end

#resource_without_title?(o) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


256
257
258
259
260
261
262
263
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 256

def resource_without_title?(o)
  if o.instance_of?(Model::BlockExpression)
    statements = o.statements
    statements.length == 2 && statements[0].instance_of?(Model::QualifiedName) && statements[1].instance_of?(Model::LiteralHash)
  else
    false
  end
end

#rvalue(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Performs check if this is valid as a rvalue



87
88
89
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 87

def rvalue(o)
  @@rvalue_visitor.visit_this_0(self, o)
end

#rvalue_CollectExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



990
991
992
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 990

def rvalue_CollectExpression(o)
  acceptor.accept(Issues::NOT_RVALUE, o)
end

#rvalue_Definition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



994
995
996
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 994

def rvalue_Definition(o)
  acceptor.accept(Issues::NOT_RVALUE, o)
end

#rvalue_Expression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

By default, all expressions are reported as being rvalues Implement specific rvalue checks for those that are not.



988
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 988

def rvalue_Expression(o); end

#rvalue_NodeDefinition(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



998
999
1000
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 998

def rvalue_NodeDefinition(o)
  acceptor.accept(Issues::NOT_RVALUE, o)
end

#rvalue_UnaryExpression(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1002
1003
1004
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1002

def rvalue_UnaryExpression(o)
  rvalue o.expr
end

#top(definition, idx = -1)) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

—TOP CHECK Performs check if this is valid as a container of a definition (class, define, node)



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 93

def top(definition, idx = -1)
  o = container(idx)
  idx -= 1
  case o
  when NilClass, Model::ApplyExpression, Model::HostClassDefinition, Model::Program
    # ok, stop scanning parents
  when Model::BlockExpression
    c = container(idx)
    if !c.is_a?(Model::Program) &&
      (definition.is_a?(Model::FunctionDefinition) || definition.is_a?(Model::TypeAlias) || definition.is_a?(Model::TypeDefinition))

      # not ok. These can never be nested in a block
      acceptor.accept(Issues::NOT_ABSOLUTE_TOP_LEVEL, definition)
    else
      # ok, if this is a block representing the body of a class, or is top level
      top(definition, idx)
    end
  when Model::LambdaExpression
    # A LambdaExpression is a BlockExpression, and this check is needed to prevent the polymorph method for BlockExpression
    # to accept a lambda.
    # A lambda can not iteratively create classes, nodes or defines as the lambda does not have a closure.
    acceptor.accept(Issues::NOT_TOP_LEVEL, definition)
  else
    # fail, reached a container that is not top level
    acceptor.accept(Issues::NOT_TOP_LEVEL, definition)
  end
end

#type_ref?(o) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


448
449
450
451
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 448

def type_ref?(o)
  o = o.left_expr if o.is_a?(Model::AccessExpression)
  o.is_a?(Model::QualifiedReference)
end

#valid_top_construct?(o) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


567
568
569
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 567

def valid_top_construct?(o)
  o.is_a?(Model::Definition) && !o.is_a?(Model::NodeDefinition)
end

#validate(model) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Validates the entire model by visiting each model element and calling ‘check`. The result is collected (or acted on immediately) by the configured diagnostic provider/acceptor given when creating this Checker.



53
54
55
56
57
58
59
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 53

def validate(model)
  # tree iterate the model, and call check for each element
  @path = []
  check(model)
  internal_check_top_construct_in_module(model)
  model._pcore_all_contents(@path) { |element| check(element) }
end

#varname_to_s(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Produces string part of something named, or nil if not a QualifiedName or QualifiedReference



1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/puppet/pops/validation/checker4_0.rb', line 1124

def varname_to_s(o)
  case o
  when Model::QualifiedName
    o.value
  when Model::QualifiedReference
    o.value
  else
    nil
  end
end