Move reprolang to a top-level directory (#363)

Reprolang is a toy language that can be used to write very simple integration tests for scip. I find it to be very useful. I was surprised that it's stored in some deeply nested directory.

Since the project is a language with its own indexer, I made it more isolated with its own go.mod. I've also migrated it to use tree-sitter/go-tree-sitter instead of no longer maintained smacker/go-tree-sitter.

Author: jupblb

bindings/go/scip/testutil/test_runner.go

@@ -1,4 +1,4 @@
-package main
+package testutil
 
 import (
 	"testing"

cmd/scip/test_test.go …ngs/go/scip/testutil/test_runner_test.gocmd/scip/test_test.go renamed to bindings/go/scip/testutil/test_runner_test.go cmd/scip/test_test.go renamed to bindings/go/scip/testutil/test_runner_test.go

@@ -27,7 +27,7 @@
     pname = "scip-bindings-go";
     inherit version;
     src = ./.;
-    vendorHash = "sha256-ywSR9yRysnm2E6kI8UJS6XcpuqKJF8wJpHcYS7TGmjI=";
+    vendorHash = "sha256-JuGh7/CnpCWABK6WYE+Mo7P8X0glFrFa9ve9eO//1v8=";
     buildTags = [ "asserts" ];
     subPackages = [
       "bindings/go/scip"
@@ -56,19 +56,22 @@
 
   reprolang =
     let
-      reprolangVersion =
-        (builtins.fromJSON (builtins.readFile ./cmd/scip/tests/reprolang/package.json)).version;
+      reprolangVersion = (builtins.fromJSON (builtins.readFile ./reprolang/package.json)).version;
     in
-    assert pkgs.lib.assertMsg (reprolangVersion == version)
-      "Version mismatch in cmd/scip/tests/reprolang/package.json: expected ${version}, got ${reprolangVersion}";
+    assert pkgs.lib.assertMsg (
+      reprolangVersion == version
+    ) "Version mismatch in reprolang/package.json: expected ${version}, got ${reprolangVersion}";
     pkgs.buildGoModule {
       pname = "scip-reprolang";
       inherit version;
       src = ./.;
-      vendorHash = "sha256-ywSR9yRysnm2E6kI8UJS6XcpuqKJF8wJpHcYS7TGmjI=";
+      modRoot = "./reprolang";
+      vendorHash = "sha256-H6RLXmQsufwKtI5BujsUEibVuCMpILqtX3W0Wg9m3T8=";
+      proxyVendor = true;
+      buildInputs = [ pkgs.tree-sitter ];
       subPackages = [
-        "cmd/scip/tests/reprolang/src"
-        "cmd/scip/tests/reprolang/bindings/go/repro"
+        "grammar"
+        "repro"
       ];
       installPhase = "touch $out";
     };
@@ -83,11 +86,11 @@
       tree-sitter
     ];
     buildPhase = ''
-      cd cmd/scip/tests/reprolang
-      cp -r src src-before
-      tree-sitter generate --abi 14
-      prettier --write 'src/grammar.json' 'src/node-types.json'
-      diff -rq src-before src
+      cd reprolang
+      cp -r grammar grammar-before
+      tree-sitter generate --abi 14 --output grammar
+      prettier --write 'grammar/grammar.json' 'grammar/node-types.json'
+      diff -rq grammar-before grammar
     '';
     installPhase = "touch $out";
   };

checks.nix

@@ -1,21 +1,13 @@
 package main
 
 import (
-	"bytes"
-	"flag"
 	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
 	"testing"
 
-	"github.com/hexops/autogold/v2"
 	"github.com/stretchr/testify/require"
-	"golang.org/x/exp/slices"
-
-	"github.com/sourcegraph/scip/bindings/go/scip"
-	"github.com/sourcegraph/scip/bindings/go/scip/testutil"
-	"github.com/sourcegraph/scip/cmd/scip/tests/reprolang/bindings/go/repro"
 )
 
 func TestMain(m *testing.M) {
@@ -55,164 +47,3 @@ func TestCLIReferenceInSync(t *testing.T) {
 		check([]string{command.Name, "--help"}, fmt.Sprintf("subcommand %s", command.Name))
 	}
 }
-
-var debugSnapshotAbspaths = flag.Bool("debug-snapshot-abspaths", false, "use absolute paths in snapshot outputs, useful for making uploads to test code navigation")
-
-// TestSCIPSnapshots runs all the snapshot tests.
-func TestSCIPSnapshots(t *testing.T) {
-	cwd, err := os.Getwd()
-	require.Nil(t, err)
-	testDir := filepath.Join(cwd, "tests")
-	testutil.SnapshotTest(t, testDir, func(inputDirectory, outputDirectory string, sources []*scip.SourceFile) []*scip.SourceFile {
-		testName := filepath.Base(inputDirectory)
-		var dependencies []*repro.Dependency
-		rootDirectory := filepath.Dir(inputDirectory)
-		dirs, err := os.ReadDir(rootDirectory)
-		require.Nil(t, err)
-		for _, dir := range dirs {
-			if !dir.IsDir() {
-				continue
-			}
-			if dir.Name() == testName {
-				continue
-			}
-			dependencyRoot := filepath.Join(rootDirectory, dir.Name())
-			dependencySources, err := scip.NewSourcesFromDirectory(dependencyRoot)
-			require.Nil(t, err)
-			dependencies = append(dependencies, &repro.Dependency{
-				Package: &scip.Package{
-					Manager: "repro_manager",
-					Name:    dir.Name(),
-					Version: "1.0.0",
-				},
-				Sources: dependencySources,
-			})
-		}
-		index, err := repro.Index("file:/"+inputDirectory, testName, sources, dependencies)
-		require.Nil(t, err)
-		symbolFormatter := scip.DescriptorOnlyFormatter
-		symbolFormatter.IncludePackageName = func(name string) bool { return name != testName }
-		snapshots, err := testutil.FormatSnapshots(index, "#", symbolFormatter, inputDirectory)
-		require.Nil(t, err)
-		if debugSnapshotAbspaths != nil && *debugSnapshotAbspaths {
-			inputDirAbsPath, err := filepath.Abs(inputDirectory)
-			require.Nil(t, err)
-			index.Metadata.ProjectRoot = inputDirAbsPath
-		} else {
-			index.Metadata.ProjectRoot = "file:/root"
-		}
-		return snapshots
-	})
-}
-
-func unwrap[T any](v T, err error) func(*testing.T) T {
-	return func(t *testing.T) T {
-		require.NoError(t, err)
-		return v
-	}
-}
-
-func TestSCIPTests(t *testing.T) {
-	cwd := unwrap(os.Getwd())(t)
-	testDir := filepath.Join(cwd, "tests", "test_cmd")
-	testPaths := unwrap(os.ReadDir(testDir))(t)
-	require.Truef(t, len(testPaths) >= 1, "Expected at least one test case in directory: %v", testDir)
-
-	os.Setenv("NO_COLOR", "1")
-	t.Cleanup(func() {
-		os.Unsetenv("NO_COLOR")
-	})
-
-	type TestCase struct {
-		dir        string
-		passOutput autogold.Value
-		failOutput autogold.Value
-	}
-
-	// To update the snapshot values, run 'go test ./cmd/scip -update'.
-	testCases := []TestCase{
-		{"roles",
-			autogold.Expect("✓ passes.repro (3 assertions)\n"),
-			autogold.Expect(`✗ fails-wrong-role.repro
-    Failure [Ln: 1, Col: 13]
-      Expected: 'reference reprolang repro_manager roles 1.0.0 fails-wrong-role.repro/hello().'
-      Actual:   'definition reprolang repro_manager roles 1.0.0 fails-wrong-role.repro/hello().'
-✗ fails-wrong-symbol.repro
-    Failure [Ln: 1, Col: 13]
-      Expected: 'definition reprolang repro_manager roles 1.0.0 fails-wrong-role.repro/hello2().'
-      Actual:   'definition reprolang repro_manager roles 1.0.0 fails-wrong-symbol.repro/hello().'
-`),
-		},
-		{"ranges",
-			autogold.Expect("✓ passes.repro (3 assertions)\n"),
-			autogold.Expect(`✗ fails.repro
-    Failure [Ln: 1, Col: 10]
-      Expected: 'definition passes.repro/hello().'
-        Actual: <no attributes found>
-`),
-		},
-		{"diagnostics",
-			autogold.Expect("✓ passes.repro (2 assertions)\n"),
-			autogold.Expect(`✗ fails-incorrect-diagnostic.repro
-    Failure [Ln: 1, Col: 11]
-      Expected: 'diagnostic Warning:'
-                'THIS IS NOT CORRECT'
-      Actual: * 'definition reprolang repro_manager diagnostics 1.0.0 fails-incorrect-diagnostic.repro/deprecatedMethod.'
-              * 'diagnostic Warning'
-                'deprecated identifier'
-✗ fails-no-diagnostic.repro
-    Failure [Ln: 1, Col: 11]
-      Expected: 'diagnostic Warning:'
-                'deprecated identifier'
-      Actual:   'definition reprolang repro_manager diagnostics 1.0.0 fails-no-diagnostic.repro/hello().'
-`),
-		},
-	}
-
-	for _, testPath := range testPaths {
-		require.Truef(t, slices.ContainsFunc(testCases, func(testCase TestCase) bool {
-			return testCase.dir == testPath.Name()
-		}), "Missing entry in testOutputs for %q", testPath.Name())
-	}
-
-	for _, testCase := range testCases {
-		var dirEntry os.DirEntry
-		require.Truef(t, slices.ContainsFunc(testPaths, func(entry os.DirEntry) bool {
-			if entry.Name() == testCase.dir {
-				dirEntry = entry
-				return true
-			}
-			return false
-		}), "Stale entry in testOutputs for %q; did you rename or remove the directory", testCase.dir)
-
-		subtestDir := filepath.Join(testDir, dirEntry.Name())
-		require.Truef(t, dirEntry.IsDir(), "not a directory: %q", subtestDir)
-
-		t.Run(testCase.dir, func(t *testing.T) {
-			sources := unwrap(scip.NewSourcesFromDirectory(subtestDir))(t)
-			index := unwrap(repro.Index("file:/"+subtestDir, dirEntry.Name(), sources, []*repro.Dependency{}))(t)
-
-			var passFiles, failFiles []string
-			testFiles := unwrap(os.ReadDir(subtestDir))(t)
-			for _, testFile := range testFiles {
-				if strings.HasPrefix(testFile.Name(), "passes") {
-					passFiles = append(passFiles, testFile.Name())
-				} else if strings.HasPrefix(testFile.Name(), "fails") {
-					failFiles = append(failFiles, testFile.Name())
-				} else {
-					t.Fatalf("Test files must start with 'passes' or 'fails'. Received %v", testFile.Name())
-				}
-			}
-
-			var passOutput bytes.Buffer
-			err := testMain(subtestDir, passFiles, false, index, "#", &passOutput)
-			require.NoError(t, err)
-			testCase.passOutput.Equal(t, passOutput.String())
-
-			var failOutput bytes.Buffer
-			err = testMain(subtestDir, failFiles, false, index, "#", &failOutput)
-			require.Error(t, err)
-			testCase.failOutput.Equal(t, failOutput.String())
-		})
-	}
-}