/
metadata.py
185 lines (138 loc) · 6.01 KB
/
metadata.py
1
2
3
4
5
6
7
8
9
10
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
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
"""JSL schemas for Mercator worker results."""
import jsl
from f8a_worker.schemas import JSLSchemaBaseWithRelease
ROLE_v4_0_0 = "v4-0-0"
ROLE_TITLE = jsl.roles.Var({
# clean up; look for older schema definitions in git history ;)
# allow additional properties in LockFile/LockedDependency
ROLE_v4_0_0: "Package Metadata v4-0-0",
})
class CodeRepository(jsl.Document):
"""JSL schema for code repository description."""
class Options(object):
"""JSL schema for code repository description."""
definition_id = "metadata_code_repository"
description = "Code repository description"
type = jsl.StringField(required=False)
url = jsl.StringField(required=True)
class Maintainer(jsl.Document):
"""JSL schema for maintainer description."""
class Options(object):
"""JSL schema for maintainer description."""
definition_id = "metadata_maintainer"
description = "Maintainer description"
name = jsl.StringField()
email = jsl.StringField()
url = jsl.StringField()
class LockedDependency(jsl.Document):
"""JSL schema for locked dependency description."""
class Options(object):
"""JSL schema for locked dependency description."""
definition_id = "metadata_locked_dependency"
description = "Locked dependency description"
additional_properties = True
name = jsl.StringField()
version = jsl.StringField()
specification = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
resolved = jsl.OneOfField([jsl.StringField(), jsl.NullField(), jsl.BooleanField()])
dependencies = jsl.ArrayField(jsl.DocumentField(jsl.RECURSIVE_REFERENCE_CONSTANT, as_ref=True))
# go glide
subpackages = jsl.ArrayField(jsl.StringField())
class LockFile(jsl.Document):
"""JSL schema for dependency lock file description."""
class Options(object):
"""JSL schema for dependency lock file description."""
definition_id = "metadata_lockfile"
description = "Dependency lock file description"
additional_properties = True
runtime = jsl.StringField()
version = jsl.StringField()
dependencies = jsl.ArrayField(jsl.DocumentField(LockedDependency, as_ref=True))
name = jsl.StringField()
# go glide
hash = jsl.StringField()
updated = jsl.StringField()
class NpmShrinkwrap(jsl.Document):
"""JSL schema for npm-shrinkwrap description."""
class Options(object):
"""JSL schema for npm-shrinkwrap description."""
definition_id = "npm_shrinkwrap"
description = "npm-shrinkwrap description"
name = jsl.StringField()
version = jsl.StringField()
npm_shrinkwrap_version = jsl.StringField()
node_version = jsl.StringField()
resolved_dependencies = jsl.ArrayField(jsl.StringField())
dependencies = jsl.ArrayField(jsl.StringField())
_system = jsl.StringField()
class MetadataDict(jsl.Document):
"""JSL schema for generic metadata dict in details list."""
class Options(object):
"""JSL schema for generic metadata dict in details list."""
definition_id = "details_metadata"
description = "generic metadata dict in details list"
# some of these may be missing in some ecosystem, so no required=True
# 'author' should have been list of 'authors', but it's too late now
author = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
bug_reporting = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
code_repository = jsl.OneOfField(
[jsl.DocumentField(CodeRepository, as_ref=True), jsl.NullField()]
)
declared_licenses = jsl.OneOfField([jsl.ArrayField(
jsl.StringField()),
jsl.NullField()]
)
dependencies = jsl.OneOfField(
[jsl.ArrayField(jsl.StringField()), jsl.NullField()]
)
description = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
devel_dependencies = jsl.OneOfField(
[jsl.ArrayField(jsl.StringField()), jsl.NullField()]
)
# engines are NPM thingie and can contain lots of various keys
# so we just allow pretty much anything in that dict
engines = jsl.OneOfField(
[jsl.DictField(additional_properties=True), jsl.NullField()]
)
files = jsl.OneOfField(
[jsl.ArrayField(jsl.StringField()), jsl.NullField()]
)
git_head = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
homepage = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
keywords = jsl.OneOfField(
[jsl.ArrayField(jsl.StringField()), jsl.NullField()]
)
# metadata is a rubygems thing and can contain arbitrary key/value pairs
metadata = jsl.OneOfField(
[jsl.DictField(additional_properties=True), jsl.NullField()]
)
name = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
platform = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
readme = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
scripts = jsl.OneOfField(
[jsl.DictField(additional_properties=True), jsl.NullField()]
)
version = jsl.OneOfField([jsl.StringField(), jsl.NullField()])
contributors = jsl.OneOfField(
[jsl.ArrayField(jsl.StringField()), jsl.NullField()])
maintainers = jsl.OneOfField(
[jsl.ArrayField(jsl.StringField()), jsl.NullField()])
_tests_implemented = jsl.BooleanField()
ecosystem = jsl.StringField()
_dependency_tree_lock = jsl.OneOfField([
jsl.DocumentField(LockFile, as_ref=True), jsl.NullField()
])
path = jsl.OneOfField(
[jsl.StringField(), jsl.NullField()],
required=False
)
class MercatorResult(JSLSchemaBaseWithRelease):
"""JSL schema for Mercator worker results."""
class Options(object):
"""JSL schema for Mercator worker results."""
definition_id = "metadata"
description = "Result of Mercator worker"
details = jsl.ArrayField(jsl.DocumentField(MetadataDict, as_ref=True))
status = jsl.StringField(enum=["success", "error"], required=True)
summary = jsl.ArrayField(jsl.StringField(), required=True)
THE_SCHEMA = MercatorResult