.github/renovate.json5

@@ -22,17 +22,16 @@
   "commitMessagePrefix": "chore:",
   // This will run go mod tidy after each go.mod update.
   "postUpdateOptions": ["gomodTidy"],
+  // Groups:
   "packageRules": [
-    // Groups:
     {
       "matchManagers": ["gomod"],
       "matchUpdateTypes": [
         "minor",
         "patch",
       ],
-      "groupName": "minor and patch golang dependencies",
+      "groupName": "minor and patch Golang dependencies",
     },
-    // Labels:
     {
       "matchManagers": ["github-actions"],
       "addLabels": ["github-actions"],
@@ -59,6 +58,5 @@
     "**/vendor/**",
     "**/node_modules/**",
     "**/test_data/**",
-    "examples/**",
   ]
 }

.github/scripts/release-notes.sh

@@ -22,10 +22,10 @@ extract_header() {
 	local commit="$1"
 	local header_name="$2"
 	awk "
-    /^\s?$/ {next}
+    /^\s?$/ {next};
     /^--+/ {rn=0};
     /^Signed-off-by|Co-authored-by/ {rn=0};
-    /^## $header_name/ {rn=1}
+    /^## $header_name/ {rn=1};
     rn && !/^##/ && !/^--+/ {print};
     /^##/ && !/^## $header_name/ {rn=0}" <<<"$commit"
 }

.github/workflows/e2e-tests-dispatch.yml

@@ -18,6 +18,11 @@ on:
         description: Okta authentication server identifier
         required: false
         type: string
+      sequentialApplyAndDelete:
+        description: Perform apply/delete requests sequentially
+        required: false
+        type: boolean
+        default: true
 jobs:
   test:
     uses: ./.github/workflows/e2e-tests.yml
@@ -26,5 +31,6 @@ jobs:
       ref: "${{ github.ref_name }}"
       oktaOrgUrl: "${{ inputs.oktaOrgUrl }}"
       oktaAuthServer: "${{ inputs.oktaAuthServer }}"
+      sequentialApplyAndDelete: "${{ inputs.sequentialApplyAndDelete }}"
     secrets:
       clientSecret: "${{ inputs.clientSecret }}"

.github/workflows/e2e-tests.yml

@@ -19,6 +19,11 @@ on:
         required: false
         type: string
         default: main
+      sequentialApplyAndDelete:
+        description: Whether to perform apply/delete requests sequentially
+        required: false
+        type: boolean
+        default: true
     secrets:
       clientSecret:
         description: Client secret to use for authentication
@@ -44,4 +49,5 @@ jobs:
           NOBL9_SDK_OKTA_ORG_URL: ${{ inputs.oktaOrgUrl }}
           NOBL9_SDK_OKTA_AUTH_SERVER: ${{ inputs.oktaAuthServer }}
           NOBL9_SDK_NO_CONFIG_FILE: true
+          NOBL9_SDK_TEST_RUN_SEQUENTIAL_APPLY_AND_DELETE: ${{ inputs.sequentialApplyAndDelete }}
         run: make test/e2e

.golangci.yml

@@ -22,8 +22,6 @@ issues:
     - linters:
         - revive
       text: "error-strings: error strings should not be capitalized or end with punctuation or a newline"
-  exclude-dirs:
-    - scripts
   # Value 0 means show all.
   max-issues-per-linter: 0
   max-same-issues: 0

Makefile

@@ -8,11 +8,11 @@ GO_ENUM_VERSION := v0.6.0
 # renovate datasource=github-releases depName=securego/gosec
 GOSEC_VERSION := v2.20.0
 # renovate datasource=github-releases depName=golangci/golangci-lint
-GOLANGCI_LINT_VERSION := v1.59.1
+GOLANGCI_LINT_VERSION := v1.60.1
 # renovate datasource=go depName=golang.org/x/vuln/cmd/govulncheck
 GOVULNCHECK_VERSION := v1.1.3
 # renovate datasource=go depName=golang.org/x/tools/cmd/goimports
-GOIMPORTS_VERSION := v0.23.0
+GOIMPORTS_VERSION := v0.24.0
 # renovate datasource=go depName=github.com/vburenin/ifacemaker
 IFACEMAKER_VERSION := v1.2.1
 
@@ -44,6 +44,9 @@ test:
 ## Run all end-to-end tests (requires Nobl9 platform credentials).
 test/e2e:
 	# The '-count=1' flag disables tests results caching, as per https://go.dev/doc/go1.10#test.
+	@if [ "$(GITHUB_ACTIONS)" != "true" ]; then \
+		export NOBL9_SDK_TEST_RUN_SEQUENTIAL_APPLY_AND_DELETE=true; \
+	fi; \
 	go test -count=1 -race -test.v -timeout=5m -tags=e2e_test ./tests
 
 ## Record tests and save them in ./bin/recorded-tests.json.
