code.cloudfoundry.org/cli@v7.1.0+incompatible/command/v6/update_user_provided_service_command_test.go

package v6_test

import (
	"encoding/json"
	"errors"
	"fmt"

	"code.cloudfoundry.org/cli/actor/v2action"
	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv2/constant"
	"code.cloudfoundry.org/cli/command/commandfakes"
	"code.cloudfoundry.org/cli/command/flag"
	. "code.cloudfoundry.org/cli/command/v6"
	"code.cloudfoundry.org/cli/command/v6/v6fakes"
	"code.cloudfoundry.org/cli/util/configv3"
	"code.cloudfoundry.org/cli/util/ui"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
	. "github.com/onsi/gomega/gbytes"
	. "github.com/onsi/gomega/gstruct"
)

var _ = Describe("update-user-provided-service Command", func() {
	const (
		fakeServiceInstanceName = "fake-service-instance-name"
	)

	var (
		cmd             *UpdateUserProvidedServiceCommand
		fakeConfig      *commandfakes.FakeConfig
		fakeSharedActor *commandfakes.FakeSharedActor
		fakeActor       *v6fakes.FakeUpdateUserProvidedServiceActor
		input           *Buffer
		testUI          *ui.UI
		executeErr      error
		extraArgs       []string
	)

	BeforeEach(func() {
		input = NewBuffer()
		testUI = ui.NewTestUI(input, NewBuffer(), NewBuffer())
		fakeConfig = new(commandfakes.FakeConfig)
		fakeActor = new(v6fakes.FakeUpdateUserProvidedServiceActor)
		fakeSharedActor = new(commandfakes.FakeSharedActor)

		cmd = &UpdateUserProvidedServiceCommand{
			UI:           testUI,
			Config:       fakeConfig,
			SharedActor:  fakeSharedActor,
			Actor:        fakeActor,
			RequiredArgs: flag.ServiceInstance{ServiceInstance: fakeServiceInstanceName},
		}
	})

	JustBeforeEach(func() {
		executeErr = cmd.Execute(extraArgs)
	})

	It("checks the user is logged in, and targeting an org and space", func() {
		Expect(fakeSharedActor.CheckTargetCallCount()).To(Equal(1))
		orgChecked, spaceChecked := fakeSharedActor.CheckTargetArgsForCall(0)
		Expect(orgChecked).To(BeTrue())
		Expect(spaceChecked).To(BeTrue())
	})

	When("checking the target returns an error", func() {
		BeforeEach(func() {
			fakeSharedActor.CheckTargetReturns(errors.New("explode"))
		})

		It("returns the error", func() {
			Expect(executeErr).To(MatchError("explode"))
		})
	})

	When("the user is logged in, and is targeting an org and space", func() {
		const (
			fakeOrgName   = "fake-org-name"
			fakeSpaceName = "fake-space-name"
			fakeSpaceGUID = "fake-space-guid"
			fakeUserName  = "fake-user-name"
		)

		BeforeEach(func() {
			fakeConfig.TargetedSpaceReturns(configv3.Space{
				Name: fakeSpaceName,
				GUID: fakeSpaceGUID,
			})

			fakeConfig.TargetedOrganizationReturns(configv3.Organization{
				Name: fakeOrgName,
			})

			fakeConfig.CurrentUserReturns(configv3.User{Name: fakeUserName}, nil) //TODO: test errors
		})

		It("looks up the service instance GUID", func() {
			Expect(fakeActor.GetServiceInstanceByNameAndSpaceCallCount()).To(Equal(1))
			name, spaceGUID := fakeActor.GetServiceInstanceByNameAndSpaceArgsForCall(0)
			Expect(name).To(Equal(fakeServiceInstanceName))
			Expect(spaceGUID).To(Equal(fakeSpaceGUID))
		})

		When("looking up the service instance GUID returns warnings", func() {
			BeforeEach(func() {
				fakeActor.GetServiceInstanceByNameAndSpaceReturns(
					v2action.ServiceInstance{},
					v2action.Warnings{"something obstreperous"},
					nil,
				)
			})

			It("reports the warning", func() {
				Expect(testUI.Err).To(Say("something obstreperous"))
			})
		})

		When("looking up the service instance GUID fails", func() {
			BeforeEach(func() {
				fakeActor.GetServiceInstanceByNameAndSpaceReturns(
					v2action.ServiceInstance{},
					v2action.Warnings{"something obstreperous"},
					errors.New("something awful"),
				)
			})

			It("returns the error and warnings", func() {
				Expect(testUI.Err).To(Say("something obstreperous"))
				Expect(executeErr).To(MatchError("something awful"))
			})
		})

		When("the service instance is not user-provided", func() {
			It("fails with an error", func() {
				Expect(executeErr).To(MatchError(fmt.Sprintf("The service instance '%s' is not user-provided", fakeServiceInstanceName)))
			})
		})

		When("looking up the service instance GUID succeeds, and it is user-provided", func() {
			const (
				fakeServiceInstanceGUID = "fake-service-instance-guid"
			)

			BeforeEach(func() {
				fakeActor.GetServiceInstanceByNameAndSpaceReturns(
					v2action.ServiceInstance{
						GUID: fakeServiceInstanceGUID,
						Type: constant.UserProvidedService,
					},
					nil,
					nil,
				)
			})

			When("no flags are provided", func() {
				It("succeeds", func() {
					Expect(executeErr).NotTo(HaveOccurred())
				})

				It("says that no flags were provided", func() {
					Expect(testUI.Out).To(Say("No flags specified. No changes were made"))
					Expect(testUI.Out).To(Say("OK"))
				})
			})

			Context("updating log URL", func() {
				BeforeEach(func() {
					cmd.SyslogDrainURL.IsSet = true
					cmd.SyslogDrainURL.Value = "fake-syslog-drain-url"
				})

				It("succeeds", func() {
					Expect(executeErr).NotTo(HaveOccurred())
				})

				It("displays messages to the user", func() {
					expectOKMessage(testUI, fakeServiceInstanceName, fakeOrgName, fakeSpaceName, fakeUserName)
				})

				It("updates the syslog URL", func() {
					Expect(fakeActor.UpdateUserProvidedServiceInstanceCallCount()).To(Equal(1))
					guid, instanceChanges := fakeActor.UpdateUserProvidedServiceInstanceArgsForCall(0)
					Expect(guid).To(Equal(fakeServiceInstanceGUID))
					Expect(instanceChanges).To(MatchAllFields(Fields{
						"SyslogDrainURL":  PointTo(Equal("fake-syslog-drain-url")),
						"RouteServiceURL": BeNil(),
						"Tags":            BeNil(),
						"Credentials":     BeNil(),
					}))
				})
			})

			Context("updating credentials", func() {
				BeforeEach(func() {
					cmd.Credentials.IsSet = true
					cmd.Credentials.UserPromptCredentials = []string{"pass phrase", "cred"}

					_, err := input.Write([]byte("very secret passphrase\nsecret cred\n"))
					Expect(err).NotTo(HaveOccurred())
				})

				It("prompts the user for credentials", func() {
					Expect(testUI.Out).To(Say("pass phrase: "))
					Expect(testUI.Out).To(Say("cred: "))
				})

				It("does not echo the credentials", func() {
					Expect(testUI.Out).NotTo(Say("secret"))
					Expect(testUI.Err).NotTo(Say("secret"))
				})

				It("succeeds", func() {
					Expect(executeErr).NotTo(HaveOccurred())
				})

				It("displays messages to the user", func() {
					expectOKMessage(testUI, fakeServiceInstanceName, fakeOrgName, fakeSpaceName, fakeUserName)
				})

				It("updates the credentials", func() {
					Expect(fakeActor.UpdateUserProvidedServiceInstanceCallCount()).To(Equal(1))
					guid, instanceChanges := fakeActor.UpdateUserProvidedServiceInstanceArgsForCall(0)
					Expect(guid).To(Equal(fakeServiceInstanceGUID))
					Expect(instanceChanges).To(MatchAllFields(Fields{
						"Credentials": Equal(map[string]interface{}{
							"pass phrase": "very secret passphrase",
							"cred":        "secret cred",
						}),
						"RouteServiceURL": BeNil(),
						"Tags":            BeNil(),
						"SyslogDrainURL":  BeNil(),
					}))
				})
			})

			Context("updating routes URL", func() {
				BeforeEach(func() {
					cmd.RouteServiceURL.IsSet = true
					cmd.RouteServiceURL.Value = "fake-route-url"
				})

				It("succeeds", func() {
					Expect(executeErr).NotTo(HaveOccurred())
				})

				It("displays messages to the user", func() {
					expectOKMessage(testUI, fakeServiceInstanceName, fakeOrgName, fakeSpaceName, fakeUserName)
				})

				It("updates the routes URL", func() {
					Expect(fakeActor.UpdateUserProvidedServiceInstanceCallCount()).To(Equal(1))
					guid, instanceChanges := fakeActor.UpdateUserProvidedServiceInstanceArgsForCall(0)
					Expect(guid).To(Equal(fakeServiceInstanceGUID))
					Expect(instanceChanges).To(MatchAllFields(Fields{
						"RouteServiceURL": PointTo(Equal("fake-route-url")),
						"Tags":            BeNil(),
						"SyslogDrainURL":  BeNil(),
						"Credentials":     BeNil(),
					}))
				})
			})

			Context("updating tags", func() {
				BeforeEach(func() {
					cmd.Tags.IsSet = true
					cmd.Tags.Value = []string{"foo", "bar"}
				})

				It("succeeds", func() {
					Expect(executeErr).NotTo(HaveOccurred())
				})

				It("displays messages to the user", func() {
					expectOKMessage(testUI, fakeServiceInstanceName, fakeOrgName, fakeSpaceName, fakeUserName)
				})

				It("updates the tags", func() {
					Expect(fakeActor.UpdateUserProvidedServiceInstanceCallCount()).To(Equal(1))
					guid, instanceChanges := fakeActor.UpdateUserProvidedServiceInstanceArgsForCall(0)
					Expect(guid).To(Equal(fakeServiceInstanceGUID))
					Expect(instanceChanges).To(MatchAllFields(Fields{
						"Tags":            PointTo(ConsistOf("foo", "bar")),
						"SyslogDrainURL":  BeNil(),
						"RouteServiceURL": BeNil(),
						"Credentials":     BeNil(),
					}))
				})
			})

			When("unsetting values", func() {
				BeforeEach(func() {
					cmd.RouteServiceURL.IsSet = true
					cmd.Credentials.IsSet = true
					cmd.SyslogDrainURL.IsSet = true
					cmd.Tags.IsSet = true
				})

				It("sends empty values", func() {
					Expect(fakeActor.UpdateUserProvidedServiceInstanceCallCount()).To(Equal(1))
					guid, instanceChanges := fakeActor.UpdateUserProvidedServiceInstanceArgsForCall(0)
					Expect(guid).To(Equal(fakeServiceInstanceGUID))
					bytes, err := json.Marshal(instanceChanges)
					Expect(err).NotTo(HaveOccurred())
					Expect(bytes).To(MatchJSON(`
          {
					  "tags": [],
						"syslog_drain_url": "",
						"route_service_url": "",
						"credentials": {}
					}`))
				})
			})

			When("the action returns warnings", func() {
				BeforeEach(func() {
					cmd.Tags.IsSet = true
					cmd.Tags.Value = []string{"foo", "bar"}

					fakeActor.UpdateUserProvidedServiceInstanceReturns(v2action.Warnings{"some", "warnings"}, nil)
				})

				It("reports the warnings to the user", func() {
					Expect(testUI.Err).To(Say("some"))
					Expect(testUI.Err).To(Say("warnings"))
				})
			})

			When("the action fails", func() {
				BeforeEach(func() {
					cmd.Tags.IsSet = true
					cmd.Tags.Value = []string{"foo", "bar"}

					fakeActor.UpdateUserProvidedServiceInstanceReturns(
						v2action.Warnings{"some", "warnings"},
						errors.New("utterly awful happenings"),
					)
				})

				It("reports the failure and warnings", func() {
					Expect(testUI.Err).To(Say("some"))
					Expect(testUI.Err).To(Say("warnings"))
					Expect(executeErr).To(MatchError("utterly awful happenings"))
				})
			})
		})
	})
})

func expectOKMessage(testUI *ui.UI, serviceName, orgName, spaceName, userName string) {
	Expect(testUI.Out).To(Say("Updating user provided service %s in org %s / space %s as %s...", serviceName, orgName, spaceName, userName))
	Expect(testUI.Out).To(Say("OK"))
	Expect(testUI.Out).To(Say("TIP: Use 'cf restage' for any bound apps to ensure your env variable changes take effect"))
}