Merge pull request #1654 from breml/rename-incus-generate

Rename incus-generate and incus-doc

Author: stgraber

Makefile

@@ -127,7 +127,7 @@ update-protobuf:
 
 .PHONY: update-schema
 update-schema:
-	cd cmd/generate-database && $(GO) build -o $(GOPATH)/bin/incus-generate -tags "$(TAG_SQLITE3)" $(DEBUG) && cd -
+	cd cmd/generate-database && $(GO) build -o $(GOPATH)/bin/generate-database -tags "$(TAG_SQLITE3)" $(DEBUG) && cd -
 	$(GO) generate ./...
 	gofmt -s -w ./internal/server/db/
 	goimports -w ./internal/server/db/
@@ -143,8 +143,8 @@ endif
 .PHONY: update-metadata
 update-metadata: build
 	@echo "Generating golang documentation metadata"
-	cd cmd/generate-config && CGO_ENABLED=0 $(GO) build -o $(GOPATH)/bin/incus-doc
-	$(GOPATH)/bin/incus-doc . --json ./internal/server/metadata/configuration.json --txt ./doc/config_options.txt
+	cd cmd/generate-config && CGO_ENABLED=0 $(GO) build -o $(GOPATH)/bin/generate-config
+	$(GOPATH)/bin/generate-config . --json ./internal/server/metadata/configuration.json --txt ./doc/config_options.txt
 
 .PHONY: doc-setup
 doc-setup: client

cmd/generate-config/README.md

@@ -1,13 +1,13 @@
-# incus-doc
+# generate-config
 
 A small CLI to parse comments in a Golang codebase meant to be used for a documentation tool (like Sphinx for example).
 
 It parses the comments from the AST and extracts their documentation.
 
 # Usage
 
-    $ incus-doc -h
-    Usage of incus-doc:
+    $ generate-config -h
+    Usage of generate-config:
     -e value
         Path that will be excluded from the process
 
@@ -78,7 +78,7 @@ A comment is formatted this way:
 
 The go-swagger spec from source generator can only handles `swagger:meta` (global file/package level documentation), `swagger:route` (API endpoints), `swagger:params` (function parameters), `swagger:operation` (method documentation), `swagger:response` (API response content documentation), `swagger:model` (struct documentation) generation. In our use case, we would want a config variable spec generator that can bundle any key-value data pairs alongside metadata to build a sense of hierarchy and identity (we want to associate a unique key to each gendoc comment group that will also be displayed in the generated documentation)
 
-In a swagger fashion, `incus-doc` can associate metadata key-value pairs (here for example, `group` and `key`) to data key-value pairs. As a result, it can generate a YAML tree out of the code documentation and also a Markdown document.
+In a swagger fashion, `generate-config` can associate metadata key-value pairs (here for example, `group` and `key`) to data key-value pairs. As a result, it can generate a YAML tree out of the code documentation and also a Markdown document.
 
 ## Output
 

cmd/generate-config/incus_doc.go

