Class: PDK::Validate::TaskMetadataLint

Inherits:
BaseValidator show all
Defined in:
lib/pdk/validate/metadata/task_metadata_lint.rb

Constant Summary collapse

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

Constants inherited from BaseValidator

BaseValidator::INVOKE_STYLE

Class Method Summary collapse

Methods inherited from BaseValidator

cmd_path, parse_options, parse_targets, process_invalid, process_skipped

Class Method Details

.create_spinner(targets = [], options = {}) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 27

def self.(targets = [], options = {})
  return unless PDK::CLI::Util.interactive?
  options = options.merge(PDK::CLI::Util.)

  exec_group = options[:exec_group]
  @spinner = if exec_group
               exec_group.((targets), options)
             else
               TTY::Spinner.new("[:spinner] #{(targets)}", options)
             end
  @spinner.auto_spin
end

.download_schema_from_forge ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 64

def self.download_schema_from_forge
  PDK.logger.debug(_('Task Metadata Schema was not found in the cache. Now downloading from the forge.'))
  require 'net/https'
  require 'openssl'

  uri = URI.parse(FORGE_SCHEMA_URL)
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE if Gem.win_platform?
  request = Net::HTTP::Get.new(uri.request_uri)
  response = http.request(request)

  raise PDK::CLI::FatalError, _('Unable to download Task Metadata Schema file. %{code}: %{message}.') % { code: response.code, message: response.message } unless response.code == '200'

  response.body
rescue StandardError => e
  raise PDK::CLI::FatalError, _('Unable to download Task Metadata Schema file. Check internet connectivity and retry this action. %{error}') % { error: e }
end

.invoke(report, options = {}) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 83

def self.invoke(report, options = {})
  targets, skipped, invalid = parse_targets(options)

  process_skipped(report, skipped)
  process_invalid(report, invalid)

  return 0 if targets.empty?

  return_val = 0
  (targets, options)

  targets.each do |target|
    unless File.readable?(target)
      report.add_event(
        file:     target,
        source:   name,
        state:    :failure,
        severity: 'error',
        message:  _('Could not be read.'),
      )
      return_val = 1
      next
    end

    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, File.read(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',
        )
      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_val = 1
      end
    end
  end

  (return_val)
  return_val
end

.name ⇒ Object 



13
14
15
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 13

def self.name
  'task-metadata-lint'
end

.pattern ⇒ Object 



17
18
19
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 17

def self.pattern
  'tasks/*.json'
end

.schema_file ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 52

def self.schema_file
  schema = if PDK::Util.package_install? && File.exist?(vendored_task_schema_path)
             File.read(vendored_task_schema_path)
           else
             download_schema_from_forge
           end

  JSON.parse(schema)
rescue JSON::ParserError
  raise PDK::CLI::FatalError, _('Failed to parse Task Metadata Schema file.')
end

.spinner_text(_targets = []) ⇒ Object 



21
22
23
24
25
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 21

def self.(_targets = [])
  _('Checking task metadata style (%{targets}).') % {
    targets: pattern,
  }
end

.stop_spinner(exit_code) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 40

def self.(exit_code)
  if exit_code.zero? && @spinner
    @spinner.success
  elsif @spinner
    @spinner.error
  end
end

.vendored_task_schema_path ⇒ Object 



48
49
50
 
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 48

def self.vendored_task_schema_path
  @vendored_task_schema_path ||= File.join(PDK::Util.package_cachedir, 'task.json')
end