-
Notifications
You must be signed in to change notification settings - Fork 369
/
test_saved_search.py
executable file
·231 lines (205 loc) · 9.02 KB
/
test_saved_search.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
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
#!/usr/bin/env python
#
# Copyright 2011-2015 Splunk, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"): you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from __future__ import absolute_import
import datetime
from tests import testlib
import logging
from time import sleep
import splunklib.client as client
from splunklib.six.moves import zip
import pytest
@pytest.mark.smoke
class TestSavedSearch(testlib.SDKTestCase):
def setUp(self):
super(TestSavedSearch, self).setUp()
saved_searches = self.service.saved_searches
logging.debug("Saved searches namespace: %s", saved_searches.service.namespace)
self.saved_search_name = testlib.tmpname()
query = "search index=_internal * earliest=-1m | head 3"
self.saved_search = saved_searches.create(self.saved_search_name, query)
def tearDown(self):
super(TestSavedSearch, self).setUp()
for saved_search in self.service.saved_searches:
if saved_search.name.startswith('delete-me'):
try:
for job in saved_search.history():
job.cancel()
self.service.saved_searches.delete(saved_search.name)
except KeyError:
pass
def check_saved_search(self, saved_search):
self.check_entity(saved_search)
expected_fields = ['alert.expires',
'alert.severity',
'alert.track',
'alert_type',
'dispatch.buckets',
'dispatch.lookups',
'dispatch.max_count',
'dispatch.max_time',
'dispatch.reduce_freq',
'dispatch.spawn_process',
'dispatch.time_format',
'dispatch.ttl',
'max_concurrent',
'realtime_schedule',
'restart_on_searchpeer_add',
'run_on_startup',
'search',
'action.email',
'action.populate_lookup',
'action.rss',
'action.script',
'action.summary_index']
for f in expected_fields:
saved_search[f]
self.assertGreaterEqual(saved_search.suppressed, 0)
self.assertGreaterEqual(saved_search['suppressed'], 0)
is_scheduled = saved_search.content['is_scheduled']
self.assertTrue(is_scheduled == '1' or is_scheduled == '0')
is_visible = saved_search.content['is_visible']
self.assertTrue(is_visible == '1' or is_visible == '0')
def test_create(self):
self.assertTrue(self.saved_search_name in self.service.saved_searches)
self.check_saved_search(self.saved_search)
def test_delete(self):
self.assertTrue(self.saved_search_name in self.service.saved_searches)
self.service.saved_searches.delete(self.saved_search_name)
self.assertFalse(self.saved_search_name in self.service.saved_searches)
self.assertRaises(client.HTTPError,
self.saved_search.refresh)
def test_update(self):
is_visible = testlib.to_bool(self.saved_search['is_visible'])
self.saved_search.update(is_visible=not is_visible)
self.saved_search.refresh()
self.assertEqual(testlib.to_bool(self.saved_search['is_visible']), not is_visible)
def test_cannot_update_name(self):
new_name = self.saved_search_name + '-alteration'
self.assertRaises(client.IllegalOperationException,
self.saved_search.update, name=new_name)
def test_name_collision(self):
opts = self.opts.kwargs.copy()
opts['owner'] = '-'
opts['app'] = '-'
opts['sharing'] = 'user'
service = client.connect(**opts)
logging.debug("Namespace for collision testing: %s", service.namespace)
saved_searches = service.saved_searches
name = testlib.tmpname()
query1 = '* earliest=-1m | head 1'
query2 = '* earliest=-2m | head 2'
namespace1 = client.namespace(app='search', sharing='app')
namespace2 = client.namespace(owner='admin', app='search', sharing='user')
saved_search2 = saved_searches.create(
name, query2,
namespace=namespace1)
saved_search1 = saved_searches.create(
name, query1,
namespace=namespace2)
self.assertRaises(client.AmbiguousReferenceException,
saved_searches.__getitem__, name)
search1 = saved_searches[name, namespace1]
self.check_saved_search(search1)
search1.update(**{'action.email.from': 'nobody@nowhere.com'})
search1.refresh()
self.assertEqual(search1['action.email.from'], 'nobody@nowhere.com')
search2 = saved_searches[name, namespace2]
search2.update(**{'action.email.from': 'nemo@utopia.com'})
search2.refresh()
self.assertEqual(search2['action.email.from'], 'nemo@utopia.com')
self.check_saved_search(search2)
def test_dispatch(self):
try:
job = self.saved_search.dispatch()
while not job.is_ready():
sleep(0.1)
self.assertTrue(job.sid in self.service.jobs)
finally:
job.cancel()
def test_dispatch_with_options(self):
try:
kwargs = { 'dispatch.buckets': 100 }
job = self.saved_search.dispatch(**kwargs)
while not job.is_ready():
sleep(0.1)
self.assertTrue(job.sid in self.service.jobs)
finally:
job.cancel()
def test_history(self):
try:
old_jobs = self.saved_search.history()
N = len(old_jobs)
logging.debug("Found %d jobs in saved search history", N)
job = self.saved_search.dispatch()
while not job.is_ready():
sleep(0.1)
history = self.saved_search.history()
self.assertEqual(len(history), N+1)
self.assertTrue(job.sid in [j.sid for j in history])
finally:
job.cancel()
def test_history_with_options(self):
try:
old_jobs = self.saved_search.history()
old_jobs_cnt = len(old_jobs)
curr_job_cnt = 50
for _ in range(curr_job_cnt):
job = self.saved_search.dispatch()
while not job.is_ready():
sleep(0.1)
# fetching all the jobs
history = self.saved_search.history(count=0)
self.assertEqual(len(history), old_jobs_cnt + curr_job_cnt)
# fetching 3 jobs
history = self.saved_search.history(count=3)
self.assertEqual(len(history), 3)
finally:
job.cancel()
def test_scheduled_times(self):
self.saved_search.update(cron_schedule='*/5 * * * *', is_scheduled=True)
scheduled_times = self.saved_search.scheduled_times()
logging.debug("Scheduled times: %s", scheduled_times)
self.assertTrue(all([isinstance(x, datetime.datetime)
for x in scheduled_times]))
time_pairs = list(zip(scheduled_times[:-1], scheduled_times[1:]))
for earlier, later in time_pairs:
diff = later-earlier
# diff is an instance of datetime.timedelta, which
# didn't get a total_seconds() method until Python 2.7.
# Since we support Python 2.6, we have to calculate the
# total seconds ourselves.
total_seconds = diff.days*24*60*60 + diff.seconds
self.assertEqual(total_seconds/60.0, 5)
def test_no_equality(self):
self.assertRaises(client.IncomparableException,
self.saved_search.__eq__, self.saved_search)
def test_suppress(self):
suppressed_time = self.saved_search['suppressed']
self.assertGreaterEqual(suppressed_time, 0)
new_suppressed_time = suppressed_time+100
self.saved_search.suppress(new_suppressed_time)
self.assertLessEqual(self.saved_search['suppressed'],
new_suppressed_time)
self.assertGreater(self.saved_search['suppressed'],
suppressed_time)
self.saved_search.unsuppress()
self.assertEqual(self.saved_search['suppressed'], 0)
if __name__ == "__main__":
try:
import unittest2 as unittest
except ImportError:
import unittest
unittest.main()