Publish analysis utils

PiperOrigin-RevId: 883189301

Author: cloud-deploy-samples-bot

analysis/util/alertwindow.go

@@ -0,0 +1,60 @@
+// Package analysisutil provides utility functions.
+package analysisutil
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"time"
+
+	cdenv "github.com/GoogleCloudPlatform/cloud-deploy-samples/packages/cdenv"
+	cdapi "google.golang.org/api/clouddeploy/v1"
+)
+
+// AlertTimeWindow holds the rollout start time and the end time to look for alerts (which is now).
+type AlertTimeWindow struct {
+	// StartTime is the start time of the alert window in RFC3339 format.
+	StartTime time.Time
+	// EndTime is the end time of the alert window in RFC3339 format.
+	EndTime time.Time
+}
+
+// TimeWindow returns the start time of the rollout as a string representing the number of
+// milliseconds since the Unix epoch (this is the time format expected by Datadog).
+func TimeWindow(ctx context.Context) (*AlertTimeWindow, error) {
+	// Construct the  rollout resource name.
+	projectID := os.Getenv(cdenv.ProjectIDEnvKey)
+	location := os.Getenv(cdenv.LocationEnvKey)
+	pipelineID := os.Getenv(cdenv.PipelineEnvKey)
+	releaseID := os.Getenv(cdenv.ReleaseEnvKey)
+	rolloutID := os.Getenv(cdenv.RolloutEnvKey)
+
+	rolloutName := fmt.Sprintf("projects/%s/locations/%s/deliveryPipelines/%s/releases/%s/rollouts/%s",
+		projectID, location, pipelineID, releaseID, rolloutID)
+
+	cdService, err := cdapi.NewService(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("unable to create Cloud Deploy API service: %v", err)
+	}
+
+	rollout, err := cdService.Projects.Locations.DeliveryPipelines.Releases.Rollouts.Get(rolloutName).Do()
+	if err != nil {
+		return nil, fmt.Errorf("unable to get rollout from Cloud Deploy API: %v", err)
+	}
+
+	parsedStartTime, err := time.Parse(time.RFC3339, rollout.DeployStartTime)
+	if err != nil {
+		return nil, fmt.Errorf("unable to convert start time to RFC3339 format in order to validate time")
+	}
+
+	endTime := time.Now().Format(time.RFC3339)
+	parsedEndTime, err := time.Parse(time.RFC3339, endTime)
+	if err != nil {
+		return nil, fmt.Errorf("unable to convert start time to RFC3339 format in order to validate time")
+	}
+	if parsedStartTime.After(parsedEndTime) {
+		return nil, fmt.Errorf("start time is after end time")
+	}
+
+	return &AlertTimeWindow{StartTime: parsedStartTime, EndTime: parsedEndTime}, nil
+}

analysis/util/gcs.go

@@ -0,0 +1,32 @@
+// Package analysisutil provides utilities for uploading analysis results to GCS.
+package analysisutil
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"cloud.google.com/go/storage"
+	cdenv "github.com/GoogleCloudPlatform/cloud-deploy-samples/packages/cdenv"
+	"github.com/GoogleCloudPlatform/cloud-deploy-samples/packages/gcs"
+)
+
+// AnalysisMetadata represents the Analysis result metadata that will be uploaded to GCS.
+type AnalysisMetadata struct {
+	// Metadata contains metadata associated with the analysis result.
+	Metadata map[string]string `json:"metadata,omitempty"`
+}
+
+// UploadResult uploads the result to GCS.
+func UploadResult(ctx context.Context, analysisMetadata *AnalysisMetadata, client *storage.Client) error {
+	data, err := json.Marshal(analysisMetadata)
+	if err != nil {
+		return fmt.Errorf("failed to marshal analysis metadata: %v, error: %w", analysisMetadata, err)
+	}
+	// Get the GCS URI where the results file should be uploaded. The full path is in the format of
+	// {outputPath}/{gcs.ResultObjectSuffix}.
+	outputPath := os.Getenv(cdenv.OutputGCSEnvKey)
+	uri := fmt.Sprintf("%s/%s", outputPath, gcs.ResultObjectSuffix)
+	return gcs.Upload(ctx, client, uri, &gcs.UploadContent{Data: data})
+}