@@ -116,7 +119,7 @@ generate/code:
 	echo "Generating Go code..."
 	$(call _ensure_installed,binary,go-enum)
 	$(call _ensure_installed,binary,ifacemaker)
-	go generate ./... ./docs/mock_example
+	go generate -tags=e2e_test ./... ./docs/mock_example
 	${MAKE} format/go
 
 ## Generate examples from code.

cspell.yaml

@@ -68,8 +68,10 @@ words:
   - dynatrace
   - endef
   - enduml
+  - errgroup
   - examplegen
   - fatalf
+  - generify
   - gobin
   - gofile
   - goimports
@@ -113,9 +115,11 @@ words:
   - opentsdb
   - opsgenie
   - pagerduty
+  - pastlatest
   - pathutils
   - plantuml
   - preconfigured
+  - projectservice
   - promql
   - puml
   - retryable

docs/DEVELOPMENT.md

@@ -29,8 +29,7 @@ and makes local debugging easier.
 
 ## Testing
 
-Currently nobl9-go is automatically verified with unit tests only.
-It is encouraged to create a simple MVP program which verifies the introduced
+It is encouraged to create a simple MVP program which verifies that introduced
 changes work. There's a dedicated section in PR template `## Testing` which
 is a great place to add such `main.go` code snippet.
 Here's an example:
@@ -87,6 +86,20 @@ rules:
 If you wish to record the tests run `make test/record`.
 By default, the tests are recorded inside `./bin` folder.
 
+### End-to-end test
+
+Tests which are run against Nobl9 API are located under [tests](../tests/)
+folder.
+They are standard Go tests, annotated with build tag `e2e_test`, they can
+be executed with `make test/e2e`.
+In order to run them, a set of basic Nobl9 credentials is required:
+
+- *NOBL9_SDK_CLIENT_ID*
+- *NOBL9_SDK_CLIENT_SECRET*
+
+There's also a [dispatch action](https://github.com/nobl9/nobl9-go/actions/workflows/e2e-tests-dispatch.yml)
+available.
+
 ## Releases
 
 Refer to [RELEASE.md](./RELEASE.md) for more information on release process.
@@ -101,8 +114,13 @@ We use the following tools to do that:
   your own const-based enums. It can generate methods for decoding the custom
   type from and to string, so you can use the enum type directly in your
   struct.
-- [Our custom tool](scripts/generate-object-impl.go)
-  for generating `manifest.Object` methods implementation for all object kinds.
+- [objectimpl](../internal/cmd/objectimpl)
+  for generating `manifest.Object` implementation for all object kinds.
+- [docgen](../internal/cmd/docgen/)
+  for generating documentation based on validation rules, Go doc comments and
+  generate examples.
+- [examplegen](../internal/cmd/examplegen/)
+  for generating examples for each manifest object.
 
 ## Validation
 

docs/RELEASE.md

@@ -16,7 +16,7 @@ created. For example, If you end up changing PR title from `sec:` to `fix:`
 you'll have to manually remove `security` label.
 
 On each commit to `main` branch, Release Drafter will update the next release
-draft. Once you're ready to create new version, simply publish this draft.
+draft.
 
 In addition to Release Drafter, we're also running a script which extracts
 explicitly listed release notes and breaking changes which are optionally

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/stretchr/testify v1.9.0
 	github.com/teambition/rrule-go v1.8.2
 	golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8
+	golang.org/x/sync v0.7.0
 	golang.org/x/text v0.16.0
 	golang.org/x/time v0.5.0
 )

go.sum

@@ -57,6 +57,8 @@ golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A=
 golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
 golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8 h1:LoYXNGAShUG3m/ehNk4iFctuhGX/+R1ZpfJ4/ia80JM=
 golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8/go.mod h1:jj3sYF3dwk5D+ghuXyeI3r5MFf+NT2An6/9dOA95KSI=
+golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
+golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=

internal/cmd/docgen/README.md

@@ -6,6 +6,7 @@ It merges:
 - Go doc comments
 - [Validation plan](../../validation/plan.go)
 - Custom documentation and formatting
+- Generated examples
 
 into a single YAML file.
 

internal/cmd/docgen/object_doc.go

