Class: PDK::Validate::PuppetSyntax

Inherits:
BaseValidator show all
Defined in:
lib/pdk/validate/puppet/puppet_syntax.rb

Constant Summary collapse

ERROR_CONTEXT =

In Puppet >= 5.3.4, the error context formatting was changed to facilitate localization

%r{(?:file:\s(?<file>.+?)|line:\s(?<line>.+?)|column:\s(?<column>.+?))}
ERROR_CONTEXT_LEGACY =

In Puppet < 5.3.3, the error context was formatted in these variations:

- "at file_path:line_num:col_num"
- "at file_path:line_num"
- "at line line_num"
- "in file_path"

%r{(?:at\sline\s(?<line>\d+)|at\s(?<file>.+?):(?<line>\d+):(?<column>\d+)|at\s(?<file>.+?):(?<line>\d+)|in\s(?<file>.+?))}
PUPPET_SYNTAX_PATTERN = 
%r{^
  (?<severity>.+?):\s
  (?<message>.+?)
  (?:
    \s\(#{ERROR_CONTEXT}(,\s#{ERROR_CONTEXT})*\)| # attempt to match the new localisation friendly location
    \s#{ERROR_CONTEXT_LEGACY}| # attempt to match the old " at file:line:column" location
    $                                               # handle cases where the output has no location
  )
$}x

Constants inherited from BaseValidator

BaseValidator::INVOKE_STYLE

Class Method Summary collapse

Methods inherited from BaseValidator

cmd_path, invoke, parse_targets, process_invalid, process_skipped

Class Method Details

.cmd ⇒ Object 



31
32
33
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 31

def self.cmd
  'puppet'
end

.name ⇒ Object 



27
28
29
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 27

def self.name
  'puppet-syntax'
end

.null_file ⇒ Object 



47
48
49
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 47

def self.null_file
  Gem.win_platform? ? 'NUL' : '/dev/null'
end

.parse_offense(offense) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 79

def self.parse_offense(offense)
  sanitize_console_output(offense)

  offense_data = {
    source:  name,
    state:  :failure,
  }

  attributes = offense.match(PUPPET_SYNTAX_PATTERN)

  attributes.names.each do |name|
    offense_data[name.to_sym] = attributes[name] unless attributes[name].nil?
  end

  offense_data
end

.parse_options(_options, targets) ⇒ Object 



43
44
45
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 43

def self.parse_options(_options, targets)
  ['parser', 'validate', '--config', null_file].concat(targets)
end

.parse_output(report, result, targets) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 51

def self.parse_output(report, result, targets)
  # Due to PUP-7504, we will have to programmatically construct the json
  # object from the text output for now.
  output = result[:stderr].split("\n").reject { |entry| entry.empty? }

  results_data = []
  output.each do |offense|
    offense_data = parse_offense(offense)
    results_data << offense_data
  end

  # puppet parser validate does not include files without problems in its
  # output, so we need to go through the list of targets and add passing
  # events to the report for any target not listed in the output.
  targets.reject { |target| results_data.any? { |j| j[:file] == target } }.each do |target|
    report.add_event(
      file:     target,
      source:   name,
      severity: :ok,
      state:    :passed,
    )
  end

  results_data.each do |offense|
    report.add_event(offense)
  end
end

.pattern ⇒ Object 



35
36
37
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 35

def self.pattern
  '**/**.pp'
end

.sanitize_console_output(line) ⇒ Object 



96
97
98
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 96

def self.sanitize_console_output(line)
  line.gsub!(%r{\e\[([;\d]+)?m}, '')
end

.spinner_text(_targets = nil) ⇒ Object 



39
40
41
 
# File 'lib/pdk/validate/puppet/puppet_syntax.rb', line 39

def self.(_targets = nil)
  _('Checking Puppet manifest syntax (%{pattern}).') % { pattern: pattern }
end