1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// protoc invokes the protobuf compiler and captures the resulting .pb.go file.
package main
import (
"bytes"
"errors"
"flag"
"fmt"
"io/ioutil"
"log"
"os"
"os/exec"
"path/filepath"
"strings"
)
type genFileInfo struct {
base string // The basename of the path
path string // The full path to the final file
expected bool // Whether the file is expected by the rules
created bool // Whether the file was created by protoc
from *genFileInfo // The actual file protoc produced if not Path
unique bool // True if this base name is unique in expected results
ambiguious bool // True if there were more than one possible outputs that matched this file
}
func run(args []string) error {
// process the args
args, err := readParamsFiles(args)
if err != nil {
return err
}
options := multiFlag{}
descriptors := multiFlag{}
expected := multiFlag{}
imports := multiFlag{}
flags := flag.NewFlagSet("protoc", flag.ExitOnError)
protoc := flags.String("protoc", "", "The path to the real protoc.")
outPath := flags.String("out_path", "", "The base output path to write to.")
plugin := flags.String("plugin", "", "The go plugin to use.")
importpath := flags.String("importpath", "", "The importpath for the generated sources.")
compilerPath := flags.String("compiler_path", "", "The value for PATH.")
flags.Var(&options, "option", "The plugin options.")
flags.Var(&descriptors, "descriptor_set", "The descriptor set to read.")
flags.Var(&expected, "expected", "The expected output files.")
flags.Var(&imports, "import", "Map a proto file to an import path.")
if err := flags.Parse(args); err != nil {
return err
}
// Output to a temporary folder and then move the contents into place below.
// This is to work around long file paths on Windows.
tmpDir, err := ioutil.TempDir("", "go_proto")
if err != nil {
return err
}
tmpDir = abs(tmpDir) // required to work with long paths on Windows
absOutPath := abs(*outPath) // required to work with long paths on Windows
defer os.RemoveAll(tmpDir)
pluginBase := filepath.Base(*plugin)
pluginName := strings.TrimSuffix(
strings.TrimPrefix(filepath.Base(*plugin), "protoc-gen-"), ".exe")
for _, m := range imports {
options = append(options, fmt.Sprintf("M%v", m))
}
protoc_args := []string{
fmt.Sprintf("--%v_out=%v:%v", pluginName, strings.Join(options, ","), tmpDir),
"--plugin", fmt.Sprintf("%v=%v", strings.TrimSuffix(pluginBase, ".exe"), *plugin),
"--descriptor_set_in", strings.Join(descriptors, string(os.PathListSeparator)),
}
protoc_args = append(protoc_args, flags.Args()...)
cmd := exec.Command(*protoc, protoc_args...)
cmd.Env = append(os.Environ(), fmt.Sprintf("PATH=%s", *compilerPath))
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
return fmt.Errorf("error running protoc: %v", err)
}
// Build our file map, and test for existance
files := map[string]*genFileInfo{}
byBase := map[string]*genFileInfo{}
for _, path := range expected {
info := &genFileInfo{
path: path,
base: filepath.Base(path),
expected: true,
unique: true,
}
files[info.path] = info
if byBase[info.base] != nil {
info.unique = false
byBase[info.base].unique = false
} else {
byBase[info.base] = info
}
}
// Walk the generated files
filepath.Walk(tmpDir, func(path string, f os.FileInfo, err error) error {
relPath, err := filepath.Rel(tmpDir, path)
if err != nil {
return err
}
if relPath == "." {
return nil
}
if f.IsDir() {
if err := os.Mkdir(filepath.Join(absOutPath, relPath), f.Mode()); !os.IsExist(err) {
return err
}
return nil
}
if !strings.HasSuffix(path, ".go") {
return nil
}
info := &genFileInfo{
path: path,
base: filepath.Base(path),
created: true,
}
if foundInfo, ok := files[relPath]; ok {
foundInfo.created = true
foundInfo.from = info
return nil
}
files[relPath] = info
copyTo := byBase[info.base]
switch {
case copyTo == nil:
// Unwanted output
case !copyTo.unique:
// not unique, no copy allowed
case copyTo.from != nil:
copyTo.ambiguious = true
info.ambiguious = true
default:
copyTo.from = info
copyTo.created = true
info.expected = true
}
return nil
})
buf := &bytes.Buffer{}
for _, f := range files {
switch {
case f.expected && !f.created:
// Some plugins only create output files if the proto source files have
// have relevant definitions (e.g., services for grpc_gateway). Create
// trivial files that the compiler will ignore for missing outputs.
data := []byte("// +build ignore\n\npackage ignore")
if err := ioutil.WriteFile(abs(f.path), data, 0644); err != nil {
return err
}
case f.expected && f.ambiguious:
fmt.Fprintf(buf, "Ambiguious output %v.\n", f.path)
case f.from != nil:
data, err := ioutil.ReadFile(f.from.path)
if err != nil {
return err
}
if err := ioutil.WriteFile(abs(f.path), data, 0644); err != nil {
return err
}
case !f.expected:
//fmt.Fprintf(buf, "Unexpected output %v.\n", f.path)
}
if buf.Len() > 0 {
fmt.Fprintf(buf, "Check that the go_package option is %q.", *importpath)
return errors.New(buf.String())
}
}
return nil
}
func main() {
if err := run(os.Args[1:]); err != nil {
log.Fatal(err)
}
}
|
