Handle ambigous profile/group parameters #4377
Conversation
noraz31
force-pushed
the
handle_ambigous_parameters
branch
4 times, most recently
from
23f9a04 to
92cbeaa
Compare
noraz31
force-pushed
the
handle_ambigous_parameters
branch
from
92cbeaa to
22f992d
Compare
| self.set_checker_enabled(checker, enabled) | ||
| LOG.error(templ.substitute(entity="profile", | ||
| identifier=identifier)) | ||
| sys.exit(1) |
There was a problem hiding this comment.
Is exit status 1 the proper exit code in case of configuration errors?
There was a problem hiding this comment.
Same applies 10 lines below
There was a problem hiding this comment.
I think yes. These are the exit code listed by CodeChecker analyze --help
Exit status
0 - Successful analysis
1 - CodeChecker error
3 - Analysis of at least one translation unit failed
128+signum - Terminating on a fatal signal whose number is signum
| @@ -210,23 +212,40 @@ def initialize_checkers(self, | |||
| profiles = checker_labels.get_description('profile') | |||
| guidelines = checker_labels.occurring_values('guideline') | |||
|
|
|||
| templ = Template("The ${entity} name '${identifier}' conflicts with a " | |||
| "checker(-group) name. Please use -e ${entity}: to " | |||
There was a problem hiding this comment.
We should be very specific about what conflicts with what. So if you can provide an exact error message instead of ...with a checker(-group)... then please be specific.
There was a problem hiding this comment.
That's right, AFAIK it is always a checker group name that is conflicting, so I'll correct this.
| @@ -216,10 +225,15 @@ def f(checks, checkers): | |||
|
|
|||
| # Enable "security" profile checkers without "profile:" prefix. | |||
| cfg_handler = ClangSA.construct_config_handler(args) | |||
| cfg_handler.initialize_checkers(checkers, | |||
| [('security', True)]) | |||
There was a problem hiding this comment.
Why are you replacing the security prefix? enabling with sensitive?
There was a problem hiding this comment.
After this change is introduced, "-e security" should throw an error as "security" is a profile name that conflicts with a checker group name. However, "-e sensitive" should continue to function as it has previously, because the "sensitive" profile name does not conflict with any checker group names. This is what I intend to test here.
noraz31
force-pushed
the
handle_ambigous_parameters
branch
from
22f992d to
1ad9851
Compare
There was a problem hiding this comment.
-
Please fix the description of the initialize_checkers function: instead of "Is considered in this order" in case of name clash, an error is emitted.
-
Also fix the description of the CodeChecker analyze --help that name clashes are not accepted around line 681 " checkers_opts.add_argument('-e', '--enable',"
noraz31
force-pushed
the
handle_ambigous_parameters
branch
2 times, most recently
from
4c0a007 to
e1bf58f
Compare
Introduce the -e prefix: option, to improve handling of ambigous parameters (such as "security" etc.)
noraz31
force-pushed
the
handle_ambigous_parameters
branch
from
e1bf58f to
919744e
Compare
Introduce the -e prefix: option, to improve handling of ambigous parameters.
such as "security" which is a checker prefix group and a profile at the same time