Add includes flag to include dependent proto files (hjames9#145)

Author: hjames9

README.md

@@ -73,6 +73,7 @@ Options:
 	--lockdir [.]		directory of proto.lock file
 	--protoroot [.]		root of directory tree containing proto files
 	--uptodate [false]	enforce that proto.lock file is up-to-date with proto files
+	--includes 		comma-separated list of additional filepaths to include
 ```
 
 ## Related Projects & Users

cmd/protolock/main.go

@@ -34,6 +34,7 @@ Options:
 	--lockdir [.]		directory of proto.lock file
 	--protoroot [.]		root of directory tree containing proto files
 	--uptodate [false]	enforce that proto.lock file is up-to-date with proto files
+	--includes 		comma-separated list of additional filepaths to include
 `
 
 var (
@@ -46,6 +47,7 @@ var (
 	lockDir   = options.String("lockdir", ".", "directory of proto.lock file")
 	protoRoot = options.String("protoroot", ".", "root of directory tree containing proto files")
 	upToDate  = options.Bool("uptodate", false, "enforce that proto.lock file is up-to-date with proto files")
+	includes  = options.String("includes", "", "comma-separated list of additional filepaths to include")
 )
 
 func main() {
@@ -66,6 +68,7 @@ func main() {
 		*ignore,
 		*upToDate,
 		*debug,
+		*includes,
 	)
 	if err != nil {
 		fmt.Println(err)

config.go

@@ -3,6 +3,7 @@ package protolock
 import (
 	"os"
 	"path/filepath"
+	"strings"
 )
 
 type Config struct {
@@ -11,11 +12,12 @@ type Config struct {
 	Ignore    string
 	UpToDate  bool
 	Debug     bool
+	Includes  []string
 }
 
 func NewConfig(
 	lockDir, protoRoot, ignores string,
-	upToDate, debug bool,
+	upToDate, debug bool, includes string,
 ) (*Config, error) {
 	l, err := filepath.Abs(lockDir)
 	if err != nil {
@@ -26,11 +28,24 @@ func NewConfig(
 		return nil, err
 	}
 
+	var includesAbs []string
+	if len(includes) > 0 {
+		includesOrig := strings.Split(includes, ",")
+		for _, c := range includesOrig {
+			i, err := filepath.Abs(c)
+			if err != nil {
+				return nil, err
+			}
+			includesAbs = append(includesAbs, i)
+		}
+	}
+
 	return &Config{
 		LockDir:   l,
 		ProtoRoot: p,
 		Ignore:    ignores,
 		UpToDate:  upToDate,
+		Includes:  includesAbs,
 	}, nil
 }
 

parse.go

@@ -21,8 +21,8 @@ type Protolock struct {
 }
 
 type Definition struct {
-	Filepath Protopath `json:"protopath,omitempty"`
-	Def      Entry     `json:"def,omitempty"`
+	Filepath *Protopath `json:"protopath,omitempty"`
+	Def      Entry      `json:"def,omitempty"`
 }
 
 type Entry struct {
@@ -49,14 +49,14 @@ type Option struct {
 }
 
 type Message struct {
-	Name          string    `json:"name,omitempty"`
-	Fields        []Field   `json:"fields,omitempty"`
-	Maps          []Map     `json:"maps,omitempty"`
-	ReservedIDs   []int     `json:"reserved_ids,omitempty"`
-	ReservedNames []string  `json:"reserved_names,omitempty"`
-	Filepath      Protopath `json:"filepath,omitempty"`
-	Messages      []Message `json:"messages,omitempty"`
-	Options       []Option  `json:"options,omitempty"`
+	Name          string     `json:"name,omitempty"`
+	Fields        []Field    `json:"fields,omitempty"`
+	Maps          []Map      `json:"maps,omitempty"`
+	ReservedIDs   []int      `json:"reserved_ids,omitempty"`
+	ReservedNames []string   `json:"reserved_names,omitempty"`
+	Filepath      *Protopath `json:"filepath,omitempty"`
+	Messages      []Message  `json:"messages,omitempty"`
+	Options       []Option   `json:"options,omitempty"`
 }
 
 type EnumField struct {
@@ -90,9 +90,9 @@ type Field struct {
 }
 
 type Service struct {
-	Name     string    `json:"name,omitempty"`
-	RPCs     []RPC     `json:"rpcs,omitempty"`
-	Filepath Protopath `json:"filepath,omitempty"`
+	Name     string     `json:"name,omitempty"`
+	RPCs     []RPC      `json:"rpcs,omitempty"`
+	Filepath *Protopath `json:"filepath,omitempty"`
 }
 
 type RPC struct {
@@ -111,13 +111,13 @@ type Report struct {
 }
 
 type Warning struct {
-	Filepath Protopath `json:"filepath,omitempty"`
-	Message  string    `json:"message,omitempty"`
-	RuleName string    `json:"rulename,omitempty"`
+	Filepath *Protopath `json:"filepath,omitempty"`
+	Message  string     `json:"message,omitempty"`
+	RuleName string     `json:"rulename,omitempty"`
 }
 
 type ProtoFile struct {
-	ProtoPath Protopath
+	ProtoPath *Protopath
 	Entry     Entry
 }
 
@@ -512,10 +512,10 @@ func Compare(current, update Protolock) (*Report, error) {
 }
 
 // getProtoFiles finds recursively all .proto files to be processed.
-func getProtoFiles(root string, ignores string) ([]string, error) {
+func getProtoFiles(root string, ignores string, includes []string) ([]string, error) {
 	protoFiles := []string{}
 
-	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
+	protoWalker := func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
@@ -547,11 +547,22 @@ func getProtoFiles(root string, ignores string) ([]string, error) {
 		protoFiles = append(protoFiles, path)
 
 		return nil
-	})
+	}
+
+	err := filepath.Walk(root, protoWalker)
 	if err != nil {
 		return nil, err
 	}
 
+	if len(includes) > 0 {
+		for _, i := range includes {
+			err := filepath.Walk(i, protoWalker)
+			if err != nil {
+				return nil, err
+			}
+		}
+	}
+
 	return protoFiles, nil
 }
 
@@ -566,7 +577,7 @@ func getUpdatedLock(cfg Config) (*Protolock, error) {
 		return nil, err
 	}
 
-	protoFiles, err := getProtoFiles(root, cfg.Ignore)
+	protoFiles, err := getProtoFiles(root, cfg.Ignore, cfg.Includes)
 	if err != nil {
 		return nil, err
 	}
@@ -593,9 +604,27 @@ func getUpdatedLock(cfg Config) (*Protolock, error) {
 		}
 
 		localPath := strings.TrimPrefix(path, root)
+		isProtoRootFile := localPath != path
 		localPath = strings.TrimPrefix(localPath, string(filepath.Separator))
+
+		var pathType string
+		if isProtoRootFile {
+			pathType = "protodir"
+		} else {
+			includesPos := 0
+			for pos, include := range cfg.Includes {
+				if strings.HasPrefix(localPath, include) {
+					includesPos = pos
+					break
+				}
+			}
+			pathType = fmt.Sprintf("includes%d", includesPos)
+			localPath = strings.TrimPrefix(path, cfg.Includes[includesPos])
+			localPath = strings.TrimPrefix(localPath, string(filepath.Separator))
+		}
+
 		protoFile := ProtoFile{
-			ProtoPath: ProtoPath(Protopath(localPath)),
+			ProtoPath: &Protopath{localPath, pathType},
 			Entry:     entry,
 		}
 		files = append(files, protoFile)

protopath.go

@@ -15,22 +15,31 @@ const (
 )
 
 // Protopath is a type to assist in OS filepath transformations
-type Protopath string
+type Protopath struct {
+	PathName string `json:"path_name,omitempty"`
+	PathType string `json:"path_type,omitempty"`
+}
 
 // OSPath converts a path in the Protopath format to the OS path format
 func OSPath(ProtoPath Protopath) Protopath {
-	return Protopath(
-		strings.Replace(string(ProtoPath), ProtoSep, FileSep, -1),
-	)
+	return Protopath{
+		strings.Replace(string(ProtoPath.PathName), ProtoSep, FileSep, -1),
+		ProtoPath.PathType,
+	}
 }
 
 // ProtoPath converts a path in the OS path format to Protopath format
 func ProtoPath(OSPath Protopath) Protopath {
-	return Protopath(
-		strings.Replace(string(OSPath), FileSep, ProtoSep, -1),
-	)
+	return Protopath{
+		strings.Replace(string(OSPath.PathName), FileSep, ProtoSep, -1),
+		OSPath.PathType,
+	}
 }
 
 func (p Protopath) String() string {
-	return string(p)
+	return string(p.PathName)
+}
+
+func ProtopathPtr(p Protopath) *Protopath {
+	return &p
 }

report.go

@@ -28,10 +28,10 @@ func HandleReport(report *Report, w io.Writer, err error) (int, error) {
 
 func orderByPathAndMessage(warnings []Warning) {
 	sort.Slice(warnings, func(i, j int) bool {
-		if warnings[i].Filepath < warnings[j].Filepath {
+		if warnings[i].Filepath.PathName < warnings[j].Filepath.PathName {
 			return true
 		}
-		if warnings[i].Filepath > warnings[j].Filepath {
+		if warnings[i].Filepath.PathName > warnings[j].Filepath.PathName {
 			return false
 		}
 		return warnings[i].Message < warnings[j].Message