forked from scylladb/scylla-cluster-tests
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsct.py
executable file
·1113 lines (930 loc) · 48.8 KB
/
sct.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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# See LICENSE for more details.
#
# Copyright (c) 2021 ScyllaDB
# pylint: disable=too-many-lines
# pylint: disable=too-many-lines
import os
import re
import sys
import unittest
import logging
import glob
import time
import subprocess
import traceback
from concurrent.futures import ProcessPoolExecutor
from pathlib import Path
from functools import partial
import pytest
import click
import click_completion
from prettytable import PrettyTable
from sdcm.results_analyze import PerformanceResultsAnalyzer
from sdcm.sct_config import SCTConfiguration
from sdcm.sct_runner import AwsSctRunner, GceSctRunner
from sdcm.utils.cloud_monitor import cloud_report, cloud_qa_report
from sdcm.utils.common import (list_instances_aws, list_instances_gce, list_resources_docker, clean_cloud_resources,
all_aws_regions, get_scylla_ami_versions, get_s3_scylla_repos_mapping,
list_logs_by_test_id, get_branched_ami, gce_meta_to_dict,
aws_tags_to_dict, list_elastic_ips_aws, get_builder_by_test_id,
clean_resources_according_post_behavior, clean_sct_runners,
search_test_id_in_latest, get_testrun_dir, format_timestamp, list_clusters_gke,
list_clusters_eks, get_all_gce_regions)
from sdcm.utils.jepsen import JepsenResults
from sdcm.monitorstack import (restore_monitoring_stack, get_monitoring_stack_services,
kill_running_monitoring_stack_services)
from sdcm.cluster import TestConfig
from sdcm.utils.log import setup_stdout_logger
from sdcm.utils.prepare_region import AwsRegion
from sdcm.utils.get_username import get_username
from sdcm.send_email import get_running_instances_for_email_report, read_email_data_from_file, build_reporter
from utils.build_system.create_test_release_jobs import JenkinsPipelines
LOGGER = setup_stdout_logger()
click_completion.init()
def sct_option(name, sct_name, **kwargs):
sct_opt = SCTConfiguration.get_config_option(sct_name)
multimple_use = kwargs.pop('multiple', False)
sct_opt.update(kwargs)
return click.option(name, type=sct_opt['type'], help=sct_opt['help'], multiple=multimple_use)
def install_callback(ctx, _, value):
if not value or ctx.resilient_parsing:
return value
shell, path = click_completion.core.install()
click.echo('%s completion installed in %s' % (shell, path))
return sys.exit(0)
def install_package_from_dir(ctx, _, directories):
if directories or not ctx.resilient_parsing:
for directory in directories:
subprocess.check_call(["sudo", sys.executable, "-m", "pip", "install", directory])
return directories
def add_file_logger(level: int = logging.DEBUG) -> None:
cmd_path = "-".join(click.get_current_context().command_path.split()[1:])
logdir = TestConfig().make_new_logdir(update_latest_symlink=False, postfix=f"-{cmd_path}")
handler = logging.FileHandler(os.path.join(logdir, "hydra.log"))
handler.setLevel(level)
LOGGER.addHandler(handler)
@click.group()
@click.option('--install-bash-completion', is_flag=True, callback=install_callback, expose_value=False,
help="Install completion for the current shell. Make sure to have psutil installed.")
@click.option('--install-package-from-directory', callback=install_package_from_dir, multiple=True, envvar='PACKAGES_PATHS',
type=click.Path(), expose_value=False,
help="Install paths for extra python pacakges to install, scylla-cluster-plugins for example")
def cli():
pass
# '''
# Work in progress
# from sdcm.tester import ClusterTester
# @cli.command()
# @click.option('--scylla-version', type=str, default='3.0.3')
# @sct_option('--db-nodes', 'n_db_nodes')
# @sct_option('--loader-nodes', 'n_loaders')
# @sct_option('--monitor-nodes', 'n_monitor_nodes')
# def provision(**kwargs):
# logging.basicConfig(level=logging.INFO)
# # click.secho('Going to install scylla cluster version={}'.format(kwargs['scylla_version']), reverse=True, fg='bright_yellow')
# # TODO: find a better way for ctrl+c to kill this process
# test = ClusterTester(methodName='setUp')
# test._setup_environment_variables()
# test.setUp()
# ''' # pylint: disable=pointless-string-statement
@cli.command('clean-resources', help='clean tagged instances in both clouds (AWS/GCE)')
@click.option('--post-behavior', is_flag=True, default=False, help="clean all resources according to post behavior")
@click.option('--user', type=str, help='user name to filter instances by')
@sct_option('--test-id', 'test_id', help='test id to filter by. Could be used multiple times', multiple=True)
@click.option('--logdir', type=str, help='directory with test run')
@click.option('--dry-run', is_flag=True, default=False, help='dry run')
@click.option('-b', '--backend', type=click.Choice(SCTConfiguration.available_backends), help="Backend to use")
@click.pass_context
def clean_resources(ctx, post_behavior, user, test_id, logdir, dry_run, backend): # pylint: disable=too-many-arguments,too-many-branches
"""Clean cloud resources.
There are different options how to run clean up:
- To clean resources for the latest run according to post behavior
$ hydra clean-resources --post-behavior
- The same as above but with altered logdir
$ hydra clean-resources --post-behavior --logdir /path/to/logdir
- To clean resources for some Test ID according to post behavior (test run status extracted from logdir)
$ hydra clean-resources --post-behavior --test-id TESTID
- The same as above but with altered logdir
$ hydra clean-resources --post-behavior --test-id TESTID --logdir /path/to/logdir
- To clean resources for the latest run ignoring post behavior
$ hydra clean-resources
- The same as above but with altered logdir
$ hydra clean-resources --logdir /path/to/logdir
- To clean all resources belong to some Test ID:
$ hydra clean-resources --test-id TESTID
- To clean all resources belong to some user:
$ hydra clean-resources --user vasya.pupkin
Also you can add --dry-run option to see what should be cleaned.
"""
add_file_logger()
user_param = {"RunByUser": user} if user else {}
if not post_behavior and user and not test_id and not logdir:
click.echo(f"Clean all resources belong to user `{user}'")
params = (user_param, )
else:
if not logdir and (post_behavior or not test_id):
logdir = TestConfig().base_logdir()
if not test_id and (latest_test_id := search_test_id_in_latest(logdir)):
click.echo(f"Latest TestId in {logdir} is {latest_test_id}")
test_id = (latest_test_id, )
if not test_id:
click.echo(clean_resources.get_help(ctx))
return
if post_behavior:
click.echo(f"Clean resources according to post behavior for following Test IDs: {test_id}")
else:
click.echo(f"Clean all resources for following Test IDs: {test_id}")
params = ({"TestId": tid, **user_param} for tid in test_id)
if backend is None:
if os.environ.get('SCT_CLUSTER_BACKEND', None) is None:
os.environ['SCT_CLUSTER_BACKEND'] = 'aws'
else:
os.environ['SCT_CLUSTER_BACKEND'] = backend
if post_behavior:
click.echo(f"Use {logdir} as a logdir")
clean_func = partial(clean_resources_according_post_behavior, config=SCTConfiguration(), logdir=logdir)
else:
clean_func = clean_cloud_resources
if dry_run:
click.echo("Make a dry-run")
for param in params:
clean_func(param, dry_run=dry_run)
click.echo(f"Resources for {param} have cleaned")
@cli.command('list-resources', help='list tagged instances in both clouds (AWS/GCE)')
@click.option('--user', type=str, help='user name to filter instances by')
@click.option('--get-all', is_flag=True, default=False, help='All resources')
@click.option('--get-all-running', is_flag=True, default=False, help='All running resources')
@sct_option('--test-id', 'test_id', help='test id to filter by')
@click.option('--verbose', is_flag=True, default=False, help='if enable, will log progress')
@click.pass_context
def list_resources(ctx, user, test_id, get_all, get_all_running, verbose):
# pylint: disable=too-many-locals,too-many-arguments,too-many-branches,too-many-statements
add_file_logger()
params = dict()
if user:
params['RunByUser'] = user
if test_id:
params['TestId'] = test_id
if all([not get_all, not get_all_running, not user, not test_id]):
click.echo(list_resources.get_help(ctx))
if get_all_running:
table_header = ["Name", "Region-AZ", "PublicIP", "TestId", "RunByUser", "LaunchTime"]
else:
table_header = ["Name", "Region-AZ", "State", "TestId", "RunByUser", "LaunchTime"]
click.secho("Checking AWS EC2...", fg='green')
aws_instances = list_instances_aws(tags_dict=params, running=get_all_running, verbose=verbose)
if aws_instances:
aws_table = PrettyTable(table_header)
aws_table.align = "l"
aws_table.sortby = 'LaunchTime'
for instance in aws_instances:
tags = aws_tags_to_dict(instance.get('Tags'))
name = tags.get("Name", "N/A")
test_id = tags.get("TestId", "N/A")
run_by_user = tags.get("RunByUser", "N/A")
aws_table.add_row([
name,
instance['Placement']['AvailabilityZone'],
instance.get('PublicIpAddress', 'N/A') if get_all_running else instance['State']['Name'],
test_id,
run_by_user,
instance['LaunchTime'].ctime()])
click.echo(aws_table.get_string(title="Instances used on AWS"))
else:
click.secho("Nothing found for selected filters in AWS!", fg="yellow")
click.secho("Checking AWS Elastic IPs...", fg='green')
elastic_ips_aws = list_elastic_ips_aws(tags_dict=params, verbose=verbose)
if elastic_ips_aws:
aws_table = PrettyTable(["AllocationId", "PublicIP", "TestId", "RunByUser", "InstanceId (attached to)"])
aws_table.align = "l"
aws_table.sortby = 'AllocationId'
for eip in elastic_ips_aws:
tags = aws_tags_to_dict(eip.get('Tags'))
test_id = tags.get("TestId", "N/A")
run_by_user = tags.get("RunByUser", "N/A")
aws_table.add_row([
eip['AllocationId'],
eip['PublicIp'],
test_id,
run_by_user,
eip.get('InstanceId', 'N/A')])
click.echo(aws_table.get_string(title="EIPs used on AWS"))
else:
click.secho("No elastic ips found for selected filters in AWS!", fg="yellow")
click.secho("Checking GKE...", fg='green')
gke_clusters = list_clusters_gke(tags_dict=params, verbose=verbose)
if gke_clusters:
gke_table = PrettyTable(["Name", "Region-AZ", "TestId", "RunByUser", "CreateTime"])
gke_table.align = "l"
gke_table.sortby = 'CreateTime'
for cluster in gke_clusters:
tags = gce_meta_to_dict(cluster.extra['metadata'])
gke_table.add_row([cluster.name,
cluster.zone,
tags.get('TestId', 'N/A') if tags else "N/A",
tags.get('RunByUser', 'N/A') if tags else "N/A",
cluster.cluster_info['createTime'],
])
click.echo(gke_table.get_string(title="GKE clusters"))
else:
click.secho("Nothing found for selected filters in GKE!", fg="yellow")
click.secho("Checking GCE...", fg='green')
gce_instances = list_instances_gce(tags_dict=params, running=get_all_running, verbose=verbose)
if gce_instances:
gce_table = PrettyTable(table_header)
gce_table.align = "l"
gce_table.sortby = 'LaunchTime'
for instance in gce_instances:
tags = gce_meta_to_dict(instance.extra['metadata'])
public_ips = ", ".join(instance.public_ips) if None not in instance.public_ips else "N/A"
gce_table.add_row([instance.name,
instance.extra["zone"].name,
public_ips if get_all_running else instance.state,
tags.get('TestId', 'N/A') if tags else "N/A",
tags.get('RunByUser', 'N/A') if tags else "N/A",
instance.extra['creationTimestamp'],
])
click.echo(gce_table.get_string(title="Resources used on GCE"))
else:
click.secho("Nothing found for selected filters in GCE!", fg="yellow")
click.secho("Checking EKS...", fg='green')
eks_clusters = list_clusters_eks(tags_dict=params, verbose=verbose)
if eks_clusters:
eks_table = PrettyTable(["Name", "TestId", "Region", "RunByUser", "CreateTime"])
eks_table.align = "l"
eks_table.sortby = 'CreateTime'
for cluster in eks_clusters:
tags = gce_meta_to_dict(cluster.extra['metadata'])
eks_table.add_row([cluster.name,
tags.get('TestId', 'N/A') if tags else "N/A",
cluster.region_name,
tags.get('RunByUser', 'N/A') if tags else "N/A",
cluster.create_time,
])
click.echo(eks_table.get_string(title="EKS clusters"))
else:
click.secho("Nothing found for selected filters in EKS!", fg="yellow")
click.secho("Checking Docker...", fg="green")
docker_resources = \
list_resources_docker(tags_dict=params, running=get_all_running, group_as_builder=True, verbose=verbose)
if any(docker_resources.values()):
if docker_resources.get("containers"):
docker_table = PrettyTable(["Name", "Builder", "Public IP" if get_all_running else "Status",
"TestId", "RunByUser", "Created"])
docker_table.align = "l"
docker_table.sortby = "Created"
for builder_name, docker_containers in docker_resources["containers"].items():
for container in docker_containers:
container.reload()
docker_table.add_row([
container.name,
builder_name,
container.attrs["NetworkSettings"]["IPAddress"] if get_all_running else container.status,
container.labels.get("TestId", "N/A"),
container.labels.get("RunByUser", "N/A"),
container.attrs.get("Created", "N/A"),
])
click.echo(docker_table.get_string(title="Containers used on Docker"))
if docker_resources.get("images"):
docker_table = PrettyTable(["Name", "Builder", "TestId", "RunByUser", "Created"])
docker_table.align = "l"
docker_table.sortby = "Created"
for builder_name, docker_images in docker_resources["images"].items():
for image in docker_images:
image.reload()
for tag in image.tags:
docker_table.add_row([
tag,
builder_name,
image.labels.get("TestId", "N/A"),
image.labels.get("RunByUser", "N/A"),
image.attrs.get("Created", "N/A"),
])
click.echo(docker_table.get_string(title="Images used on Docker"))
else:
click.secho("Nothing found for selected filters in Docker!", fg="yellow")
@cli.command('list-ami-versions', help='list Amazon Scylla formal AMI versions')
@click.option('-r', '--region', type=click.Choice(all_aws_regions(cached=True)), default='eu-west-1')
def list_ami_versions(region):
add_file_logger()
amis = get_scylla_ami_versions(region)
tbl = PrettyTable(["Name", "ImageId", "CreationDate"])
tbl.align = "l"
for ami in amis:
tbl.add_row([ami['Name'], ami['ImageId'], ami['CreationDate']])
click.echo(tbl.get_string(title="Scylla AMI versions"))
@cli.command('list-ami-branch', help="""list Amazon Scylla branched AMI versions
\n\n[VERSION] is a branch version to look for, ex. 'branch-2019.1:latest', 'branch-3.1:all'""")
@click.option('-r', '--region', type=click.Choice(all_aws_regions(cached=True)), default='eu-west-1')
@click.argument('version', type=str, default='branch-3.1:all')
def list_ami_branch(region, version):
add_file_logger()
def get_tags(ami):
return {i['Key']: i['Value'] for i in ami.tags}
if ":" not in version:
version += ":all"
amis = get_branched_ami(version, region_name=region)
tbl = PrettyTable(["Name", "ImageId", "CreationDate", "BuildId", "Test Status"])
tbl.align = "l"
for ami in amis:
tags = get_tags(ami)
test_status = [(k, v) for k, v in tags.items() if k.startswith('JOB:')]
test_status = [click.style(k, fg='green') for k, v in test_status if v == 'PASSED'] + \
[click.style(k, fg='red') for k, v in test_status if not v == 'PASSED']
test_status = ", ".join(test_status) if test_status else click.style('Unknown', fg='yellow')
tbl.add_row([ami.name, ami.id, ami.creation_date, tags['build-id'], test_status])
click.echo(tbl.get_string(title="Scylla AMI branch versions"))
@cli.command('list-repos', help='List repos url of Scylla formal versions')
@click.option('-d', '--dist-type', type=click.Choice(['centos', 'ubuntu', 'debian']),
default='centos', help='Distribution type')
@click.option('-v', '--dist-version', type=click.Choice(['xenial', 'trusty', 'bionic', 'focal', # Ubuntu
'jessie', 'stretch', 'buster']), # Debian
default=None, help='deb style versions')
def list_repos(dist_type, dist_version):
add_file_logger()
if not dist_type == 'centos' and dist_version is None:
click.secho("when passing --dist-type=debian/ubuntu need to pass --dist-version as well", fg='red')
sys.exit(1)
repo_maps = get_s3_scylla_repos_mapping(dist_type, dist_version)
tbl = PrettyTable(["Version Family", "Repo Url"])
tbl.align = "l"
for version_prefix, repo_url in repo_maps.items():
tbl.add_row([version_prefix, repo_url])
click.echo(tbl.get_string(title="Scylla Repos"))
@cli.command('output-conf', help="Output test configuration readed from the file")
@click.argument('config_files', type=str, default='')
@click.option('-b', '--backend', type=click.Choice(SCTConfiguration.available_backends))
def output_conf(config_files, backend):
add_file_logger()
if backend:
os.environ['SCT_CLUSTER_BACKEND'] = backend
if config_files:
os.environ['SCT_CONFIG_FILES'] = config_files
config = SCTConfiguration()
click.secho(config.dump_config(), fg='green')
sys.exit(0)
def _run_yaml_test(backend, full_path, env):
output = []
error = False
output.append(f'---- linting: {full_path} -----')
while os.environ:
os.environ.popitem()
for key, value in env.items():
os.environ[key] = value
os.environ['SCT_CLUSTER_BACKEND'] = backend
os.environ['SCT_CONFIG_FILES'] = full_path
logging.getLogger().handlers = []
logging.getLogger().disabled = True
config = SCTConfiguration()
try:
config.verify_configuration()
config.check_required_files()
except Exception as exc: # pylint: disable=broad-except
output.append(''.join(traceback.format_exception(type(exc), exc, exc.__traceback__)))
error = True
return error, output
@cli.command(help="Test yaml in test-cases directory")
@click.option('-b', '--backend', type=click.Choice(SCTConfiguration.available_backends), default='aws')
@click.option('-i', '--include', type=str, default='')
@click.option('-e', '--exclude', type=str, default='')
def lint_yamls(backend, exclude: str, include: str): # pylint: disable=too-many-locals,too-many-branches
if not include:
raise ValueError('You did not provide include filters')
exclude_filters = []
for flt in exclude.split(','):
if not flt:
continue
try:
exclude_filters.append(re.compile(flt))
except Exception as exc: # pylint: disable=broad-except
raise ValueError(f'Exclude filter "{flt}" compiling failed with: {exc}') from exc
include_filters = []
for flt in include.split(','):
if not flt:
continue
try:
include_filters.append(re.compile(flt))
except Exception as exc: # pylint: disable=broad-except
raise ValueError(f'Include filter "{flt}" compiling failed with: {exc}') from exc
original_env = {**os.environ}
process_pool = ProcessPoolExecutor(max_workers=5) # pylint: disable=consider-using-with
features = []
for root, _, files in os.walk('./test-cases'):
for file in files:
full_path = os.path.join(root, file)
if not any((flt.search(file) or flt.search(full_path) for flt in include_filters)):
continue
if any((flt.search(file) or flt.search(full_path) for flt in exclude_filters)):
continue
features.append(process_pool.submit(_run_yaml_test, backend, full_path, original_env))
failed = False
for pp_feature in features:
error, pp_output = pp_feature.result()
if error:
failed = True
click.secho('\n'.join(pp_output), fg='red')
else:
click.secho('\n'.join(pp_output), fg='green')
print()
sys.exit(1 if failed else 0)
@cli.command(help="Check test configuration file")
@click.argument('config_file', type=str, default='')
@click.option('-b', '--backend', type=click.Choice(SCTConfiguration.available_backends), default='aws')
def conf(config_file, backend):
add_file_logger()
if backend:
os.environ['SCT_CLUSTER_BACKEND'] = backend
if config_file:
os.environ['SCT_CONFIG_FILES'] = config_file
config = SCTConfiguration()
try:
config.verify_configuration()
config.check_required_files()
except Exception as ex: # pylint: disable=broad-except
logging.exception(str(ex))
click.secho(str(ex), fg='red')
sys.exit(1)
else:
click.secho(config.dump_config(), fg='green')
sys.exit(0)
@cli.command('conf-docs', help="Show all available configuration in yaml/markdown format")
@click.option('-o', '--output-format', type=click.Choice(["yaml", "markdown"]), default="yaml", help="type of the output")
def conf_docs(output_format):
add_file_logger()
os.environ['SCT_CLUSTER_BACKEND'] = "aws" # just to pass SCTConfiguration() verification.
config_logger = logging.getLogger('sdcm.sct_config')
config_logger.setLevel(logging.ERROR)
if output_format == 'markdown':
click.secho(SCTConfiguration().dump_help_config_markdown())
elif output_format == 'yaml':
click.secho(SCTConfiguration().dump_help_config_yaml())
@cli.command("perf-regression-report", help="Generate and send performance regression report")
@click.option("-i", "--es-id", required=True, type=str, help="Id of the run in Elastic Search")
@click.option("-e", "--emails", required=True, type=str, help="Comma separated list of emails. Example [email protected],[email protected]")
def perf_regression_report(es_id, emails):
add_file_logger()
email_list = emails.split(",")
click.secho(message="Will send Performance Regression report to %s" % email_list, fg="green")
LOGGER.setLevel(logging.DEBUG)
results_analyzer = PerformanceResultsAnalyzer(es_index="performanceregressiontest", es_doc_type="test_stats",
send_email=True, email_recipients=email_list, logger=LOGGER)
click.secho(message="Checking regression comparing to: %s" % es_id, fg="green")
results_analyzer.check_regression(es_id)
click.secho(message="Done." % email_list, fg="yellow")
@click.group(help="Group of commands for investigating testrun")
def investigate():
pass
@investigate.command('show-logs', help="Show logs collected for testrun filtered by test-id")
@click.argument('test_id')
@click.option('-o', '--output-format', type=click.Choice(["table", "markdown"]), default="table", help="type of the output")
def show_log(test_id, output_format):
add_file_logger()
files = list_logs_by_test_id(test_id)
if output_format == 'table':
table = PrettyTable(["Date", "Log type", "Link"])
table.align = "l"
for log in files:
table.add_row([log["date"].strftime("%Y%m%d_%H%M%S"), log["type"], log["link"]])
click.echo(table.get_string(title="Log links for testrun with test id {}".format(test_id)))
elif output_format == 'markdown':
click.echo("\n## Logs\n")
for log in files:
click.echo(f'* **{log["type"]}** - {log["link"]}')
@investigate.command('show-monitor', help="Run monitoring stack with saved data locally")
@click.argument('test_id')
@click.option("--date-time", type=str, required=False, help='Datetime of monitor-set archive is collected')
@click.option("--kill", type=bool, required=False, help='Kill and remove containers')
def show_monitor(test_id, date_time, kill):
add_file_logger()
click.echo('Search monitoring stack archive files for test id {} and restoring...'.format(test_id))
# if debug_log:
# LOGGER.setLevel(logging.DEBUG)
try:
status = restore_monitoring_stack(test_id, date_time)
except Exception as details: # pylint: disable=broad-except
LOGGER.error("%s", details)
status = False
table = PrettyTable(['Service', 'Container', 'Link'])
table.align = 'l'
if status:
click.echo('Monitoring stack restored')
for docker in get_monitoring_stack_services():
table.add_row([docker['service'], docker["name"], 'http://localhost:{}'.format(docker["port"])])
click.echo(table.get_string(title='Monitoring stack services'))
if kill:
kill_running_monitoring_stack_services()
else:
click.echo('Errors were found when restoring Scylla monitoring stack')
kill_running_monitoring_stack_services()
sys.exit(1)
@investigate.command('show-jepsen-results', help="Run a server with Jepsen results")
@click.argument('test_id')
def show_jepsen_results(test_id):
add_file_logger()
click.secho(message=f"\nSearch Jepsen results archive files for test id {test_id} and restoring...\n", fg="green")
jepsen = JepsenResults()
if jepsen.restore_jepsen_data(test_id):
click.secho(
message=f"\nJepsen data restored, starting web server on http://localhost:{jepsen.jepsen_results_port}/\n"
f"Press Ctrl-C to stop the server.\n",
fg="green",
)
jepsen.run_jepsen_web_server()
@investigate.command('search-builder', help='Search builder where test run with test-id located')
@click.argument('test-id')
def search_builder(test_id):
logging.getLogger("paramiko").setLevel(logging.CRITICAL)
add_file_logger()
results = get_builder_by_test_id(test_id)
tbl = PrettyTable(['Builder Name', "Public IP", "path"])
tbl.align = 'l'
for result in results:
tbl.add_row([result['builder']['name'], result['builder']['public_ip'], result['path']])
click.echo(tbl.get_string(title='Found builders for Test-id: {}'.format(test_id)))
@investigate.command('show-events', help='Return content of file events_log/events for running job by test-id')
@click.argument('test-id')
@click.option("--follow", type=bool, required=False, is_flag=True, default=False,
help="Follow job events log file (similar tail -f <file>)")
@click.option("--last-n", type=int, required=False, help="return last n lines from events.log file")
@click.option("--save-to", type=str, required=False, help="Download events.log file and save to provided dir")
def show_events(test_id: str, follow: bool = False, last_n: int = None, save_to: str = None):
logging.getLogger("paramiko").setLevel(logging.CRITICAL)
add_file_logger()
builders = get_builder_by_test_id(test_id)
if not builders:
LOGGER.info("Builder was not found for provided test-id %s", test_id)
for builder in builders:
LOGGER.info(
"Applying action for events.log on builder %s:%s...", builder['builder']['name'], builder['builder']['public_ip'])
remoter = builder["builder"]["remoter"]
if follow or last_n:
options = "-f " if follow else ""
options += f"-n {last_n} " if last_n else ""
try:
remoter.run("tail %s %s/events_log/events.log", options, builder['path'])
except KeyboardInterrupt:
LOGGER.info('Monitoring events.log for test-id %s stopped!', test_id)
elif save_to:
remoter.receive_files(f"{builder['path']}/events_log/events.log", save_to)
LOGGER.info("Events saved to %s", save_to)
else:
remoter.run(f"cat {builder['path']}/events_log/events.log")
click.echo("Show events done.")
cli.add_command(investigate)
@cli.command('unit-tests', help="Run all the SCT internal unit-tests")
@click.option("-t", "--test", required=False, default="",
help="Run specific test file from unit-tests directory")
def unit_tests(test):
sys.exit(pytest.main(['-v', '-p', 'no:warnings', 'unit_tests/{}'.format(test)]))
@cli.command('pre-commit', help="Run pre-commit checkers")
def pre_commit():
result = 0
result += os.system(
'bash -c "git show -s --format=%B > /tmp/commit-msg; '
'pre-commit run --hook-stage commit-msg --commit-msg-filename /tmp/commit-msg"'
)
result += os.system('pre-commit run -a --show-diff-on-failure')
result = 1 if result else 0
sys.exit(result)
class OutputLogger():
def __init__(self, filename, terminal):
self.terminal = terminal
self.log = open(filename, "a") # pylint: disable=consider-using-with
def write(self, message):
self.terminal.write(message)
self.log.write(message)
def flush(self):
self.terminal.flush()
self.log.flush()
def isatty(self): # pylint: disable=no-self-use
return False
@cli.command('run-test', help="Run SCT test using unittest")
@click.argument('argv')
@click.option('-b', '--backend', type=click.Choice(SCTConfiguration.available_backends), help="Backend to use")
@click.option('-c', '--config', multiple=True, type=click.Path(exists=True), help="Test config .yaml to use, can have multiple of those")
@click.option('-l', '--logdir', help="Directory to use for logs")
def run_test(argv, backend, config, logdir):
if config:
os.environ['SCT_CONFIG_FILES'] = str(list(config))
if backend:
os.environ['SCT_CLUSTER_BACKEND'] = backend
if logdir:
os.environ['_SCT_LOGDIR'] = logdir
logfile = os.path.join(TestConfig().logdir(), 'output.log')
sys.stdout = OutputLogger(logfile, sys.stdout)
sys.stderr = OutputLogger(logfile, sys.stderr)
unittest.main(module=None, argv=['python -m unittest', argv],
failfast=False, buffer=False, catchbreak=True)
@cli.command('run-pytest', help="Run tests using pytest")
@click.argument('target')
@click.option('-b', '--backend', type=click.Choice(SCTConfiguration.available_backends), help="Backend to use")
@click.option('-c', '--config', multiple=True, type=click.Path(exists=True), help="Test config .yaml to use, can have multiple of those")
@click.option('-l', '--logdir', help="Directory to use for logs")
def run_pytest(target, backend, config, logdir):
if config:
os.environ['SCT_CONFIG_FILES'] = str(list(config))
if backend:
os.environ['SCT_CLUSTER_BACKEND'] = backend
if logdir:
os.environ['_SCT_LOGDIR'] = logdir
logfile = os.path.join(TestConfig().logdir(), 'output.log')
sys.stdout = OutputLogger(logfile, sys.stdout)
sys.stderr = OutputLogger(logfile, sys.stderr)
if not target:
print("argv is referring to the directory or file that contain tests, it can't be empty")
sys.exit(1)
sys.exit(pytest.main(['-s', '-v', '-p', 'no:warnings', target]))
@cli.command("cloud-usage-report", help="Generate and send Cloud usage report")
@click.option("-e", "--emails", required=True, type=str, help="Comma separated list of emails. Example [email protected],[email protected]")
def cloud_usage_report(emails):
add_file_logger()
email_list = emails.split(",")
click.secho(message="Will send Cloud Usage report to %s" % email_list, fg="green")
cloud_report(mail_to=email_list)
click.secho(message="Done." % email_list, fg="yellow")
@cli.command("cloud-usage-qa-report", help="Generate and send Cloud usage report")
@click.option("-e", "--emails", required=True, type=str, help="Comma separated list of emails. Example [email protected],[email protected]")
@click.option("-u", "--user", required=False, type=str, help="User or instance owner")
def cloud_usage_qa_report(emails, user=None):
add_file_logger()
email_list = emails.split(",")
click.secho(message="Will send Cloud Usage report to %s" % email_list, fg="green")
cloud_qa_report(mail_to=email_list, user=user)
click.secho(message="Done." % email_list, fg="yellow")
@cli.command('collect-logs', help='Collect logs from cluster by test-id')
@click.option('--test-id', help='Find cluster by test-id')
@click.option('--logdir', help='Path to directory with sct results')
@click.option('--backend', help='Cloud where search nodes', default=None)
@click.option('--config-file', type=str, help='config test file path')
def collect_logs(test_id=None, logdir=None, backend=None, config_file=None):
add_file_logger()
from sdcm.logcollector import Collector # pylint: disable=import-outside-toplevel
logging.getLogger("paramiko").setLevel(logging.CRITICAL)
if backend is None:
if os.environ.get('SCT_CLUSTER_BACKEND', None) is None:
os.environ['SCT_CLUSTER_BACKEND'] = 'aws'
else:
os.environ['SCT_CLUSTER_BACKEND'] = backend
if config_file and not os.environ.get('SCT_CONFIG_FILES', None):
os.environ['SCT_CONFIG_FILES'] = config_file
config = SCTConfiguration()
collector = Collector(test_id=test_id, params=config, test_dir=logdir)
collected_logs = collector.run()
table = PrettyTable(['Cluster set', 'Link'])
table.align = 'l'
for cluster_type, s3_links in collected_logs.items():
for link in s3_links:
table.add_row([cluster_type, link])
click.echo(table.get_string(title="Collected logs by test-id: {}".format(collector.test_id)))
# pylint: disable=too-many-arguments,too-many-branches
@cli.command('send-email', help='Send email with results for testrun')
@click.option('--test-id', help='Test-id of run')
@click.option('--test-status', help='Override test status FAILED|ABORTED')
@click.option('--start-time', help='Override test start time')
@click.option('--started-by', help='Default user that started the test')
@click.option('--runner-ip', type=str, required=False, help="Sct runner ip for the running test")
@click.option('--email-recipients', help="Send email to next recipients")
@click.option('--logdir', help='Directory where to find testrun folder')
def send_email(test_id=None, test_status=None, start_time=None, started_by=None, runner_ip=None,
email_recipients=None, logdir=None):
if started_by is None:
started_by = get_username()
add_file_logger()
if not email_recipients:
LOGGER.warning("No email recipients. Email will not be sent")
return
LOGGER.info('Email will be sent to next recipients: %s', email_recipients)
if not logdir:
logdir = os.path.expanduser('~/sct-results')
test_results = None
if start_time is None:
start_time = format_timestamp(time.time())
else:
start_time = format_timestamp(int(start_time))
testrun_dir = get_testrun_dir(test_id=test_id, base_dir=logdir)
if testrun_dir:
with open(os.path.join(testrun_dir, 'test_id'), 'r') as file:
test_id = file.read().strip()
email_results_file = os.path.join(testrun_dir, "email_data.json")
test_results = read_email_data_from_file(email_results_file)
else:
LOGGER.warning("Failed to find test directory for %s", test_id)
if test_results:
reporter = test_results.get("reporter", "")
test_results['nodes'] = get_running_instances_for_email_report(test_id, runner_ip)
else:
LOGGER.warning("Failed to read test results for %s", test_id)
reporter = "TestAborted"
if not test_status:
test_status = 'ABORTED'
test_results = {
"job_url": os.environ.get("BUILD_URL"),
"subject": f"{test_status}: {os.environ.get('JOB_NAME')}: {start_time}",
"start_time": start_time,
"end_time": format_timestamp(time.time()),
"grafana_screenshots": "",
"grafana_snapshots": "",
"nodes": "",
"test_id": "",
"username": ""
}
if started_by:
test_results["username"] = started_by
if test_id:
test_results.update({
"test_id": test_id,
"nodes": get_running_instances_for_email_report(test_id, runner_ip)
})
test_results['logs_links'] = list_logs_by_test_id(test_results.get('test_id', test_id))
email_recipients = email_recipients.split(',')
reporter = build_reporter(reporter, email_recipients, testrun_dir)
if not reporter:
LOGGER.warning("No reporter found")
sys.exit(1)
try:
reporter.send_report(test_results)
except Exception: # pylint: disable=broad-except
LOGGER.error("Failed to create email due to the following error:\n%s", traceback.format_exc())
build_reporter("TestAborted", email_recipients, testrun_dir).send_report({
"job_url": os.environ.get("BUILD_URL"),
"subject": f"FAILED: {os.environ.get('JOB_NAME')}: {start_time}",
})
@cli.command('create-operator-test-release-jobs',
help="Create pipeline jobs for a new scylla-operator branch/release")
@click.argument('branch', type=str)
@click.argument('username', envvar='JENKINS_USERNAME', type=str)
@click.argument('password', envvar='JENKINS_PASSWORD', type=str)
@click.option('--sct_branch', default='master', type=str)
@click.option('--sct_repo', default='[email protected]:scylladb/scylla-cluster-tests.git', type=str)
def create_operator_test_release_jobs(branch, username, password, sct_branch, sct_repo):
add_file_logger()
base_job_dir = "scylla-operator"
server = JenkinsPipelines(
username=username, password=password, base_job_dir=base_job_dir,
sct_branch_name=sct_branch, sct_repo=sct_repo)
server.create_directory(name=branch, display_name=branch)
server.base_job_dir = "/".join([server.base_job_dir, branch])
def walk_dirs(path):
for dirpath, dirnames, filenames in os.walk(path):
for filename in filenames:
if filename.endswith('.jenkinsfile'):
finalpath = "/".join([dirpath, filename])
server.create_pipeline_job(finalpath, "", job_name_suffix="")
for dirname in dirnames:
server.create_directory(name=dirname, display_name=dirname)
server.base_job_dir = "/".join([server.base_job_dir, dirname])
walk_dirs("/".join([dirpath, dirname]))
server.base_job_dir = server.base_job_dir.rsplit("/", 1)[0]
break
path = "/".join([str(server.base_sct_dir), "jenkins-pipelines/operator"])
walk_dirs(path)
@cli.command('create-test-release-jobs', help="Create pipeline jobs for a new branch")
@click.argument('branch', type=str)
@click.argument('username', envvar='JENKINS_USERNAME', type=str)
@click.argument('password', envvar='JENKINS_PASSWORD', type=str)
@click.option('--sct_branch', default='master', type=str)
@click.option('--sct_repo', default='[email protected]:scylladb/scylla-cluster-tests.git', type=str)
def create_test_release_jobs(branch, username, password, sct_branch, sct_repo):
add_file_logger()
base_job_dir = f'{branch}'
server = JenkinsPipelines(username=username, password=password, base_job_dir=base_job_dir,
sct_branch_name=sct_branch, sct_repo=sct_repo)
for group_name, group_desc in [
('longevity', 'SCT Longevity Tests'),
('rolling-upgrade', 'SCT Rolling Upgrades'),
('gemini-', 'SCT Gemini Tests'),
('features-', 'SCT Feature Tests'),
('artifacts', 'SCT Artifacts Tests'),
('load-test', 'SCT Load Tests'),
('repair-based-operation', "SCT RBO Tests"),
]:
server.create_directory(name=group_name, display_name=group_desc)
for jenkins_file in glob.glob(f'{server.base_sct_dir}/jenkins-pipelines/{group_name}*.jenkinsfile'):
server.create_pipeline_job(jenkins_file, group_name)
if group_name == 'load-test':
for jenkins_file in glob.glob(f'{server.base_sct_dir}/jenkins-pipelines/admission_control_overload*'):
server.create_pipeline_job(jenkins_file, group_name)
if group_name == 'repair-based-operation':
for jenkins_file in glob.glob(f'{server.base_sct_dir}/jenkins-pipelines/repair-based-operation/*'):
server.create_pipeline_job(jenkins_file, group_name)
server.create_directory(name='artifacts-offline-install', display_name='SCT Artifacts Offline Install Tests')
def jenkinsfile_generator():
for i in ['ami', 'amazon2', 'docker', 'gce-image']:
yield f'-{i}.jenkinsfile' in jenkins_file
for jenkins_file in glob.glob(f'{server.base_sct_dir}/jenkins-pipelines/artifacts-*.jenkinsfile'):
if any(jenkinsfile_generator()):
continue
server.create_pipeline_job(jenkins_file, 'artifacts-offline-install')
for jenkins_file in glob.glob(f'{server.base_sct_dir}/jenkins-pipelines/nonroot-offline-install/*.jenkinsfile'):
server.create_pipeline_job(jenkins_file, 'artifacts-offline-install',
job_name=str(Path(jenkins_file).stem) + '-nonroot')
@cli.command('create-test-release-jobs-enterprise', help="Create pipeline jobs for a new branch")
@click.argument('branch', type=str)