@@ -116,11 +116,32 @@ var validationInferredProperties = []struct {
 
 func readObjectExamples(root string, typ reflect.Type) []string {
 	relPath := strings.TrimPrefix(typ.PkgPath(), moduleRootPath)
-	objectPath := filepath.Join(root, relPath, "example.yaml")
+	examplesPath := filepath.Join(root, relPath, "examples.yaml")
 	// #nosec G304
-	data, err := os.ReadFile(objectPath)
+	data, err := os.ReadFile(examplesPath)
+	if err == nil {
+		return []string{string(data)}
+	}
+	if !os.IsNotExist(err) {
+		log.Panicf("failed to read examples for object, path: %s, err: %v", examplesPath, err)
+	}
+	examplesDirPath := filepath.Join(filepath.Dir(examplesPath), "examples")
+	dir, err := os.ReadDir(examplesDirPath)
 	if err != nil {
-		log.Panicf("failed to read examples for object, path: %s, err: %v", objectPath, err)
+		log.Panicf("failed to read examples for object, path: %s, err: %v", examplesDirPath, err)
+	}
+	examples := make([]string, 0, len(dir))
+	for _, entry := range dir {
+		if entry.IsDir() {
+			continue
+		}
+		path := filepath.Join(examplesDirPath, entry.Name())
+		// #nosec G304
+		data, err = os.ReadFile(path)
+		if err != nil {
+			log.Panicf("failed to read examples for object, path: %s, err: %v", path, err)
+		}
+		examples = append(examples, string(data))
 	}
-	return []string{string(data)}
+	return examples
 }

internal/cmd/docgen/objects.go

@@ -13,6 +13,7 @@ import (
 	v1alphaDataExport "github.com/nobl9/nobl9-go/manifest/v1alpha/dataexport"
 	v1alphaDirect "github.com/nobl9/nobl9-go/manifest/v1alpha/direct"
 	v1alphaProject "github.com/nobl9/nobl9-go/manifest/v1alpha/project"
+	v1alphaReport "github.com/nobl9/nobl9-go/manifest/v1alpha/report"
 	v1alphaRoleBinding "github.com/nobl9/nobl9-go/manifest/v1alpha/rolebinding"
 	v1alphaService "github.com/nobl9/nobl9-go/manifest/v1alpha/service"
 	v1alphaSLO "github.com/nobl9/nobl9-go/manifest/v1alpha/slo"
@@ -104,6 +105,12 @@ var objectsRegistry = []*ObjectDoc{
 		validationProperties: objectPlansToDocs(validation.Plan(v1alphaRoleBinding.RoleBinding{}.GetValidator())),
 		object:               v1alphaRoleBinding.RoleBinding{},
 	},
+	{
+		Kind:                 manifest.KindReport,
+		Version:              manifest.VersionV1alpha,
+		validationProperties: objectPlansToDocs(validation.Plan(v1alphaReport.Report{}.GetValidator())),
+		object:               v1alphaReport.Report{},
+	},
 }
 
 func objectPlansToDocs(plans []validation.PropertyPlan) []PropertyDoc {

internal/cmd/examplegen/README.md

@@ -0,0 +1,21 @@
+# examplegen
+
+`examplegen` is a tool that generates examples for manifest objects.
+
+These examples are usually stored in the `examples` directory of
+the respective object's package or in the object's package directory itself
+inside `examples.yaml` file.
+
+Each object can have its variants and sub-variants.
+Example of such distinction for SLO is Prometheus based SLO with
+_calendar aligned_ time window.
+Prometheus will be the variant and _calendar aligned_ time window
+will be the sub-variant.
+
+## Usage
+
+Run from the repository root's Makefile:
+
+```shell
+make generate/examples
+```

internal/cmd/examplegen/main.go

@@ -71,6 +71,7 @@ func getV1alphaExamplesConfigs() []examplesGeneratorConfig {
 		v1alphaExamples.BudgetAdjustment(),
 		v1alphaExamples.DataExport(),
 		v1alphaExamples.RoleBinding(),
+		v1alphaExamples.Report(),
 	}
 	for _, examples := range allExamples {
 		object := examples[0].GetObject().(manifest.Object)

internal/manifest/objects_test.go

@@ -2,6 +2,7 @@ package manifest
 
 import (
 	"context"
+	"os"
 	"path/filepath"
 	"testing"
 
@@ -17,7 +18,7 @@ import (
 
 func TestMain(m *testing.M) {
 	v1alphaParser.UseStrictDecodingMode = true
-	m.Run()
+	os.Exit(m.Run())
 }
 
 func TestObjectExamples(t *testing.T) {

internal/manifest/v1alpha/examples/agent.go

@@ -41,6 +41,8 @@ var betaChannelAgents = []v1alpha.DataSourceType{
 	v1alpha.LogicMonitor,
 	v1alpha.AzurePrometheus,
 	v1alpha.GCM,
+	// In order to use AWS cross-account o11y.
+	v1alpha.CloudWatch,
 }
 
 func (a agentExample) Generate() v1alphaAgent.Agent {