Method exec

Test/astc_test_functional.py:399–455

Execute a positive test. Will trigger a test failure if the subprocess return code is any value other than zero. Args: cmd: The cmd to execute. pattern: A regex pattern to search for, must contain a single group which will be

(self, cmd: list[str | Path],
             pattern: Optional[re.Pattern] = None)

            self.assertAlmostEqual(ref_channel, new_channel, delta=max_delta)

    def exec(self, cmd: list[str | Path],
             pattern: Optional[re.Pattern] = None) -> str:
        '''
        Execute a positive test.

        Will trigger a test failure if the subprocess return code is any value
        other than zero.

        Args:
            cmd: The cmd to execute.
            pattern: A regex pattern to search for, must contain a single group
                which will be returned to the caller. The test will fail if no
                pattern match is found.

        Return:
            The stdout output of the child process if no pattern, or the first
            group match from the pattern when applied to stdout output of the
            child process.
        '''
        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
        if ASTCENC_CLI_ALWAYS or (not passed and ASTCENC_CLI_ON_ERROR):
            print('\n' + ' '.join(cmd_str))

        if ASTCENC_LOG_ALWAYS or (not passed and ASTCENC_LOG_ON_ERROR):
            print(rstdout)
            print(rstderr)

        if rcode < 0:
            msg = f'Exec died with signal {signal.Signals(-rcode).name}'
            self.assertGreaterEqual(rcode, 0, msg)

        if rcode > 0:
            msg = f'Exec died with application error {rcode}'
            self.assertEqual(rcode, 0, msg)

        # If there is a regex pattern provided, then search for it
        if pattern:
            if match := pattern.search(rstdout):
                return match.group(1)
            self.assertIsNotNone(match)

        return rstdout