Deploy a service after cf dev is started

Add a `deploy-service` command that allow the user to deploy
a new white listed service to the current deployment.
CF Dev need to be started in order to execute this command

[#161153365]

Author: joaopapereira

cmd/deploy-service/deploy_service.go

@@ -0,0 +1,99 @@
+package deploy_service
+
+import (
+	"code.cloudfoundry.org/cfdev/config"
+	e "code.cloudfoundry.org/cfdev/errors"
+	"code.cloudfoundry.org/cfdev/metadata"
+	"code.cloudfoundry.org/cfdev/provision"
+	"fmt"
+	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
+	"io"
+	"os"
+	"path/filepath"
+)
+
+//go:generate mockgen -package mocks -destination mocks/ui.go code.cloudfoundry.org/cfdev/cmd/deploy-service UI
+type UI interface {
+	Say(message string, args ...interface{})
+	Writer() io.Writer
+}
+
+//go:generate mockgen -package mocks -destination mocks/metadata_reader.go code.cloudfoundry.org/cfdev/cmd/deploy-service MetaDataReader
+type MetaDataReader interface {
+	Read(tarballPath string) (metadata.Metadata, error)
+}
+
+//go:generate mockgen -package mocks -destination mocks/provisioner.go code.cloudfoundry.org/cfdev/cmd/deploy-service Provisioner
+type Provisioner interface {
+	Ping() error
+	DeployServices(provision.UI, []provision.Service) error
+	GetWhiteListedService(string, []provision.Service) (*provision.Service, error)
+}
+
+const compatibilityVersion = "v3"
+
+type DeployService struct {
+	Exit           chan struct{}
+	UI             UI
+	Provisioner    Provisioner
+	MetaDataReader MetaDataReader
+	Config         config.Config
+}
+
+type Args struct {
+	Service string
+}
+
+func (c *DeployService) Cmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:  "deploy-service",
+		RunE: c.RunE,
+		Short: "Deploy a new service",
+		Long: "Command deploy a new service provided as a parameter",
+	}
+
+	return cmd
+}
+
+func (c *DeployService) RunE(cmd *cobra.Command, args []string) error {
+	go func() {
+		<-c.Exit
+		os.Exit(128)
+	}()
+
+	if len(args) != 1 {
+		return errors.New("A service name need to be passed as a argument")
+	}
+
+	return c.Execute(Args{
+		Service: args[0],
+	})
+}
+
+func (c *DeployService) Execute(args Args) error {
+	metadataConfig, err := c.MetaDataReader.Read(filepath.Join(c.Config.CacheDir, "metadata.yml"))
+	if err != nil {
+		return e.SafeWrap(err, fmt.Sprintf("something went wrong while reading the assets. Please execute 'cf dev start'"))
+	}
+
+	if metadataConfig.Version != compatibilityVersion {
+		return fmt.Errorf("asset version is incompatible with the current version of the plugin. Please execute 'cf dev start'")
+	}
+
+	if c.Provisioner.Ping() != nil {
+		return fmt.Errorf("cf dev is not running. Please execute 'cf dev start'")
+	}
+
+	var service *provision.Service
+	service, err = c.Provisioner.GetWhiteListedService(args.Service, metadataConfig.Services)
+	if err != nil {
+		return e.SafeWrap(err, "Failed to whitelist service")
+	}
+
+	if err := c.Provisioner.DeployServices(c.UI, []provision.Service{*service}); err != nil {
+		return e.SafeWrap(err, "Failed to deploy services")
+	}
+
+	return nil
+}

cmd/deploy-service/deploy_service_suite_test.go

@@ -0,0 +1,13 @@
+package deploy_service
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestDeployService(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Cmd Deploy Service Suite")
+}

cmd/deploy-service/deploy_service_test.go

@@ -0,0 +1,104 @@
+package deploy_service_test
+
+import (
+	"code.cloudfoundry.org/cfdev/cmd/deploy-service"
+	"code.cloudfoundry.org/cfdev/cmd/deploy-service/mocks"
+	"code.cloudfoundry.org/cfdev/config"
+	"code.cloudfoundry.org/cfdev/metadata"
+	"code.cloudfoundry.org/cfdev/provision"
+	"errors"
+	"github.com/golang/mock/gomock"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"path/filepath"
+)
+
+var _ = Describe("DeployService", func() {
+	var (
+		mockController     *gomock.Controller
+		mockMetadataReader *mocks.MockMetaDataReader
+		mockProvisioner    *mocks.MockProvisioner
+		mockUI             *mocks.MockUI
+		cmd                *deploy_service.DeployService
+	)
+	BeforeEach(func() {
+		mockController = gomock.NewController(GinkgoT())
+		mockUI = mocks.NewMockUI(mockController)
+		mockMetadataReader = mocks.NewMockMetaDataReader(mockController)
+		mockProvisioner = mocks.NewMockProvisioner(mockController)
+
+		cmd = &deploy_service.DeployService{
+			UI:             mockUI,
+			MetaDataReader: mockMetadataReader,
+			Provisioner:    mockProvisioner,
+			Config: config.Config{
+				CacheDir: "some-cache-dir",
+			},
+		}
+	})
+
+	AfterEach(func() {})
+
+	Describe("happy path", func() {
+		It("deploys a new service", func() {
+			service := provision.Service{
+				Name: "some-service",
+			}
+			mockMetadataReader.EXPECT().Read(filepath.Join("some-cache-dir", "metadata.yml")).Return(metadata.Metadata{
+				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)
+
+			err := cmd.Execute(deploy_service.Args{
+				Service: "some-service",
+			})
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+
+	Describe("When cf dev is not running", func() {
+		It("returns an error", func() {
+			service := provision.Service{
+				Name: "some-service",
+			}
+			mockMetadataReader.EXPECT().Read(filepath.Join("some-cache-dir", "metadata.yml")).Return(metadata.Metadata{
+				Version:  "v3",
+				Services: []provision.Service{service},
+			}, nil)
+			mockProvisioner.EXPECT().Ping().Return(errors.New("some issue happened"))
+
+			err := cmd.Execute(deploy_service.Args{
+				Service: "some-service",
+			})
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("cf dev is not running"))
+		})
+	})
+
+	Describe("When service is not whitelisted", func() {
+		It("returns an error", func() {
+			service := provision.Service{
+				Name: "some-service",
+			}
+			mockMetadataReader.EXPECT().Read(filepath.Join("some-cache-dir", "metadata.yml")).Return(metadata.Metadata{
+				Version:  "v3",
+				Services: []provision.Service{service},
+			}, nil)
+			mockProvisioner.EXPECT().Ping().Return(nil)
+			mockProvisioner.EXPECT().GetWhiteListedService(
+				"some-service",
+				[]provision.Service{service}).Return(&service, errors.New("unknown service"))
+
+
+			err := cmd.Execute(deploy_service.Args{
+				Service: "some-service",
+			})
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("Failed to whitelist service"))
+		})
+	})
+})