@@ -296,7 +296,7 @@ func writeDocFile(inputJSONPath, outputTxtPath string) error {
 
 	sortedEntityKeys := getSortedKeysFromMap(jsonDoc.Configs)
 	// create a string buffer
-	buffer := bytes.NewBufferString("// Code generated by incus-doc; DO NOT EDIT.\n\n")
+	buffer := bytes.NewBufferString("// Code generated by generate-config from the incus project; DO NOT EDIT.\n\n")
 	for _, entityKey := range sortedEntityKeys {
 		entityEntries := jsonDoc.Configs[entityKey]
 		sortedGroupKeys := getSortedKeysFromMap(entityEntries.(map[string]any))

cmd/generate-config/incus_doc_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-// Test the alphabetical sorting of a `incus-doc` JSON structure.
+// Test the alphabetical sorting of a `generate-config` JSON structure.
 func TestJSONSorted(t *testing.T) {
 	projectEntries := make(map[string]any)
 	projectEntries["entityKey1"] = map[string]any{

cmd/generate-config/main.go

@@ -12,9 +12,9 @@ var exclude []string
 var jsonOutput string
 var txtOutput string
 var rootCmd = &cobra.Command{
-	Use:   "incus-doc",
-	Short: "incus-doc - a simple tool to generate documentation for Incus",
-	Long:  "incus-doc - a simple tool to generate documentation for Incus. It outputs a YAML and a Markdown file that contain the content of all `gendoc:generate` statements in the project.",
+	Use:   "generate-config",
+	Short: "generate-config - a simple tool to generate documentation for Incus",
+	Long:  "generate-config - a simple tool to generate documentation for Incus. It outputs a YAML and a Markdown file that contain the content of all `gendoc:generate` statements in the project.",
 	Args:  cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		if len(args) != 1 {
@@ -42,9 +42,9 @@ func main() {
 	rootCmd.Flags().StringVarP(&txtOutput, "txt", "t", "", "Output TXT file containing the generated documentation")
 	err := rootCmd.Execute()
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "incus-doc failed: %v", err)
+		fmt.Fprintf(os.Stderr, "generate-config failed: %v", err)
 		os.Exit(1)
 	}
 
-	log.Println("incus-doc finished successfully")
+	log.Println("generate-config finished successfully")
 }

cmd/generate-database/README.md

@@ -1,12 +1,12 @@
-# `incus-generate`
+# `generate-database`
 
 ## Introduction
 
-`incus-generate` is a database statement and associated `go` function generator
-for Incus and related projects. `incus-generate` utilizes `go`'s code generation
+`generate-database` is a database statement and associated `go` function generator
+for Incus and related projects. `generate-database` utilizes `go`'s code generation
 directives (`//go:generate ...`) alongside go's [ast](https://pkg.go.dev/go/ast)
 package for parsing the syntax tree for go structs and variables. We use
-`incus-generate` for the majority of our SQL statements and database interactions
+`generate-database` for the majority of our SQL statements and database interactions
 on the `go` side for consistency and predictability.
 
 ## Usage
@@ -18,12 +18,12 @@ establish the command, the target file, and ensure the file has been cleared of
 content:
 
 ```go
-//go:generate -command mapper incus-generate db mapper -t instances.mapper.go
+//go:generate -command mapper generate-database db mapper -t instances.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 
 ```
 
-This will initiate a call to `incus-generate db mapper -t instances.mapper.go` on
+This will initiate a call to `generate-database db mapper -t instances.mapper.go` on
 each call to the go generation directive `mapper`.
 
 ### Generation Directive Arguments
@@ -136,7 +136,7 @@ type InstanceFilter struct {
 }
 ```
 
-`incus-generate` will handle parsing of structs differently based on the composition of the struct in four different ways.
+`generate-database` will handle parsing of structs differently based on the composition of the struct in four different ways.
 
 Non-`EntityType` structs will only support `GetMany`, `Create`, `Update`, and `Delete` functions.
 
@@ -154,7 +154,7 @@ including a comma separated list to `references=<OtherEntity>` in the code gener
 ### ReferenceTable
 
 A struct that contains a field named `ReferenceID` will be parsed this way.
-`incus-generate` will use this struct to generate more abstract SQL statements and functions of the form `<parent_table>_<this_table>`.
+`generate-database` will use this struct to generate more abstract SQL statements and functions of the form `<parent_table>_<this_table>`.
 
 Real world invocation of these statements and functions should be done through an `EntityTable` `method` call with the tag `references=<ThisStruct>`. This `EntityTable` will replace the `<parent_table>` above.
 

cmd/generate-database/file/write.go

@@ -27,10 +27,10 @@ func Reset(path string, imports []string, buildComment string, iface bool) error
 
 	content := fmt.Sprintf(`%spackage %s
 
-// The code below was generated by %s - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
-`, buildComment, os.Getenv("GOPACKAGE"), os.Args[0])
+`, buildComment, os.Getenv("GOPACKAGE"))
 
 	for _, uri := range imports {
 		content += fmt.Sprintf("\t%q\n", uri)

cmd/generate-database/root.go

@@ -9,7 +9,7 @@ import (
 // Return a new root command.
 func newRoot() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "incus-generate",
+		Use:   "generate-database",
 		Short: "Code generation tool for Incus development",
 		Long: `This is the entry point for all "go:generate" directives
 used in Incus' source code.`,

doc/config_options.txt

@@ -1,4 +1,4 @@
-// Code generated by incus-doc; DO NOT EDIT.
+// Code generated by generate-config from the incus project; DO NOT EDIT.
 
 <!-- config group cluster-cluster start -->
 ```{config:option} scheduler.instance cluster-cluster

internal/server/db/cluster/certificate_projects.go

@@ -4,7 +4,7 @@ package cluster
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t certificate_projects.mapper.go
+//go:generate -command mapper generate-database db mapper -t certificate_projects.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e certificate_project objects

internal/server/db/cluster/certificate_projects.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/certificates.go

@@ -15,7 +15,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t certificates.mapper.go
+//go:generate -command mapper generate-database db mapper -t certificates.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e certificate objects

internal/server/db/cluster/certificates.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/cluster_groups.go

@@ -7,7 +7,7 @@ import (
 	"github.com/lxc/incus/v6/shared/api"
 )
 
-//go:generate -command mapper incus-generate db mapper -t cluster_groups.mapper.go
+//go:generate -command mapper generate-database db mapper -t cluster_groups.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e cluster_group objects table=cluster_groups

internal/server/db/cluster/cluster_groups.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/config.go

@@ -4,7 +4,7 @@ package cluster
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t config.mapper.go
+//go:generate -command mapper generate-database db mapper -t config.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e config objects

internal/server/db/cluster/config.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/devices.go

@@ -8,7 +8,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t devices.mapper.go
+//go:generate -command mapper generate-database db mapper -t devices.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e device objects

internal/server/db/cluster/devices.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/images.go

@@ -9,7 +9,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t images.mapper.go
+//go:generate -command mapper generate-database db mapper -t images.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e image objects

internal/server/db/cluster/images.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/instance_profiles.go

@@ -10,7 +10,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t instance_profiles.mapper.go
+//go:generate -command mapper generate-database db mapper -t instance_profiles.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e instance_profile objects

internal/server/db/cluster/instance_profiles.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/instances.go

@@ -15,7 +15,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t instances.mapper.go
+//go:generate -command mapper generate-database db mapper -t instances.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e instance objects

internal/server/db/cluster/instances.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/networks_integrations.go

@@ -11,7 +11,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t networks_integrations.mapper.go
+//go:generate -command mapper generate-database db mapper -t networks_integrations.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e network_integration objects

internal/server/db/cluster/networks_integrations.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/nodes.go

@@ -1,6 +1,6 @@
 package cluster
 
-//go:generate -command mapper incus-generate db mapper -t nodes.mapper.go
+//go:generate -command mapper generate-database db mapper -t nodes.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e node id

internal/server/db/cluster/nodes.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/nodes_cluster_groups.go

@@ -2,7 +2,7 @@ package cluster
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t nodes_cluster_groups.mapper.go
+//go:generate -command mapper generate-database db mapper -t nodes_cluster_groups.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e node_cluster_group objects table=nodes_cluster_groups

internal/server/db/cluster/nodes_cluster_groups.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/operations.go

@@ -8,7 +8,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t operations.mapper.go
+//go:generate -command mapper generate-database db mapper -t operations.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e operation objects

internal/server/db/cluster/operations.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"

internal/server/db/cluster/profiles.go

@@ -12,7 +12,7 @@ import (
 
 // Code generation directives.
 //
-//go:generate -command mapper incus-generate db mapper -t profiles.mapper.go
+//go:generate -command mapper generate-database db mapper -t profiles.mapper.go
 //go:generate mapper reset -i -b "//go:build linux && cgo && !agent"
 //
 //go:generate mapper stmt -e profile objects

internal/server/db/cluster/profiles.mapper.go

@@ -2,7 +2,7 @@
 
 package cluster
 
-// The code below was generated by incus-generate - DO NOT EDIT!
+// The code below was generated by generate-database from the incus project - DO NOT EDIT!
 
 import (
 	"context"