[Part 1] Improved error handling with beautiful trace and exit code in cli, input_engine and cvedb #798

Niraj-Kamdar · 2020-07-12T06:31:55Z

Features added:

colorful trace
custom exit code
Four different error handling mode:
1. TruncTrace (default)
2. FullTrace (while logging level debug)
3. NoTrace (while quite mode)
4. Ignore
  It will ignore exception and is for internal use only.

Fixes #787 and #788.

codecov-commenter · 2020-07-12T07:46:35Z

Codecov Report

Merging #798 into master will increase coverage by 5.06%.
The diff coverage is 78.90%.

@@            Coverage Diff             @@
##           master     #798      +/-   ##
==========================================
+ Coverage   82.40%   87.47%   +5.06%     
==========================================
  Files         147      148       +1     
  Lines        2523     2594      +71     
  Branches      297      305       +8     
==========================================
+ Hits         2079     2269     +190     
+ Misses        371      254     -117     
+ Partials       73       71       -2

Flag	Coverage Δ
#longtests	`87.47% <78.90%> (+5.06%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
cve_bin_tool/csv2cve.py	`0.00% <0.00%> (ø)`
cve_bin_tool/cvedb.py	`85.89% <27.27%> (+30.34%)`	⬆️
cve_bin_tool/error_handler.py	`81.63% <81.63%> (ø)`
cve_bin_tool/cli.py	`84.48% <83.33%> (+6.70%)`	⬆️
cve_bin_tool/input_engine.py	`93.44% <100.00%> (+0.22%)`	⬆️
test/test_cli.py	`100.00% <100.00%> (+17.27%)`	⬆️
test/test_input_engine.py	`100.00% <100.00%> (ø)`
cve_bin_tool/version_scanner.py	`85.71% <0.00%> (+1.78%)`	⬆️
cve_bin_tool/extractor.py	`61.06% <0.00%> (+3.05%)`	⬆️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6335920...b825724. Read the comment docs.

fix extractor problems.

Niraj-Kamdar

I have changed modernize exception handling of almost every module except OutputEngine since @SinghHrmn is working on it. I have talked with him and he will incorporate changes in his future PR.

Niraj-Kamdar · 2020-07-12T08:10:26Z

cve_bin_tool/error_handler.py

+import sys
+from enum import Enum
+
+from rich.console import Console
+from rich.traceback import Traceback


Created new module for exception handling.

Niraj-Kamdar · 2020-07-12T08:11:05Z

cve_bin_tool/error_handler.py

+class InsufficientArgs(Exception):
+    """ Insufficient command line arguments"""
+
+
+class InvalidCsvError(Exception):
+    """ Given File is an Invalid CSV """
+


Moved all exception to one place in error_handler so that new contributor can easily see which exit code is used and always give unique exit code.

Niraj-Kamdar · 2020-07-12T08:13:39Z

cve_bin_tool/error_handler.py

+def excepthook(exc_type, exc_val, exc_tb):
+    trace = Traceback.from_exception(exc_type, exc_val, exc_tb)
+    CONSOLE.print(trace)
+    if ERROR_CODES.get(exc_type):
+        sys.exit(ERROR_CODES[exc_type])


custom excepthook with colorized traceback.

Niraj-Kamdar · 2020-07-12T08:26:00Z

cve_bin_tool/error_handler.py

+class ErrorHandler:
+    """
+    @summary: Error handler context manager.
+    usecases:
+        Different modes that can ignore error, print full trace, truncated trace and no trace.
+        Log messages if logger specified.
+    @param: mode (ErrorMode): Can take any valid ErrorMode as an arg and change output according to that.
+    @param: logger: logs error message specified while raising Exception if logger is passed
+                    while class initialization.
+                    Ex: raise ValueError("file required") will log 'file required'.
+    """


