|
1 | | -// Package cmd is the package that contains the commands of the application. |
2 | 1 | package cmd |
3 | 2 |
|
4 | 3 | import ( |
5 | | - "errors" |
| 4 | + "fmt" |
| 5 | + "log" |
6 | 6 | "os" |
7 | | - "strings" |
| 7 | + "path/filepath" |
8 | 8 |
|
9 | 9 | "github.com/spf13/cobra" |
10 | | - "github.com/spf13/pflag" |
| 10 | + "gopkg.in/yaml.v3" |
11 | 11 |
|
12 | 12 | "github.com/aiven/go-api-schemas/internal/diff" |
13 | 13 | "github.com/aiven/go-api-schemas/internal/gen" |
14 | | - "github.com/aiven/go-api-schemas/internal/pkg/types" |
15 | | - "github.com/aiven/go-api-schemas/internal/pkg/util" |
16 | | - "github.com/aiven/go-api-schemas/internal/reader" |
17 | | - "github.com/aiven/go-api-schemas/internal/writer" |
| 14 | + "github.com/aiven/go-api-schemas/internal/types" |
18 | 15 | ) |
19 | 16 |
|
20 | | -// logger is the logger of the application. |
21 | | -var logger = &util.Logger{} |
22 | | - |
23 | | -// NewCmdRoot returns a pointer to the root command. |
24 | | -func NewCmdRoot(l *util.Logger) *cobra.Command { |
| 17 | +func NewCmdRoot() *cobra.Command { |
25 | 18 | cmd := &cobra.Command{ |
26 | 19 | Use: "go-api-schemas foo.json bar.json baz.json", |
27 | 20 | Short: "go-api-schemas is a tool for generating and persisting user configuration option schemas from " + |
28 | 21 | "Aiven APIs.", |
29 | | - Run: run, |
| 22 | + RunE: run, |
30 | 23 | Args: cobra.MinimumNArgs(1), |
31 | 24 | } |
32 | 25 |
|
33 | | - cmd.Flags().StringP("output-dir", "o", "", "the output directory for the generated files") |
34 | | - |
35 | | - cmd.Flags().BoolP("regenerate", "r", false, "regenerates the files in the output directory") |
36 | | - |
37 | | - logger = l |
38 | | - |
| 26 | + cmd.Flags().StringP("output-dir", "o", "pkg/dist", "the output directory for the generated files") |
| 27 | + cmd.Flags().BoolP( |
| 28 | + "regenerate", "r", false, |
| 29 | + "regenerate files without comparing against existing files (useful for removing deprecations)", |
| 30 | + ) |
39 | 31 | return cmd |
40 | 32 | } |
41 | 33 |
|
42 | | -// setupOutputDir sets up the output directory. |
43 | | -func setupOutputDir(flags *pflag.FlagSet) error { |
44 | | - outputDir, err := flags.GetString("output-dir") |
| 34 | +func run(cmd *cobra.Command, fileNames []string) error { |
| 35 | + outputDir, err := cmd.Flags().GetString("output-dir") |
45 | 36 | if err != nil { |
46 | | - return err |
| 37 | + return fmt.Errorf("error getting output directory: %w", err) |
47 | 38 | } |
48 | 39 |
|
49 | | - if outputDir == "" { |
50 | | - var wd string |
51 | | - |
52 | | - wd, err = os.Getwd() |
53 | | - if err != nil { |
54 | | - return err |
55 | | - } |
| 40 | + regenerate, err := cmd.Flags().GetBool("regenerate") |
| 41 | + if err != nil { |
| 42 | + return fmt.Errorf("error getting regeneration flag: %w", err) |
| 43 | + } |
56 | 44 |
|
57 | | - outputDir = strings.Join([]string{wd, "pkg/dist"}, string(os.PathSeparator)) |
| 45 | + generationResult, err := gen.Run(fileNames...) |
| 46 | + if err != nil { |
| 47 | + return fmt.Errorf("error generating: %w", err) |
| 48 | + } |
58 | 49 |
|
59 | | - err = flags.Set("output-dir", outputDir) |
| 50 | + readResult := make(types.ReadResult) |
| 51 | + if !regenerate { |
| 52 | + readResult, err = read(outputDir) |
60 | 53 | if err != nil { |
61 | | - return err |
| 54 | + return fmt.Errorf("error reading files: %w", err) |
62 | 55 | } |
63 | 56 | } |
64 | 57 |
|
65 | | - fi, err := os.Stat(outputDir) |
| 58 | + diffResult, err := diff.Diff(readResult, generationResult) |
66 | 59 | if err != nil { |
67 | | - return err |
| 60 | + return fmt.Errorf("error diffing schemas: %w", err) |
68 | 61 | } |
69 | 62 |
|
70 | | - if !fi.IsDir() { |
71 | | - return errors.New("output directory is not a directory") |
| 63 | + err = write(outputDir, diffResult) |
| 64 | + if err != nil { |
| 65 | + return fmt.Errorf("error writing files: %w", err) |
72 | 66 | } |
73 | | - |
74 | 67 | return nil |
75 | 68 | } |
76 | 69 |
|
77 | | -// setup sets up the application. |
78 | | -func setup(flags *pflag.FlagSet) { |
79 | | - logger.Info.Println("go-api-schemas tool started") |
80 | | - |
81 | | - logger.Info.Println("setting up output directory") |
82 | | - |
83 | | - if err := setupOutputDir(flags); err != nil { |
84 | | - logger.Error.Fatalf("error setting up output directory: %s", err) |
| 70 | +func read(outputDir string) (types.ReadResult, error) { |
| 71 | + result := make(types.ReadResult) |
| 72 | + for k, v := range getSchemaFilenames() { |
| 73 | + result[k] = make(map[string]*types.UserConfigSchema) |
| 74 | + filePath := filepath.Join(outputDir, v) |
| 75 | + err := readFile(filePath, result[k]) |
| 76 | + if err != nil && !os.IsNotExist(err) { |
| 77 | + return nil, fmt.Errorf("%q: %w", filePath, err) |
| 78 | + } |
85 | 79 | } |
86 | 80 |
|
87 | | - logger.Info.Println("setting up environment variables") |
| 81 | + return result, nil |
88 | 82 | } |
89 | 83 |
|
90 | | -// run is the function that is called when the rootCmd is executed. |
91 | | -func run(cmd *cobra.Command, args []string) { |
92 | | - flags := cmd.Flags() |
| 84 | +func readFile(filePath string, schema map[string]*types.UserConfigSchema) error { |
| 85 | + f, err := os.Open(filepath.Clean(filePath)) |
| 86 | + if err != nil { |
| 87 | + return err |
| 88 | + } |
93 | 89 |
|
94 | | - setup(flags) |
| 90 | + defer withLogError(f.Close) |
| 91 | + return yaml.NewDecoder(f).Decode(schema) |
| 92 | +} |
95 | 93 |
|
96 | | - shouldRegenerate, err := flags.GetBool("regenerate") |
97 | | - if err != nil { |
98 | | - logger.Error.Fatalf("error getting regeneration flag: %s", err) |
| 94 | +func write(outputDir string, result types.DiffResult) error { |
| 95 | + for k, v := range getSchemaFilenames() { |
| 96 | + p := filepath.Join(outputDir, v) |
| 97 | + err := writeFile(p, result[k]) |
| 98 | + if err != nil { |
| 99 | + return fmt.Errorf("%q: %w", p, err) |
| 100 | + } |
99 | 101 | } |
100 | 102 |
|
101 | | - logger.Info.Println("generating") |
| 103 | + return nil |
| 104 | +} |
102 | 105 |
|
103 | | - gr, err := gen.Run(args...) |
| 106 | +func writeFile(filePath string, schema map[string]*types.UserConfigSchema) error { |
| 107 | + f, err := os.Create(filepath.Clean(filePath)) |
104 | 108 | if err != nil { |
105 | | - logger.Error.Fatalf("error generating: %s", err) |
| 109 | + return err |
106 | 110 | } |
107 | 111 |
|
108 | | - rr := make(types.ReadResult) |
| 112 | + defer withLogError(f.Close) |
109 | 113 |
|
110 | | - if !shouldRegenerate { |
111 | | - logger.Info.Println("reading files") |
| 114 | + e := yaml.NewEncoder(f) |
| 115 | + defer withLogError(e.Close) |
112 | 116 |
|
113 | | - rr, err = reader.Run(logger, flags) |
114 | | - if err != nil && !os.IsNotExist(err) { |
115 | | - logger.Error.Fatalf("error reading files: %s", err) |
116 | | - } |
117 | | - } |
| 117 | + const indentSpaces = 2 |
| 118 | + e.SetIndent(indentSpaces) |
| 119 | + return e.Encode(schema) |
| 120 | +} |
118 | 121 |
|
119 | | - logger.Info.Println("diffing") |
120 | | - dr, err := diff.Run(rr, gr) |
121 | | - if err != nil { |
122 | | - logger.Error.Fatalf("error diffing: %s", err) |
123 | | - } |
| 122 | +const ( |
| 123 | + serviceSchemaFilename = "service_types.yml" |
| 124 | + integrationSchemaFilename = "integration_types.yml" |
| 125 | + integrationEndpointSchemaFilename = "integration_endpoint_types.yml" |
| 126 | +) |
124 | 127 |
|
125 | | - logger.Info.Println("writing files") |
126 | | - if err = writer.Run(logger, flags, dr); err != nil { |
127 | | - logger.Error.Fatalf("error writing files: %s", err) |
| 128 | +func getSchemaFilenames() map[types.SchemaType]string { |
| 129 | + return map[types.SchemaType]string{ |
| 130 | + types.ServiceSchemaType: serviceSchemaFilename, |
| 131 | + types.IntegrationSchemaType: integrationSchemaFilename, |
| 132 | + types.IntegrationEndpointSchemaType: integrationEndpointSchemaFilename, |
128 | 133 | } |
| 134 | +} |
129 | 135 |
|
130 | | - logger.Info.Println("done") |
| 136 | +func withLogError(f func() error) { |
| 137 | + if err := f(); err != nil { |
| 138 | + log.Println("[ERROR]: " + err.Error()) |
| 139 | + } |
131 | 140 | } |
0 commit comments