Top Level Namespace

Defined Under Namespace

Classes: PuppetLint, PuppetResource

Instance Method Summary collapse

Instance Method Details

#check_class(klass) ⇒ Object 



225
226
227
228
229
230
231
232
233
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 225

def check_class(klass)
  # No lookup lookups allowed in a class.
  lookup klass
  # Cannot include or declare classes from other modules
  class_illegal_include klass
  illegal_class_declaration klass
  # System::role only goes in roles
  check_no_system_role klass
end

#check_define(define) ⇒ Object 



235
236
237
238
239
240
241
242
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 235

def check_define(define)
  # No lookup calls are admitted in defines. ever.
  lookup define
  # No class can be included in defines, like in classes
  class_illegal_include define
  # Non-profile defines should respect the rules for classes
  illegal_class_declaration define unless define.module_name == 'profile'
end

#check_deprecations(resource) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 407

def check_deprecations(resource)
  # Check the resource for declarations of deprecated defines
  legacy_validate_errors resource
  legacy_hiera resource
  deprecated_defines = ['base::service_unit']
  deprecated_defines.each do |deprecated|
    resource.resource?(deprecated).each do |token|
      msg = {
        message: "wmf-style: '#{resource.name}' should not include the deprecated define '#{token.value}'",
        line: token.line,
        column: token.column
      }
      notify :error, msg
    end
  end
end

#check_no_defines(klass) ⇒ Object 



396
397
398
399
400
401
402
403
404
405
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 396

def check_no_defines(klass)
  # In a role, check if there is any define apart from one system::role call
  return if klass.declared_resources == klass.resource?('system::role')
  msg = {
    message: "wmf-style: role '#{klass.name}' should not include defines",
    line: 1,
    column: 1
  }
  notify :error, msg
end

#check_no_system_role(klass) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 384

