Add --project-root option to override the root inside scip files (#142)

This option can be useful if the scip file is produced inside a docker
container, and the project root in the file points to a non-existent
location.

Author: keynmol

bindings/go/scip/testutil/format.go

@@ -1,6 +1,7 @@
 package testutil
 
 import (
+	"log"
 	"net/url"
 	"os"
 	"path/filepath"
@@ -18,25 +19,36 @@ func FormatSnapshots(
 	index *scip.Index,
 	commentSyntax string,
 	symbolFormatter scip.SymbolFormatter,
+	customProjectRoot string,
 ) ([]*scip.SourceFile, error) {
 	var result []*scip.SourceFile
-	projectRoot, err := url.Parse(index.Metadata.ProjectRoot)
+	projectRootUrl, err := url.Parse(index.Metadata.ProjectRoot)
 	if err != nil {
 		return nil, err
 	}
 
+	localSourcesRoot := projectRootUrl.Path
+	if customProjectRoot != "" {
+		localSourcesRoot = customProjectRoot
+	} else if _, err := os.Stat(localSourcesRoot); errors.Is(err, os.ErrNotExist) {
+		cwd, _ := os.Getwd()
+		log.Printf("Project root [%s] doesn't exist, using current working directory [%s] instead. "+
+			"To override this behaviour, use --root=<folder> option directly", projectRootUrl.Path, cwd)
+		localSourcesRoot = cwd
+	}
+
 	var documentErrors error
 	for _, document := range index.Documents {
-		snapshot, err := FormatSnapshot(document, index, commentSyntax, symbolFormatter)
+		sourceFilePath := filepath.Join(localSourcesRoot, document.RelativePath)
+		snapshot, err := FormatSnapshot(document, index, commentSyntax, symbolFormatter, sourceFilePath)
 		err = symbolFormatter.OnError(err)
 		if err != nil {
 			documentErrors = errors.CombineErrors(
 				documentErrors,
 				errors.Wrap(err, document.RelativePath),
 			)
 		}
-		sourceFile := scip.NewSourceFile(
-			filepath.Join(projectRoot.Path, document.RelativePath),
+		sourceFile := scip.NewSourceFile(sourceFilePath,
 			document.RelativePath,
 			snapshot,
 		)
@@ -55,16 +67,10 @@ func FormatSnapshot(
 	index *scip.Index,
 	commentSyntax string,
 	formatter scip.SymbolFormatter,
+	sourceFilePath string,
 ) (string, error) {
 	b := strings.Builder{}
-	uri, err := url.Parse(filepath.Join(index.Metadata.ProjectRoot, document.RelativePath))
-	if err != nil {
-		return "", err
-	}
-	if uri.Scheme != "file" {
-		return "", errors.New("expected url scheme 'file', obtained " + uri.Scheme)
-	}
-	data, err := os.ReadFile(uri.Path)
+	data, err := os.ReadFile(sourceFilePath)
 	if err != nil {
 		return "", err
 	}

cmd/main_test.go

@@ -91,7 +91,7 @@ func TestSCIPSnapshots(t *testing.T) {
 		require.Nil(t, err)
 		symbolFormatter := scip.DescriptorOnlyFormatter
 		symbolFormatter.IncludePackageName = func(name string) bool { return name != testName }
-		snapshots, err := testutil.FormatSnapshots(index, "#", symbolFormatter)
+		snapshots, err := testutil.FormatSnapshots(index, "#", symbolFormatter, "")
 		require.Nil(t, err)
 		if debugSnapshotAbspaths != nil && *debugSnapshotAbspaths {
 			inputDirAbsPath, err := filepath.Abs(inputDirectory)

cmd/snapshot.go

@@ -13,10 +13,11 @@ import (
 )
 
 type snapshotFlags struct {
-	from          string
-	output        string
-	strict        bool
-	commentSyntax string
+	from              string
+	output            string
+	customProjectRoot string
+	strict            bool
+	commentSyntax     string
 }
 
 func snapshotCommand() cli.Command {
@@ -36,6 +37,12 @@ and symbol information.`,
 				Destination: &snapshotFlags.output,
 				Value:       "scip-snapshot",
 			},
+			&cli.StringFlag{
+				Name: "project-root",
+				Usage: "Override project root in the SCIP file. " +
+					"For example, this can be helpful when the SCIP index was created inside a Docker image or created on another computer",
+				Destination: &snapshotFlags.customProjectRoot,
+			},
 			&cli.BoolFlag{
 				Name:        "strict",
 				Usage:       "If true, fail fast on errors",
@@ -74,7 +81,7 @@ func snapshotMain(flags snapshotFlags) error {
 			return errors.Wrap(err, "use --strict=false to ignore this error")
 		}
 	}
-	snapshots, err := testutil.FormatSnapshots(index, flags.commentSyntax, symbolFormatter)
+	snapshots, err := testutil.FormatSnapshots(index, flags.commentSyntax, symbolFormatter, flags.customProjectRoot)
 	if err != nil {
 		return err
 	}