~aleteoryx/muditaos

muditaos/test/custom_quotes.py -rw-r--r-- 13.5 KiB
a405cad6Aleteoryx trim readme 6 days ago
                                                                                
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
import base64
import os.path
import serial
import random
import json
import zlib
import argparse
import time
from tqdm import tqdm

http_methods = {
    'GET': 1,
    'POST': 2,
    'PUT': 3,
    'DELETE': 4
}

endpoint_types = {
    'Invalid': 0,
    'DeviceInfo': 1,
    'Update': 2,
    'FilesystemUpload': 3,
    'Backup': 4,
    'Restore': 5,
    'Factory': 6,
    'Contacts': 7,
    'Messages': 8,
    'Calllog': 9,
    'CalendarEventsPlaceholder': 10,
    'DeveloperMode': 11,
    'Bluetooth': 12,
    'UsbSecurity': 13,
    'Outbox': 14,
    'Reboot': 15,
    'TimeSync': 16,
    'Quotes': 17
}

payload_marker = '#'
payload_size_len = 9
port_timeout_short_s = 1
port_timeout_medium_s = 2
port_timeout_long_s = 5
port_baudrate = 115200

default_rx_data_size = 1024
chunk_rx_data_size = 1024 * 200

sync_filename = 'sync.tar'
sync_path = '/user/temp/' + sync_filename

def get_new_uuid() -> int:
    return random.randint(1, 10000)

def send_data(port_path: str, payload_str: str, expected_response: int) -> bool:
    payload_len_str = str(len(payload_str)).rjust(payload_size_len, '0')
    request_str = payload_marker + payload_len_str + payload_str

    with serial.Serial(port_path, port_baudrate, timeout=port_timeout_short_s) as port:
        port.write(request_str.encode('ascii'))
        response = port.read(2048)
        resp_json = json.loads(response[10:])
        status = resp_json['status']
        if status == expected_response:
            print(f'Request success')
            return True
        print(f'Request failed, status {status}')
        return False
    
def get_request_response(port_path: str, request: str, expected_size: int) -> bytes:
    payload_len_str = str(len(request)).rjust(payload_size_len, '0')
    request_str = payload_marker + payload_len_str + request

    with serial.Serial(port_path, port_baudrate, timeout=port_timeout_medium_s) as port:
        port.write(request_str.encode('ascii'))
        response = port.read(expected_size)
    return response
    
def get_str_data(port_path: str, payload_str: str, expected_responses: list, body_str: str) -> str:
    payload_len_str = str(len(payload_str)).rjust(payload_size_len, '0')
    request_str = payload_marker + payload_len_str + payload_str

    with serial.Serial(port_path, port_baudrate, timeout=port_timeout_short_s) as port:
        port.write(request_str.encode('ascii'))
        response = port.read(2048)
        resp_json = json.loads(response[10:])
        status = resp_json['status']

        for expected_status in expected_responses:
            if status == expected_status:
                print(f'Request success')
                body = resp_json['body']
                return body[body_str]
            
        print(f'Request failed, status {status}')
        return ""

def add_quote(port_path: str, quote_str: str, author_str: str) -> bool:
    uuid = get_new_uuid()

    payload = {
        'endpoint': endpoint_types['Quotes'],
        'method': http_methods['POST'],
        'uuid': uuid,
        'body': {
            'quote': quote_str,
            'author': author_str
        }
    }

    payload_str = json.dumps(payload)
    payload_len_str = str(len(payload_str)).rjust(payload_size_len, '0')
    request_str = payload_marker + payload_len_str + payload_str

    with serial.Serial(port_path, port_baudrate, timeout=port_timeout_short_s) as port:
        port.write(request_str.encode('ascii'))
        response = port.read(2048)
        resp_json = json.loads(response[10:])
        status = resp_json['status']
        if status == 200:
            print(f'Request success {resp_json["body"]}')
            return True
        print(f'Request failed, status {status}')
        return False
    
def edit_quote(port_path: str, quote_id: int,  quote_str: str, author_str: str) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Quotes'],
        'method': http_methods['PUT'],
        'uuid': uuid,
        'body': {
            'quoteID': quote_id,
            'quote': quote_str,
            'author': author_str
        }
    }
    payload_str = json.dumps(payload)
    return send_data(port_path, payload_str, 200)

