chore: Move object-impl generator to cmd (#462)

## Motivation Internal Go tools for the project should be kept under `internal/cmd` instead of `scripts`.
nobl9 · Jun 17, 2024 · ba38285 · ba38285
1 parent d621694
commit ba38285
Show file tree

Hide file tree

Showing 32 changed files with 50 additions and 36 deletions.
diff --git a/cspell.yaml b/cspell.yaml
@@ -99,6 +99,7 @@ words:
   - noprefix
   - nriq
   - nrql
+  - objectimpl
   - opentsdb
   - opsgenie
   - pagerduty
@@ -133,6 +134,7 @@ words:
   - timeseries
   - timeslice
   - timeslices
+  - tmpl
   - tpng
   - tsdb
   - twindow

diff --git a/internal/cmd/objectimpl/README.md b/internal/cmd/objectimpl/README.md
@@ -0,0 +1,16 @@
+# docgen
+
+`objectimpl` is a tool that generates boilerplate functions for manifest objects
+in order to implement `manifest.Object` interface.
+
+It utilizes `text/template` to generate the code.
+
+## Usage
+
+Add the following `generate` directive to the file that contains
+the `manifest.Object` object definition.
+Replace the `<OBJECT_KIND>` with the struct name of your object, e.g. `Project`.
+
+```go
+//go:generate go run ../../../internal/cmd/objectimpl <OBJECT_KIND>
+```
diff --git a/scripts/generate-object-impl.go → internal/cmd/objectimpl/main.go b/scripts/generate-object-impl.go → internal/cmd/objectimpl/main.go
@@ -15,7 +15,7 @@ import (
 	"unicode"
 )
 
-//go:embed generate-object-impl.tpl
+//go:embed object.tmpl
 var templateStr string
 
 type generator struct {
@@ -80,7 +80,7 @@ func main() {
 		errFatal(err.Error())
 	}
 	outputName := filepath.Join(cwd, fmt.Sprintf("%s_object.go", strings.TrimSuffix(filename, ".go")))
-	if err = os.WriteFile(outputName, formatted, 0600); err != nil {
+	if err = os.WriteFile(outputName, formatted, 0o600); err != nil {
 		errFatal(err.Error())
 	}
 }
@@ -168,11 +168,7 @@ func (g *generator) hasOrganizationAndManifestSource(fields *ast.FieldList) bool
 	return hasOrganization && hasManifestSource
 }
 
-func errFatal(f string, a ...interface{}) {
-	if len(a) == 0 {
-		fmt.Fprintln(os.Stderr, f)
-	} else {
-		fmt.Fprintf(os.Stderr, f+"\n", a...)
-	}
+func errFatal(f string) {
+	fmt.Fprintln(os.Stderr, f)
 	os.Exit(1)
 }
diff --git a/scripts/generate-object-impl.tpl → internal/cmd/objectimpl/object.tmpl b/scripts/generate-object-impl.tpl → internal/cmd/objectimpl/object.tmpl
diff --git a/manifest/v1alpha/agent/agent.go b/manifest/v1alpha/agent/agent.go
@@ -7,7 +7,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go Agent
+//go:generate go run ../../../internal/cmd/objectimpl Agent
 
 // New creates new Agent instance.
 func New(metadata Metadata, spec Spec) Agent {

diff --git a/manifest/v1alpha/agent/agent_object.go b/manifest/v1alpha/agent/agent_object.go
diff --git a/manifest/v1alpha/alert/alert.go b/manifest/v1alpha/alert/alert.go
@@ -5,7 +5,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go Alert
+//go:generate go run ../../../internal/cmd/objectimpl Alert
 
 // New creates a new Alert based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) Alert {

diff --git a/manifest/v1alpha/alert/alert_object.go b/manifest/v1alpha/alert/alert_object.go
diff --git a/manifest/v1alpha/alertmethod/alert_method.go b/manifest/v1alpha/alertmethod/alert_method.go
@@ -4,7 +4,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go AlertMethod
+//go:generate go run ../../../internal/cmd/objectimpl AlertMethod
 
 // New creates a new AlertMethod based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) AlertMethod {

diff --git a/manifest/v1alpha/alertmethod/alert_method_object.go b/manifest/v1alpha/alertmethod/alert_method_object.go
diff --git a/manifest/v1alpha/alertpolicy/alert_policy.go b/manifest/v1alpha/alertpolicy/alert_policy.go
@@ -7,7 +7,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go AlertPolicy
+//go:generate go run ../../../internal/cmd/objectimpl AlertPolicy
 
 func New(metadata Metadata, spec Spec) AlertPolicy {
 	return AlertPolicy{

diff --git a/manifest/v1alpha/alertpolicy/alert_policy_object.go b/manifest/v1alpha/alertpolicy/alert_policy_object.go
diff --git a/manifest/v1alpha/alertsilence/alert_silence.go b/manifest/v1alpha/alertsilence/alert_silence.go
@@ -6,7 +6,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go AlertSilence
+//go:generate go run ../../../internal/cmd/objectimpl AlertSilence
 
 // New creates a new AlertSilence based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) AlertSilence {

diff --git a/manifest/v1alpha/alertsilence/alert_silence_object.go b/manifest/v1alpha/alertsilence/alert_silence_object.go
diff --git a/manifest/v1alpha/annotation/annotation.go b/manifest/v1alpha/annotation/annotation.go
@@ -6,7 +6,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go Annotation
+//go:generate go run ../../../internal/cmd/objectimpl Annotation
 
 // New creates a new Annotation based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) Annotation {

diff --git a/manifest/v1alpha/annotation/annotation_object.go b/manifest/v1alpha/annotation/annotation_object.go
diff --git a/manifest/v1alpha/budgetadjustment/budget_adjustment.go b/manifest/v1alpha/budgetadjustment/budget_adjustment.go
@@ -6,7 +6,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go BudgetAdjustment
+//go:generate go run ../../../internal/cmd/objectimpl BudgetAdjustment
 
 func New(metadata Metadata, spec Spec) BudgetAdjustment {
 	return BudgetAdjustment{

diff --git a/manifest/v1alpha/budgetadjustment/budget_adjustment_object.go b/manifest/v1alpha/budgetadjustment/budget_adjustment_object.go
diff --git a/manifest/v1alpha/dataexport/data_export.go b/manifest/v1alpha/dataexport/data_export.go
@@ -9,7 +9,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go DataExport
+//go:generate go run ../../../internal/cmd/objectimpl DataExport
 
 // New creates a new DataExport based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) DataExport {

diff --git a/manifest/v1alpha/dataexport/data_export_object.go b/manifest/v1alpha/dataexport/data_export_object.go
diff --git a/manifest/v1alpha/direct/direct.go b/manifest/v1alpha/direct/direct.go
@@ -7,7 +7,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go Direct
+//go:generate go run ../../../internal/cmd/objectimpl Direct
 
 func New(metadata Metadata, spec Spec) Direct {
 	return Direct{

diff --git a/manifest/v1alpha/direct/direct_object.go b/manifest/v1alpha/direct/direct_object.go
diff --git a/manifest/v1alpha/project/project.go b/manifest/v1alpha/project/project.go
@@ -5,7 +5,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go Project
+//go:generate go run ../../../internal/cmd/objectimpl Project
 
 // New creates a new Project based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) Project {

diff --git a/manifest/v1alpha/project/project_object.go b/manifest/v1alpha/project/project_object.go
diff --git a/manifest/v1alpha/rolebinding/role_binding.go b/manifest/v1alpha/rolebinding/role_binding.go
@@ -4,7 +4,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go RoleBinding
+//go:generate go run ../../../internal/cmd/objectimpl RoleBinding
 
 func New(metadata Metadata, spec Spec) RoleBinding {
 	return RoleBinding{

diff --git a/manifest/v1alpha/rolebinding/role_binding_object.go b/manifest/v1alpha/rolebinding/role_binding_object.go
diff --git a/manifest/v1alpha/service/service.go b/manifest/v1alpha/service/service.go
@@ -5,7 +5,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go Service
+//go:generate go run ../../../internal/cmd/objectimpl Service
 
 // New creates a new Service based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) Service {

diff --git a/manifest/v1alpha/service/service_object.go b/manifest/v1alpha/service/service_object.go
diff --git a/manifest/v1alpha/slo/slo.go b/manifest/v1alpha/slo/slo.go
@@ -5,7 +5,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest/v1alpha"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go SLO
+//go:generate go run ../../../internal/cmd/objectimpl SLO
 
 // New creates a new SLO based on provided Metadata nad Spec.
 func New(metadata Metadata, spec Spec) SLO {

diff --git a/manifest/v1alpha/slo/slo_object.go b/manifest/v1alpha/slo/slo_object.go
diff --git a/manifest/v1alpha/usergroup/user_group.go b/manifest/v1alpha/usergroup/user_group.go
@@ -4,7 +4,7 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-//go:generate go run ../../../scripts/generate-object-impl.go UserGroup
+//go:generate go run ../../../internal/cmd/objectimpl UserGroup
 
 func New(metadata Metadata, spec Spec) UserGroup {
 	return UserGroup{

diff --git a/manifest/v1alpha/usergroup/user_group_object.go b/manifest/v1alpha/usergroup/user_group_object.go