[clangd] Ensure we test for compatibility of serialized index format

[kadircet]

As a side note, I've tested with a clangd-indexer before https://github.com/llvm/llvm-project/commit/71064b02701dd65065dd412fb01afe81ff83f746 and we got the failure (malformed/truncated refs).

[sammccall]

Very nice, thanks for doing this!

clang-tools-extra/clangd/test/index-serialization/version-is-correct.test

2

I think this test is REQUIRES: zlib
(see windows failures)

2

nit: maybe say a bit more about what the test does? And separate what the test does vs what failure means vs what action to take a little.

This test tries to parse a checked-in binary index.
If it fails, there has been...
Please bump the version number...

4

nit: regenerate sample.idx

6

this isn't easy to copy/paste because of the comment markers.
This file isn't interpreted so there's no need for them, I think...

It could also be formatted so it's easier to recognize the command (surround by blank lines, indent by a couple of spaces?)

11

dexp ... -c="find B" | grep Bar?

[kadircet]

• Update comments
• Query for Bar
• Only run with zlib

[sammccall]

clang-tools-extra/clangd/test/index-serialization/version-is-correct.test

6

again, we don't need the comment markers (but do need the line-continuations) for copy-paste

16

as discussed offline, maybe || not grep -v -e RUN: -e REQUIRES: %S ?

[kadircet]

• Drop comment markers
• Make failure print the doc

[kadircet]

• Drop subshell usage

[dmajor]

This broke the bots: http://lab.llvm.org:8011/#/builders/109/builds/2682

  File "/b/1/clang-x86_64-debian-fast/llvm.obj/tools/clang/tools/extra/clangd/test/lit.site.cfg.py", line 35
    config.have_zlib =
                      ^
SyntaxError: invalid syntax

[kadircet]

should be fixed with https://github.com/llvm/llvm-project/commit/8dc2aa0e412171dad5cdc1aa60a92ddcd3800202. please let me know if it doesn't work.

[kadircet]

Looks like it is already green at http://lab.llvm.org:8011/#/builders/109/builds/2693

[dmajor]

In D91330#2394415, @kadircet wrote:

Looks like it is already green at http://lab.llvm.org:8011/#/builders/109/builds/2693

Yep, I'm seeing the same, thanks!

clang-tools-extra/clangd/test/index-serialization/Inputs/sample.h

+#pragma once
+
+// Introduce a symbol.
+struct Foo {};

clang-tools-extra/clangd/test/index-serialization/Inputs/sample.cpp

+// Include a file to ensure we have multiple sources.
+#include "sample.h"
+
+// This introduces a symbol, a reference and a relation.
+struct Bar : public Foo {};

clang-tools-extra/clangd/test/index-serialization/version-is-correct.test

+# REQUIRES: zlib
+This test tries to parse a checked-in binary index.
+If this test fails it means there has been a backward incompatilbe change to
+serialization format.
+Please bump the version number in
+clang-tools-extra/clangd/index/Serialization.cpp and regenarate sample.idx with
+
+  clangd-indexer \
+    clang-tools-extra/clangd/test/index-serialization/Inputs/sample.cpp > \
+    clang-tools-extra/clangd/test/index-serialization/Inputs/sample.idx
+
+Also if you've introduced new slabs/chunks to serialized index, make sure
+indexing sample.cpp would yield non-trivial values for those.
+# RUN: dexp %/S/Inputs/sample.idx -c="find B" | grep Bar || not grep -v '^#' %s

clang-tools-extra/clangd/test/lit.cfg.py

 config.substitutions.append(('%clangd-benchmark-dir',
                              config.clangd_binary_dir + "/benchmarks"))
 
 if config.clangd_build_xpc:
   config.available_features.add('clangd-xpc-support')
 
 if config.clangd_enable_remote:
   config.available_features.add('clangd-remote-index')
+
+if config.have_zlib:
+  config.available_features.add('zlib')

clang-tools-extra/clangd/test/lit.site.cfg.py.in

except KeyError:
     e = sys.exc_info()[1]
     key, = e.args
     lit_config.fatal("unable to find %r parameter, use '--param=%s=VALUE'" % (key,key))
 
 config.clangd_source_dir = "@CMAKE_CURRENT_SOURCE_DIR@/.."
 config.clangd_binary_dir = "@CMAKE_CURRENT_BINARY_DIR@/.."
 config.clangd_build_xpc = @CLANGD_BUILD_XPC@
 config.clangd_enable_remote = @CLANGD_ENABLE_REMOTE@
+config.have_zlib = @LLVM_ENABLE_ZLIB@
 
 # Delegate logic to lit.cfg.py.
 lit_config.load_config(config, "@CMAKE_CURRENT_SOURCE_DIR@/lit.cfg.py")