Class: PDK::Validate::TaskMetadataLint
- Inherits:
-
BaseValidator
- Object
- BaseValidator
- PDK::Validate::TaskMetadataLint
- 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
Class Method Summary collapse
- .create_spinner(targets = [], options = {}) ⇒ Object
- .invoke(report, options = {}) ⇒ Object
- .name ⇒ Object
- .pattern ⇒ Object
- .schema_file ⇒ Object
- .spinner_text(_targets = []) ⇒ Object
- .stop_spinner(exit_code) ⇒ Object
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.create_spinner(targets = [], = {}) return unless PDK::CLI::Util.interactive? = .merge(PDK::CLI::Util.spinner_opts_for_platform) exec_group = [:exec_group] @spinner = if exec_group exec_group.add_spinner(spinner_text(targets), ) else TTY::Spinner.new("[:spinner] #{spinner_text(targets)}", ) end @spinner.auto_spin end |
.invoke(report, options = {}) ⇒ Object
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 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 |
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 58 def self.invoke(report, = {}) targets, skipped, invalid = parse_targets() process_skipped(report, skipped) process_invalid(report, invalid) return 0 if targets.empty? return_val = 0 create_spinner(targets, ) 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. } 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 stop_spinner(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
48 49 50 51 52 53 54 55 56 |
# File 'lib/pdk/validate/metadata/task_metadata_lint.rb', line 48 def self.schema_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. 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.spinner_text(_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.stop_spinner(exit_code) if exit_code.zero? && @spinner @spinner.success elsif @spinner @spinner.error end end |