New ErrorHandler context manager. It supports 4 types of mode Ignore (ignore error), NoTrace (trace won't print), TruncTrace(truncated trace for the context only (default)), FullTrace (full trace default when debugging.)

While using ErrorHandler context manager if error get throws it sets exit_code to error_code of that error. This will be helpful in Ignore mode to inspect if exception get throw.

Niraj-Kamdar · 2020-07-12T08:29:35Z

cve_bin_tool/error_handler.py

+ERROR_CODES = {
+    SystemExit: -2,
+    FileNotFoundError: -3,
+    InvalidCsvError: -4,
+    InvalidJsonError: -4,
+    MissingFieldsError: -5,
+    InsufficientArgs: -6,
+    EmptyCache: -7,
+    CVEDataForYearNotInCache: -8,
+    CVEDataForCurlVersionNotInCache: -9,
+    AttemptedToWriteOutsideCachedir: -10,
+    SHAMismatch: -11,
+    ExtractionFailed: -12,
+    UnknownArchiveType: 13,
+}


Dictionary mapping of exception with the error code.

Niraj-Kamdar · 2020-07-12T08:36:25Z

cve_bin_tool/cli.py

+    if 0 < LOGGER.level <= 10:
+        error_mode = ErrorMode.FullTrace
+    elif LOGGER.level >= 50:
+        error_mode = ErrorMode.NoTrace
+    else:
+        error_mode = ErrorMode.TruncTrace
+


Set error mode according to logging level. It will not print exception trace in quite mode (Currently we are printing that)

Niraj-Kamdar · 2020-07-12T08:38:17Z

cve_bin_tool/cvedb.py

-            raise AttemptedToWriteOutsideCachedir(filepath)
+            with ErrorHandler(mode=self.error_mode, logger=self.LOGGER):
+                raise AttemptedToWriteOutsideCachedir(filepath)


Always use ErrorHandler context manager while raising exception.

cve_bin_tool/extractor.py

Niraj-Kamdar · 2020-07-12T08:48:55Z

test/test_cli.py

+        with self.assertRaises(SystemExit) as e:
+            main(["cve-bin-tool"])
+        self.assertEqual(e.exception.args[0], -6)


Modernize tests

Separate PR for extractor

cve_bin_tool/error_handler.py

pdxjohnny

See Terri's comment

Co-authored-by: Terri Oda <terri@toybox.ca>

Niraj-Kamdar added 5 commits July 12, 2020 11:38

Improved error handling

f6aec93

fix input_engine tests

4101bd7

fix test_cli

5ef4043

sort imports

d60df53

fix test_cli flag test

409ada2

fixed docstring

d6ea4c9

Niraj-Kamdar force-pushed the error branch from b0eb902 to 710eaf9 Compare July 12, 2020 08:44

fix extractor.

710eaf9

fix extractor problems.

Niraj-Kamdar commented Jul 12, 2020

View reviewed changes

revert extractor changes

22eaf38

Separate PR for extractor

Niraj-Kamdar changed the title ~~Improved error handling with beautiful trace and exit code.~~ [Part 1] Improved error handling with beautiful trace and exit code. Jul 13, 2020

Niraj-Kamdar mentioned this pull request Jul 13, 2020

[Part 2] Improved error handling in extractor. #804

Closed

Niraj-Kamdar changed the title ~~[Part 1] Improved error handling with beautiful trace and exit code.~~ [Part 1] Improved error handling with beautiful trace and exit code in cli, input_engine and cvedb Jul 13, 2020

terriko requested changes Jul 15, 2020

View reviewed changes

cve_bin_tool/error_handler.py Outdated Show resolved Hide resolved

pdxjohnny approved these changes Jul 15, 2020

View reviewed changes

pdxjohnny added the awaiting changes label Jul 15, 2020

Update cve_bin_tool/error_handler.py

4f51a91

Co-authored-by: Terri Oda <terri@toybox.ca>

Niraj-Kamdar requested review from terriko and pdxjohnny July 16, 2020 06:46

Merge remote-tracking branch 'upstream/master' into error

b825724

Niraj-Kamdar force-pushed the error branch 2 times, most recently from 9e931d1 to b825724 Compare July 17, 2020 07:20

pdxjohnny merged commit 2304b4b into intel:master Jul 17, 2020

Niraj-Kamdar deleted the error branch July 18, 2020 06:07

[Part 1] Improved error handling with beautiful trace and exit code in cli, input_engine and cvedb #798

[Part 1] Improved error handling with beautiful trace and exit code in cli, input_engine and cvedb #798

Niraj-Kamdar commented Jul 12, 2020 •

edited

codecov-commenter commented Jul 12, 2020 •

edited

Niraj-Kamdar left a comment •

edited

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

Niraj-Kamdar Jul 12, 2020

pdxjohnny left a comment

[Part 1] Improved error handling with beautiful trace and exit code in cli, input_engine and cvedb #798

[Part 1] Improved error handling with beautiful trace and exit code in cli, input_engine and cvedb #798

Conversation

Niraj-Kamdar commented Jul 12, 2020 • edited

codecov-commenter commented Jul 12, 2020 • edited

Codecov Report

Niraj-Kamdar left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pdxjohnny left a comment

Choose a reason for hiding this comment

Niraj-Kamdar commented Jul 12, 2020 •

edited

codecov-commenter commented Jul 12, 2020 •

edited

Niraj-Kamdar left a comment •

edited