forked from peak/s5cmd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bench.py
executable file
·597 lines (492 loc) · 18.1 KB
/
bench.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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
#!/usr/bin/env python
import argparse
import datetime
import os
import re
import shutil
import subprocess
from tempfile import mkdtemp
def main(argv=None):
parser = argparse.ArgumentParser(
description="Compare performance of two different builds of s5cmd.",
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
)
parser.add_argument(
"-s",
"--s5cmd",
nargs=2,
metavar=("OLD", "NEW"),
default=("latest_release", "master"),
help="Reference to old and new s5cmd."
"It can be a decimal indicating PR number,any of the version tags like v2.0.0 or any commit tag. Additionally "
"it can be 'latest_release' or 'master'.",
)
parser.add_argument(
"-w",
"--warmup",
default="2",
help="Number of program executions before the actual benchmark:",
)
parser.add_argument(
"-r", "--runs", default="10", help="Number of runs to perform for each command"
)
parser.add_argument(
"-o", "--output_file_name", default="summary.md", help="Name of the output file"
)
parser.add_argument(
"-b", "--bucket", required=True, help="Name of the bucket in remote"
)
parser.add_argument(
"-l",
"--local-path",
help="specify a local path for temporary files to be loaded.",
)
parser.add_argument(
"-p",
"--prefix",
default="s5cmd-benchmarks-",
help="Key prefix to be used while uploading to a specified bucket",
)
parser.add_argument(
"-hf",
"--hyperfine-extra-flags",
help="hyperfine global extra flags. "
"Write in between quotation marks "
"and start with a space to avoid bugs.",
)
parser.add_argument(
"-sf",
"--s5cmd-extra-flags",
help="s5cmd global extra flags. "
"Write in between quotation marks "
"and start with a space to avoid bugs.",
)
ok, err_msg = check_dependencies()
if not ok:
print(err_msg)
raise SystemExit(1)
args = parser.parse_args(argv)
cwd = os.getcwd()
local_dir, dst_path = create_bench_dir(args.bucket, args.prefix, args.local_path)
print("The created local&remote files will be deleted at the end of tests.")
print(
f"Hyperfine will execute s5cmd uploads {args.warmup} times to warmup, and {args.runs} times for measurements."
)
old_s5cmd, new_s5cmd = build_s5cmd_exec(args.s5cmd[0], args.s5cmd[1], local_dir)
scenarios = [
Scenario(
name="small files",
cwd=cwd,
dst_path=dst_path,
local_dir=local_dir,
file_size="1M",
file_count="10000",
s5cmd_args=args.s5cmd_extra_flags,
hyperfine_args={
"runs": args.runs,
"warmup": args.warmup,
"extra_flags": args.hyperfine_extra_flags,
},
),
Scenario(
name="large file",
cwd=cwd,
dst_path=dst_path,
local_dir=local_dir,
file_size="10G",
file_count="1",
s5cmd_args=args.s5cmd_extra_flags,
hyperfine_args={
"runs": args.runs,
"warmup": args.warmup,
"extra_flags": args.hyperfine_extra_flags,
},
),
Scenario(
name="very large file",
cwd=cwd,
dst_path=dst_path,
local_dir=local_dir,
file_size="300G",
file_count="1",
s5cmd_args=args.s5cmd_extra_flags,
hyperfine_args={
"runs": "1",
"warmup": "0",
"extra_flags": args.hyperfine_extra_flags,
},
),
]
scenario_details = []
for s in scenarios:
scenario_details.append(f"| {s.name} | {s.file_size} | {s.file_count} |")
for idx, scenario in enumerate(scenarios):
if idx == 0:
scenario.setup(
args.output_file_name,
initialize_bench=True,
all_scenario_details=scenario_details,
)
else:
scenario.setup(args.output_file_name)
scenario.run(old_s5cmd, new_s5cmd)
scenario.teardown()
# append detailed_summary to output_file_name
with open(os.path.join(cwd, "detailed_summary.md"), "r+") as f:
detailed_summary = join_with_spaces(f.readlines())
with open(os.path.join(cwd, args.output_file_name), "a") as f:
f.write(detailed_summary)
cleanup(local_dir, cwd)
class S5cmd:
def __init__(self, folder_path, clone_path, name, tag):
self.clone_path = clone_path
self.name = name
self.tag = tag
self.descriptive_name = ""
self.path = os.path.join(folder_path, self.name)
self.build()
def build(self):
if self.tag == "master":
self.tag = self._get_master_commit_tag().strip()
self._checkout_commit()
self.descriptive_name = "master"
elif self.tag == "latest_release":
releases = self._get_all_releases()
self.tag = releases.strip().split("\n")[-1]
self.tag = self.tag.removeprefix("'refs/tags/").removesuffix("'")
self._checkout_version()
self.descriptive_name = "latest_release:" + self.tag
elif is_pr(self.tag):
self._checkout_pr()
self.descriptive_name = "PR:" + self.tag
elif is_version_tag(self.tag):
self._checkout_version()
self.descriptive_name = "version:" + self.tag
else:
self._checkout_commit()
self.descriptive_name = "commit" + self.tag
os.chdir(self.clone_path)
run_cmd(["go", "build", "-o", self.path])
def _checkout_commit(self):
cmd = ["git", "-C", self.clone_path, "checkout", self.tag, "-q"]
return run_cmd(cmd)
def _get_master_commit_tag(self):
cmd = ["git", "-C", self.clone_path, "rev-parse", "--short", "origin/master"]
return run_cmd(cmd, verbose=False)
def _get_all_releases(self):
cmd = [
"git",
"-C",
self.clone_path,
"for-each-ref",
"--sort=creatordate",
"--format",
"'%(refname)'",
"refs/tags",
]
return run_cmd(cmd, verbose=False)
def _checkout_pr(self):
fetch_cmd = [
"git",
"-C",
self.clone_path,
"fetch",
"origin",
f"pull/{self.tag}/head",
"-q",
]
checkout_cmd = ["git", "-C", self.clone_path, "checkout", "FETCH_HEAD", "-q"]
stdout = [run_cmd(fetch_cmd), run_cmd(checkout_cmd)]
return stdout
def _checkout_version(self):
cmd = ["git", "-C", self.clone_path, "checkout", f"tags/{self.tag}", "-q"]
return run_cmd(cmd)
class Scenario:
def __init__(
self,
name,
cwd,
file_size,
file_count,
s5cmd_args,
hyperfine_args,
local_dir,
dst_path,
):
self.all_scenario_details = None
self.initialize_bench = False
self.run_name = None
self.name = name
self.cwd = cwd
self.file_size = file_size
self.file_count = file_count
self.s5cmd_args = ""
if s5cmd_args is not None:
self.s5cmd_args = s5cmd_args
self.hyperfine_args = hyperfine_args
self.local_dir = local_dir
self.folder_dir = ""
self.output_file_name = ""
self.run_types = ["upload", "download", "remove"]
self.dst_path = dst_path
def setup(
self, output_file_name, initialize_bench=False, all_scenario_details=None
):
self.output_file_name = output_file_name
self.initialize_bench = initialize_bench
self.all_scenario_details = all_scenario_details
if self.file_count:
self.file_count = int(self.file_count)
self.create_files()
else:
self.folder_dir = f"{self.local_dir}/"
def create_files(self):
# create subdirectory under local_dir named with a scenario name
# create file_count files with each file_size size
self.folder_dir = f'{self.local_dir}/{self.name.replace(" ", "-")}'
os.mkdir(self.folder_dir)
os.chdir(self.folder_dir)
if self.file_count <= 0:
raise ValueError(f"{self.file_count} cannot be negative.")
else:
for i in range(self.file_count):
run_cmd(
["truncate", "-s", f"{int(to_bytes(self.file_size))}", f"tmp{i}"]
)
def teardown(self):
# remove local files at teardown
shutil.rmtree(self.folder_dir)
def run(self, old_s5cmd, new_s5cmd):
s5cmd_cmds = self.get_s5cmd_commands(old_s5cmd, new_s5cmd)
for run in self.run_types:
os.chdir(self.folder_dir)
cmd = [
"hyperfine",
"--export-markdown",
os.path.join(self.local_dir, "temp.md"),
"-u",
"second",
"--runs",
self.hyperfine_args["runs"],
"--warmup",
self.hyperfine_args["warmup"],
"-n",
old_s5cmd.descriptive_name,
"-n",
new_s5cmd.descriptive_name,
]
self.run_name = f"{run} {self.name}"
print(f"Running: {self.run_name}:\n")
if run == "upload":
cmd.append(s5cmd_cmds["old_upload"])
cmd.append(s5cmd_cmds["new_upload"])
elif run == "download":
cmd.append(s5cmd_cmds["old_download"])
cmd.append(s5cmd_cmds["new_download"])
elif run == "remove":
cmd.append(s5cmd_cmds["old_remove"])
cmd.append(s5cmd_cmds["new_remove"])
# if there is only one run without warmups, then do not prepare.
if (
int(self.hyperfine_args["runs"]) > 1
or int(self.hyperfine_args["warmup"]) >= 1
):
cmd.append("--prepare")
cmd.append(s5cmd_cmds["prepare_old_for_remove"])
cmd.append("--prepare")
cmd.append(s5cmd_cmds["prepare_new_for_remove"])
if self.hyperfine_args["extra_flags"]:
cmd.append(self.hyperfine_args["extra_flags"].strip())
output = run_cmd(cmd)
summary = self.parse_output(output)
if self.initialize_bench:
init_bench_results(
self.cwd, self.output_file_name, self.all_scenario_details
)
self.initialize_bench = False
with open(os.path.join(self.cwd, self.output_file_name), "a") as f:
f.write(summary)
detailed_summary = ""
temp_dir = os.path.join(self.local_dir, "temp.md")
with open(temp_dir, "r+") as f:
lines = f.readlines()
# get hyperfine markdown output and add a new column in the front as scenario name
detailed_summary = (
f"| {self.run_name} {lines[-1]}" f"| {self.run_name} {lines[-2]}"
)
with open(os.path.join(self.cwd, "detailed_summary.md"), "a") as f:
f.write(detailed_summary)
def get_s5cmd_commands(self, old_s5cmd, new_s5cmd):
result = {}
old_upload = join_with_spaces(
[self.s5cmd_args, "cp", f'"*"', f"{self.dst_path}/old/"]
)
old_upload = f"{old_s5cmd.path} {old_upload}"
result["old_upload"] = old_upload
prepare_old_for_remove = f"{old_upload} | sleep 10"
result["prepare_old_for_remove"] = prepare_old_for_remove
new_upload = join_with_spaces(
[self.s5cmd_args, "cp", '"*"', f"{self.dst_path}/new/"]
)
new_upload = f"{new_s5cmd.path} {new_upload}"
result["new_upload"] = new_upload
prepare_new_for_remove = f"{new_upload} | sleep 10"
result["prepare_new_for_remove"] = prepare_new_for_remove
old_download = join_with_spaces(
[self.s5cmd_args, "cp", f'"{self.dst_path}/old/*"', "old/"]
)
old_download = f"{old_s5cmd.path} {old_download}"
result["old_download"] = old_download
new_download = join_with_spaces(
[self.s5cmd_args, "cp", f'"{self.dst_path}/new/*"', "new/"]
)
new_download = f"{new_s5cmd.path} {new_download}"
result["new_download"] = new_download
new_remove = join_with_spaces(
[self.s5cmd_args, "rm", f'"{self.dst_path}/new/*"']
)
new_remove = f"{new_s5cmd.path} {new_remove}"
result["new_remove"] = new_remove
old_remove = join_with_spaces(
[self.s5cmd_args, "rm", f'"{self.dst_path}/old/*"']
)
old_remove = f"{old_s5cmd.path} {old_remove}"
result["old_remove"] = old_remove
return result
def parse_output(self, output):
lines = output.split("\n")
summary = ""
for i, line in enumerate(lines):
# get the next two lines after summary and format it as markdown table.
if "Summary" in line:
line1 = lines[i + 1].replace("\n", "").strip()
line2 = lines[i + 2].replace("\n", "").strip()
summary = f"| {self.run_name} | {line1} {line2} |\n"
return summary
def init_bench_results(cwd, output_file_name, scenario_details):
header = (
"### Benchmark summary: "
"\n| Scenario | File Size | File Count |"
"\n|:---|:---|:---|"
"\n"
)
summary = (
f"{header}"
f"{join_with_newlines(scenario_details)}"
"\n\n|Scenario| Summary |"
"\n|:---|:---|"
"\n"
)
with open(os.path.join(cwd, output_file_name), "w") as file:
file.write(summary)
detailed_summary = (
"\n### Detailed summary: "
"\n|Scenario| Command | Mean [s] | Min [s] | Max [s] | Relative |"
"\n|:---|:---|---:|---:|---:|---:|"
"\n"
)
with open(os.path.join(cwd, "detailed_summary.md"), "w") as file:
file.write(detailed_summary)
def join_with_spaces(lst):
return " ".join(lst)
def join_with_newlines(lst):
return "\n".join(lst)
def to_bytes(size):
if size.isdigit():
return int(size)
unit = size[-1]
if unit == "K":
return int(size[:-1]) * 1024
elif unit == "M":
return int(size[:-1]) * (1024**2)
elif unit == "G":
return int(size[:-1]) * (1024**3)
elif unit == "T":
return int(size[:-1]) * (1024**4)
elif unit == "P":
return int(size[:-1]) * (1024**5)
else:
raise ValueError("Given size is not correct.")
def build_s5cmd_exec(old, new, local_dir):
run_cmd(
[
"git",
"-C",
local_dir,
"clone",
"https://github.com/kmiku7/s5cmd.git",
"-q",
]
)
clone_dir = os.path.join(local_dir, "s5cmd")
old = S5cmd(local_dir, clone_dir, "old", old)
new = S5cmd(local_dir, clone_dir, "new", new)
return old, new
def is_pr(tag):
if tag is None or tag == "" or tag == "0":
return False
return re.match(r"^\d+$", tag) is not None
def is_version_tag(tag):
if tag is None or tag == "":
return False
return re.match(r"^v(\d+.){2}(\d)(-[a-z]*.?\d?)?$", tag) is not None
def create_bench_dir(bucket, prefix, local_path):
"""
Create a benchmark directory with a unique name to specified local_path.
If no path is specified, create temporary directory using mkdtemp.
In both of those cases, use the same unique name to create remote path name.
:param bucket: remote bucket to be used to create remote_path
:param prefix: prefix to be used after specified bucket for remote_path
:param local_path: specify a path for temporary files to be created in your local. If empty,
use default temporary folder path of your device.
:returns:
- local_dir - created local_dir path as local_path/bench-unique_suffix
- remote_path - created remote_path as s3://bucket/prefix/unique_suffix
"""
if local_path:
basename = "bench"
suffix = datetime.datetime.now().strftime("%y%m%d_%H%M%S")
tmp_dir = "_".join([basename, suffix])
if os.path.isdir(local_path):
os.chdir(local_path)
else:
raise NotADirectoryError(local_path)
os.chdir(local_path)
os.mkdir(tmp_dir)
os.chdir(tmp_dir)
local_dir = os.getcwd()
remote_path = f"s3://{bucket}/{prefix}/{suffix}"
else:
local_dir = mkdtemp(prefix=prefix)
idx = local_dir.rfind(prefix[-1]) + 1
remote_path = f"s3://{bucket}/{prefix}/{local_dir[idx:]}"
print(f"All the local temporary files will be created at {local_dir}")
print(f"All the remote files will be uploaded to {remote_path}")
return local_dir, remote_path
def run_cmd(cmd, verbose=True):
process = subprocess.run(cmd, capture_output=True, text=True)
if verbose:
print(process.stdout, end="")
print(process.stderr, end="")
return process.stdout
def cleanup(tmp_dir, temp_result_file_dir):
temp_summary = os.path.join(temp_result_file_dir, "detailed_summary.md")
if os.path.isfile(temp_summary):
os.remove(temp_summary)
shutil.rmtree(tmp_dir)
def check_dependencies():
"""
Checks external binary dependencies and returns bool, str tuple.
Returns True, None if all dependencies are installed.
Returns False, Descriptive Message if any of the dependencies is not installed.
"""
dependencies = ["git", "go", "hyperfine", "truncate"]
for d in dependencies:
if shutil.which(d) is None:
return (
False,
f"{d} is not found. Please install it to your system and run the script again.",
)
return True, None
if __name__ == "__main__":
main()