[debuginfo-tests][dexter] Add _verify_options to TestToolBase

[Pierre-vh]

Summary

This is a minor patch, but it's needed by two other patches (see child revisions), so if one of those two patches is accepted, this should be accepted as well.

This simply adds a feature that allows classes deriving from TestToolBase to stop the execution of the tool early if the options provided are inadequate.

[StephenTozer]

LGTM except for the inline comment.

debuginfo-tests/dexter/dex/tools/TestToolBase.py

97

Full stop here.

[Pierre-vh]

Adding the full stop as requested

Note that I will not commit this patch unless one of the child diffs are committed and that this change is still needed (because this patch is not useful on its own)

[StephenTozer]

Actually, after looking at how this is being used in the child revisions, it looks like this should be folded into handle_options - that function is already used to check whether the supplied options to a tool are valid, and raises an Error if not. That seems more consistent with the rest of Dexter than returning a ReturnCode.FAIL, which is currently only used if the test is run without any errors but has a failing score.

[StephenTozer]

In D75337#1901253, @StephenTozer wrote:

Actually, after looking at how this is being used in the child revisions, it looks like this should be folded into handle_options

Just to clarify (since I realise this is ambiguous) I think the _verify_options logic in the child revisions should be folded into handle_options, raising Errors instead of returning False, and this revision can be shelved since it's otherwise unnecessary.

[Pierre-vh]

Revision abandoned as the logic in _verify_options has been folded into handle_options in the child revisions.

debuginfo-tests/dexter/dex/tools/TestToolBase.py

def handle_options(self, defaults):
         if not os.path.isdir(options.results_directory):
             try:
                 os.makedirs(options.results_directory, exist_ok=True)
             except OSError as e:
                 raise Error(
                     '<d>could not create directory</> <r>"{}"</> <y>({})</>'.
                     format(options.results_directory, e.strerror))
 
+    # Checks if the provided options are valid/supported by this tool
+    # if it return false, the tool fails.
+    def _verify_options(self, options) -> bool:
+        return True
+
     def go(self) -> ReturnCode:  # noqa
         options = self.context.options
 
         options.executable = os.path.join(
             self.context.working_directory.path, 'tmp.exe')
 
+        if not self._verify_options(options):
+            return ReturnCode.FAIL
+
         if os.path.isdir(options.test_path):
 
             subdirs = sorted([
                 r for r, _, f in os.walk(options.test_path)
                 if 'test.cfg' in f
             ])
 
             for subdir in subdirs: