refactor(scaffolding): update CDK Go scaffolding (#1463)

* refactor(scaffolding): update CDK Go scaffolding

Adhere to golang project layout standards

Signed-off-by: Timothy MacDonald <[email protected]>

* refactor(scaffolding): change directory structure to match best practices

Signed-off-by: Timothy MacDonald <[email protected]>

* refactor(scaffolding): update CDK Go scaffolding

Update to match project structure best practices and add internals

Signed-off-by: Timothy MacDonald <[email protected]>

* refactor(typo): change comment

Signed-off-by: Timothy MacDonald <[email protected]>

* refactor(comments): fix comments

Signed-off-by: Timothy MacDonald <[email protected]>

* refactor: change case of README.md

Signed-off-by: Timothy MacDonald <[email protected]>

* refactor: fix case of README.md

Signed-off-by: Timothy MacDonald <[email protected]>

---------

Signed-off-by: Timothy MacDonald <[email protected]>

Author: Timothy MacDonald

internal/databox/blob.go

@@ -7,9 +7,9 @@ COVERAGEHTML?=coverage.html
 GOJUNITOUT?=go-junit.xml
 PACKAGENAME?=[[.Component]]
 CLINAME?=lacework
-GO_LDFLAGS="-X github.com/lacework/go-sdk/cli/cmd.Version=$(shell cat VERSION) \
-            -X github.com/lacework/go-sdk/cli/cmd.GitSHA=$(shell git rev-parse HEAD) \
-            -X github.com/lacework/go-sdk/cli/cmd.BuildTime=$(shell date +%Y%m%d%H%M%S)"
+GO_LDFLAGS="-X [[.Component]]/internal/version.Version=$(shell cat VERSION) \
+            -X [[.Component]]/internal/version.GitSHA=$(shell git rev-parse HEAD) \
+            -X [[.Component]]/internal/version..BuildTime=$(shell date +%Y%m%d%H%M%S)"
 GOFLAGS=-mod=vendor
 CGO_ENABLED?=0
 export GOFLAGS GO_LDFLAGS CGO_ENABLED

internal/databox/static/scaffoldings/golang/Makefile

@@ -0,0 +1,3 @@
+# `/cmd`
+
+Main applications for this project.

internal/databox/static/scaffoldings/golang/cmd/README.md

@@ -1,6 +1,6 @@
 module [[.Component]]
 
-go 1.18
+go 1.20
 
 require (
 	github.com/spf13/cobra v1.6.1

internal/databox/static/scaffoldings/golang/go.mod

@@ -0,0 +1,3 @@
+# `/internal`
+
+Private application and library code. This is the code you don't want others importing in their applications or libraries.

internal/databox/static/scaffoldings/golang/internal/README.md

@@ -0,0 +1,34 @@
+//
+// Copyright:: Copyright 2023, Lacework Inc.
+// License:: Apache License, Version 2.0
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+package logger
+
+import (
+	"os"
+
+	"github.com/lacework/go-sdk/lwlogger"
+)
+
+// Log allows this component to leverage our Go-SDK lwlogger
+//
+// Example:
+//
+//	import "[[.Component]]/internal/logger"
+//	logger.Log.Info("an informational message")
+//	logger.Log.Debug("a debug message")
+//	logger.Log.Infow("info message with variables", "foo", "bar")
+var Log = lwlogger.New(os.Getenv("LW_LOG")).Sugar()

internal/databox/static/scaffoldings/golang/internal/logger/logger.go

@@ -0,0 +1,73 @@
+package metric
+
+import (
+	"context"
+	"os"
+
+	"[[.Component]]/internal/logger"
+	"[[.Component]]/internal/version"
+
+	cdk "github.com/lacework/go-sdk/cli/cdk/go/proto/v1"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
+)
+
+var cdkClient cdk.CoreClient
+
+func init() {
+	// Set up a connection to the CDK server
+	logger.Log.Infow("connecting to gRPC server", "address", os.Getenv("LW_CDK_TARGET"))
+	conn, err := grpc.Dial(os.Getenv("LW_CDK_TARGET"),
+		// we allow insecure connections since we are connecting to 'localhost'
+		grpc.WithTransportCredentials(insecure.NewCredentials()))
+	if err != nil {
+		logger.Log.Warn("Cannot initialize CDK client", "error", err.Error())
+	} else {
+		cdkClient = cdk.NewCoreClient(conn)
+	}
+}
+
+func SendMetricData(feature string, data map[string]string) {
+	if cdkClient == nil {
+		logger.Log.Warn("unable to send telemetry",
+			"type", "data",
+			"error", "client not initialized",
+		)
+		return
+	}
+
+	// add version
+	data["version"] = version.Version
+
+	go func() {
+		_, err := cdkClient.Honeyvent(context.Background(), &cdk.HoneyventRequest{
+			Feature: feature, FeatureData: data,
+		})
+		if err != nil {
+			logger.Log.Warn("unable to send telemetry",
+				"type", "data", "error", err.Error(),
+			)
+		}
+	}()
+}
+
+func SendMetricError(e error) {
+	if cdkClient == nil {
+		logger.Log.Warn("unable to send telemetry",
+			"type", "error",
+			"error", "client not initialized",
+		)
+		return
+	}
+
+	go func() {
+		_, err := cdkClient.Honeyvent(context.Background(), &cdk.HoneyventRequest{
+			Error: e.Error(),
+		})
+		if err != nil {
+			logger.Log.Warn("unable to send telemetry",
+				"type", "error", "error", err.Error(),
+			)
+		}
+	}()
+}

internal/databox/static/scaffoldings/golang/internal/metric/metric.go

@@ -0,0 +1,15 @@
+package version
+
+var (
+	// All the following "unknown" variables are being injected at
+	// build time via the cross-platform directive inside the Makefile
+	//
+	// Version is the semver coming from the VERSION file
+	Version = "unknown"
+
+	// GitSHA is the git ref that the cli was built from
+	GitSHA = "unknown"
+
+	// BuildTime is a human-readable time when the cli was built at
+	BuildTime = "unknown"
+)

internal/databox/static/scaffoldings/golang/internal/version/version.go

@@ -17,7 +17,9 @@
 
 package main
 
-import "[[.Component]]/cmd"
+import (
+	"[[.Component]]/cmd"
+)
 
 func main() {
 	cmd.Execute()

internal/databox/static/scaffoldings/golang/main.go

@@ -0,0 +1,3 @@
+# `/pkg`
+
+Library code that's ok to use by external applications (e.g., `/pkg/mypubliclib`).