-
Notifications
You must be signed in to change notification settings - Fork 375
/
mass_store_run.py
1454 lines (1223 loc) · 58.7 KB
/
mass_store_run.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
# -------------------------------------------------------------------------
#
# Part of the CodeChecker project, under the Apache License v2.0 with
# LLVM Exceptions. See LICENSE for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
# -------------------------------------------------------------------------
import base64
import json
import os
import sqlalchemy
import tempfile
import time
import zipfile
import zlib
from collections import defaultdict
from datetime import datetime
from hashlib import sha256
from tempfile import TemporaryDirectory
from typing import Any, Dict, List, Optional, Set, Tuple
import codechecker_api_shared
from codechecker_api.codeCheckerDBAccess_v6 import ttypes
from codechecker_common import skiplist_handler
from codechecker_common.logger import get_logger
from codechecker_common.util import load_json
from codechecker_report_converter.util import trim_path_prefixes
from codechecker_report_converter.report import report_file, Report
from codechecker_report_converter.report.hash import get_report_path_hash
from codechecker_report_converter.source_code_comment_handler import \
SourceCodeCommentHandler, SpellException, contains_codechecker_comment
from ..database import db_cleanup
from ..database.config_db_model import Product
from ..database.database import DBSession
from ..database.run_db_model import AnalysisInfo, AnalyzerStatistic, \
BugPathEvent, BugReportPoint, ReportAnnotations, ExtendedReportData, \
File, FileContent, Report as DBReport, ReviewStatus as ReviewStatusRule, \
Run, RunHistory, RunLock
from ..metadata import checker_is_unavailable, MetadataInfoParser
from .report_server import ThriftRequestHandler
from .thrift_enum_helper import report_extended_data_type_str
LOG = get_logger('server')
STORE_TIME_LOG = get_logger('store_time')
class LogTask:
def __init__(self, run_name: str, message: str):
self.__run_name = run_name
self.__msg = message
self.__start_time = time.time()
def __enter__(self, *args):
LOG.info("[%s] %s...", self.__run_name, self.__msg)
def __exit__(self, *args):
LOG.info("[%s] %s done... (duration: %s sec)", self.__run_name,
self.__msg, round(time.time() - self.__start_time, 2))
# FIXME: when these types are introduced we need to use those.
SourceLineComments = List[Any]
def unzip(b64zip: str, output_dir: str) -> int:
"""
This function unzips the base64 encoded zip file. This zip is extracted
to a temporary directory and the ZIP is then deleted. The function returns
the size of the extracted decompressed zip file.
"""
if len(b64zip) == 0:
return 0
with tempfile.NamedTemporaryFile(suffix='.zip') as zip_file:
LOG.debug("Unzipping mass storage ZIP '%s' to '%s'...",
zip_file.name, output_dir)
zip_file.write(zlib.decompress(base64.b64decode(b64zip)))
with zipfile.ZipFile(zip_file, 'r', allowZip64=True) as zipf:
try:
zipf.extractall(output_dir)
return os.stat(zip_file.name).st_size
except Exception:
LOG.error("Failed to extract received ZIP.")
import traceback
traceback.print_exc()
raise
return 0
def get_file_content(file_path: str) -> bytes:
"""Return the file content for the given filepath. """
with open(file_path, 'rb') as f:
return f.read()
def parse_codechecker_review_comment(
source_file_name: str,
report_line: int,
checker_name: str
) -> SourceLineComments:
"""Parse the CodeChecker review comments from a source file at a given
position. Returns an empty list if there are no comments.
"""
src_comment_data = []
with open(source_file_name, encoding='utf-8', errors='ignore') as f:
if contains_codechecker_comment(f):
sc_handler = SourceCodeCommentHandler()
try:
src_comment_data = sc_handler.filter_source_line_comments(
f, report_line, checker_name)
except SpellException as ex:
LOG.warning("File %s contains %s", source_file_name, ex)
return src_comment_data
def add_file_record(
session: DBSession,
file_path: str,
content_hash: str
) -> Optional[int]:
"""
Add the necessary file record pointing to an already existing content.
Returns the added file record id or None, if the content_hash is not
found.
This function must not be called between add_checker_run() and
finish_checker_run() functions when SQLite database is used!
add_checker_run() function opens a transaction which is closed by
finish_checker_run() and since SQLite doesn't support parallel
transactions, this API call will wait until the other transactions
finish. In the meantime the run adding transaction times out.
This function doesn't insert blame info in the File objects because those
are added by __add_blame_info(). In previous CodeChecker versions git info
was not stored at all, so upgrading to a new CodeChecker results the
storage of git blame info even for files that are already stored. For this
reason we can't avoid an update on File and FileContent tables, but we can
avoid double reading of blame info json files.
"""
file_record = session.query(File) \
.filter(File.content_hash == content_hash,
File.filepath == file_path) \
.one_or_none()
if file_record:
return file_record.id
try:
# Parallel storage of runs containing common file paths results a
# "duplicate key violation" error. This is handled by CodeChecker, so
# practically it causes no problem. The INSERT command of the second
# transaction will be thrown away. However, some DB systems are
# supporting "ON CONFLICT DO NOTHING" clause in INSERT statement which
# solves the same issue gracefully.
# TODO: "ON CONFLICT DO NOTHING" feature is available for SQLite engine
# too in SQLAlchemy 1.4.
if session.bind.dialect.name == 'postgresql':
insert_stmt = sqlalchemy.dialects.postgresql.insert(File).values(
filepath=file_path,
filename=os.path.basename(file_path),
content_hash=content_hash).on_conflict_do_nothing(
index_elements=['filepath', 'content_hash'])
file_id = session.execute(insert_stmt).inserted_primary_key[0]
session.commit()
return file_id
else:
file_record = File(file_path, content_hash, None, None)
session.add(file_record)
session.commit()
except sqlalchemy.exc.IntegrityError as ex:
LOG.error(ex)
# Other transaction might have added the same file in the
# meantime.
session.rollback()
file_record = session.query(File) \
.filter(File.content_hash == content_hash,
File.filepath == file_path).one_or_none()
return file_record.id if file_record else None
def get_blame_file_data(
blame_file: str
) -> Tuple[Optional[str], Optional[str], Optional[str]]:
"""
Get blame information from the given file.
It will return a tuple of 'blame information', 'remote url' and
'tracking branch'.
"""
blame_info = None
remote_url = None
tracking_branch = None
if os.path.isfile(blame_file):
data = load_json(blame_file)
if data:
remote_url = data.get("remote_url")
tracking_branch = data.get("tracking_branch")
blame_info = data
# Remove fields which are not needed anymore from the blame info.
del blame_info["remote_url"]
del blame_info["tracking_branch"]
return blame_info, remote_url, tracking_branch
class SourceReviewStatus:
"""
Helper class for handling in source review statuses.
Collect the same info as a review status rule.
FIXME Change this to dataclass when available
"""
def __init__(
self,
status: str,
message: bytes,
bug_hash: Any,
author: str,
date: datetime,
in_source: bool,
):
self.status = status
self.message = message
self.bug_hash = bug_hash
self.author = author
self.date = date
self.in_source = in_source
class MassStoreRun:
def __init__(
self,
report_server: ThriftRequestHandler,
name: str,
tag: Optional[str],
version: Optional[str],
b64zip: str,
force: bool,
trim_path_prefixes: Optional[List[str]],
description: Optional[str]
):
""" Initialize object. """
self.__report_server = report_server
self.__name = name
self.__tag = tag
self.__version = version
self.__b64zip = b64zip
self.__force = force
self.__trim_path_prefixes = trim_path_prefixes
self.__description = description
self.__mips: Dict[str, MetadataInfoParser] = {}
self.__analysis_info: Dict[str, AnalysisInfo] = {}
self.__duration: int = 0
self.__report_count: int = 0
self.__report_limit: int = 0
self.__wrong_src_code_comments: List[str] = []
self.__already_added_report_hashes: Set[str] = set()
self.__severity_map: Dict[str, int] = {}
self.__new_report_hashes: Dict[str, Tuple] = {}
self.__all_report_checkers: Set[str] = set()
self.__added_reports: List[Tuple[DBReport, Report]] = list()
self.__get_report_limit_for_product()
@property
def __manager(self):
return self.__report_server._manager
@property
def __Session(self):
return self.__report_server._Session
@property
def __config_database(self):
return self.__report_server._config_database
@property
def __product(self):
return self.__report_server._product
@property
def __context(self):
return self.__report_server._context
@property
def user_name(self):
return self.__report_server._get_username()
def __check_run_limit(self):
"""
Checks the maximum allowed of uploadable runs for the current product.
"""
max_run_count = self.__manager.get_max_run_count()
with DBSession(self.__config_database) as session:
product = session.query(Product).get(self.__product.id)
if product.run_limit:
max_run_count = product.run_limit
# Session that handles constraints on the run.
with DBSession(self.__Session) as session:
if not max_run_count:
return
LOG.debug("Check the maximum number of allowed runs which is %d",
max_run_count)
run = session.query(Run) \
.filter(Run.name == self.__name) \
.one_or_none()
# If max_run_count is not set in the config file, it will allow
# the user to upload unlimited runs.
run_count = session.query(Run.id).count()
# If we are not updating a run or the run count is reached the
# limit it will throw an exception.
if not run and run_count >= max_run_count:
remove_run_count = run_count - max_run_count + 1
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.GENERAL,
f"You reached the maximum number of allowed runs "
f"({run_count}/{max_run_count})! Please remove at least "
f"{remove_run_count} run(s) before you try it again.")
def __store_run_lock(self, session: DBSession):
"""
Store a RunLock record for the given run name into the database.
"""
try:
# If the run can be stored, we need to lock it first. If there is
# already a lock in the database for the given run name which is
# expired and multiple processes are trying to get this entry from
# the database for update we may get the following exception:
# could not obtain lock on row in relation "run_locks"
# This is the reason why we have to wrap this query to a try/except
# block.
run_lock = session.query(RunLock) \
.filter(RunLock.name == self.__name) \
.with_for_update(nowait=True).one_or_none()
except (sqlalchemy.exc.OperationalError,
sqlalchemy.exc.ProgrammingError) as ex:
LOG.error("Failed to get run lock for '%s': %s", self.__name, ex)
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.DATABASE,
"Someone is already storing to the same run. Please wait "
"while the other storage is finished and try it again.")
if not run_lock:
# If there is no lock record for the given run name, the run
# is not locked -- create a new lock.
run_lock = RunLock(self.__name, self.user_name)
session.add(run_lock)
elif run_lock.has_expired(
db_cleanup.RUN_LOCK_TIMEOUT_IN_DATABASE):
# There can be a lock in the database, which has already
# expired. In this case, we assume that the previous operation
# has failed, and thus, we can re-use the already present lock.
run_lock.touch()
run_lock.username = self.user_name
else:
# In case the lock exists and it has not expired, we must
# consider the run a locked one.
when = run_lock.when_expires(
db_cleanup.RUN_LOCK_TIMEOUT_IN_DATABASE)
username = run_lock.username if run_lock.username is not None \
else "another user"
LOG.info("Refusing to store into run '%s' as it is locked by "
"%s. Lock will expire at '%s'.", self.__name, username,
when)
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.DATABASE,
"The run named '{0}' is being stored into by {1}. If the "
"other store operation has failed, this lock will expire "
"at '{2}'.".format(self.__name, username, when))
# At any rate, if the lock has been created or updated, commit it
# into the database.
try:
session.commit()
except (sqlalchemy.exc.IntegrityError,
sqlalchemy.orm.exc.StaleDataError):
# The commit of this lock can fail.
#
# In case two store ops attempt to lock the same run name at the
# same time, committing the lock in the transaction that commits
# later will result in an IntegrityError due to the primary key
# constraint.
#
# In case two store ops attempt to lock the same run name with
# reuse and one of the operation hangs long enough before COMMIT
# so that the other operation commits and thus removes the lock
# record, StaleDataError is raised. In this case, also consider
# the run locked, as the data changed while the transaction was
# waiting, as another run wholly completed.
LOG.info("Run '%s' got locked while current transaction "
"tried to acquire a lock. Considering run as locked.",
self.__name)
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.DATABASE,
"The run named '{0}' is being stored into by another "
"user.".format(self.__name))
def __free_run_lock(self, session: DBSession):
""" Remove the lock from the database for the given run name. """
# Using with_for_update() here so the database (in case it supports
# this operation) locks the lock record's row from any other access.
run_lock = session.query(RunLock) \
.filter(RunLock.name == self.__name) \
.with_for_update(nowait=True).one()
session.delete(run_lock)
session.commit()
def __store_source_files(
self,
source_root: str,
filename_to_hash: Dict[str, str]
) -> Dict[str, int]:
""" Storing file contents from plist. """
file_path_to_id = {}
for file_name, file_hash in filename_to_hash.items():
source_file_name = os.path.join(source_root, file_name.strip("/"))
source_file_name = os.path.realpath(source_file_name)
LOG.debug("Storing source file: %s", source_file_name)
trimmed_file_path = trim_path_prefixes(
file_name, self.__trim_path_prefixes)
if not os.path.isfile(source_file_name):
# The file was not in the ZIP file, because we already
# have the content. Let's check if we already have a file
# record in the database or we need to add one.
LOG.debug('%s not found or already stored.', trimmed_file_path)
with DBSession(self.__Session) as session:
fid = add_file_record(
session, trimmed_file_path, file_hash)
if not fid:
LOG.error("File ID for %s is not found in the DB with "
"content hash %s. Missing from ZIP?",
source_file_name, file_hash)
file_path_to_id[trimmed_file_path] = fid
LOG.debug("%d fileid found", fid)
continue
with DBSession(self.__Session) as session:
self.__add_file_content(session, source_file_name, file_hash)
file_path_to_id[trimmed_file_path] = add_file_record(
session, trimmed_file_path, file_hash)
return file_path_to_id
def __add_blame_info(
self,
blame_root: str,
filename_to_hash: Dict[str, str]
):
"""
This function updates blame info in File and FileContent tables if
these were NULL. This function exists only because in earlier
CodeChecker versions blame info was not stored in these tables and
in a subsequent storage we can't update the tables for an unchanged
file since __store_source_files() updates only the ones that are in the
.zip file. This function stores blame info even if the corresponding
source file is not in the .zip file.
"""
with DBSession(self.__Session) as session:
for subdir, _, files in os.walk(blame_root):
for f in files:
blame_file = os.path.join(subdir, f)
file_path = blame_file[len(blame_root.rstrip("/")):]
blame_info, remote_url, tracking_branch = \
get_blame_file_data(blame_file)
compressed_blame_info = None
if blame_info:
compressed_blame_info = zlib.compress(
json.dumps(blame_info).encode('utf-8'),
zlib.Z_BEST_COMPRESSION)
session \
.query(FileContent) \
.filter(FileContent.blame_info.is_(None)) \
.filter(FileContent.content_hash ==
filename_to_hash.get(file_path)) \
.update({"blame_info": compressed_blame_info})
session \
.query(File) \
.filter(File.remote_url.is_(None)) \
.filter(File.filepath == file_path) \
.update({
"remote_url": remote_url,
"tracking_branch": tracking_branch})
session.commit()
def __add_file_content(
self,
session: DBSession,
source_file_name: str,
content_hash: Optional[str]
):
"""
Add the necessary file contents. If content_hash in None then this
function calculates the content hash. Or if it's available at the
caller and it's provided then it will not be calculated again.
This function must not be called between add_checker_run() and
finish_checker_run() functions when SQLite database is used!
add_checker_run() function opens a transaction which is closed by
finish_checker_run() and since SQLite doesn't support parallel
transactions, this API call will wait until the other transactions
finish. In the meantime the run adding transaction times out.
This function doesn't insert blame info in the FileContent objects
because those are added by __add_blame_info(). In previous CodeChecker
versions git info was not stored at all, so upgrading to a new
CodeChecker results the storage of git blame info even for files that
are already stored. For this reason we can't avoid an update on File
and FileContent tables, but we can avoid double reading of blame info
json files.
"""
source_file_content = None
if not content_hash:
source_file_content = get_file_content(source_file_name)
hasher = sha256()
hasher.update(source_file_content)
content_hash = hasher.hexdigest()
file_content = session.query(FileContent).get(content_hash)
if not file_content:
if not source_file_content:
source_file_content = get_file_content(source_file_name)
try:
compressed_content = zlib.compress(
source_file_content, zlib.Z_BEST_COMPRESSION)
if session.bind.dialect.name == 'postgresql':
insert_stmt = sqlalchemy.dialects.postgresql \
.insert(FileContent).values(
content_hash=content_hash,
content=compressed_content,
blame_info=None).on_conflict_do_nothing(
index_elements=['content_hash'])
session.execute(insert_stmt)
else:
fc = FileContent(content_hash, compressed_content, None)
session.add(fc)
session.commit()
except sqlalchemy.exc.IntegrityError:
# Other transaction moght have added the same content in
# the meantime.
session.rollback()
def __store_analysis_statistics(
self,
session: DBSession,
run_history_id: int
):
"""
Store analysis statistics for the given run history.
It will unique the statistics for each analyzer type based on the
metadata information.
"""
stats = defaultdict(lambda: {
"versions": set(),
"failed_sources": set(),
"successful_sources": set(),
"successful": 0
})
for mip in self.__mips.values():
self.__duration += int(sum(mip.check_durations))
for analyzer_type, res in mip.analyzer_statistics.items():
if "version" in res:
stats[analyzer_type]["versions"].add(res["version"])
if "failed_sources" in res:
if self.__version == '6.9.0':
stats[analyzer_type]["failed_sources"].add(
'Unavailable in CodeChecker 6.9.0!')
else:
stats[analyzer_type]["failed_sources"].update(
res["failed_sources"])
if "successful_sources" in res:
stats[analyzer_type]["successful_sources"].update(
res["successful_sources"])
if "successful" in res:
stats[analyzer_type]["successful"] += res["successful"]
for analyzer_type, stat in stats.items():
analyzer_version = None
if stat["versions"]:
analyzer_version = zlib.compress(
"; ".join(stat["versions"]).encode('utf-8'),
zlib.Z_BEST_COMPRESSION)
failed = 0
compressed_files = None
if stat["failed_sources"]:
compressed_files = zlib.compress(
'\n'.join(stat["failed_sources"]).encode('utf-8'),
zlib.Z_BEST_COMPRESSION)
failed = len(stat["failed_sources"])
successful = len(stat["successful_sources"]) \
if stat["successful_sources"] else stat["successful"]
analyzer_statistics = AnalyzerStatistic(
run_history_id, analyzer_type, analyzer_version,
successful, failed, compressed_files)
session.add(analyzer_statistics)
def __store_analysis_info(
self,
session: DBSession,
run_history: RunHistory
):
""" Store analysis info for the given run history. """
for src_dir_path, mip in self.__mips.items():
for analyzer_command in mip.check_commands:
cmd = zlib.compress(
analyzer_command.encode("utf-8"),
zlib.Z_BEST_COMPRESSION)
analysis_info_rows = session \
.query(AnalysisInfo) \
.filter(AnalysisInfo.analyzer_command == cmd) \
.all()
if analysis_info_rows:
# It is possible when multiple runs are stored
# simultaneously to the server with the same analysis
# command that multiple entries are stored into the
# database. In this case we will select the first one.
analysis_info = analysis_info_rows[0]
else:
analysis_info = AnalysisInfo(analyzer_command=cmd)
session.add(analysis_info)
run_history.analysis_info.append(analysis_info)
self.__analysis_info[src_dir_path] = analysis_info
def __add_or_update_run(
self,
session: DBSession,
run_history_time: datetime
) -> Tuple[int, bool]:
"""
Store run related data to the database.
By default updates the results if name already exists.
Using the force flag removes existing analysis results for a run.
"""
try:
LOG.debug("Adding run '%s'...", self.__name)
run = session.query(Run) \
.filter(Run.name == self.__name) \
.one_or_none()
update_run = True
if run and self.__force:
# Clean already collected results.
if not run.can_delete:
# Deletion is already in progress.
msg = f"Can't delete {run.id}"
LOG.debug(msg)
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.DATABASE,
msg)
LOG.info('Removing previous analysis results...')
session.delete(run)
# Not flushing after delete leads to a constraint violation
# error later, when adding run entity with the same name as
# the old one.
session.flush()
checker_run = Run(self.__name, self.__version)
session.add(checker_run)
session.flush()
run_id = checker_run.id
elif run:
# There is already a run, update the results.
run.date = datetime.now()
run.duration = -1
session.flush()
run_id = run.id
else:
# There is no run create new.
checker_run = Run(self.__name, self.__version)
session.add(checker_run)
session.flush()
run_id = checker_run.id
update_run = False
# Add run to the history.
LOG.debug("Adding run history.")
if self.__tag is not None:
run_history = session.query(RunHistory) \
.filter(RunHistory.run_id == run_id,
RunHistory.version_tag == self.__tag) \
.one_or_none()
if run_history:
run_history.version_tag = None
session.add(run_history)
cc_versions = set()
for mip in self.__mips.values():
if mip.cc_version:
cc_versions.add(mip.cc_version)
cc_version = '; '.join(cc_versions) if cc_versions else None
run_history = RunHistory(
run_id, self.__tag, self.user_name, run_history_time,
cc_version, self.__description)
session.add(run_history)
session.flush()
LOG.debug("Adding run done.")
self.__store_analysis_statistics(session, run_history.id)
self.__store_analysis_info(session, run_history)
session.flush()
LOG.debug("Storing analysis statistics done.")
return run_id, update_run
except Exception as ex:
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.GENERAL,
str(ex))
def __add_report(
self,
session: DBSession,
run_id: int,
report: Report,
file_path_to_id: Dict[str, int],
review_status: SourceReviewStatus,
detection_status: str,
detection_time: datetime,
run_history_time: datetime,
analysis_info: AnalysisInfo,
analyzer_name: Optional[str] = None,
fixed_at: Optional[datetime] = None
) -> int:
""" Add report to the database. """
try:
checker_name = report.checker_name
# Cache the severity of the checkers
try:
severity = self.__severity_map[checker_name]
except KeyError:
severity_name = \
self.__context.checker_labels.severity(checker_name)
severity = ttypes.Severity._NAMES_TO_VALUES[severity_name]
self.__severity_map[checker_name] = severity
db_report = DBReport(
run_id, report.report_hash, file_path_to_id[report.file.path],
report.message, checker_name or 'NOT FOUND',
report.category, report.type, report.line, report.column,
severity, review_status.status, review_status.author,
review_status.message, run_history_time,
review_status.in_source,
detection_status, detection_time,
len(report.bug_path_events), analyzer_name)
db_report.fixed_at = fixed_at
if analysis_info:
db_report.analysis_info.append(analysis_info)
session.add(db_report)
self.__added_reports.append((db_report, report))
# THE id is none at this point of time
# wondering if not returning anything is good?
# The report is already handled at the above lines
return db_report.id
except Exception as ex:
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.GENERAL,
str(ex))
def __add_report_context(self, session, file_path_to_id):
try:
for db_report, report in self.__added_reports:
LOG.debug("Storing bug path positions.")
for i, p in enumerate(report.bug_path_positions):
session.add(BugReportPoint(
p.range.start_line, p.range.start_col,
p.range.end_line, p.range.end_col,
i, file_path_to_id[p.file.path], db_report.id))
LOG.debug("Storing bug path events.")
for i, event in enumerate(report.bug_path_events):
session.add(BugPathEvent(
event.range.start_line, event.range.start_col,
event.range.end_line, event.range.end_col,
i, event.message, file_path_to_id[event.file.path],
db_report.id))
LOG.debug("Storing notes.")
for note in report.notes:
data_type = report_extended_data_type_str(
ttypes.ExtendedReportDataType.NOTE)
session.add(ExtendedReportData(
note.range.start_line, note.range.start_col,
note.range.end_line, note.range.end_col,
note.message, file_path_to_id[note.file.path],
db_report.id, data_type))
LOG.debug("Storing macro expansions.")
for macro in report.macro_expansions:
data_type = report_extended_data_type_str(
ttypes.ExtendedReportDataType.MACRO)
session.add(ExtendedReportData(
macro.range.start_line, macro.range.start_col,
macro.range.end_line, macro.range.end_col,
macro.message, file_path_to_id[macro.file.path],
db_report.id, data_type))
if report.annotations:
self.__validate_and_add_report_annotations(
session, db_report.id, report.annotations)
session.flush()
except Exception as ex:
raise codechecker_api_shared.ttypes.RequestFailed(
codechecker_api_shared.ttypes.ErrorCode.GENERAL,
str(ex))
def __process_report_file(
self,
report_file_path: str,
session: DBSession,
source_root: str,
run_id: int,
file_path_to_id: Dict[str, int],
run_history_time: datetime,
skip_handler: skiplist_handler.SkipListHandler,
hash_map_reports: Dict[str, List[Any]]
) -> bool:
"""
Process and save reports from the given report file to the database.
"""
reports = report_file.get_reports(report_file_path)
if not reports:
return True
def get_review_status_from_source(
report: Report) -> SourceReviewStatus:
"""
Return the review status set in the source code belonging to
the given report.
- Return the review status if it is set in the source code.
- If the review status is ambiguous (i.e. multiple source code
comments belong to it) then (unreviewed, in_source=False)
returns.
"""
# The original file path is needed here, not the trimmed, because
# the source files are extracted as the original file path.
source_file_name = os.path.realpath(os.path.join(
source_root, report.file.original_path.strip("/")))
if os.path.isfile(source_file_name):
src_comment_data = parse_codechecker_review_comment(
source_file_name, report.line, report.checker_name)
if len(src_comment_data) == 1:
data = src_comment_data[0]
status, message = data.status, bytes(data.message, 'utf-8')
review_status = SourceReviewStatus(
status=status,
message=message,
bug_hash=report.report_hash,
author=self.user_name,
date=run_history_time,
in_source=True
)
return review_status
elif len(src_comment_data) > 1:
LOG.warning(
"Multiple source code comment can be found "
"for '%s' checker in '%s' at line %s. "
"This suppression will not be taken into account!",
report.checker_name, source_file_name, report.line)
self.__wrong_src_code_comments.append(
f"{source_file_name}|{report.line}|"
f"{report.checker_name}")
# A better way to handle reports where the review status is not
# set in the source is to return None, and set the reviews status
# and set the review status info at report addition time.
return SourceReviewStatus(
status="unreviewed",
message=b'',
bug_hash=report.report_hash,
author=self.user_name,
date=run_history_time,
in_source=False
)
def get_missing_file_ids(report: Report) -> List[str]:
""" Returns file paths which database file id is missing. """
missing_ids_for_files = []
for file_path in report.trimmed_files:
file_id = file_path_to_id.get(file_path, -1)
if file_id == -1:
missing_ids_for_files.append(file_path)
return missing_ids_for_files
root_dir_path = os.path.dirname(report_file_path)
mip = self.__mips[root_dir_path]
analysis_info = self.__analysis_info.get(root_dir_path)
for report in reports:
self.__report_count += 1
report.trim_path_prefixes(self.__trim_path_prefixes)
missing_ids_for_files = get_missing_file_ids(report)
if missing_ids_for_files:
LOG.warning("Failed to get database id for file path '%s'! "
"Skip adding report: %s:%d:%d [%s]",
' '.join(missing_ids_for_files), report.file.path,
report.line, report.column, report.checker_name)
continue
self.__all_report_checkers.add(report.checker_name)
if skip_handler.should_skip(report.file.original_path):
continue
report_path_hash = get_report_path_hash(report)
if report_path_hash in self.__already_added_report_hashes:
LOG.debug('Not storing report. Already added: %s', report)
continue
LOG.debug("Storing report to the database...")
detection_status = 'new'
detected_at = run_history_time
old_report = None
if report.report_hash in hash_map_reports:
old_report = hash_map_reports[report.report_hash][0]
old_status = old_report.detection_status
detection_status = 'reopened' \
if old_status == 'resolved' else 'unresolved'
detected_at = old_report.detected_at
analyzer_name = mip.checker_to_analyzer.get(