wip: Setup testing for SCIP!

Author: varungandhi-src

test/BUILD

@@ -57,6 +57,43 @@ cc_binary(
     ],
 )
 
+cc_binary(
+    name = "scip_test_runner",
+    testonly = 1,
+    srcs = [
+        "scip_test_runner.cc"
+    ],
+    linkstatic = select({
+        "//tools/config:linkshared": 0,
+        "//conditions:default": 1,
+    }),
+    visibility = ["//tools:__pkg__", "//test/scip:__pkg__"],
+    deps = [ # TODO(varun): Revisit dependencies after rewriting test runner.
+        "//ast/desugar",
+        "//ast/treemap",
+        "//cfg/builder",
+        "//class_flatten",
+        "//common/web_tracer_framework:tracing",
+        "//core/serialize",
+        "//definition_validator",
+        "//infer",
+        "//local_vars",
+        "//main/autogen", # TODO(varun): why is this needed?
+        "//namer",
+        "//payload",
+        "//proto",
+        "//resolver",
+        "//rewriter",
+        "//scip_indexer:interface",
+        "//scip_indexer:scip_indexer",
+        "//test/helpers",
+        "@com_google_absl//absl/strings",
+        "@cxxopts",
+        "@doctest",
+        "@doctest//:doctest_custom_main",
+    ]
+)
+
 cc_binary(
     name = "parser_test_runner",
     testonly = 1,
@@ -251,6 +288,17 @@ pipeline_tests(
     "WhitequarkParserTests",
 )
 
+pipeline_tests(
+    "test_corpus_scip",
+    glob(
+        [
+            "testdata/scip/**/*.rb",
+            "testdata/scip/**/*.exp",
+        ],
+    ),
+    "SCIPTests",
+)
+
 pipeline_tests(
     "test_corpus_lsp",
     glob(

test/pipeline_test.bzl

@@ -100,6 +100,7 @@ def single_package_rbi_test(name, rb_files):
 _TEST_RUNNERS = {
     "PosTests": ":pipeline_test_runner",
     "LSPTests": ":lsp_test_runner",
+    "SCIPTests": ":scip_test_runner",
     "WhitequarkParserTests": ":parser_test_runner",
     "PackagerTests": ":pipeline_test_runner",
 }

test/scip/BUILD

@@ -0,0 +1,3 @@
+load(":scip_test.bzl", "scip_test_suite")
+
+scip_test_suite(paths = glob(["testdata/*"]))

test/scip/scip_test.bzl

@@ -0,0 +1,59 @@
+def basename(p):
+    return p.rpartition("/")[-1]
+
+def extension(p):
+    ext = basename(p).partition(".")[-1]
+    if ext == ",": # partition returns "," if there is no match 🙃
+        return ""
+    return ext
+
+def scip_test_suite(paths):
+    tests = []
+    updates = []
+    for path in paths:
+        names = scip_test(path)
+        if names:
+            tests.append(names[0])
+            updates.append(names[1])
+    native.test_suite(
+        name = "scip",
+        tests = tests,
+    )
+    native.test_suite(
+        name = "update",
+        tests = updates,
+    )
+
+
+def scip_test(path):
+    # path will end in either .snapshot, .rb or have no extension.
+
+    ext = extension(path)
+    if ext == "snapshot":
+        return 
+    
+    if ext != "rb":
+        # TODO(varun): Add support for folder tests, when there is no extension
+        return None
+
+    test_name = basename(path).partition(".")[0]
+    snapshot_path = path + ".snapshot"
+    args = ["$(location {})".format(path), "--output=$(location {})".format(snapshot_path)]
+    data = [path, snapshot_path, "//test:scip_test_runner"]
+    native.sh_test(
+        name = test_name,
+        srcs = ["scip_test_runner.sh"],
+        args = args,
+        data = data,
+        size = "small",
+    )
+    update_test_name = "update_".format(test_name) 
+    native.sh_test(
+        name = update_test_name,
+        srcs = ["scip_test_runner.sh"],
+        args = args + ["--update-snapshots"],
+        data = data,
+        tags = ["manual"],
+        size = "small",
+    )
+    return (test_name, update_test_name)

test/scip/scip_test_runner.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+set -euo pipefail
+./test/scip_test_runner "$@"

test/scip/testdata/syntax.rb

@@ -0,0 +1,16 @@
+# typed: true
+
+a = [57, 33]
+i = 0
+a[i] # a.[](i)
+a << 970 # a.push(970)
+a[2..-1]
+
+def globalFn1()
+  x = 10
+  x
+end
+
+def globalFn2()
+  x = globalFn1()
+end

test/scip/testdata/syntax.rb.snapshot

@@ -0,0 +1,29 @@
+ # typed: true
+ 
+ a = [57, 33]
+#^ definition local 1~#119448696
+#^^^^^^^^^^^^^^^ definition scip-ruby gem TODO TODO <static-init>().
+ i = 0
+#^ definition local 2~#119448696
+ a[i] # a.[](i)
+#^ reference local 1~#119448696
+ a << 970 # a.push(970)
+#^ reference local 1~#119448696
+ a[2..-1]
+#^ reference local 1~#119448696
+ 
+ def globalFn1()
+#^^^^^^^^^^^^^^^ definition scip-ruby gem TODO TODO globalFn1().
+   x = 10
+#  ^ definition local 1~#3846536873
+   x
+#  ^ reference local 1~#3846536873
+ end
+ 
+ def globalFn2()
+#^^^^^^^^^^^^^^^ definition scip-ruby gem TODO TODO globalFn2().
+   x = globalFn1()
+#  ^ definition local 1~#3796204016
+#  ^^^^^^^^^^^^^^^ reference local 1~#3796204016
+#      ^^^^^^^^^ reference scip-ruby gem TODO TODO globalFn1().
+ end