VYGR-391: Add opsgenie integrations to notifications

cmd/synchronization/app/BUILD.bazel

@@ -14,6 +14,7 @@ go_library(
         "//pkg/composition/client:go_default_library",
         "//pkg/k8s:go_default_library",
         "//pkg/k8s/updater:go_default_library",
+        "//pkg/opsgenie:go_default_library",
         "//pkg/options:go_default_library",
         "//pkg/releases:go_default_library",
         "//pkg/releases/deployinator/client:go_default_library",

cmd/synchronization/app/controller_constructor.go

@@ -7,6 +7,7 @@ import (
 	comp_v1_client "github.com/atlassian/voyager/pkg/composition/client"
 	"github.com/atlassian/voyager/pkg/k8s"
 	"github.com/atlassian/voyager/pkg/k8s/updater"
+	"github.com/atlassian/voyager/pkg/opsgenie"
 	"github.com/atlassian/voyager/pkg/releases"
 	"github.com/atlassian/voyager/pkg/releases/deployinator/client"
 	"github.com/atlassian/voyager/pkg/servicecentral"
@@ -79,6 +80,10 @@ func (cc *ControllerConstructor) New(config *ctrl.Config, cctx *ctrl.Context) (*
 	scHTTPClient := util.HTTPClient()
 	scClient := servicecentral.NewServiceCentralClient(config.Logger, scHTTPClient, opts.ASAPClientConfig, opts.Providers.ServiceCentralURL)
 
+	// create a client for talking to Opsgenie Integration Manager
+	ogHTTPClient := util.HTTPClient()
+	ogClient := opsgenie.New(config.Logger, ogHTTPClient, opts.ASAPClientConfig, opts.Providers.OpsgenieIntegrationsManagerURL)
+
 	scErrorCounter := prometheus.NewCounter(
 		prometheus.CounterOpts{
 			Namespace: config.AppName,
@@ -133,6 +138,7 @@ func (cc *ControllerConstructor) New(config *ctrl.Config, cctx *ctrl.Context) (*
 		ServiceCentral:    servicecentral.NewStore(config.Logger, scClient),
 		ReleaseManagement: releases.NewReleaseManagement(deployinatorHTTPClient, config.Logger),
 		ClusterLocation:   opts.Location.ClusterLocation(),
+		Opsgenie:          ogClient,
 
 		ConfigMapUpdater:          configMapObjectUpdater,
 		RoleBindingUpdater:        roleBindingObjectUpdater,

cmd/synchronization/app/options.go

@@ -21,15 +21,17 @@ type Options struct {
 }
 
 type Providers struct {
-	ServiceCentralURL *url.URL // we use custom json marshalling to read it
-	DeployinatorURL   *url.URL
+	ServiceCentralURL              *url.URL // we use custom json marshalling to read it
+	DeployinatorURL                *url.URL
+	OpsgenieIntegrationsManagerURL *url.URL
 }
 
 // UnmarshalJSON unmarshals our untyped config file into a typed struct including URLs
 func (p *Providers) UnmarshalJSON(data []byte) error {
 	var rawProviders struct {
-		ServiceCentral string `json:"serviceCentral"`
-		Deployinator   string `json:"deployinator"`
+		ServiceCentral              string `json:"serviceCentral"`
+		Deployinator                string `json:"deployinator"`
+		OpsgenieIntegrationsManager string `json:"opsgenieIntegrationsManager"`
 	}
 
 	if err := json.Unmarshal(data, &rawProviders); err != nil {
@@ -43,7 +45,17 @@ func (p *Providers) UnmarshalJSON(data []byte) error {
 	}
 	depURL, err := url.Parse(rawProviders.Deployinator)
 	p.DeployinatorURL = depURL
-	return errors.Wrap(err, "unable to parse Deployinator URL")
+	if err != nil {
+		return errors.Wrap(err, "unable to parse Deployinator URL")
+	}
+
+	ogUrl, err := url.Parse(rawProviders.OpsgenieIntegrationsManager)
+	if err != nil {
+		return errors.Wrap(err, "unable to parse Opsgenie Integrations Manager URL")
+	}
+	p.OpsgenieIntegrationsManagerURL = ogUrl
+
+	return nil
 }
 
 func (o *Options) DefaultAndValidate() []error {
@@ -54,6 +66,10 @@ func (o *Options) DefaultAndValidate() []error {
 		allErrors = append(allErrors, errors.New("providers.serviceCentral must be a valid URL"))
 	}
 
+	if o.Providers.OpsgenieIntegrationsManagerURL == nil {
+		allErrors = append(allErrors, errors.New("providers.OpsgenieIntegrationsManagerURL must be a valid URL"))
+	}
+
 	return allErrors
 }
 

pkg/apis/creator/v1/types.go

@@ -59,6 +59,7 @@ func (ss *ServiceSpec) EmailAddress() string {
 // +k8s:deepcopy-gen=true
 type ServiceMetadata struct {
 	PagerDuty *PagerDutyMetadata `json:"pagerDuty,omitempty"`
+	Opsgenie  *OpsgenieMetadata  `json:"opsgenie,omitempty"`
 	Bamboo    *BambooMetadata    `json:"bamboo,omitempty"`
 }
 
@@ -100,6 +101,10 @@ type PagerDutyIntegrationMetadata struct {
 	IntegrationKey string `json:"integrationKey,omitempty"`
 }
 
+type OpsgenieMetadata struct {
+	Team string `json:"team,omitempty"`
+}
+
 // +k8s:deepcopy-gen=true
 type Compliance struct {
 	PRGBControl *bool `json:"prgbControl,omitempty"`

pkg/apis/orchestration/meta/BUILD.bazel

@@ -5,5 +5,8 @@ go_library(
     srcs = ["types.go"],
     importpath = "github.com/atlassian/voyager/pkg/apis/orchestration/meta",
     visibility = ["//visibility:public"],
-    deps = ["//:go_default_library"],
+    deps = [
+        "//:go_default_library",
+        "//pkg/opsgenie:go_default_library",
+    ],
 )

pkg/apis/orchestration/meta/types.go

@@ -1,6 +1,9 @@
 package meta
 
-import "github.com/atlassian/voyager"
+import (
+	"github.com/atlassian/voyager"
+	"github.com/atlassian/voyager/pkg/opsgenie"
+)
 
 const (
 	ConfigMapConfigKey = "config"
@@ -27,9 +30,10 @@ type ServiceProperties struct {
 
 // Notification is used in the ServiceProperties.
 type Notifications struct {
-	Email                        string    `json:"email"`
-	LowPriorityPagerdutyEndpoint PagerDuty `json:"lowPriority"`
-	PagerdutyEndpoint            PagerDuty `json:"main"`
+	Email                        string                 `json:"email"`
+	LowPriorityPagerdutyEndpoint PagerDuty              `json:"lowPriority"`
+	PagerdutyEndpoint            PagerDuty              `json:"main"`
+	OpsgenieIntegrations         []opsgenie.Integration `json:"opsgenieIntegrations"`
 }
 
 // PagerDuty is used in the ServiceProperties.

pkg/opsgenie/client.go

@@ -41,7 +41,7 @@ func New(logger *zap.Logger, httpClient *http.Client, asap pkiutil.ASAP, baseURL
 	}
 }
 
-// Gets OpsGenie integrations
+// Gets Opsgenie integrations
 // return codes:
 // - 400: Bad request to Opsgenie
 // - 401: Unauthorized

pkg/opsgenie/client_test.go

@@ -33,7 +33,7 @@ func TestGetIntegrations(t *testing.T) {
 	defer ogIntManagerMockServer.Close()
 
 	// when
-	ogIntManagerClient := mockOpsGenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
+	ogIntManagerClient := mockOpsgenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
 	_, retriable, err := ogIntManagerClient.GetOrCreateIntegrations(context.Background(), teamName)
 
 	// then
@@ -58,7 +58,7 @@ func TestGetIntegrationsTeamNotFound(t *testing.T) {
 	defer ogIntManagerMockServer.Close()
 
 	// when
-	ogIntManagerClient := mockOpsGenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
+	ogIntManagerClient := mockOpsgenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
 	_, retriable, err := ogIntManagerClient.GetOrCreateIntegrations(context.Background(), teamName)
 
 	// then
@@ -83,7 +83,7 @@ func TestGetIntegrationsRateLimited(t *testing.T) {
 	defer ogIntManagerMockServer.Close()
 
 	// when
-	ogIntManagerClient := mockOpsGenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
+	ogIntManagerClient := mockOpsgenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
 	_, retriable, err := ogIntManagerClient.GetOrCreateIntegrations(context.Background(), teamName)
 
 	// then
@@ -108,7 +108,7 @@ func TestGetIntegrationsInternalServerError(t *testing.T) {
 	defer ogIntManagerMockServer.Close()
 
 	// when
-	ogIntManagerClient := mockOpsGenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
+	ogIntManagerClient := mockOpsgenieIntegrationManagerClient(t, ogIntManagerMockServer.URL, pkitest.MockASAPClientConfig(t))
 	_, retriable, err := ogIntManagerClient.GetOrCreateIntegrations(context.Background(), teamName)
 
 	// then
@@ -117,7 +117,7 @@ func TestGetIntegrationsInternalServerError(t *testing.T) {
 	require.True(t, retriable)
 }
 
-func mockOpsGenieIntegrationManagerClient(t *testing.T, serverMockAddress string, asap pkiutil.ASAP) *Client {
+func mockOpsgenieIntegrationManagerClient(t *testing.T, serverMockAddress string, asap pkiutil.ASAP) *Client {
 	opsgenieIntegrationManagerURL, err := url.Parse(serverMockAddress)
 	require.NoError(t, err)
 	httpClient := util.HTTPClient()

pkg/opsgenie/it/client_manual_test.go

@@ -17,7 +17,7 @@ import (
 )
 
 const (
-	opsGenieIntManURL = "https://micros.prod.atl-paas.net"
+	opsgenieIntManURL = "https://micros.prod.atl-paas.net"
 )
 
 // NOTE: THIS WILL CREATE INTEGRATIONS IF NONE EXIST
@@ -32,7 +32,7 @@ func TestGetIntegrations(t *testing.T) {
 	require.NoError(t, asapErr)
 
 	client := util.HTTPClient()
-	c := opsgenie.New(testLogger, client, asapConfig, parseURL(t, opsGenieIntManURL))
+	c := opsgenie.New(testLogger, client, asapConfig, parseURL(t, opsgenieIntManURL))
 
 	// Get Service Attributes
 	resp, _, err := c.GetOrCreateIntegrations(ctx, "Platform SRE")

pkg/opsgenie/types.go

@@ -5,13 +5,22 @@ type IntegrationsResponse struct {
 }
 
 type Integration struct {
-	ID       string `json:"id"`
-	Name     string `json:"name"`
-	Type     string `json:"type"`
-	TeamID   string `json:"teamId"`
-	TeamName string `json:"teamName"`
-	Priority string `json:"priority"`
-	APIKey   string `json:"apiKey"`
-	Endpoint string `json:"endpoint"`
-	EnvType  string `json:"envType"`
+	ID       string  `json:"id"`
+	Name     string  `json:"name"`
+	Type     string  `json:"type"`
+	TeamID   string  `json:"teamId"`
+	TeamName string  `json:"teamName"`
+	Priority string  `json:"priority"`
+	APIKey   string  `json:"apiKey"`
+	Endpoint string  `json:"endpoint"`
+	EnvType  EnvType `json:"envType"`
 }
+
+type EnvType string
+
+const (
+	EnvTypeDev     EnvType = "dev"
+	EnvTypeStaging EnvType = "staging"
+	EnvTypeProd    EnvType = "prod"
+	EnvTypeGlobal  EnvType = "null" // Intentionally a string called "null" as this is the expected result from opsgenie int manager
+)

pkg/servicecentral/client.go

@@ -300,14 +300,8 @@ func (c *Client) GetService(ctx context.Context, user auth.OptionalUser, service
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to get attributes for service")
 	}
-	ogTeamAttr, found, err := findOpsGenieTeamServiceAttribute(resp)
-	if err != nil {
-		return nil, errors.Wrap(err, "failed to get OpsGenie attributes for service")
-	}
 
-	if found {
-		service.Attributes = append(service.Attributes, ogTeamAttr)
-	}
+	service.Attributes = resp
 
 	return service, nil
 }
@@ -344,7 +338,8 @@ func (c *Client) DeleteService(ctx context.Context, user auth.User, serviceUUID
 }
 
 // GetServiceAttributes queries service central for the attributes of a given service. Can return an empty array if no attributes were found
-func (c *Client) GetServiceAttributes(ctx context.Context, user auth.OptionalUser, serviceUUID string) ([]ServiceAttributeResponse, error) {
+func (c *Client) GetServiceAttributes(ctx context.Context, user auth.OptionalUser, serviceUUID string) ([]ServiceAttribute, error) {
+	var svcAttrResp []ServiceAttribute
 	req, err := c.rm.NewRequest(
 		pkiutil.AuthenticateWithASAP(c.asap, asapAudience, user.NameOrElse(noUser)),
 		restclient.Method(http.MethodGet),
@@ -353,32 +348,31 @@ func (c *Client) GetServiceAttributes(ctx context.Context, user auth.OptionalUse
 		restclient.Header("Accept", "application/json"),
 	)
 	if err != nil {
-		return nil, errors.Wrap(err, "failed to create get service attributes request")
+		return svcAttrResp, errors.Wrap(err, "failed to create get service attributes request")
 	}
 
 	response, err := c.httpClient.Do(req)
 	if err != nil {
-		return nil, errors.Wrap(err, "failed to execute get service attributes request")
+		return svcAttrResp, errors.Wrap(err, "failed to execute get service attributes request")
 	}
 
 	defer util.CloseSilently(response.Body)
 	respBody, err := ioutil.ReadAll(response.Body)
 	if err != nil {
-		return nil, errors.Wrap(err, "failed to read response body")
+		return svcAttrResp, errors.Wrap(err, "failed to read response body")
 	}
 
 	if response.StatusCode != http.StatusOK {
 		message := fmt.Sprintf("failed to get attributes for service %q. Response: %s", serviceUUID, respBody)
-		return nil, clientError(response.StatusCode, message)
+		return svcAttrResp, clientError(response.StatusCode, message)
 	}
 
-	var parsedBody []ServiceAttributeResponse
-	err = json.Unmarshal(respBody, &parsedBody)
+	err = json.Unmarshal(respBody, &svcAttrResp)
 	if err != nil {
-		return nil, errors.Wrap(err, "failed to unmarshal response body")
+		return svcAttrResp, errors.Wrap(err, "failed to unmarshal response body")
 	}
 
-	return parsedBody, nil
+	return svcAttrResp, nil
 }
 
 func clientError(statusCode int, message string) error {
@@ -445,27 +439,28 @@ func convertV2ServiceToV1(v2Service V2Service) ServiceDataRead {
 	return service
 }
 
-func findOpsGenieTeamServiceAttribute(attributes []ServiceAttributeResponse) (ServiceAttribute, bool /*found*/, error) {
-	const opsGenieSchemaName = "opsgenie"
+// findOpsgenieAttribute searches a given list of ServiceAttributes for a single OpsgenieAttribute
+func findOpsgenieAttribute(attributes []ServiceAttribute) (OpsgenieAttribute, bool /*found*/, error) {
+	const opsgenieSchemaName = "opsgenie"
 	count := 0
 	found := false
-	ogTeamAttr := ServiceAttribute{}
+	ogTeamAttr := OpsgenieAttribute{}
 	for _, attr := range attributes {
-		if attr.Schema.Name != opsGenieSchemaName {
+		if attr.Schema.Name != opsgenieSchemaName {
 			continue
 		}
 
 		team, ok := attr.Value["team"]
 		if !ok {
-			return ogTeamAttr, found, errors.Errorf("expected to find team name within schema of name %q", opsGenieSchemaName)
+			return ogTeamAttr, found, errors.Errorf("expected to find team name within schema of name %q", opsgenieSchemaName)
 		}
 
-		ogTeamAttr = ServiceAttribute{Team: team}
+		ogTeamAttr = OpsgenieAttribute{Team: team}
 		found = true
 		count++
 	}
 	if count > 1 {
-		return ogTeamAttr, found, errors.New("found more than one OpsGenie service attribute")
+		return ogTeamAttr, found, errors.New("found more than one Opsgenie service attribute")
 	}
 	return ogTeamAttr, found, nil
 }