clang-tools-extra/clangd/test/system-include-extractor.test

   1 # RUN: rm -rf %t.dir && mkdir -p %t.dir
   2
   3 # The mock driver below is a shell script:
   4 # REQUIRES: shell
   5
   6 # Create a bin directory to store the mock-driver and add it to the path
   7 # RUN: mkdir -p %t.dir/bin
   8 # RUN: export PATH=%t.dir/bin:$PATH
   9 # Generate a mock-driver that will print %temp_dir%/my/dir and
  10 # %temp_dir%/my/dir2 as include search paths.
  11 # RUN: echo '#!/bin/sh' >> %t.dir/bin/my_driver.sh
  12 # RUN: echo '[ "$0" = "%t.dir/bin/my_driver.sh" ] || exit' >> %t.dir/bin/my_driver.sh
  13 # RUN: echo '[ "$1" = "-print-file-name=include" ] && echo "%t.dir/builtin" && exit' >> %t.dir/bin/my_driver.sh
  14 # RUN: echo 'args="$*"' >> %t.dir/bin/my_driver.sh
  15 # Check that clangd preserves certain flags like `-nostdinc` from
  16 # original invocation in compile_commands.json.
  17 # RUN: echo '[ -z "${args##*"-nostdinc"*}" ] || exit' >> %t.dir/bin/my_driver.sh
  18 # RUN: echo '[ -z "${args##*"--sysroot /my/sysroot/path"*}" ] || exit' >> %t.dir/bin/my_driver.sh
  19 # RUN: echo '[ -z "${args##*"-isysroot /isysroot"*}" ] || exit' >> %t.dir/bin/my_driver.sh
  20 # RUN: echo '[ -z "${args##*"-target arm-linux-gnueabihf"*}" ] || exit' >> %t.dir/bin/my_driver.sh
  21 # RUN: echo 'echo line to ignore >&2' >> %t.dir/bin/my_driver.sh
  22 # RUN: echo 'printf "Target: arm-linux-gnueabihf\r\n" >&2' >> %t.dir/bin/my_driver.sh
  23 # RUN: echo 'printf "#include <...> search starts here:\r\n" >&2' >> %t.dir/bin/my_driver.sh
  24 # RUN: echo 'echo %t.dir/my/dir/ >&2' >> %t.dir/bin/my_driver.sh
  25 # RUN: echo 'echo %t.dir/my/dir2/ >&2' >> %t.dir/bin/my_driver.sh
  26 # RUN: echo 'echo %t.dir/builtin >&2' >> %t.dir/bin/my_driver.sh
  27 # RUN: echo 'printf "End of search list.\r\n" >&2' >> %t.dir/bin/my_driver.sh
  28 # RUN: chmod +x %t.dir/bin/my_driver.sh
  29
  30 # Create header files my/dir/a.h and my/dir2/b.h
  31 # RUN: mkdir -p %t.dir/my/dir
  32 # RUN: touch %t.dir/my/dir/a.h
  33 # RUN: mkdir -p %t.dir/my/dir2
  34 # RUN: touch %t.dir/my/dir2/b.h
  35 # RUN: mkdir -p %t.dir/builtin
  36 # RUN: touch %t.dir/builtin/c.h
  37
  38 # Generate a compile_commands.json that will query the mock driver we've
  39 # created. Which should add a.h and b.h into include search path.
  40 # RUN: echo '[{"directory": "%/t.dir", "command": "my_driver.sh the-file.cpp --target=arm-linux-gnueabihf -nostdinc --sysroot /my/sysroot/path -isysroot/isysroot", "file": "the-file.cpp"}]' > %t.dir/compile_commands.json
  41
  42 # RUN: sed -e "s|INPUT_DIR|%/t.dir|g" %s > %t.test.1
  43 # On Windows, we need the URI in didOpen to look like "uri":"file:///C:/..."
  44 # (with the extra slash in the front), so we add it here.
  45 # RUN: sed -E -e 's|"file://([A-Z]):/|"file:///\1:/|g' %t.test.1 > %t.test
  46
  47 # Bless the mock driver we've just created so that clangd can execute it.
  48 # Note: include clangd's stderr in the FileCheck input with "2>&1" so that we
  49 # can match output lines like "ASTWorker building file"
  50 # RUN: clangd -lit-test -query-driver="**.test,**.sh" < %t.test 2>&1 | FileCheck -strict-whitespace %t.test
  51 {"jsonrpc":"2.0","id":0,"method":"initialize","params":{}}
  52 ---
  53 {
  54   "jsonrpc":"2.0",
  55   "method":"textDocument/didOpen",
  56   "params": {
  57     "textDocument": {
  58       "uri": "file://INPUT_DIR/the-file.cpp",
  59       "languageId":"cpp",
  60       "version":1,
  61       "text":"#include <a.h>\n#include <b.h>\n#if !defined(__ARM_ARCH) || !defined(__gnu_linux__)\n#error \"Invalid target\"\n#endif\n#if __has_include(<c.h>)\n#error \"wrong-toolchain builtins\"\n#endif\n"
  62     }
  63   }
  64 }
  65 # Look for the "ASTWorker building file" line so that the subsequent diagnostics
  66 # that are matches are for the C++ source file and not a config file.
  67 # CHECK: ASTWorker building file
  68 # CHECK:   "method": "textDocument/publishDiagnostics",
  69 # CHECK-NEXT:   "params": {
  70 # CHECK-NEXT:     "diagnostics": [],
  71 # CHECK-NEXT:     "uri": "file://{{.*}}/the-file.cpp",
  72 ---
  73 {"jsonrpc":"2.0","id":10000,"method":"shutdown"}
  74 ---
  75 {"jsonrpc":"2.0","method":"exit"}
  76
  77 # Generate a different compile_commands.json which does not point to the mock driver
  78 # RUN: echo '[{"directory": "%/t.dir", "command": "gcc the-file.cpp --target=arm-linux-gnueabihf -nostdinc --sysroot /my/sysroot/path -isysroot/isysroot", "file": "the-file.cpp"}]' > %t.dir/compile_commands.json
  79
  80 # Generate a clangd config file which points to the mock driver instead
  81 # RUN: echo 'CompileFlags:' > %t.dir/.clangd
  82 # RUN: echo '  Compiler: my_driver.sh' >> %t.dir/.clangd
  83
  84 # Run clangd a second time, to make sure it picks up the driver name from the config file
  85 # Note, we need to pass -enable-config because -lit-test otherwise disables it
  86 # RUN: clangd -lit-test -enable-config -query-driver="**.test,**.sh" < %t.test 2>&1 | FileCheck -strict-whitespace %t.test