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
|
# distbuild/protocol.py -- abstractions for the JSON messages
#
# Copyright (C) 2012, 2014-2015 Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
'''Construct protocol message objects (dicts).'''
# Version refers to an integer that should be incremented by one each time a
# time a change is introduced that would break server/initiator compatibility
VERSION = 4
_required_fields = {
'build-request': [
'id',
'repo',
'ref',
'morphology',
'partial',
'protocol_version',
'allow_detach',
],
'build-progress': [
'id',
'message',
],
'step-started': [
'id',
'step_name',
'worker_name',
],
'build-started': [
'id',
],
'step-already-started': [
'id',
'step_name',
'worker_name',
],
'step-output': [
'id',
'step_name',
'stdout',
'stderr',
],
'step-finished': [
'id',
'step_name',
],
'step-failed': [
'id',
'step_name',
],
'build-finished': [
'id',
'urls',
],
'build-failed': [
'id',
'reason',
],
'build-cancelled': [
'id',
],
'exec-request': [
'id',
'argv',
'stdin_contents',
],
'exec-cancel': [
'id',
],
'http-request': [
'id',
'url',
'method',
'headers',
'body',
],
'list-requests': [
'id',
'protocol_version',
],
'request-output': [
'message',
],
'build-cancel': [
'id',
'protocol_version',
],
'build-status': [
'id',
'protocol_version',
],
'graphing-started': [
'id',
],
'graphing-finished': [
'id'
],
'cache-state': [
'id',
'unbuilt',
'total'
]
}
_optional_fields = {
'build-request': [
'original_ref',
'component_names'
]
}
def _validate(message_type, **kwargs):
required_fields = _required_fields[message_type]
optional_fields = _optional_fields.get(message_type, [])
known_types = _required_fields.keys()
assert message_type in known_types
for name in required_fields:
assert name in kwargs, 'field %s is required' % name
for name in kwargs:
assert (name in required_fields or name in optional_fields), \
'field %s is not allowed' % name
def message(message_type, **kwargs):
_validate(message_type, **kwargs)
msg = dict(kwargs)
msg['type'] = message_type
return msg
def is_valid_message(msg):
if 'type' not in msg:
return False
msg_type = msg['type']
del msg['type']
try:
_validate(msg_type, **msg)
return True
except AssertionError:
return False
finally:
msg['type'] = msg_type
|
