-
Notifications
You must be signed in to change notification settings - Fork 0
/
sg_sync_function_tester.py
434 lines (399 loc) · 20.8 KB
/
sg_sync_function_tester.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
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
import json
import os
import requests
from requests.auth import HTTPBasicAuth
from datetime import datetime
import logging
import sys
import time
# The WORK class represents the main functionality for interacting with
# Sync Gateway to test the Sync Function
class Work():
# Default configuration values
debug = False
sgHost = "http://localhost"
sgPort = "4984"
sgAdminPort = "4985"
sgDb = "sync_gateway"
sgDbScope = "_default"
sgDbCollection = "_default"
sgTestUsers = [{"userName": "bob", "password": "12345", "sgSession": ""}]
sgAdminUser = ""
sgAdminPassword = "Administrator"
logPathToWriteTo = "password"
jsonFolder = "jsons"
operations = []
# Initializes the WORK object with the given configuration file
def __init__(self, config_file):
self.readConfig(config_file)
self.setupLogging()
# Reads the configuration from the specified file
# and sets up the object's attributes
def readConfig(self, config_file):
try:
with open(config_file, "r") as f:
config = json.load(f)
except FileNotFoundError:
raise Exception(f"Configuration file '{config_file}' not found.")
except json.JSONDecodeError:
raise Exception(f"Configuration file '{config_file}'"
f"is not valid JSON."
)
self.sgLogName = config.get("logPathToWriteTo", self.logPathToWriteTo)
self.sgHost = config.get("sgHost", self.sgHost)
self.sgPort = config.get("sgPort", self.sgPort)
self.sgAdminPort = config.get("sgAdminPort", self.sgAdminPort)
self.sgDb = config.get("sgDb", self.sgDb)
self.sgDbScope = config.get("sgDbScope", self.sgDbScope)
self.sgDbCollection = config.get("sgDbCollection", self.sgDbCollection)
self.sgTestUsers = config.get("sgTestUsers", self.sgTestUsers)
self.sgAdminUser = config.get("sgAdminUser", self.sgAdminUser)
self.sgAdminPassword = config.get(
"sgAdminPassword", self.sgAdminPassword
)
self.jsonFolder = config.get("jsonFolder", self.jsonFolder)
self.debug = config.get("debug", self.debug)
self.operations = config.get("operations", self.operations)
# Sets up logging for the application with ISO 8601 timestamps
def setupLogging(self):
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
log_filename = f"{self.sgLogName}_{timestamp}.log"
self.logger = logging.getLogger()
self.logger.setLevel(logging.DEBUG if self.debug else logging.INFO)
formatter = logging.Formatter(
"%(asctime)s.%(msecs)03d - %(levelname)s - %(message)s",
datefmt='%Y-%m-%dT%H:%M:%S'
)
file_handler = logging.FileHandler(log_filename)
file_handler.setFormatter(formatter)
self.logger.addHandler(file_handler)
# Store the file handler so it can be closed later
self.file_handler = file_handler
# Closes the log file
def closeLogFile(self):
if hasattr(self, 'file_handler'):
self.file_handler.close()
self.logger.removeHandler(self.file_handler)
# Constructs the database URL based on scope and collection
def constructDbUrl(self):
if self.sgDbScope == "_default" and self.sgDbCollection == "_default":
return self.sgDb
else:
return f"{self.sgDb}.{self.sgDbScope}.{self.sgDbCollection}"
# Performs an HTTP request to the Sync Gateway
def httpRequest(
self,
method,
url,
json_data=None,
userName="",
password="",
session="",
is_admin=False
):
try:
headers = {"Content-Type": "application/json"}
if session:
headers["Cookie"] = f"SyncGatewaySession={session}"
if is_admin:
auth = HTTPBasicAuth(self.sgAdminUser, self.sgAdminPassword)
url = url.replace(
f":{self.sgPort}/",
f":{self.sgAdminPort}/"
)
else:
auth = (HTTPBasicAuth(userName, password)
if userName and password else None)
response = requests.request(
method,
url,
json=json_data,
headers=headers,
auth=auth
)
# Handle the case where response might
# be a dictionary (for testing purposes)
if isinstance(response, dict):
return response
response.raise_for_status()
return response.json() if response.text else None
except requests.RequestException as e:
if self.debug:
self.logger.error(f"Error in HTTP {method}: {e}")
return None
# Retrieves the changes feed from Sync Gateway
def getChangesFeed(
self, userName="",
password="", session="",
is_admin=False, channels=None
):
sgUrl = f"{self.sgHost}:{self.sgPort}/{self.sgDb}/_changes"
if channels:
sgUrl += f"?filter=sync_gateway/bychannel&channels={channels}"
return self.httpRequest(
"GET", sgUrl,
userName=userName, password=password,
session=session, is_admin=is_admin
)
# Performs a purge operation on the specified document IDs
def postPurge(self, docIds):
sgUrl = f"{self.sgHost}:{self.sgAdminPort}/{self.sgDb}/_purge"
purgeData = {docId: ["*"] for docId in docIds}
result = self.httpRequest(
"POST", sgUrl,
json_data=purgeData, is_admin=True
)
return result.json() if hasattr(result, 'json') else result
def openJsonFolder(self):
json_folder = self.jsonFolder
processed_docs = []
for filename in os.listdir(json_folder):
if filename.endswith(".json"):
with open(os.path.join(json_folder, filename), "r") as f:
json_data = json.load(f)
doc_id = json_data.get("_id")
if doc_id:
processed_docs.append(doc_id)
rev = None
for operation in self.operations:
if operation.startswith("SLEEP"):
sleep_time = 1 # Default sleep time
if ":" in operation:
try:
sleep_time = int(operation.split(":")[1])
except ValueError:
self.logger.warning(
f"Invalid sleep time format:"
f"{operation}. Using default 1 second."
)
self.logger.info(
f"[success] - [SLEEP] - Sleeping for"
f"{sleep_time} seconds"
)
time.sleep(sleep_time)
continue
is_admin = "_ADMIN" in operation
if is_admin:
op, *rest = operation.split("_ADMIN")
params = (rest[0].split(":", 1)[1]
if rest and ":" in rest[0] else "")
else:
op, *rest = operation.split(":")
params = rest[0] if rest else ""
for user in self.sgTestUsers:
sgUrl = (
f"{self.sgHost}:"
f"{self.sgPort if not is_admin else self.sgAdminPort}/"
f"{self.constructDbUrl()}/{doc_id}"
)
userName = user["userName"]
password = user["password"]
session = user["sgSession"]
if op == "GET":
try:
result = self.httpRequest(
"GET", sgUrl, userName=userName,
password=password, session=session,
is_admin=is_admin
)
status = "success" if result else "failed"
self.logger.info(
f"[{status}] - [GET] - "
f"[{'Admin' if is_admin else userName}] - "
f"GET result for [{doc_id}] - "
f"{json.dumps(result) if result else 'null'}"
)
if result:
rev = result.get('_rev')
except requests.RequestException:
self.logger.info(
f"[failed] - [GET] - "
f"[{'Admin' if is_admin else userName}] - "
f"GET result for [{doc_id}] - null"
)
elif op == "PUT":
try:
# Get the current document first
current_doc = self.httpRequest(
"GET", sgUrl, userName=userName,
password=password, session=session,
is_admin=is_admin
)
if current_doc and '_rev' in current_doc:
# Update the revision if the document exists
json_data['_rev'] = current_doc['_rev']
json_data['dateTimeStamp'] = datetime.now().isoformat()
result = self.httpRequest(
"PUT", sgUrl, json_data=json_data,
userName=userName, password=password,
session=session, is_admin=is_admin
)
status = "success" if result and result.get("ok") else "failed"
self.logger.info(
f"[{status}] - [PUT] - "
f"[{'Admin' if is_admin else userName}] - "
f"PUT result for [{doc_id}] - "
f"{json.dumps(result)}"
)
if result and result.get("rev"):
rev = result["rev"]
except requests.RequestException as e:
self.logger.error(
f"[failed] - [PUT] - "
f"[{'Admin' if is_admin else userName}] - "
f"Error in HTTP PUT for [{doc_id}] - {str(e)}"
)
self.logger.info(
f"[failed] - [PUT] - "
f"[{'Admin' if is_admin else userName}] - "
f"PUT result for [{doc_id}] - null"
)
elif op == "DELETE":
try:
# Get the current document first
current_doc = self.httpRequest(
"GET", sgUrl, userName=userName,
password=password, session=session,
is_admin=is_admin
)
if current_doc and '_rev' in current_doc:
rev = current_doc['_rev']
delete_url = (
f"{self.sgHost}:"
f"{self.sgPort if not is_admin else self.sgAdminPort}/"
f"{self.constructDbUrl()}/{doc_id}?rev={rev}"
)
result = self.httpRequest(
"DELETE", delete_url,
userName=userName, password=password,
session=session, is_admin=is_admin
)
status = "success" if result and result.get("ok") else "failed"
self.logger.info(
f"[{status}] - [DELETE] - "
f"[{'Admin' if is_admin else userName}] - "
f"DELETE result for [{doc_id}] - "
f"{json.dumps(result)}"
)
else:
self.logger.warning(
f"[failed] - [DELETE] - "
f"[{'Admin' if is_admin else userName}] - "
f"Unable to delete [{doc_id}] - "
f"Document not found"
"or no revision available"
)
except requests.RequestException as e:
self.logger.error(
f"[failed] - [DELETE] - "
f"[{'Admin' if is_admin else userName}] - "
f"Error in HTTP DELETE for "
f"[{doc_id}] - {str(e)}"
)
self.logger.info(
f"[failed] - [DELETE] - "
f"[{'Admin' if is_admin else userName}] - "
f"DELETE result for [{doc_id}] - null"
)
elif op == "CHANGES":
try:
channels = params if params else None
sgUrl = (
f"{self.sgHost}:"
f"{self.sgPort if not is_admin else self.sgAdminPort}/"
f"{self.constructDbUrl()}/_changes"
)
if channels:
sgUrl += (
f"?filter=sync_gateway/bychannel"
f"&channels={channels}"
)
result = self.httpRequest(
"GET", sgUrl, userName=userName,
password=password, session=session,
is_admin=is_admin
)
status = "success" if result else "failed"
result_count = len(result.get("results", [])) if result else 0
filter_flag = "true" if channels else "false"
self.logger.info(
f"[{status}] - [CHANGES] - "
f"[{'Admin' if is_admin else userName}] - "
f"Changes feed result for [{doc_id}], "
f"channelFilter:{filter_flag}, "
f"channels:{channels if channels else 'None'}, "
f"rows: {result_count} - "
f"{json.dumps(result)}"
)
except requests.RequestException as e:
self.logger.error(
f"[failed] - [CHANGES] - "
f"[{'Admin' if is_admin else userName}] - "
f"Error in HTTP CHANGES for [{doc_id}]"
f"- {str(e)}"
)
self.logger.info(
f"[failed] - [CHANGES] - "
f"[{'Admin' if is_admin else userName}] - "
f"Changes feed result for [{doc_id}], "
"channelFilter:false, channels:None,"
"rows: 0 - null"
)
elif op == "PURGE":
try:
result = self.postPurge([doc_id])
status = "success" if result and result.get("purged") else "failed"
result_str = (
json.dumps(result) if isinstance(result, dict)
else str(result)
)
self.logger.info(
f"[{status}] - [PURGE] - [Admin] - "
f"Purge result for "
f"[{doc_id}] - {result_str}"
)
except requests.RequestException as e:
self.logger.error(
f"[failed] - [PURGE] - [Admin] - "
f"Error in HTTP PURGE for "
f"[{doc_id}] - {str(e)}"
)
self.logger.info(
f"[failed] - [PURGE] - [Admin] - "
f"Purge result for [{doc_id}] - null"
)
elif op == "GET_RAW":
try:
raw_url = (
f"{self.sgHost}:{self.sgAdminPort}/"
f"{self.constructDbUrl()}/_raw/{doc_id}"
)
result = self.httpRequest(
"GET",
raw_url,
is_admin=True
)
status = "success" if result else "failed"
self.logger.info(
f"[{status}] - [GET_RAW] - [Admin] - "
f"GET_RAW result for [{doc_id}] - "
f"{json.dumps(result) if result else 'null'}"
)
except requests.RequestException as e:
self.logger.error(
f"[failed] - [GET_RAW] - [Admin] - "
f"Error in HTTP GET_RAW for "
f"[{doc_id}] - {str(e)}"
)
self.logger.info(
f"[failed] - [GET_RAW] - [Admin] - "
f"GET_RAW result for [{doc_id}] - null"
)
if __name__ == "__main__":
if len(sys.argv) != 2:
print("Usage: python3 sg_sync_function_tester.py <config_file>")
sys.exit(1)
config_file = sys.argv[1]
workAll = Work(config_file)
workAll.openJsonFolder()
workAll.closeLogFile()