def delete_quote(port_path: str, quote_id: int) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Quotes'],
        'method': http_methods['DELETE'],
        'uuid': uuid,
        'body': {
            'quoteID': quote_id
        }
    }
    payload_str = json.dumps(payload)
    return send_data(port_path, payload_str, 204)

def change_group(port_path: str, quote_group: str) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Quotes'],
        'method': http_methods['PUT'],
        'uuid': uuid,
        'body': {
            'group': quote_group
        }
    }
    payload_str = json.dumps(payload)
    return send_data(port_path, payload_str, 200)

def change_interval(port_path: str, quote_interval: str) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Quotes'],
        'method': http_methods['PUT'],
        'uuid': uuid,
        'body': {
            'interval': quote_interval
        }
    }
    payload_str = json.dumps(payload)
    return send_data(port_path, payload_str, 200)
    
def get_settings(port_path: str, settings: str) -> str:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Quotes'],
        'method': http_methods['GET'],
        'uuid': uuid,
        'body': {
            'settings': settings
        }
    }
    payload_str = json.dumps(payload)
    return get_str_data(port_path, payload_str, [200], settings)

def start_sync(port_path: str) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Backup'],
        'method': http_methods['POST'],
        'uuid': uuid,
        'body': {
            "category" : "sync"
        }
    }
    payload_str = json.dumps(payload)
    return send_data(port_path, payload_str, 202)

def wait_for_sync_end(port_path: str, timeout: int) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['Backup'],
        'method': http_methods['GET'],
        'uuid': uuid,
        'body': {
            "category" : "sync"
        }
    }
    payload_str = json.dumps(payload)

    start_timestamp = time.time()
    while time.time() < start_timestamp + timeout:
        status = get_str_data(port_path, payload_str, [204, 303], 'state')
        print("sync status: " + status)
        if status == "finished":
            return True
        time.sleep(1)

    return False

def download_file(port_path: str, path: str) -> bool:
    uuid = get_new_uuid()
    chunk_size = 0
    file_size = 0

    payload = {
        'endpoint': endpoint_types['FilesystemUpload'],
        'method': http_methods['GET'],
        'uuid': uuid,
        'body': {
            'fileName': path
        }
    }
    payload_str = json.dumps(payload)

    request_id = {
        'endpoint': endpoint_types['FilesystemUpload'],
        'method': http_methods['GET'],
        'uuid': uuid,
        'body': {
            'rxID': 0,
            'chunkNo': 1
        }
    }

    response = get_request_response(port_path, payload_str, default_rx_data_size)
    if not response:
        print("Request GET file " + path + " info failed!")
        return False
    
    resp_json = json.loads(response[10:])
    status = resp_json['status']
    if status == 200:
        request_id['body']['rxID'] = resp_json['body']['rxID']
        chunk_size = resp_json['body']['chunkSize']
        file_size = resp_json['body']['fileSize']
    else:
        print(f'Request failed, status: {status}')
        return False

    chunks = int((file_size / chunk_size) + 1)
    print(f'File size: {file_size} chunk size: {chunk_size} chunks: {chunks}')

    filename = "temp/" + sync_filename
    os.makedirs(os.path.dirname(filename), exist_ok=True)
    progress_bar = tqdm(desc=f'Downloading \'{path}\'', total=file_size, unit='bytes', unit_scale=True, unit_divisor=1024)
    with open(filename, 'wb') as file:
        for i in range(1, chunks + 1):
            request_id_str = json.dumps(request_id)
            response = get_request_response(port_path, request_id_str, chunk_rx_data_size)
            if not response:
                print("Request GET chunkNo: " + request_id['body']['chunkNo'] + " failed!")
                return False

            resp_json = json.loads(response[10:])
            status = resp_json['status']
            if status == 200:
                data = base64.b64decode(resp_json['body']['data'])
                file.write(data)
                request_id['body']['chunkNo'] = i + 1
                progress_bar.update(len(data))
            else:
                print(f'Request failed, status {status}')
                progress_bar.close()
                return False

    progress_bar.close()
    return True

