Merge pull request #1383 from bstaletic/valgrind

[READY] Run valgrind in CI

Author: mergify[bot]

azure-pipelines.yml

@@ -20,7 +20,7 @@ jobs:
         YCM_BENCHMARK: true
         COVERAGE: false
       'C++ linting':
-        YCM_PYTHON_VERSION: '3.6.3'
+        YCM_PYTHON_VERSION: '3.8.0'
         YCM_CLANG_TIDY: true
         COVERAGE: false
     maxParallel: 6

azure/lint.sh

@@ -13,7 +13,7 @@ pyenv global ${YCM_PYTHON_VERSION}
 python_version=$(python -c 'import sys; print( "{}.{}.{}".format( *sys.version_info[:3] ) )')
 echo "Checking python version (actual ${python_version} vs expected ${YCM_PYTHON_VERSION})"
 test ${python_version} == ${YCM_PYTHON_VERSION}
-
-python build.py --clang-completer --clang-tidy --no-regex
+YCM_TESTRUN=1 python build.py --clang-completer --clang-tidy --valgrind
+python run_tests.py --valgrind --skip-build --no-flake8
 
 set +e

azure/linux/install_dependencies.sh

@@ -20,7 +20,7 @@ if [ "${YCM_CLANG_TIDY}" ]; then
   wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
   sudo apt-add-repository "deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-8 main"
   sudo apt-get update
-  sudo apt-get install -y clang-tidy-8
+  sudo apt-get install -y clang-tidy-8 valgrind
   sudo update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-8 100
 fi
 

build.py

@@ -430,6 +430,10 @@ def ParseArguments():
   parser.add_argument( '--no-regex',
                        action = 'store_true',
                        help = "Don't build the regex module" )
+  parser.add_argument( '--valgrind',
+                       action = 'store_true',
+                       help = 'For developers: '
+                              'Run core tests inside valgrind.' )
   parser.add_argument( '--clang-tidy',
                        action = 'store_true',
                        help = 'For developers: Run clang-tidy static analysis '
@@ -543,13 +547,26 @@ def RunYcmdTests( args, build_dir ):
   tests_cmd = [ p.join( tests_dir, 'ycm_core_tests' ) ]
   if args.core_tests != '*':
     tests_cmd.append( '--gtest_filter={}'.format( args.core_tests ) )
-  CheckCall( tests_cmd,
-             env = new_env,
-             quiet = args.quiet,
-             status_message = 'Running ycmd tests' )
-
-
-def RunYcmdBenchmarks( build_dir ):
+  if not args.valgrind:
+    CheckCall( tests_cmd,
+               env = new_env,
+               quiet = args.quiet,
+               status_message = 'Running ycmd tests' )
+  else:
+    new_env[ 'PYTHONMALLOC' ] = 'malloc'
+    cmd = [ 'valgrind',
+            '--gen-suppressions=all',
+            '--error-exitcode=1',
+            '--leak-check=full',
+            '--show-leak-kinds=all',
+            '--show-reachable=no',
+            '--suppressions=' + p.join( DIR_OF_THIS_SCRIPT,
+                                        'valgrind.suppressions' ),
+            p.join( tests_dir, 'ycm_core_tests' ) ]
+    CheckCall( cmd, env = new_env )
+
+
+def RunYcmdBenchmarks( args, build_dir ):
   benchmarks_dir = p.join( build_dir, 'ycm', 'benchmarks' )
   new_env = os.environ.copy()
 
@@ -636,7 +653,7 @@ def BuildYcmdLib( cmake, cmake_common_args, script_args ):
     if script_args.core_tests:
       RunYcmdTests( script_args, build_dir )
     if 'YCM_BENCHMARK' in os.environ:
-      RunYcmdBenchmarks( build_dir )
+      RunYcmdBenchmarks( script_args, build_dir )
   finally:
     os.chdir( DIR_OF_THIS_SCRIPT )
 

pytest.ini

@@ -5,3 +5,4 @@ xfail_strict = true
 log_level = debug
 log_date_format = "%Y-%m-%d %H:%M:%S"
 log_format = "%(asctime)s - %(levelname)s - %(message)s"
+markers = valgrind_skip

run_tests.py

@@ -149,6 +149,9 @@ def ParseArguments():
   parser.add_argument( '--quiet', action = 'store_true',
                        help = 'Quiet installation mode. Just print overall '
                               'progress and errors' )
+  parser.add_argument( '--valgrind',
+                       action = 'store_true',
+                       help = 'Run tests inside valgrind.' )
 
   parsed_args, pytests_args = parser.parse_known_args()
 
@@ -213,6 +216,37 @@ def BuildYcmdLibs( args ):
     subprocess.check_call( build_cmd )
 
 
+def PytestValgrind( parsed_args, extra_pytests_args ):
+  pytests_args = [ '-v' ]
+  if extra_pytests_args:
+    pytests_args.extend( extra_pytests_args )
+  else:
+    pytests_args += glob.glob(
+      p.join( DIR_OF_THIS_SCRIPT, 'ycmd', 'tests', 'bindings', '*_test.py' ) )
+    pytests_args += glob.glob(
+      p.join( DIR_OF_THIS_SCRIPT, 'ycmd', 'tests', 'clang', '*_test.py' ) )
+    pytests_args += glob.glob(
+      p.join( DIR_OF_THIS_SCRIPT, 'ycmd', 'tests', '*_test.py' ) )
+    # Avoids needing all completers for a valgrind run
+    pytests_args += [ '-m', 'not valgrind_skip' ]
+
+  new_env = os.environ.copy()
+  new_env[ 'PYTHONMALLOC' ] = 'malloc'
+  new_env[ 'LD_LIBRARY_PATH' ] = LIBCLANG_DIR
+  cmd = [ 'valgrind',
+          '--gen-suppressions=all',
+          '--error-exitcode=1',
+          '--leak-check=full',
+          '--show-leak-kinds=all',
+          '--show-reachable=no',
+          '--suppressions=' + p.join( DIR_OF_THIS_SCRIPT,
+                                      'valgrind.suppressions' ) ]
+  subprocess.check_call( cmd +
+                         [ sys.executable, '-m', 'pytest' ] +
+                         pytests_args,
+                         env = new_env )
+
+
 def PytestTests( parsed_args, extra_pytests_args ):
   pytests_args = [ '-v' ]
 
@@ -305,7 +339,10 @@ def Main():
   if not parsed_args.no_flake8:
     RunFlake8()
   BuildYcmdLibs( parsed_args )
-  PytestTests( parsed_args, pytests_args )
+  if parsed_args.valgrind:
+    PytestValgrind( parsed_args, pytests_args )
+  else:
+    PytestTests( parsed_args, pytests_args )
 
 
 if __name__ == "__main__":