import errno import logging import os import select import subprocess import time import tempfile # Create Cppcheck project file import sys def create_gui_project_file(project_file, root_path=None, import_project=None, paths=None, exclude_paths=None, suppressions=None, addon=None): cppcheck_xml = ('\n' '\n') if root_path: cppcheck_xml += ' \n' if import_project: cppcheck_xml += ' ' + import_project + '\n' if paths: cppcheck_xml += ' \n' for path in paths: cppcheck_xml += ' \n' cppcheck_xml += ' \n' if exclude_paths: cppcheck_xml += ' \n' for path in exclude_paths: cppcheck_xml += ' \n' cppcheck_xml += ' \n' if suppressions: cppcheck_xml += ' \n' for suppression in suppressions: cppcheck_xml += ' \n' cppcheck_xml += ' \n' if addon: cppcheck_xml += ' \n' cppcheck_xml += ' %s\n' % addon cppcheck_xml += ' \n' cppcheck_xml += '\n' with open(project_file, 'wt') as f: f.write(cppcheck_xml) def __lookup_cppcheck_exe(): # path the script is located in script_path = os.path.dirname(os.path.realpath(__file__)) exe_name = "cppcheck" if sys.platform == "win32": exe_name += ".exe" exe_path = None if 'TEST_CPPCHECK_EXE_LOOKUP_PATH' in os.environ: lookup_paths = [os.environ['TEST_CPPCHECK_EXE_LOOKUP_PATH']] else: lookup_paths = [os.path.join(script_path, '..', '..'), '.'] for base in lookup_paths: for path in ('', 'bin', os.path.join('bin', 'debug')): tmp_exe_path = os.path.join(base, path, exe_name) if os.path.isfile(tmp_exe_path): exe_path = tmp_exe_path break if exe_path: exe_path = os.path.abspath(exe_path) print("using '{}'".format(exe_path)) return exe_path def __run_subprocess_tty(args, env=None, cwd=None, timeout=None): import pty mo, so = pty.openpty() me, se = pty.openpty() p = subprocess.Popen(args, stdout=so, stderr=se, env=env, cwd=cwd) for fd in [so, se]: os.close(fd) select_timeout = 0.04 # seconds readable = [mo, me] result = {mo: b'', me: b''} try: start_time = time.monotonic() while readable: ready, _, _ = select.select(readable, [], [], select_timeout) for fd in ready: try: data = os.read(fd, 512) except OSError as e: if e.errno != errno.EIO: raise # EIO means EOF on some systems readable.remove(fd) else: if not data: # EOF readable.remove(fd) result[fd] += data if timeout is not None and (time.monotonic() - start_time): break finally: for fd in [mo, me]: os.close(fd) if p.poll() is None: p.kill() return_code = p.wait() stdout = result[mo] stderr = result[me] return return_code, stdout, stderr def __run_subprocess(args, env=None, cwd=None, timeout=None): p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env, cwd=cwd) try: stdout, stderr = p.communicate(timeout=timeout) return_code = p.returncode p = None except subprocess.TimeoutExpired: import psutil # terminate all the child processes child_procs = psutil.Process(p.pid).children(recursive=True) if len(child_procs) > 0: for child in child_procs: child.terminate() try: # call with timeout since it might be stuck p.communicate(timeout=5) p = None except subprocess.TimeoutExpired: pass raise finally: if p: # sending the signal to the process groups causes the parent Python process to terminate as well #os.killpg(os.getpgid(p.pid), signal.SIGTERM) # Send the signal to all the process groups p.terminate() stdout, stderr = p.communicate() p = None return return_code, stdout, stderr # Run Cppcheck with args def cppcheck_ex(args, env=None, remove_checkers_report=True, cwd=None, cppcheck_exe=None, timeout=None, tty=False): exe = cppcheck_exe if cppcheck_exe else __lookup_cppcheck_exe() assert exe is not None, 'no cppcheck binary found' # do not inject arguments for calls with exclusive options has_exclusive = bool({'--doc', '--errorlist', '-h', '--help', '--version'} & set(args)) if not has_exclusive and ('TEST_CPPCHECK_INJECT_J' in os.environ): found_j = False for arg in args: if arg.startswith('-j'): found_j = True break if not found_j: arg_j = '-j' + str(os.environ['TEST_CPPCHECK_INJECT_J']) args.append(arg_j) if not has_exclusive and ('TEST_CPPCHECK_INJECT_CLANG' in os.environ): found_clang = False for arg in args: if arg.startswith('--clang'): found_clang = True break if not found_clang: arg_clang = '--clang=' + str(os.environ['TEST_CPPCHECK_INJECT_CLANG']) args.append(arg_clang) if not has_exclusive and ('TEST_CPPCHECK_INJECT_EXECUTOR' in os.environ): found_jn = False found_executor = False for arg in args: if arg.startswith('-j') and arg != '-j1': found_jn = True continue if arg.startswith('--executor'): found_executor = True continue # only add '--executor' if we are actually using multiple jobs if found_jn and not found_executor: arg_executor = '--executor=' + str(os.environ['TEST_CPPCHECK_INJECT_EXECUTOR']) args.append(arg_executor) builddir_tmp = None if not has_exclusive and ('TEST_CPPCHECK_INJECT_BUILDDIR' in os.environ): found_builddir = False for arg in args: if arg.startswith('--cppcheck-build-dir=') or arg == '--no-cppcheck-build-dir': found_builddir = True break if not found_builddir: builddir_tmp = tempfile.TemporaryDirectory(prefix=str(os.environ['TEST_CPPCHECK_INJECT_BUILDDIR'])) arg_clang = '--cppcheck-build-dir=' + builddir_tmp.name args.append(arg_clang) logging.info(exe + ' ' + ' '.join(args)) run_subprocess = __run_subprocess_tty if tty else __run_subprocess return_code, stdout, stderr = run_subprocess([exe] + args, env=env, cwd=cwd, timeout=timeout) stdout = stdout.decode(encoding='utf-8', errors='ignore').replace('\r\n', '\n') stderr = stderr.decode(encoding='utf-8', errors='ignore').replace('\r\n', '\n') if builddir_tmp: builddir_tmp.cleanup() if remove_checkers_report: if stderr.find('[checkersReport]\n') > 0: start_id = stderr.find('[checkersReport]\n') start_line = stderr.rfind('\n', 0, start_id) if start_line <= 0: stderr = '' else: stderr = stderr[:start_line + 1] elif stderr.find(': (information) Active checkers: ') >= 0: pos = stderr.find(': (information) Active checkers: ') if pos == 0: stderr = '' elif stderr[pos - 1] == '\n': stderr = stderr[:pos] return return_code, stdout, stderr, exe def cppcheck(*args, **kwargs): return_code, stdout, stderr, _ = cppcheck_ex(*args, **kwargs) return return_code, stdout, stderr def assert_cppcheck(args, ec_exp=None, out_exp=None, err_exp=None, env=None, cwd=None): exitcode, stdout, stderr = cppcheck(args, env=env, cwd=cwd) if ec_exp is not None: assert exitcode == ec_exp, stdout if out_exp is not None: out_lines = stdout.splitlines() assert out_lines == out_exp, out_lines if err_exp is not None: err_lines = stderr.splitlines() assert err_lines == err_exp, err_lines