Merge branch 'main' into PC-13028-support-for-azure-prometheus-direct

nobl9 · Jun 19, 2024 · 988294e · 988294e
2 parents aba3dce + cd7b62d
commit 988294e
Show file tree

Hide file tree

Showing 59 changed files with 163 additions and 56 deletions.
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -43,4 +43,5 @@ jobs:
           NOBL9_SDK_CLIENT_SECRET: ${{ secrets.clientSecret }}
           NOBL9_SDK_OKTA_ORG_URL: ${{ inputs.oktaOrgUrl }}
           NOBL9_SDK_OKTA_AUTH_SERVER: ${{ inputs.oktaAuthServer }}
+          NOBL9_SDK_NO_CONFIG_FILE: true
         run: make test/e2e
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/go.mod b/go.mod
@@ -6,7 +6,7 @@ require (
 	github.com/BurntSushi/toml v1.4.0
 	github.com/MicahParks/jwkset v0.5.18
 	github.com/MicahParks/keyfunc/v3 v3.3.3
-	github.com/aws/aws-sdk-go v1.53.20
+	github.com/aws/aws-sdk-go v1.54.3
 	github.com/bmatcuk/doublestar/v4 v4.6.1
 	github.com/goccy/go-yaml v1.11.3
 	github.com/golang-jwt/jwt/v5 v5.2.1

diff --git a/go.sum b/go.sum
@@ -4,8 +4,8 @@ github.com/MicahParks/jwkset v0.5.18 h1:WLdyMngF7rCrnstQxA7mpRoxeaWqGzPM/0z40PJU
 github.com/MicahParks/jwkset v0.5.18/go.mod h1:q8ptTGn/Z9c4MwbcfeCDssADeVQb3Pk7PnVxrvi+2QY=
 github.com/MicahParks/keyfunc/v3 v3.3.3 h1:c6j9oSu1YUo0k//KwF1miIQlEMtqNlj7XBFLB8jtEmY=
 github.com/MicahParks/keyfunc/v3 v3.3.3/go.mod h1:f/UMyXdKfkZzmBeBFUeYk+zu066J1Fcl48f7Wnl5Z48=
-github.com/aws/aws-sdk-go v1.53.20 h1:cYWPvZLP1gPj5CfUdnfjaaA7WFK3FGoJ/R9+Ks1inU4=
-github.com/aws/aws-sdk-go v1.53.20/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk=
+github.com/aws/aws-sdk-go v1.54.3 h1:Bk+EXoq6v5I1xmHR9GQGpsMWZZFXs+FD+5uPyEmfgX0=
+github.com/aws/aws-sdk-go v1.54.3/go.mod h1:eRwEWoyTWFMVYVQzKMNHWP5/RV4xIUGMQfXQHfHkpNU=
 github.com/bmatcuk/doublestar/v4 v4.6.1 h1:FH9SifrbvJhnlQpztAx++wlkk70QBf0iBWDwNy7PA4I=
 github.com/bmatcuk/doublestar/v4 v4.6.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

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
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "private": true,
   "type": "module",
   "devDependencies": {
-    "cspell": "8.8.4",
+    "cspell": "8.9.0",
     "markdownlint-cli": "0.41.0",
     "yaml": "2.4.5"
   },

diff --git a/sdk/parser.go → sdk/decode.go b/sdk/parser.go → sdk/decode.go
diff --git a/sdk/parser_test.go → sdk/decode_test.go b/sdk/parser_test.go → sdk/decode_test.go
@@ -17,8 +17,8 @@ import (
 	v1alphaService "github.com/nobl9/nobl9-go/manifest/v1alpha/service"
 )
 
-//go:embed test_data/parser
-var parserTestData embed.FS
+//go:embed test_data/decode
+var decodeTestData embed.FS
 
 func TestDecode(t *testing.T) {
 	for _, test := range []struct {
@@ -198,7 +198,7 @@ func TestDecodeSingle(t *testing.T) {
 
 func readInputFile(t *testing.T, name string) []byte {
 	t.Helper()
-	data, err := parserTestData.ReadFile(filepath.Join("test_data", "parser", name))
+	data, err := decodeTestData.ReadFile(filepath.Join("test_data", "decode", name))
 	require.NoError(t, err)
 	return data
 }
diff --git a/sdk/printer.go → sdk/encode.go b/sdk/printer.go → sdk/encode.go
@@ -10,17 +10,29 @@ import (
 	"github.com/nobl9/nobl9-go/manifest"
 )
 
-// PrintObjects prints objects to the given [io.Writer] in specified [manifest.ObjectFormat].
+// EncodeObjects writes objects to the given [io.Writer] in the specified [manifest.ObjectFormat].
+func EncodeObjects(objects []manifest.Object, out io.Writer, format manifest.ObjectFormat) error {
+	return encodeObjects(objects, out, format)
+}
+
+// EncodeObject writes a single object to the given [io.Writer] in the specified [manifest.ObjectFormat].
+func EncodeObject(object manifest.Object, out io.Writer, format manifest.ObjectFormat) error {
+	return encodeObjects(object, out, format)
+}
+
+// PrintObjects prints objects to the given [io.Writer] in the specified [manifest.ObjectFormat].
+// Deprecated: Use EncodeObjects instead.
 func PrintObjects(objects []manifest.Object, out io.Writer, format manifest.ObjectFormat) error {
-	return printObjects(objects, out, format)
+	return encodeObjects(objects, out, format)
 }
 
-// PrintObject prints a single object to the given [io.Writer] in specified [manifest.ObjectFormat].
+// PrintObject prints a single object to the given [io.Writer] in the specified [manifest.ObjectFormat].
+// Deprecated: Use EncodeObject instead.
 func PrintObject(object manifest.Object, out io.Writer, format manifest.ObjectFormat) error {
-	return printObjects(object, out, format)
+	return encodeObjects(object, out, format)
 }
 
-func printObjects(objects any, out io.Writer, format manifest.ObjectFormat) error {
+func encodeObjects(objects any, out io.Writer, format manifest.ObjectFormat) error {
 	switch format {
 	case manifest.ObjectFormatJSON:
 		enc := json.NewEncoder(out)