forked from carbonblack/cbapi-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodels.py
More file actions
294 lines (249 loc) · 8.87 KB
/
models.py
File metadata and controls
294 lines (249 loc) · 8.87 KB
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
from __future__ import absolute_import
from cbapi.models import UnrefreshableModel, NewBaseModel
from cbapi.errors import ApiError, ServerError
from .query import RunQuery, RunHistoryQuery, ResultQuery, FacetQuery
import logging
import time
log = logging.getLogger(__name__)
class Run(NewBaseModel):
"""
Represents a LiveQuery run.
Example::
>>> run = cb.select(Run, run_id)
>>> print(run.name, run.sql, run.create_time)
>>> print(run.status, run.match_count)
>>> run.refresh()
"""
primary_key = "id"
swagger_meta_file = "psc/livequery/models/run.yaml"
urlobject = "/livequery/v1/orgs/{}/runs"
urlobject_single = "/livequery/v1/orgs/{}/runs/{}"
_is_deleted = False
def __init__(self, cb, model_unique_id=None, initial_data=None):
if initial_data is not None:
item = initial_data
elif model_unique_id is not None:
url = self.urlobject_single.format(cb.credentials.org_key, model_unique_id)
item = cb.get_object(url)
model_unique_id = item.get("id")
super(Run, self).__init__(
cb,
model_unique_id=model_unique_id,
initial_data=item,
force_init=False,
full_doc=True,
)
@classmethod
def _query_implementation(cls, cb):
return RunQuery(cls, cb)
def _refresh(self):
if self._is_deleted:
raise ApiError("cannot refresh a deleted query")
url = self.urlobject_single.format(self._cb.credentials.org_key, self.id)
resp = self._cb.get_object(url)
self._info = resp
self._last_refresh_time = time.time()
return True
def stop(self):
if self._is_deleted:
raise ApiError("cannot stop a deleted query")
url = self.urlobject_single.format(self._cb.credentials.org_key, self.id) + "/status"
result = self._cb.put_object(url, {'status': 'CANCELLED'})
if (result.status_code == 200):
try:
self._info = result.json()
self._last_refresh_time = time.time()
return True
except Exception:
raise ServerError(result.status_code, "Cannot parse response as JSON: {0:s}".format(result.content))
return False
def delete(self):
if self._is_deleted:
return True # already deleted
url = self.urlobject_single.format(self._cb.credentials.org_key, self.id)
result = self._cb.delete_object(url)
if result.status_code == 200:
self._is_deleted = True
return True
return False
class RunHistory(Run):
"""
Represents a historical LiveQuery ``Run``.
"""
urlobject_history = "/livequery/v1/orgs/{}/runs/_search"
def __init__(self, cb, initial_data=None):
item = initial_data
model_unique_id = item.get("id")
super(Run, self).__init__(cb,
model_unique_id, initial_data=item,
force_init=False, full_doc=True)
@classmethod
def _query_implementation(cls, cb):
return RunHistoryQuery(cls, cb)
class Result(UnrefreshableModel):
"""
Represents a single result from a LiveQuery ``Run``.
"""
primary_key = "id"
swagger_meta_file = "psc/livequery/models/result.yaml"
urlobject = "/livequery/v1/orgs/{}/runs/{}/results/_search"
class Device(UnrefreshableModel):
"""
Represents device information for a result.
"""
primary_key = "id"
def __init__(self, cb, initial_data):
super(Result.Device, self).__init__(
cb,
model_unique_id=initial_data["id"],
initial_data=initial_data,
force_init=False,
full_doc=True,
)
class Fields(UnrefreshableModel):
"""
Represents the fields of a result.
"""
def __init__(self, cb, initial_data):
super(Result.Fields, self).__init__(
cb,
model_unique_id=None,
initial_data=initial_data,
force_init=False,
full_doc=True,
)
class Metrics(UnrefreshableModel):
"""
Represents the metrics for a result.
"""
def __init__(self, cb, initial_data):
super(Result.Metrics, self).__init__(
cb,
model_unique_id=None,
initial_data=initial_data,
force_init=False,
full_doc=True,
)
@classmethod
def _query_implementation(cls, cb):
return ResultQuery(cls, cb)
def __init__(self, cb, initial_data):
super(Result, self).__init__(
cb,
model_unique_id=initial_data["id"],
initial_data=initial_data,
force_init=False,
full_doc=True,
)
self._run_id = initial_data["id"]
self._device = Result.Device(cb, initial_data=initial_data["device"])
self._fields = Result.Fields(cb, initial_data=initial_data["fields"])
if "metrics" in initial_data:
self._metrics = Result.Metrics(cb, initial_data=initial_data["metrics"])
else:
self._metrics = Result.Metrics(cb, initial_data=None)
@property
def device_(self):
"""
Returns the reified ``Result.Device`` for this result.
"""
return self._device
@property
def fields_(self):
"""
Returns the reified ``Result.Fields`` for this result.
"""
return self._fields
@property
def metrics_(self):
"""
Returns the reified ``Result.Metrics`` for this result.
"""
return self._metrics
def query_device_summaries(self):
return self._cb.select(DeviceSummary).run_id(self._run_id)
def query_result_facets(self):
return self._cb.select(ResultFacet).run_id(self._run_id)
def query_device_summary_facets(self):
return self._cb.select(DeviceSummaryFacet).run_id(self._run_id)
class DeviceSummary(UnrefreshableModel):
"""
Represents the summary of results from a single device during a single LiveQuery ``Run``.
"""
primary_key = "id"
swagger_meta_file = "psc/livequery/models/device_summary.yaml"
urlobject = "/livequery/v1/orgs/{}/runs/{}/results/device_summaries/_search"
class Metrics(UnrefreshableModel):
"""
Represents the metrics for a result.
"""
def __init__(self, cb, initial_data):
super(DeviceSummary.Metrics, self).__init__(
cb,
model_unique_id=None,
initial_data=initial_data,
force_init=False,
full_doc=True,
)
@classmethod
def _query_implementation(cls, cb):
return ResultQuery(cls, cb)
def __init__(self, cb, initial_data):
super(DeviceSummary, self).__init__(
cb,
model_unique_id=initial_data["id"],
initial_data=initial_data,
force_init=False,
full_doc=True,
)
self._metrics = DeviceSummary.Metrics(cb, initial_data=initial_data["metrics"])
@property
def metrics_(self):
"""
Returns the reified ``DeviceSummary.Metrics`` for this result.
"""
return self._metrics
class ResultFacet(UnrefreshableModel):
"""
Represents the summary of results for a single field in a LiveQuery ``Run``.
"""
primary_key = "field"
swagger_meta_file = "psc/livequery/models/facet.yaml"
urlobject = "/livequery/v1/orgs/{}/runs/{}/results/_facet"
class Values(UnrefreshableModel):
"""
Represents the values associated with a field.
"""
def __init__(self, cb, initial_data):
super(ResultFacet.Values, self).__init__(
cb,
model_unique_id=None,
initial_data=initial_data,
force_init=False,
full_doc=True,
)
@classmethod
def _query_implementation(cls, cb):
return FacetQuery(cls, cb)
def __init__(self, cb, initial_data):
super(ResultFacet, self).__init__(
cb,
model_unique_id=None,
initial_data=initial_data,
force_init=False,
full_doc=True
)
self._values = ResultFacet.Values(cb, initial_data=initial_data["values"])
@property
def values_(self):
"""
Returns the reified ``ResultFacet.Values`` for this result.
"""
return self._values
class DeviceSummaryFacet(ResultFacet):
"""
Represents the summary of results for a single device summary in a LiveQuery ``Run``.
"""
urlobject = "/livequery/v1/orgs/{}/runs/{}/results/device_summaries/_facet"
def __init__(self, cb, initial_data):
super(DeviceSummaryFacet, self).__init__(cb, initial_data)