Class: PDK::Validate::Tasks::TasksMetadataLintValidator

Inherits:
InternalRubyValidator show all
Defined in:
lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb

Constant Summary collapse

FORGE_SCHEMA_URL = 
'https://forgeapi.puppet.com/schemas/task.json'.freeze

Instance Attribute Summary

Attributes inherited from Validator

#context, #options, #prepared

Instance Method Summary collapse

Methods inherited from InternalRubyValidator

#before_validation, #invoke, #prepare_invoke!

Methods inherited from InvokableValidator

#allow_empty_targets?, #ignore_dotfiles?, #invoke_style, #parse_targets, #pattern_ignore, #prepare_invoke!, #process_invalid, #process_skipped, #spinner, #valid_in_context?

Methods inherited from Validator

#initialize, #invoke, #prepare_invoke!, #spinner, #spinners_enabled?, #start_spinner, #stop_spinner, #valid_in_context?

Constructor Details

This class inherits a constructor from PDK::Validate::Validator

Instance Method Details

#name ⇒ Object 



9
10
11
 
# File 'lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb', line 9

def name
  'task-metadata-lint'
end

#pattern ⇒ Object 



13
14
15
 
# File 'lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb', line 13

def pattern
  contextual_pattern('tasks/*.json')
end

#schema_file ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb', line 23

def schema_file
  require 'pdk/util/vendored_file'

  schema = PDK::Util::VendoredFile.new('task.json', FORGE_SCHEMA_URL).read

  JSON.parse(schema)
rescue PDK::Util::VendoredFile::DownloadError => e
  raise PDK::CLI::FatalError, e.message
rescue JSON::ParserError
  raise PDK::CLI::FatalError, _('Failed to parse Task Metadata Schema file.')
end

#spinner_text ⇒ Object 



17
18
19
20
21
 
# File 'lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb', line 17

def 
  _('Checking task metadata style (%{pattern}).') % {
    pattern: pattern.join(' '),
  }
end

#validate_target(report, target) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
78
79
80
81
82
83
84
 
# File 'lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb', line 35

def validate_target(report, target)
  unless PDK::Util::Filesystem.readable?(target)
    report.add_event(
      file:     target,
      source:   name,
      state:    :failure,
      severity: 'error',
      message:  _('Could not be read.'),
    )
    return 1
  end

  require 'json-schema'
  begin
    # Need to set the JSON Parser and State Generator to the Native one to be
    # compatible with the multi_json adapter.
    JSON.parser = JSON::Ext::Parser if defined?(JSON::Ext::Parser)
    JSON.generator = JSON::Ext::Generator

    begin
      errors = JSON::Validator.fully_validate(schema_file, PDK::Util::Filesystem.read_file(target)) || []
    rescue JSON::Schema::SchemaError => e
      raise PDK::CLI::FatalError, _('Unable to validate Task Metadata. %{error}.') % { error: e.message }
    end

    if errors.empty?
      report.add_event(
        file:     target,
        source:   name,
        state:    :passed,
        severity: 'ok',
      )
      return 0
    else
      errors.each do |error|
        # strip off the trailing parts that aren't relevant
        error = error.split('in schema').first if error.include? 'in schema'

        report.add_event(
          file:     target,
          source:   name,
          state:    :failure,
          severity: 'error',
          message:  error,
        )
      end
      return 1
    end
  end
end