-
Notifications
You must be signed in to change notification settings - Fork 69
/
main.go
313 lines (278 loc) · 8.61 KB
/
main.go
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
// Binary ogen generates go source code from OAS.
package main
import (
"flag"
"fmt"
"io"
"os"
"path/filepath"
"regexp"
"runtime"
"runtime/pprof"
"strings"
"time"
"github.com/go-faster/errors"
"go.uber.org/multierr"
"go.uber.org/zap"
"github.com/ogen-go/ogen"
"github.com/ogen-go/ogen/gen"
"github.com/ogen-go/ogen/gen/genfs"
"github.com/ogen-go/ogen/internal/location"
"github.com/ogen-go/ogen/internal/ogenversion"
"github.com/ogen-go/ogen/internal/ogenzap"
)
func cleanDir(targetDir string, files []os.DirEntry) (rerr error) {
for _, f := range files {
if f.IsDir() {
continue
}
name := f.Name()
if !(strings.HasSuffix(name, "_gen.go") || strings.HasSuffix(name, "_gen_test.go")) {
continue
}
if !(strings.HasPrefix(name, "openapi") || strings.HasPrefix(name, "oas")) {
continue
}
// Do not return error if file does not exist.
if err := os.Remove(filepath.Join(targetDir, name)); err != nil && !os.IsNotExist(err) {
// Do not stop on first error, try to remove all files.
rerr = multierr.Append(rerr, err)
}
}
return rerr
}
func generate(data []byte, packageName, targetDir string, clean bool, opts gen.Options) error {
log := opts.Logger
spec, err := ogen.Parse(data)
if err != nil {
// For pretty error message, we need to pass location.File.
return &location.Error{
File: opts.File,
Err: errors.Wrap(err, "parse spec"),
}
}
start := time.Now()
g, err := gen.NewGenerator(spec, opts)
if err != nil {
return errors.Wrap(err, "build IR")
}
log.Debug("Build IR", zap.Duration("took", time.Since(start)))
// Clean target dir only after flag parsing, spec parsing and IR building.
switch files, err := os.ReadDir(targetDir); {
case os.IsNotExist(err):
if err := os.MkdirAll(targetDir, 0o750); err != nil {
return err
}
case err != nil:
return err
default:
if clean {
if err := cleanDir(targetDir, files); err != nil {
return errors.Wrap(err, "clean")
}
}
}
fs := genfs.FormattedSource{
// FIXME(tdakkota): write source uses imports.Process which also uses go/format.
// So, there is no reason to format source twice or provide a flag to disable formatting.
Format: false,
Root: targetDir,
}
start = time.Now()
if err := g.WriteSource(fs, packageName); err != nil {
return errors.Wrap(err, "write")
}
log.Debug("Write", zap.Duration("took", time.Since(start)))
return nil
}
func handleGenerateError(w io.Writer, color bool, err error) (r bool) {
defer func() {
// Add trailing newline to the error message if error is handled.
if r {
_, _ = fmt.Fprintln(w)
}
}()
if location.PrintPrettyError(w, color, err) {
return true
}
if notImplErr, ok := errors.Into[*gen.ErrNotImplemented](err); ok {
_, _ = fmt.Fprintf(w, `
Feature %[1]q is not implemented yet.
Try to run ogen with --debug.ignoreNotImplemented %[1]q or with --debug.noerr to skip unsupported operations.
`, notImplErr.Name)
return true
}
if ctErr, ok := errors.Into[*gen.ErrUnsupportedContentTypes](err); ok {
_, _ = fmt.Fprintf(w, `
Content types [%s] are unsupported.
Try to run ogen with --debug.ignoreNotImplemented %q or with --debug.noerr to skip unsupported operations.
Also, you can use --ct-alias to map content types to supported ones.
`,
strings.Join(ctErr.ContentTypes, ", "),
"unsupported content type",
)
return true
}
return false
}
func run() error {
set := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
set.Usage = func() {
_, toolName := filepath.Split(os.Args[0])
_, _ = fmt.Fprintf(set.Output(), "Usage: %s [options] <spec>\n", toolName)
set.PrintDefaults()
}
var (
// Generator options.
targetDir = set.String("target", "api", "Path to target dir")
packageName = set.String("package", "api", "Target package name")
inferTypes = set.Bool("infer-types", false, "Infer schema types, if type is not defined explicitly")
clean = set.Bool("clean", false, "Clean generated files before generation")
generateTests = set.Bool("generate-tests", false, "Generate tests encode-decode/based on schema examples")
allowRemote = set.Bool("allow-remote", false, "Enables remote references resolving")
skipTestsRegex = set.String("skip-tests", "", "Skip tests matched by regex")
skipUnimplemented = set.Bool("skip-unimplemented", false, "Disables generation of UnimplementedHandler")
noClient = set.Bool("no-client", false, "Disables client generation")
noServer = set.Bool("no-server", false, "Disables server generation")
noWebhookClient = set.Bool("no-webhook-client", false, "Disables webhook client generation")
noWebhookServer = set.Bool("no-webhook-server", false, "Disables webhook server generation")
// Debug options.
debugIgnoreNotImplemented = set.String("debug.ignoreNotImplemented", "",
"Ignore methods having functionality which is not implemented")
debugNoerr = set.Bool("debug.noerr", false, "Ignore errors")
// Logging options.
logOptions ogenzap.Options
// Profile options.
cpuProfile = set.String("cpuprofile", "", "Write cpu profile to file")
memProfile = set.String("memprofile", "", "Write memory profile to this file")
memProfileRate = set.Int("memprofilerate", -1, "If > 0, sets runtime.MemProfileRate")
// Version option.
version = set.Bool("version", false, "Print version and exit")
)
logOptions.RegisterFlags(set)
var (
ctAliases gen.ContentTypeAliases
convenientErrors gen.ConvenientErrors
filterPath *regexp.Regexp
filterMethods []string
)
set.Var(&convenientErrors, "convenient-errors", `Convenient errors mode: on, off or auto (default)`)
set.Var(&ctAliases, "ct-alias", "Content type alias, e.g. text/x-markdown=text/plain")
set.Func("filter-path", "Filter operations by path regex", func(s string) (err error) {
filterPath, err = regexp.Compile(s)
return err
})
set.Func("filter-methods", "Filter operations by HTTP methods (comma-separated)", func(s string) error {
for _, m := range strings.Split(s, ",") {
m = strings.TrimSpace(m)
if m == "" {
continue
}
filterMethods = append(filterMethods, m)
}
return nil
})
if err := set.Parse(os.Args[1:]); err != nil {
return err
}
if *version {
info, _ := ogenversion.GetInfo()
fmt.Println(info)
return nil
}
specPath := set.Arg(0)
if set.NArg() == 0 || specPath == "" {
set.Usage()
return errors.New("no spec provided")
}
logger, err := ogenzap.Create(logOptions)
if err != nil {
return err
}
defer func() {
_ = logger.Sync()
}()
if f := *cpuProfile; f != "" {
f, err := os.Create(f)
if err != nil {
return errors.Wrap(err, "create cpu profile")
}
defer func() {
_ = f.Close()
}()
if err := pprof.StartCPUProfile(f); err != nil {
logger.Error("Start CPU profiling", zap.Error(err))
} else {
defer pprof.StopCPUProfile()
}
}
if f := *memProfile; f != "" {
f, err := os.Create(f)
if err != nil {
return errors.Wrap(err, "create memory profile")
}
defer func() {
_ = f.Close()
}()
if *memProfileRate > 0 {
runtime.MemProfileRate = *memProfileRate
}
defer func() {
runtime.GC()
if err := pprof.WriteHeapProfile(f); err != nil {
logger.Error("Write memory profile", zap.Error(err))
}
}()
}
opts := gen.Options{
NoClient: *noClient,
NoServer: *noServer,
NoWebhookClient: *noWebhookClient,
NoWebhookServer: *noWebhookServer,
GenerateExampleTests: *generateTests,
SkipTestRegex: nil, // Set below.
SkipUnimplemented: *skipUnimplemented,
InferSchemaType: *inferTypes,
AllowRemote: *allowRemote,
Filters: gen.Filters{
PathRegex: filterPath,
Methods: filterMethods,
},
IgnoreNotImplemented: strings.Split(*debugIgnoreNotImplemented, ","),
ConvenientErrors: convenientErrors,
ContentTypeAliases: ctAliases,
Logger: logger,
}
data, err := opts.SetLocation(specPath, gen.RemoteOptions{})
if err != nil {
return err
}
if expr := *skipTestsRegex; expr != "" {
r, err := regexp.Compile(expr)
if err != nil {
return errors.Wrap(err, "skipTestsRegex")
}
opts.SkipTestRegex = r
}
if *debugNoerr {
opts.IgnoreNotImplemented = []string{"all"}
} else {
// Normalize ignore rules.
for i := range opts.IgnoreNotImplemented {
opts.IgnoreNotImplemented[i] = strings.TrimSpace(opts.IgnoreNotImplemented[i])
}
}
if err := generate(data, *packageName, *targetDir, *clean, opts); err != nil {
if handleGenerateError(os.Stderr, logOptions.Color, err) {
return errors.New("generation failed")
}
return errors.Wrap(err, "generate")
}
return nil
}
func main() {
if err := run(); err != nil {
_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
os.Exit(1)
}
}