Exit when calling `root` command with unrecognized option #8868

vepadulano · 2021-08-19T21:11:11Z

May still need polishing, will add test if logic is approved.

With this commit, when root receives an unrecognized options it prints an error (similar to other linux commands errors) and exits before showing the prompt.

$ root --nonexistingoption
Error in <TApplication::GetOptions>: unrecognized option '--nonexistingoption'
Try 'root --help' for more information.
$ cp --nonexistingoption
cp: unrecognized option '--nonexistingoption'
Try 'cp --help' for more information.

phsft-bot · 2021-08-19T21:11:18Z

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14
How to customize builds

phsft-bot · 2021-08-19T21:34:40Z

Build failed on ROOT-performance-centos8-multicore/default.
Running on olbdw-01.cern.ch:/data/sftnight/workspace/root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-08-19T21:46:57Z

Build failed on ROOT-ubuntu16/nortcxxmod.
Running on sft-ubuntu-1604-1.cern.ch:/build/workspace/root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-08-19T22:12:20Z

Build failed on ROOT-debian10-i386/cxx14.
Running on pcepsft11.dyndns.cern.ch:/home/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-08-19T22:26:51Z

Build failed on mac11.0/cxx17.
Running on macphsft20.dyndns.cern.ch:/Users/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-08-19T22:50:11Z

Build failed on mac1014/python3.
Running on macitois21.dyndns.cern.ch:/Users/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-08-20T01:07:53Z

Build failed on windows10/cxx14.
Running on null:C:\build\workspace\root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-08-20T07:38:26Z

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14
How to customize builds

vepadulano · 2021-08-20T07:43:33Z

Errors above were due to some options unrecognized by root were actually necessary for other callables in the test. Last commit moves the check to TRint and also now checks if there are multiple unrecognized options issued by the user:

$ root --random -z --nonexistingoption
root: unrecognized option '--random'
root: unrecognized option '-z'
root: unrecognized option '--nonexistingoption'
Try 'root --help' for more information.

Also changed to using std::cerr for simplicity. Before merging we can discuss the correct output stream

core/rint/src/TRint.cxx

phsft-bot · 2021-08-31T09:17:26Z

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14
How to customize builds

phsft-bot · 2021-08-31T12:13:19Z

Build failed on mac11.0/cxx17.
Running on macphsft20.dyndns.cern.ch:/Users/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

Options passed to the `root` command are parsed in `TApplication::GetOptions(Int_t *argc, char **argv)`. String options in `argv` are removed from the array of options after parsing. If any string remains in argv, it means it is not recognized by the `root` command. While these could still be useful for other `TApplication` instances, in the specific case of calling `root` which is based on `TRint` it simply means the remaining options are not valid. This commit introduces an early exit logic in the constructor of `TRint`. If there are any remaining unrecognized options as described above, they will be printed to `std::cerr` and then ROOT will terminate execution, similar to other linux commands: ``` $: root -z --nonexistingoption root: unrecognized option '-z' root: unrecognized option '--nonexistingoption' Try 'root --help' for more information. ```

phsft-bot · 2021-09-03T21:25:18Z

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14
How to customize builds

phsft-bot · 2021-09-03T21:51:12Z

Build failed on ROOT-performance-centos8-multicore/default.
Running on olbdw-01.cern.ch:/data/sftnight/workspace/root-pullrequests-build
See console output.

Errors:

[2021-09-03T21:40:28.863Z] 1196/2200 Test [cxxmodules] Start generating modules in rootcling. #930: tutorial-tmva-TMVA_SOFIE_ONNX .....................................................................***Failed Error regular expression found in output. Regex=[: error:] 0.74 sec

Failing tests:

phsft-bot · 2021-09-03T22:32:46Z

Build failed on mac11.0/cxx17.
Running on macphsft20.dyndns.cern.ch:/Users/sftnight/build/workspace/root-pullrequests-build
See console output.

Errors:

