Class CLINTest

Test/astc_test_functional.py:1437–2260

Command line interface negative tests. These tests are designed to test that bad inputs to the cmd line are handled cleanly and that errors are correctly thrown. Note that many tests are mutations of a valid positive test cmd line, to ensure that the base cmd line is valid bef

class CLINTest(CLITestBase):
    '''
    Command line interface negative tests.

    These tests are designed to test that bad inputs to the cmd line are
    handled cleanly and that errors are correctly thrown.

    Note that many tests are mutations of a valid positive test cmd line,
    to ensure that the base cmd line is valid before it is mutated many
    of these tests include a *positive test* to ensure that the starting point
    is actually a valid cmd line (otherwise we could be throwing an
    arbitrary error).
    '''
    # pylint: disable=too-many-public-methods

    def exec(self, cmd: list[str | Path], expect_pass: bool = False) -> None:
        '''
        Execute a negative test.

        Test will automatically fail if:

        * The subprocess return code is zero, unless expect_pass is True.
        * The subprocess correctly returned non-zero, but without any error
          message.
        * The subprocess dies with any kind of signal.

        Args:
            cmd (list(str)): The cmd to execute.
            expect_pass (bool): True if this cmd is actually expected to
                pass, which is used to validate commands before mutating them.
        '''
        try:
            cmd_str = [str(x) for x in cmd]
            result = sp.run(cmd_str, stdout=sp.PIPE, stderr=sp.PIPE,
                            text=True, check=True)
            rcode = result.returncode
            rstdout = result.stdout
            rstderr = result.stderr

        except sp.CalledProcessError as ex:
            rcode = ex.returncode
            rstdout = ex.stdout
            rstderr = ex.stderr

        passed = rcode == 0

        # Emit debug logging if needed (negative rcode is a signal)
        bad_result = (passed != expect_pass) or (rcode < 0)

        if ASTCENC_CLI_ALWAYS or (bad_result and ASTCENC_CLI_ON_ERROR_NEG):
            print('\n' + ' '.join(cmd_str))

        if ASTCENC_LOG_ALWAYS or (bad_result and ASTCENC_LOG_ON_ERROR_NEG):
            print(rstdout)
            print(rstderr)

        # If we expected a pass, then rcode == 0
        if expect_pass: