Class: MetadataJsonLint::Schema

Inherits:
Object
  • Object
show all
Defined in:
lib/metadata-json-lint/schema.rb

Overview

Provides validation of metadata.json against a JSON schema document maintained in this class. Provides a good first pass over the metadata with type checking and basic format/length validations. schema data structure is quite large

Instance Method Summary collapse

Instance Method Details

#schema ⇒ Object

Based on https://docs.puppet.com/puppet/latest/modules_metadata.html



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
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/metadata-json-lint/schema.rb', line 11

def schema
  {
    '$schema' => 'http://json-schema.org/draft-04/schema#',
    'properties' => {
      'author' => {
        'type' => 'string',
      },
      'data_provider' => {
        'type' => %w[null string],
      },
      'dependencies' => {
        'type' => 'array',
        'items' => {
          'properties' => {
            'name' => {
              'type' => 'string',
              'pattern' => '^\w+[/-][a-z][a-z0-9_]*$',
            },
            'version_requirement' => {
              'type' => 'string',
            },
          },
          'required' => %w[
            name
          ],
        },
      },
      'description' => {
        'type' => 'string',
      },
      'issues_url' => {
        'type' => 'string',
        'format' => 'uri',
      },
      'license' => {
        'type' => 'string',
      },
      'operatingsystem_support' => {
        'type' => 'array',
        'items' => {
          'properties' => {
            'operatingsystem' => {
              'type' => 'string',
            },
            'operatingsystemrelease' => {
              'type' => 'array',
              'items' => {
                'type' => 'string',
              },
            },
          },
          'required' => %w[
            operatingsystem
          ],
        },
      },
      'name' => {
        'type' => 'string',
        'pattern' => '^\w+-[a-z][a-z0-9_]*$',
      },
      'project_page' => {
        'type' => 'string',
        'format' => 'uri',
      },
      # Undocumented but in use: https://tickets.puppetlabs.com/browse/DOCUMENT-387
      'requirements' => {
        'type' => 'array',
        'items' => {
          'properties' => {
            'name' => {
              'type' => 'string',
            },
            'version_requirement' => {
              'type' => 'string',
            },
          },
          'required' => %w[
            name
          ],
        },
      },
      'source' => {
        'type' => 'string',
      },
      'summary' => {
        'type' => 'string',
        'maxLength' => 144,
      },
      'tags' => {
        'type' => 'array',
        'items' => {
          'type' => 'string',
        },
      },
      'version' => {
        'type' => 'string',
        'format' => 'semver',
      },
    },
    # from https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
    'required' => %w[
      author
      dependencies
      license
      name
      source
      summary
      version
    ],
  }
end

#validate(data, options = {}) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/metadata-json-lint/schema.rb', line 123

def validate(data, options = {})
  JSON::Validator.use_multi_json = false
  JSON::Validator.register_format_validator('semver', method(:semver_validator))

  JSON::Validator.fully_validate(schema, data, options.merge(errors_as_objects: true)).map do |error|
    field = error[:fragment].split('/')[1]
    field = 'root' if field.nil? || field.empty?

    message = error[:message]
              .sub(/ in schema [\w-]+/, '') # remove schema UUID, not needed in output
              .sub(%r{'#/}, "'") # remove root #/ prefix from document paths
              .sub("property ''", 'file') # call the root #/ node the file

    { field: field, message: message }
  end
end