def check_no_system_role(klass)
  # The system::role define should only be used in roles
  klass.resource?('system::role').each do |token|
    msg = {
      message: "wmf-style: #{klass.type} '#{klass.name}' declares system::role, which should only be used in roles",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#check_node(node) ⇒ Object

rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/CyclomaticComplexity



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 425

def check_node(node)
  title = node[:title_tokens].map(&:value).join(', ')
  node[:tokens].each do |token|
    msg = nil
    if token.lookup?
      msg = {
        message: "wmf-style: node '#{title}' calls lookup function",
        line: token.line,
        column: token.column
      }
    elsif token.legacy_hiera?
      msg = {
        message: "wmf-style: node '#{title}' calls legacy #{token.value} function",
        line: token.line,
        column: token.column
      }
    elsif token.class_include?
      msg = {
        message: "wmf-style: node '#{title}' includes class #{token.included_class.value}",
        line: token.line,
        column: token.column
      }
    elsif token.declared_class
      msg = {
        message: "wmf-style: node '#{title}' declares class #{token.declared_class.value}",
        line: token.line,
        column: token.column
      }
    elsif token.declared_type? && token.value != 'interface::add_ip6_mapped'
      msg = {
        message: "wmf-style: node '#{title}' declares #{token.value}",
        line: token.line,
        column: token.column
      }
    end
    notify :error, msg if msg
  end
end

#check_profile(klass) ⇒ Object

Checks and functions



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 205

def check_profile(klass)
  # All parameters of profiles should have a default value that is a lookup
  params_without_lookup_defaults klass
  # All lookup lookups should be in parameters
  lookup_not_in_params klass
  # Only a few selected classes should be included in a profile
  profile_illegal_include klass
  # System::role only goes in roles
  check_no_system_role klass
end

#check_role(klass) ⇒ Object 



216
217
218
219
220
221
222
223
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 216

def check_role(klass)
  # Hiera lookups within a role are forbidden
  lookup klass
  # A role should only include profiles
  include_not_profile klass
  # No defines should be present in a role
  check_no_defines klass
end

#class_illegal_include(klass) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 335

def class_illegal_include(klass)
  # A class should only include classes from the same module.
  modules_include_ok = [klass.module_name]
  klass.included_classes.each do |token|
    class_name = token.value.gsub(/^::/, '')
    module_name = class_name.split('::')[0]
    next if modules_include_ok.include? module_name
    msg = {
      message: "wmf-style: #{klass.type} '#{klass.name}' includes #{class_name} from another module",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#illegal_class_declaration(klass) ⇒ Object 



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 367

def illegal_class_declaration(klass)
  # Classes and defines should NEVER declare
  # classes from other modules.
  # If a class has multiple such occurrences, it should be a profile
  klass.declared_classes.each do |token|
    class_name = token.value.gsub(/^::/, '')
    module_name = class_name.split('::')[0]
    next if klass.module_name == module_name
    msg = {
      message: "wmf-style: #{klass.type} '#{klass.name}' declares class #{class_name} from another module",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#include_not_profile(klass) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 351

def include_not_profile(klass)
  # Checks that a role only includes other roles and profiles
  modules_include_ok = ['role', 'profile']
  klass.included_classes.each do |token|
    class_name = token.value.gsub(/^::/, '')
    module_name = class_name.split('::')[0]
    next if modules_include_ok.include? module_name
    msg = {
      message: "wmf-style: role '#{klass.name}' includes #{class_name} which is neither a role nor a profile",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#legacy_hiera(klass) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 249

def legacy_hiera(klass)
  # No calls to legacy hiera
  tokens = klass.legacy_hiera_calls
  tokens.each do |token|
    msg = {
      message: "wmf-style: Found deprecated function (#{token.value}) " \
               "in #{klass.type} '#{klass.name}', use lookup instead",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#legacy_validate_errors(klass) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 303

def legacy_validate_errors(klass)
  # Helper for printing errors nicely
  klass.legacy_validate_calls.each do |token|
    msg = {
      message: "wmf-style: Found legacy function (#{token.value}) call in #{klass.type} '#{klass.name}'",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#lookup(klass) ⇒ Object 



244
245
246
247
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 244

def lookup(klass)
  # Searches for lookup calls inside classes and defines.
  lookup_errors(klass.lookup_calls, klass)
end

#lookup_errors(tokens, klass) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 289

def lookup_errors(tokens, klass)
  # Helper for printing lookup errors nicely
  tokens.each do |token|
    # lookup ( 'some::label' )
    value = token.next_code_token.next_code_token.value
    msg = {
      message: "wmf-style: Found lookup call in #{klass.type} '#{klass.name}' for '#{value}'",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end

#lookup_not_in_params(klass) ⇒ Object 



279
280
281
282
283
284
285
286
287
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 279

def lookup_not_in_params(klass)
  # Checks if a lookup call is not in a parameter declaration. Used to check profiles
  # Any lookup call that is not inside a parameter declaration is a violation
  tokens = klass.lookup_calls.reject do |token|
    maybe_param = token.prev_code_token.prev_code_token
    klass.params.keys.include?(maybe_param.value)
  end
  lookup_errors(tokens, klass)
end

#params_without_lookup_defaults(klass) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 263

def params_without_lookup_defaults(klass)
  # Finds parameters that have no lookup-defined default value.
  klass.params.each do |name, data|
    next unless data[:value].select(&:lookup?).empty?
    common = "wmf-style: Parameter '#{name}' of class '#{klass.name}'"
    message = if data[:value].select(&:legacy_hiera?).empty?
                "#{common} has no call to lookup"
              else
                "#{common} hiera is deprecated use lookup"
              end
    token = data[:param]
    msg = { message: message, line: token.line, column: token.column }
    notify :error, msg
  end
end

#profile_illegal_include(klass) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/puppet-lint/plugins/check_wmf_styleguide.rb', line 315

def profile_illegal_include(klass)
  # Check if a profile includes any class that's not allowed there.
  # Allowed are: any other profile, or a class from the passwords module,
  # plus a couple parameter classes
  modules_include_ok = ['profile', 'passwords']
  classes_include_ok = ['lvs::configuration', 'network::constants']
  klass.included_classes.each do |token|
    class_name = token.value.gsub(/^::/, '')
    next if classes_include_ok.include? class_name
    module_name = class_name.split('::')[0]
    next if modules_include_ok.include? module_name
    msg = {
      message: "wmf-style: profile '#{klass.name}' includes non-profile class #{class_name}",
      line: token.line,
      column: token.column
    }
    notify :error, msg
  end
end