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 314 315 316
|
//go:build linux && cgo && !agent
package main
import (
"encoding/csv"
"errors"
"fmt"
"go/build"
"os"
"strings"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"golang.org/x/tools/go/packages"
"github.com/lxc/incus/v6/cmd/generate-database/db"
"github.com/lxc/incus/v6/cmd/generate-database/file"
"github.com/lxc/incus/v6/cmd/generate-database/lex"
)
// Return a new db command.
func newDb() *cobra.Command {
cmd := &cobra.Command{
Use: "db [sub-command]",
Short: "Database-related code generation.",
RunE: func(cmd *cobra.Command, args []string) error {
return errors.New("Not implemented")
},
}
cmd.AddCommand(newDbSchema())
cmd.AddCommand(newDbMapper())
// Workaround for subcommand usage errors. See: https://github.com/spf13/cobra/issues/706
cmd.Args = cobra.NoArgs
cmd.Run = func(cmd *cobra.Command, args []string) { _ = cmd.Usage() }
return cmd
}
func newDbSchema() *cobra.Command {
cmd := &cobra.Command{
Use: "schema",
Short: "Generate database schema by applying updates.",
RunE: func(cmd *cobra.Command, args []string) error {
return db.UpdateSchema()
},
}
return cmd
}
func newDbMapper() *cobra.Command {
cmd := &cobra.Command{
Use: "mapper [sub-command]",
Short: "Generate code mapping database rows to Go structs.",
RunE: func(cmd *cobra.Command, args []string) error {
return errors.New("Not implemented")
},
}
cmd.AddCommand(newDbMapperGenerate())
return cmd
}
func newDbMapperGenerate() *cobra.Command {
var pkgs *[]string
var boilerplateFilename string
cmd := &cobra.Command{
Use: "generate",
Short: "Generate database statememnts and transaction method and interface signature.",
RunE: func(cmd *cobra.Command, args []string) error {
if os.Getenv("GOPACKAGE") == "" {
return errors.New("GOPACKAGE environment variable is not set")
}
return generate(*pkgs, boilerplateFilename)
},
}
flags := cmd.Flags()
pkgs = flags.StringArrayP("package", "p", []string{}, "Go package where the entity struct is declared")
flags.StringVarP(&boilerplateFilename, "boilerplate-file", "b", "-", "Filename of the file where the mapper boilerplate is written to")
return cmd
}
const prefix = "//generate-database:mapper "
func generate(pkgs []string, boilerplateFilename string) error {
localPath, err := os.Getwd()
if err != nil {
return err
}
localPkg, err := packages.Load(&packages.Config{Mode: packages.NeedName}, localPath)
if err != nil {
return err
}
localPkgPath := localPkg[0].PkgPath
if len(pkgs) == 0 {
pkgs = []string{localPkgPath}
}
parsedPkgs, err := packageLoad(pkgs)
if err != nil {
return err
}
err = file.Boilerplate(boilerplateFilename)
if err != nil {
return err
}
registeredSQLStmts := map[string]string{}
for _, parsedPkg := range parsedPkgs {
for _, goFile := range parsedPkg.CompiledGoFiles {
body, err := os.ReadFile(goFile)
if err != nil {
return err
}
// Reset target to stdout
target := "-"
lines := strings.Split(string(body), "\n")
for _, line := range lines {
// Lazy matching for prefix, does not consider Go syntax and therefore
// lines starting with prefix, that are part of e.g. multiline strings
// match as well. This is highly unlikely to cause false positives.
after, ok := strings.CutPrefix(line, prefix)
if ok {
line = after
// Use csv parser to properly handle arguments surrounded by double quotes.
r := csv.NewReader(strings.NewReader(line))
r.Comma = ' ' // space
args, err := r.Read()
if err != nil {
return err
}
if len(args) == 0 {
return errors.New("command missing")
}
command := args[0]
switch command {
case "target":
if len(args) != 2 {
return fmt.Errorf("invalid arguments for command target, one argument for the target filename: %s", line)
}
target = args[1]
case "reset":
err = commandReset(args[1:], parsedPkgs, target, localPkgPath)
case "stmt":
err = commandStmt(args[1:], target, parsedPkgs, registeredSQLStmts, localPkgPath)
case "method":
err = commandMethod(args[1:], target, parsedPkgs, registeredSQLStmts, localPkgPath)
default:
err = fmt.Errorf("unknown command: %s", command)
}
if err != nil {
return err
}
}
}
}
}
return nil
}
func commandReset(commandLine []string, parsedPkgs []*packages.Package, target string, localPkgPath string) error {
var err error
flags := pflag.NewFlagSet("", pflag.ContinueOnError)
iface := flags.BoolP("interface", "i", false, "create interface files")
buildComment := flags.StringP("build", "b", "", "build comment to include")
err = flags.Parse(commandLine)
if err != nil {
return err
}
imports := db.Imports
for _, pkg := range parsedPkgs {
if pkg.PkgPath == localPkgPath {
continue
}
imports = append(imports, pkg.PkgPath)
}
err = file.Reset(target, imports, *buildComment, *iface)
if err != nil {
return err
}
return nil
}
func commandStmt(commandLine []string, target string, parsedPkgs []*packages.Package, registeredSQLStmts map[string]string, localPkgPath string) error {
var err error
flags := pflag.NewFlagSet("", pflag.ContinueOnError)
entity := flags.StringP("entity", "e", "", "database entity to generate the statement for")
err = flags.Parse(commandLine)
if err != nil {
return err
}
if len(flags.Args()) < 1 {
return errors.New("argument <kind> missing for stmt command")
}
kind := flags.Arg(0)
config, err := parseParams(flags.Args()[1:])
if err != nil {
return err
}
stmt, err := db.NewStmt(localPkgPath, parsedPkgs, *entity, kind, config, registeredSQLStmts)
if err != nil {
return err
}
return file.Append(*entity, target, stmt, false)
}
func commandMethod(commandLine []string, target string, parsedPkgs []*packages.Package, registeredSQLStmts map[string]string, localPkgPath string) error {
var err error
flags := pflag.NewFlagSet("", pflag.ContinueOnError)
iface := flags.BoolP("interface", "i", false, "create interface files")
entity := flags.StringP("entity", "e", "", "database entity to generate the method for")
err = flags.Parse(commandLine)
if err != nil {
return err
}
if len(flags.Args()) < 1 {
return errors.New("argument <kind> missing for method command")
}
kind := flags.Arg(0)
config, err := parseParams(flags.Args()[1:])
if err != nil {
return err
}
method, err := db.NewMethod(localPkgPath, parsedPkgs, *entity, kind, config, registeredSQLStmts)
if err != nil {
return err
}
return file.Append(*entity, target, method, *iface)
}
func packageLoad(pkgs []string) ([]*packages.Package, error) {
pkgPaths := []string{}
for _, pkg := range pkgs {
if pkg == "" {
var err error
localPath, err := os.Getwd()
if err != nil {
return nil, err
}
pkgPaths = append(pkgPaths, localPath)
} else {
importPkg, err := build.Import(pkg, "", build.FindOnly)
if err != nil {
return nil, fmt.Errorf("Invalid import path %q: %w", pkg, err)
}
pkgPaths = append(pkgPaths, importPkg.Dir)
}
}
parsedPkgs, err := packages.Load(&packages.Config{
Mode: packages.LoadTypes | packages.NeedTypesInfo,
}, pkgPaths...)
if err != nil {
return nil, err
}
return parsedPkgs, nil
}
func parseParams(args []string) (map[string]string, error) {
config := map[string]string{}
for _, arg := range args {
key, value, err := lex.KeyValue(arg)
if err != nil {
return nil, fmt.Errorf("Invalid config parameter: %w", err)
}
config[key] = value
}
return config, nil
}
|