feat(events): add step to emit events to GCP

cmd/gcpPublishEvent.go

@@ -0,0 +1,100 @@
+package cmd
+
+import (
+	"fmt"
+
+	piperConfig "github.com/SAP/jenkins-library/pkg/config"
+	"github.com/SAP/jenkins-library/pkg/events"
+	"github.com/SAP/jenkins-library/pkg/gcp"
+	"github.com/SAP/jenkins-library/pkg/log"
+	"github.com/SAP/jenkins-library/pkg/orchestrator"
+	"github.com/SAP/jenkins-library/pkg/telemetry"
+	"github.com/cloudevents/sdk-go/v2/event"
+
+	"github.com/pkg/errors"
+)
+
+func gcpPublishEvent(config gcpPublishEventOptions, telemetryData *telemetry.CustomData) {
+	err := runGcpPublishEvent(&config, telemetryData)
+	if err != nil {
+		log.Entry().WithError(err).Fatal("step execution failed")
+	}
+}
+
+func runGcpPublishEvent(config *gcpPublishEventOptions, _ *telemetry.CustomData) error {
+	provider, _ := orchestrator.GetOrchestratorConfigProvider(nil)
+
+	var data []byte
+	var err error
+
+	switch config.Type {
+	case string(events.PipelineRunStartedEventType):
+		data, err = events.ToByteArray(event.EventContextV1{}, events.PipelineRunStartedEventData{
+			URL:           provider.BuildURL(),
+			CommitId:      provider.CommitSHA(),
+			RepositoryURL: provider.RepoURL(),
+		})
+	case string(events.PipelineRunFinishedEventType):
+		data, err = events.ToByteArray(event.EventContextV1{}, events.PipelineRunFinishedEventData{
+			URL:           provider.BuildURL(),
+			CommitId:      provider.CommitSHA(),
+			RepositoryURL: provider.RepoURL(),
+			Outcome:       provider.BuildStatus(),
+		})
+	default:
+		return fmt.Errorf("event type %s not supported", config.Type)
+	}
+	if err != nil {
+		return errors.Wrap(err, "failed to create event data")
+	}
+
+	oidcToken, err := getOidcToken(config)
+	if err != nil {
+		return errors.Wrap(err, "failed to get OIDC token")
+	}
+
+	// get federated token
+	token, err := gcp.GetFederatedToken(config.GcpProjectNumber, config.GcpWorkloadIDentityPool, config.GcpWorkloadIDentityPoolProvider, oidcToken)
+	if err != nil {
+		return errors.Wrap(err, "failed to get federated token")
+	}
+
+	// publish event
+	err = gcp.Publish(config.GcpProjectNumber, config.Topic, token, data)
+	if err != nil {
+		return errors.Wrap(err, "failed to publish event")
+	}
+
+	log.Entry().Info("event published successfully!")
+
+	return nil
+}
+
+func getOidcToken(config *gcpPublishEventOptions) (string, error) {
+	vaultCreds := piperConfig.VaultCredentials{
+		AppRoleID:       GeneralConfig.VaultRoleID,
+		AppRoleSecretID: GeneralConfig.VaultRoleSecretID,
+		VaultToken:      GeneralConfig.VaultToken,
+	}
+	// GeneralConfig VaultServerURL and VaultNamespace are empty swicthing to stepConfig
+	var vaultConfig = map[string]interface{}{
+		"vaultServerUrl": config.VaultServerURL,
+		"vaultNamespace": config.VaultNamespace,
+	}
+
+	stepConfig := piperConfig.StepConfig{
+		Config: vaultConfig,
+	}
+	// Generating vault client
+	vaultClient, err := piperConfig.GetVaultClientFromConfig(stepConfig, vaultCreds)
+	if err != nil {
+		return "", errors.Wrap(err, "getting vault client failed")
+	}
+	// Getting oidc token and setting it in environment variable
+	token, err := vaultClient.GetOidcTokenByValidation(GeneralConfig.HookConfig.OidcConfig.RoleID)
+	if err != nil {
+		return "", errors.Wrap(err, "getting oidc token failed")
+	}
+
+	return token, nil
+}

cmd/gcpPublishEvent_generated_test.go

@@ -0,0 +1,20 @@
+//go:build unit
+// +build unit
+
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGcpPublishEventCommand(t *testing.T) {
+	t.Parallel()
+
+	testCmd := GcpPublishEventCommand()
+
+	// only high level testing performed - details are tested in step generation procedure
+	assert.Equal(t, "gcpPublishEvent", testCmd.Use, "command name incorrect")
+
+}

cmd/piper.go

@@ -54,6 +54,7 @@ type HookConfiguration struct {
 	SentryConfig SentryConfiguration `json:"sentry,omitempty"`
 	SplunkConfig SplunkConfiguration `json:"splunk,omitempty"`
 	PendoConfig  PendoConfiguration  `json:"pendo,omitempty"`
+	OidcConfig   OidcConfiguration   `json:"oidc,omitempty"`
 }
 
 // SentryConfiguration defines the configuration options for the Sentry logging system
@@ -76,6 +77,11 @@ type PendoConfiguration struct {
 	Token string `json:"token,omitempty"`
 }
 
+// OidcConfiguration defines the configuration options for the OpenID Connect authentication system
+type OidcConfiguration struct {
+	RoleID string `json:",roleID,omitempty"`
+}
+
 var rootCmd = &cobra.Command{
 	Use:   "piper",
 	Short: "Executes CI/CD steps from project 'Piper' ",
@@ -92,6 +98,7 @@ var GeneralConfig GeneralConfigOptions
 func Execute() {
 	log.Entry().Infof("Version %s", GitCommit)
 
+	rootCmd.AddCommand(GcpPublishEventCommand())
 	rootCmd.AddCommand(ArtifactPrepareVersionCommand())
 	rootCmd.AddCommand(ConfigCommand())
 	rootCmd.AddCommand(DefaultsCommand())