Add --project-root flag to scip stats (#187)

* Add `--project-root` flag to `scip stats`

See #98

* Wrap some errors

* Copy `scip stats --project-root` logic from `scip snapshot`

* Fix description of snapshot --project-root option

Author: abitrolly

bindings/go/scip/testutil/format.go

@@ -33,7 +33,7 @@ func FormatSnapshots(
 	} 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)
+			"To override this behaviour, use --project-root=<folder> option directly", projectRootUrl.Path, cwd)
 		localSourcesRoot = cwd
 	}
 

cmd/main.go

@@ -74,3 +74,12 @@ func fromFlag(storage *string) *cli.StringFlag {
 		Value:       "index.scip",
 	}
 }
+
+func projectRootFlag(storage *string) *cli.StringFlag {
+	return &cli.StringFlag{
+		Name: "project-root",
+		Usage: "Override project root in the SCIP file. " +
+			"This can be helpful when the SCIP index was created on another computer",
+		Destination: storage,
+	}
+}

cmd/snapshot.go

@@ -37,12 +37,7 @@ 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,
-			},
+			projectRootFlag(&snapshotFlags.customProjectRoot),
 			&cli.BoolFlag{
 				Name:        "strict",
 				Usage:       "If true, fail fast on errors",

cmd/stats.go

@@ -3,6 +3,7 @@ package main
 import (
 	"encoding/json"
 	"fmt"
+	"log"
 	"net/url"
 	"os"
 	"path/filepath"
@@ -16,15 +17,19 @@ import (
 )
 
 type statsFlags struct {
-	from string
+	from              string
+	customProjectRoot string
 }
 
 func statsCommand() cli.Command {
 	var statsFlags statsFlags
 	stats := cli.Command{
 		Name:  "stats",
 		Usage: "Output useful statistics about a SCIP index",
-		Flags: []cli.Flag{fromFlag(&statsFlags.from)},
+		Flags: []cli.Flag{
+			fromFlag(&statsFlags.from),
+			projectRootFlag(&statsFlags.customProjectRoot),
+		},
 		Action: func(c *cli.Context) error {
 			return statsMain(statsFlags)
 		},
@@ -36,15 +41,15 @@ func statsMain(flags statsFlags) error {
 	from := flags.from
 	index, err := readFromOption(from)
 	if err != nil {
-		return err
+		return errors.Wrap(err, "error reading SCIP file")
 	}
 	if index.Metadata == nil {
 		return errors.Errorf("Index.Metadata is nil (--from=%s)", from)
 	}
 	output := map[string]interface{}{}
-	indexStats, err := countStatistics(index)
+	indexStats, err := countStatistics(index, flags.customProjectRoot)
 	if err != nil {
-		return err
+		return errors.Wrap(err, "error counting stats")
 	}
 	jsonBytes, err := json.MarshalIndent(indexStats, "", "  ")
 	if err != nil {
@@ -61,8 +66,8 @@ type indexStatistics struct {
 	Definitions int32 `json:"definitions"`
 }
 
-func countStatistics(index *scip.Index) (*indexStatistics, error) {
-	loc, err := countLinesOfCode(index)
+func countStatistics(index *scip.Index, customProjectRoot string) (*indexStatistics, error) {
+	loc, err := countLinesOfCode(index, customProjectRoot)
 	if err != nil {
 		return nil, err
 	}
@@ -83,22 +88,37 @@ func countStatistics(index *scip.Index) (*indexStatistics, error) {
 	return stats, nil
 }
 
-func countLinesOfCode(index *scip.Index) (*gocloc.Result, error) {
+func countLinesOfCode(index *scip.Index, customProjectRoot string) (*gocloc.Result, error) {
+	var localSource string
 	root, err := url.Parse(index.Metadata.ProjectRoot)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to parse Index.Metadata.ProjectRoot as a URI %s", index.Metadata.ProjectRoot)
 	}
-	stat, err := os.Stat(root.Path)
+	if customProjectRoot != "" {
+		localSource = customProjectRoot
+	} else {
+		_, err := os.Stat(root.Path)
+		if 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, specify --project-root=<folder> option", root.Path, cwd)
+			localSource = cwd
+		} else if err != nil {
+			return nil, err
+		}
+	}
+
+	stat, err := os.Stat(localSource)
 	if err != nil {
 		return nil, err
 	}
 	if !stat.IsDir() {
-		return nil, errors.Errorf("index.Metadata.ProjectRoot is not a directory: %s", root.Path)
+		return nil, errors.Errorf("Project root [%s] is not a directory", localSource)
 	}
 	processor := gocloc.NewProcessor(gocloc.NewDefinedLanguages(), gocloc.NewClocOptions())
 	var paths []string
 	for _, document := range index.Documents {
-		paths = append(paths, filepath.Join(root.Path, document.RelativePath))
+		paths = append(paths, filepath.Join(localSource, document.RelativePath))
 	}
 	return processor.Analyze(paths)
 }