Sent analytics when a service is deployed

When a service is successfuly deployed a telemetry event is sent
with the service information

[#161153365]

Author: joaopapereira

cfanalytics/cfanalytics.go

@@ -19,6 +19,7 @@ const (
 	BOSH_ENV         = "bosh"
 	ERROR            = "error"
 	UNINSTALL        = "uninstall"
+	DEPLOY_SERVICE   = "deployed service"
 )
 
 //go:generate mockgen -package mocks -destination mocks/analytics_client.go gopkg.in/segmentio/analytics-go.v3 Client

cmd/deploy-service/deploy_service.go

@@ -1,6 +1,7 @@
 package deploy_service
 
 import (
+	"code.cloudfoundry.org/cfdev/cfanalytics"
 	"code.cloudfoundry.org/cfdev/config"
 	e "code.cloudfoundry.org/cfdev/errors"
 	"code.cloudfoundry.org/cfdev/metadata"
@@ -31,6 +32,11 @@ type Provisioner interface {
 	GetWhiteListedService(string, []provision.Service) (*provision.Service, error)
 }
 
+//go:generate mockgen -package mocks -destination mocks/analytics.go code.cloudfoundry.org/cfdev/cmd/stop Analytics
+type Analytics interface {
+	Event(event string, data ...map[string]interface{}) error
+}
+
 const compatibilityVersion = "v3"
 
 type DeployService struct {
@@ -39,6 +45,7 @@ type DeployService struct {
 	Provisioner    Provisioner
 	MetaDataReader MetaDataReader
 	Config         config.Config
+	Analytics      Analytics
 }
 
 type Args struct {
@@ -95,5 +102,8 @@ func (c *DeployService) Execute(args Args) error {
 		return e.SafeWrap(err, "Failed to deploy services")
 	}
 
+	extraProperties := map[string]interface{}{"name": args.Service}
+	c.Analytics.Event(cfanalytics.DEPLOY_SERVICE, extraProperties)
+
 	return nil
 }

cmd/deploy-service/deploy_service_test.go

@@ -19,13 +19,15 @@ var _ = Describe("DeployService", func() {
 		mockMetadataReader *mocks.MockMetaDataReader
 		mockProvisioner    *mocks.MockProvisioner
 		mockUI             *mocks.MockUI
+		mockAnalytics      *mocks.MockAnalytics
 		cmd                *deploy_service.DeployService
 	)
 	BeforeEach(func() {
 		mockController = gomock.NewController(GinkgoT())
 		mockUI = mocks.NewMockUI(mockController)
 		mockMetadataReader = mocks.NewMockMetaDataReader(mockController)
 		mockProvisioner = mocks.NewMockProvisioner(mockController)
+		mockAnalytics = mocks.NewMockAnalytics(mockController)
 
 		cmd = &deploy_service.DeployService{
 			UI:             mockUI,
@@ -34,6 +36,7 @@ var _ = Describe("DeployService", func() {
 			Config: config.Config{
 				CacheDir: "some-cache-dir",
 			},
+			Analytics:      mockAnalytics,
 		}
 	})
 
@@ -48,11 +51,13 @@ var _ = Describe("DeployService", func() {
 				Version:  "v3",
 				Services: []provision.Service{service},
 			}, nil)
+
 			mockProvisioner.EXPECT().Ping().Return(nil)
 			mockProvisioner.EXPECT().GetWhiteListedService("some-service", []provision.Service{service}).Return(&service, nil)
-
 			mockProvisioner.EXPECT().DeployServices(mockUI, []provision.Service{service}).Return(nil)
 
+			mockAnalytics.EXPECT().Event("deployed service", map[string]interface{}{"name": "some-service"})
+
 			err := cmd.Execute(deploy_service.Args{
 				Service: "some-service",
 			})

cmd/deploy-service/mocks/analytics.go

@@ -184,6 +184,7 @@ func NewRoot(exit chan struct{}, ui UI, config config.Config, analyticsClient An
 			UI:             ui,
 			Provisioner:    provision.NewController(config),
 			MetaDataReader: metaDataReader,
+			Analytics:      analyticsClient,
 			Config:         config,
 		},
 	} {

cmd/root_darwin.go

@@ -192,6 +192,7 @@ func NewRoot(exit chan struct{}, ui UI, config config.Config, analyticsClient An
 			Provisioner:    provision.NewController(config),
 			MetaDataReader: metaDataReader,
 			Config:         config,
+			Analytics:      analyticsClient,
 		},
 	} {
 		dev.AddCommand(cmd.Cmd())