[2021-09-03T22:02:59.752Z] 1057/2281 Test Partial revert of "Fix nullptr dereference bug in TList::RecursiveRem… #961: tutorial-tmva-TMVA_SOFIE_ONNX .....................................................................***Failed Error regular expression found in output. Regex=[: error:] 0.64 sec

Failing tests:

vepadulano · 2021-09-06T10:18:25Z

@eguiraud @Axel-Naumann if you're ok with this PR it is ready to be merged 👍

eguiraud

LGTM although i'm not the code owner 😄

core/rint/test/TRintTests.cxx

phsft-bot · 2021-09-06T15:39:15Z

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14
How to customize builds

phsft-bot · 2021-09-06T16:48:51Z

Build failed on mac11.0/cxx17.
Running on macphsft23.dyndns.cern.ch:/Users/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

phsft-bot · 2021-09-06T19:04:57Z

Build failed on windows10/cxx14.
Running on null:C:\build\workspace\root-pullrequests-build
See console output.

Failing tests:

vepadulano added the in:Core Libraries label Aug 19, 2021

vepadulano requested review from Axel-Naumann and eguiraud August 19, 2021 21:11

vepadulano self-assigned this Aug 19, 2021

vepadulano requested a review from pcanal as a code owner August 19, 2021 21:11

pcanal reviewed Aug 30, 2021

View reviewed changes

core/rint/src/TRint.cxx Show resolved Hide resolved

pcanal approved these changes Aug 30, 2021

View reviewed changes

vepadulano requested a review from bellenot as a code owner August 31, 2021 09:17

vepadulano force-pushed the root-unrec-opt branch from 9cf454e to e0de156 Compare September 3, 2021 21:25

eguiraud approved these changes Sep 6, 2021

View reviewed changes

core/rint/test/TRintTests.cxx Show resolved Hide resolved

core/rint/test/TRintTests.cxx Outdated Show resolved Hide resolved

[core] Add test for root unrecognized options

03106b9

vepadulano force-pushed the root-unrec-opt branch from e0de156 to 03106b9 Compare September 6, 2021 15:39

Axel-Naumann approved these changes Sep 7, 2021

View reviewed changes

vepadulano merged commit 0e0154b into root-project:master Sep 7, 2021

vepadulano deleted the root-unrec-opt branch October 25, 2021 15:22

Exit when calling root command with unrecognized option #8868

Exit when calling root command with unrecognized option #8868

Uh oh!

Conversation

vepadulano commented Aug 19, 2021

Uh oh!

phsft-bot commented Aug 19, 2021

Uh oh!

phsft-bot commented Aug 19, 2021

Failing tests:

Uh oh!

phsft-bot commented Aug 19, 2021

Failing tests:

Uh oh!

phsft-bot commented Aug 19, 2021

Failing tests:

Uh oh!

phsft-bot commented Aug 19, 2021

Failing tests:

Uh oh!

phsft-bot commented Aug 19, 2021

Failing tests:

Uh oh!

phsft-bot commented Aug 20, 2021

Failing tests:

Uh oh!

phsft-bot commented Aug 20, 2021

Uh oh!

vepadulano commented Aug 20, 2021

Uh oh!

Uh oh!

phsft-bot commented Aug 31, 2021

Uh oh!

phsft-bot commented Aug 31, 2021

Failing tests:

Uh oh!

phsft-bot commented Sep 3, 2021

Uh oh!

phsft-bot commented Sep 3, 2021

Errors:

Failing tests:

Uh oh!

phsft-bot commented Sep 3, 2021

Errors:

Failing tests:

Uh oh!

vepadulano commented Sep 6, 2021

Uh oh!

eguiraud left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

phsft-bot commented Sep 6, 2021

Uh oh!

phsft-bot commented Sep 6, 2021

Failing tests:

Uh oh!

phsft-bot commented Sep 6, 2021

Failing tests:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Exit when calling `root` command with unrecognized option #8868

Exit when calling `root` command with unrecognized option #8868