def delete_sync(port_path: str, path: str) -> bool:
    uuid = get_new_uuid()
    payload = {
        'endpoint': endpoint_types['FilesystemUpload'],
        'method': http_methods['DELETE'],
        'uuid': uuid,
        'body': {
            "removeFile" : path
        }
    }
    payload_str = json.dumps(payload)
    return send_data(port_path, payload_str, 204)

def get_quotes(port_path: str) -> bool:
    if not start_sync(port_path):
        print("Error! Synchronization has not been started.")
        return False
    print("Synchronization has started...")

    if not wait_for_sync_end(port_path, 20):
        print("Error! Synchronization fail.")
        return False
    print("Synchronization completed successfully.")

    if not download_file(port_path, sync_path):
        print("Error! Sync file download fail.")
        return False
    print("Sync file download completed.")

    if not delete_sync(port_path, sync_path):
        print("Error! Failed to delete sync file.")
        return False
    print("Sync file deletion completed successfully.")

    return True

def main():
    parser = argparse.ArgumentParser(
        prog='custom_quotes',
        description='Script used to test functionality of custom quotes endpoint in Harmony project'
    )
    parser.add_argument('-p', '--port',
                        metavar='path_to_com_port',
                        help='path to COM port of the device (e.g. /dev/ttyACM0)')
    parser.add_argument('-a', '--add',
                        action='store_true',
                        help='add new custom quote')
    parser.add_argument('-d', '--delete',
                        metavar='quote_id_to_delete',
                        type=int,
                        help='delete custom quote')
    parser.add_argument('-e', '--edit',
                        metavar='quote_id_to_edit',
                        type=int,
                        help='edit custom quote')
    parser.add_argument('-q', '--quote',
                        metavar='string_with_quote',
                        help='string with new quote')
    parser.add_argument('-t', '--author',
                        metavar='string_with_author',
                        help='string with author')
    parser.add_argument('-g', '--group',
                        metavar='string_with_group_type',
                        help='string with type of group of displayed quotes [Predefined or Custom]')
    parser.add_argument('-i', '--interval',
                        metavar='quotes_display_interval',
                        help='quotes display interval [\'x\' minutes or \'AtMidnight\']')
    parser.add_argument('-s', '--synchro',
                        metavar='settings_to_get',
                        help='get quotes file or settings [\'quotes\' or \'group\' or \'interval\']')

    args = parser.parse_args()
    if not args.port:
        print('Invalid usage: please specify device port')
        print('Run with -h to see help')
        return
    if not args.add and not args.delete and not args.edit and not args.group and not args.interval and not args.synchro:
        print('Invalid usage: please specify add, delete, edit, synchro, group or interval argument')
        print('Run with -h to see help')
        return
    if args.add:
        if not args.quote:
            print('Invalid usage: please add quote')
            print('Run with -h to see help')
            return
        else:
            print("adding new quotes: " + args.quote)
            add_quote(args.port, args.quote, args.author)
    elif args.delete:
        print("deleting quotes nr: " + str(args.delete))
        delete_quote(args.port, args.delete)
    elif args.edit:
        if not args.quote:
            print('Invalid usage: please add quote')
            print('Run with -h to see help')
            return
        else:
            print("editing quotes nr: " + str(args.edit))
            edit_quote(args.port, args.edit, args.quote, args.author)
    elif args.group:
        print("quotes group: " + args.group)
        change_group(args.port, args.group)
    elif args.interval:
        print("quotes interval: " + args.interval)
        change_interval(args.port, args.interval)
    elif args.synchro:
        if args.synchro == "quotes":
            print("downloading quotes file")
            get_quotes(args.port)
        elif args.synchro == "group":
            group = get_settings(args.port, args.synchro)
            print("quotes group: " + group)
        elif args.synchro == "interval":
            interval = get_settings(args.port, args.synchro)
            print("quotes interval: " + interval)
        else:
            print('Invalid usage: please choose one option: \'quotes\' or \'group\' or \'interval\'')
            print('Run with -h to see help')

if __name__ == '__main__':
    main()