github.com/jenspinney/cli@v6.42.1-0.20190207184520-7450c600020e+incompatible/command/v6/restage_command_test.go

package v6_test

import (
	"errors"
	"time"

	"code.cloudfoundry.org/cli/actor/actionerror"
	"code.cloudfoundry.org/cli/actor/v2action"
	"code.cloudfoundry.org/cli/actor/v2v3action"
	"code.cloudfoundry.org/cli/actor/v3action"
	"code.cloudfoundry.org/cli/command/commandfakes"
	"code.cloudfoundry.org/cli/command/translatableerror"
	. "code.cloudfoundry.org/cli/command/v6"
	"code.cloudfoundry.org/cli/command/v6/shared/sharedfakes"
	"code.cloudfoundry.org/cli/command/v6/v6fakes"
	"code.cloudfoundry.org/cli/types"
	"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"
)

var _ = Describe("Restage Command", func() {
	var (
		cmd                         RestageCommand
		testUI                      *ui.UI
		fakeConfig                  *commandfakes.FakeConfig
		fakeSharedActor             *commandfakes.FakeSharedActor
		fakeApplicationSummaryActor *sharedfakes.FakeApplicationSummaryActor
		fakeActor                   *v6fakes.FakeRestageActor
		binaryName                  string
		executeErr                  error
	)

	BeforeEach(func() {
		testUI = ui.NewTestUI(nil, NewBuffer(), NewBuffer())
		fakeConfig = new(commandfakes.FakeConfig)
		fakeSharedActor = new(commandfakes.FakeSharedActor)
		fakeActor = new(v6fakes.FakeRestageActor)
		fakeApplicationSummaryActor = new(sharedfakes.FakeApplicationSummaryActor)

		cmd = RestageCommand{
			UI:                      testUI,
			Config:                  fakeConfig,
			SharedActor:             fakeSharedActor,
			Actor:                   fakeActor,
			ApplicationSummaryActor: fakeApplicationSummaryActor,
		}

		cmd.RequiredArgs.AppName = "some-app"

		binaryName = "faceman"
		fakeConfig.BinaryNameReturns(binaryName)

		var err error
		testUI.TimezoneLocation, err = time.LoadLocation("America/Los_Angeles")
		Expect(err).NotTo(HaveOccurred())

		fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
			messages := make(chan *v2action.LogMessage)
			logErrs := make(chan error)
			appState := make(chan v2action.ApplicationStateChange)
			warnings := make(chan string)
			errs := make(chan error)

			go func() {
				appState <- v2action.ApplicationStateStaging
				appState <- v2action.ApplicationStateStarting
				close(messages)
				close(logErrs)
				close(appState)
				close(warnings)
				close(errs)
			}()

			return messages, logErrs, appState, warnings, errs
		}
	})

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

	When("checking target fails", func() {
		BeforeEach(func() {
			fakeSharedActor.CheckTargetReturns(actionerror.NotLoggedInError{BinaryName: binaryName})
		})

		It("returns an error if the check fails", func() {
			Expect(executeErr).To(MatchError(actionerror.NotLoggedInError{BinaryName: "faceman"}))

			Expect(fakeSharedActor.CheckTargetCallCount()).To(Equal(1))
			checkTargetedOrg, checkTargetedSpace := fakeSharedActor.CheckTargetArgsForCall(0)
			Expect(checkTargetedOrg).To(BeTrue())
			Expect(checkTargetedSpace).To(BeTrue())
		})
	})

	When("the user is logged in, and org and space are targeted", func() {
		BeforeEach(func() {
			fakeConfig.HasTargetedOrganizationReturns(true)
			fakeConfig.TargetedOrganizationReturns(configv3.Organization{Name: "some-org"})
			fakeConfig.HasTargetedSpaceReturns(true)
			fakeConfig.TargetedSpaceReturns(configv3.Space{
				GUID: "some-space-guid",
				Name: "some-space"})
			fakeConfig.CurrentUserReturns(
				configv3.User{Name: "some-user"},
				nil)
		})

		When("getting the current user returns an error", func() {
			var expectedErr error

			BeforeEach(func() {
				expectedErr = errors.New("getting current user error")
				fakeConfig.CurrentUserReturns(
					configv3.User{},
					expectedErr)
			})

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

		It("displays flavor text", func() {
			Expect(testUI.Err).To(Say("This action will cause app downtime\\."))
			Expect(testUI.Out).To(Say("Restaging app some-app in org some-org / space some-space as some-user..."))
		})

		When("the app does *not* exists", func() {
			BeforeEach(func() {
				fakeActor.GetApplicationByNameAndSpaceReturns(
					v2action.Application{},
					v2action.Warnings{"warning-1", "warning-2"},
					actionerror.ApplicationNotFoundError{Name: "some-app"},
				)
			})

			It("returns back an error", func() {
				Expect(executeErr).To(MatchError(actionerror.ApplicationNotFoundError{Name: "some-app"}))

				Expect(testUI.Err).To(Say("warning-1"))
				Expect(testUI.Err).To(Say("warning-2"))
			})
		})

		When("the app exists", func() {
			BeforeEach(func() {
				fakeActor.GetApplicationByNameAndSpaceReturns(
					v2action.Application{GUID: "app-guid"},
					v2action.Warnings{"warning-1", "warning-2"},
					nil,
				)
			})

			It("stages the app", func() {
				Expect(executeErr).ToNot(HaveOccurred())

				Expect(testUI.Err).To(Say("warning-1"))
				Expect(testUI.Err).To(Say("warning-2"))

				Expect(fakeActor.RestageApplicationCallCount()).To(Equal(1))
				app, _ := fakeActor.RestageApplicationArgsForCall(0)
				Expect(app.GUID).To(Equal("app-guid"))
			})

			When("passed an appStarting message", func() {
				BeforeEach(func() {
					fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
						messages := make(chan *v2action.LogMessage)
						logErrs := make(chan error)
						appState := make(chan v2action.ApplicationStateChange)
						warnings := make(chan string)
						errs := make(chan error)

						go func() {
							messages <- v2action.NewLogMessage("log message 1", 1, time.Unix(0, 0), "STG", "1")
							messages <- v2action.NewLogMessage("log message 2", 1, time.Unix(0, 0), "STG", "1")
							appState <- v2action.ApplicationStateStaging
							appState <- v2action.ApplicationStateStarting
							close(messages)
							close(logErrs)
							close(appState)
							close(warnings)
							close(errs)
						}()

						return messages, logErrs, appState, warnings, errs
					}
				})

				It("displays the log", func() {
					Expect(executeErr).ToNot(HaveOccurred())
					Expect(testUI.Out).To(Say("log message 1"))
					Expect(testUI.Out).To(Say("log message 2"))
					Expect(testUI.Out).To(Say("Waiting for app to start..."))
				})
			})

			When("passed a log message", func() {
				BeforeEach(func() {
					fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
						messages := make(chan *v2action.LogMessage)
						logErrs := make(chan error)
						appState := make(chan v2action.ApplicationStateChange)
						warnings := make(chan string)
						errs := make(chan error)

						go func() {
							messages <- v2action.NewLogMessage("log message 1", 1, time.Unix(0, 0), "STG", "1")
							messages <- v2action.NewLogMessage("log message 2", 1, time.Unix(0, 0), "STG", "1")
							messages <- v2action.NewLogMessage("log message 3", 1, time.Unix(0, 0), "Something else", "1")
							close(messages)
							close(logErrs)
							close(appState)
							close(warnings)
							close(errs)
						}()

						return messages, logErrs, appState, warnings, errs
					}
				})

				It("displays the log", func() {
					Expect(executeErr).ToNot(HaveOccurred())
					Expect(testUI.Out).To(Say("log message 1"))
					Expect(testUI.Out).To(Say("log message 2"))
					Expect(testUI.Out).ToNot(Say("log message 3"))
				})
			})

			When("passed an log err", func() {
				Context("NOAA connection times out/closes", func() {
					BeforeEach(func() {
						fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
							messages := make(chan *v2action.LogMessage)
							logErrs := make(chan error)
							appState := make(chan v2action.ApplicationStateChange)
							warnings := make(chan string)
							errs := make(chan error)

							go func() {
								messages <- v2action.NewLogMessage("log message 1", 1, time.Unix(0, 0), "STG", "1")
								messages <- v2action.NewLogMessage("log message 2", 1, time.Unix(0, 0), "STG", "1")
								messages <- v2action.NewLogMessage("log message 3", 1, time.Unix(0, 0), "STG", "1")
								logErrs <- actionerror.NOAATimeoutError{}
								close(messages)
								close(logErrs)
								close(appState)
								close(warnings)
								close(errs)
							}()

							return messages, logErrs, appState, warnings, errs
						}

						v3ApplicationSummary := v3action.ApplicationSummary{
							Application: v3action.Application{
								Name: "some-app",
							},
							ProcessSummaries: v3action.ProcessSummaries{
								{
									Process: v3action.Process{
										Type:       "aba",
										Command:    *types.NewFilteredString("some-command-1"),
										MemoryInMB: types.NullUint64{Value: 32, IsSet: true},
										DiskInMB:   types.NullUint64{Value: 1024, IsSet: true},
									},
								},
								{
									Process: v3action.Process{
										Type:       "console",
										Command:    *types.NewFilteredString("some-command-2"),
										MemoryInMB: types.NullUint64{Value: 16, IsSet: true},
										DiskInMB:   types.NullUint64{Value: 512, IsSet: true},
									},
								},
							},
						}
						applicationSummary := v2v3action.ApplicationSummary{
							ApplicationSummary: v3ApplicationSummary,
						}
						warnings := []string{"app-summary-warning"}

						fakeApplicationSummaryActor.GetApplicationSummaryByNameAndSpaceReturns(applicationSummary, warnings, nil)
					})

					It("displays a warning and continues until app has started", func() {
						Expect(executeErr).To(BeNil())
						Expect(testUI.Out).To(Say("message 1"))
						Expect(testUI.Out).To(Say("message 2"))
						Expect(testUI.Out).To(Say("message 3"))
						Expect(testUI.Err).To(Say("timeout connecting to log server, no log will be shown"))
						Expect(testUI.Out).To(Say(`name:\s+some-app`))
					})
				})

				Context("an unexpected error occurs", func() {
					var expectedErr error

					BeforeEach(func() {
						expectedErr = errors.New("err log message")
						fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
							messages := make(chan *v2action.LogMessage)
							logErrs := make(chan error)
							appState := make(chan v2action.ApplicationStateChange)
							warnings := make(chan string)
							errs := make(chan error)

							go func() {
								logErrs <- expectedErr
								close(messages)
								close(logErrs)
								close(appState)
								close(warnings)
								close(errs)
							}()

							return messages, logErrs, appState, warnings, errs
						}
					})

					It("displays the error and continues to poll", func() {
						Expect(executeErr).NotTo(HaveOccurred())
						Expect(testUI.Err).To(Say(expectedErr.Error()))
					})
				})
			})

			When("passed a warning", func() {
				Context("while NOAA is still logging", func() {
					BeforeEach(func() {
						fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
							messages := make(chan *v2action.LogMessage)
							logErrs := make(chan error)
							appState := make(chan v2action.ApplicationStateChange)
							warnings := make(chan string)
							errs := make(chan error)

							go func() {
								warnings <- "warning 1"
								warnings <- "warning 2"
								close(messages)
								close(logErrs)
								close(appState)
								close(warnings)
								close(errs)
							}()

							return messages, logErrs, appState, warnings, errs
						}
					})

					It("displays the warnings to STDERR", func() {
						Expect(executeErr).ToNot(HaveOccurred())
						Expect(testUI.Err).To(Say("warning 1"))
						Expect(testUI.Err).To(Say("warning 2"))
					})
				})

				Context("while NOAA is no longer logging", func() {
					BeforeEach(func() {
						fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
							messages := make(chan *v2action.LogMessage)
							logErrs := make(chan error)
							appState := make(chan v2action.ApplicationStateChange)
							warnings := make(chan string)
							errs := make(chan error)

							go func() {
								warnings <- "warning 1"
								warnings <- "warning 2"
								logErrs <- actionerror.NOAATimeoutError{}
								close(messages)
								close(logErrs)
								warnings <- "warning 3"
								warnings <- "warning 4"
								close(appState)
								close(warnings)
								close(errs)
							}()

							return messages, logErrs, appState, warnings, errs
						}
					})

					It("displays the warnings to STDERR", func() {
						Expect(executeErr).ToNot(HaveOccurred())
						Expect(testUI.Err).To(Say("warning 1"))
						Expect(testUI.Err).To(Say("warning 2"))
						Expect(testUI.Err).To(Say("timeout connecting to log server, no log will be shown"))
						Expect(testUI.Err).To(Say("warning 3"))
						Expect(testUI.Err).To(Say("warning 4"))
					})
				})
			})

			When("passed an API err", func() {
				var apiErr error

				BeforeEach(func() {
					fakeActor.RestageApplicationStub = func(app v2action.Application, client v2action.NOAAClient) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error) {
						messages := make(chan *v2action.LogMessage)
						logErrs := make(chan error)
						appState := make(chan v2action.ApplicationStateChange)
						warnings := make(chan string)
						errs := make(chan error)

						go func() {
							errs <- apiErr
							close(messages)
							close(logErrs)
							close(appState)
							close(warnings)
							close(errs)
						}()

						return messages, logErrs, appState, warnings, errs
					}
				})

				Context("an unexpected error", func() {
					BeforeEach(func() {
						apiErr = errors.New("err log message")
					})

					It("stops logging and returns the error", func() {
						Expect(executeErr).To(MatchError(apiErr))
					})
				})

				Context("staging failed", func() {
					BeforeEach(func() {
						apiErr = actionerror.StagingFailedError{Reason: "Something, but not nothing"}
					})

					It("stops logging and returns StagingFailedError", func() {
						Expect(executeErr).To(MatchError(translatableerror.StagingFailedError{Message: "Something, but not nothing"}))
					})
				})

				Context("staging timed out", func() {
					BeforeEach(func() {
						apiErr = actionerror.StagingTimeoutError{AppName: "some-app", Timeout: time.Nanosecond}
					})

					It("stops logging and returns StagingTimeoutError", func() {
						Expect(executeErr).To(MatchError(translatableerror.StagingTimeoutError{AppName: "some-app", Timeout: time.Nanosecond}))
					})
				})

				When("the app instance crashes", func() {
					BeforeEach(func() {
						apiErr = actionerror.ApplicationInstanceCrashedError{Name: "some-app"}
					})

					It("stops logging and returns UnsuccessfulStartError", func() {
						Expect(executeErr).To(MatchError(translatableerror.UnsuccessfulStartError{AppName: "some-app", BinaryName: "faceman"}))
					})
				})

				When("the app instance flaps", func() {
					BeforeEach(func() {
						apiErr = actionerror.ApplicationInstanceFlappingError{Name: "some-app"}
					})

					It("stops logging and returns UnsuccessfulStartError", func() {
						Expect(executeErr).To(MatchError(translatableerror.UnsuccessfulStartError{AppName: "some-app", BinaryName: "faceman"}))
					})
				})

				Context("starting timeout", func() {
					BeforeEach(func() {
						apiErr = actionerror.StartupTimeoutError{Name: "some-app"}
					})

					It("stops logging and returns StartupTimeoutError", func() {
						Expect(executeErr).To(MatchError(translatableerror.StartupTimeoutError{AppName: "some-app", BinaryName: "faceman"}))
					})
				})
			})

			When("the app finishes starting", func() {
				var (
					applicationSummary v2v3action.ApplicationSummary
				)

				BeforeEach(func() {
					v3ApplicationSummary := v3action.ApplicationSummary{
						Application: v3action.Application{
							Name: "some-app",
						},
						ProcessSummaries: v3action.ProcessSummaries{
							{
								Process: v3action.Process{
									Type:       "aba",
									Command:    *types.NewFilteredString("some-command-1"),
									MemoryInMB: types.NullUint64{Value: 32, IsSet: true},
									DiskInMB:   types.NullUint64{Value: 1024, IsSet: true},
								},
							},
							{
								Process: v3action.Process{
									Type:       "console",
									Command:    *types.NewFilteredString("some-command-2"),
									MemoryInMB: types.NullUint64{Value: 16, IsSet: true},
									DiskInMB:   types.NullUint64{Value: 512, IsSet: true},
								},
							},
						},
					}
					applicationSummary = v2v3action.ApplicationSummary{
						ApplicationSummary: v3ApplicationSummary,
					}

					fakeApplicationSummaryActor.GetApplicationSummaryByNameAndSpaceReturns(
						applicationSummary,
						v2v3action.Warnings{"combo-summary-warning"},
						nil)

				})

				It("uses the multiprocess display", func() {
					Expect(executeErr).ToNot(HaveOccurred())

					Expect(fakeApplicationSummaryActor.GetApplicationSummaryByNameAndSpaceCallCount()).To(Equal(1))
					passedAppName, spaceGUID, withObfuscatedValues := fakeApplicationSummaryActor.GetApplicationSummaryByNameAndSpaceArgsForCall(0)
					Expect(passedAppName).To(Equal("some-app"))
					Expect(spaceGUID).To(Equal("some-space-guid"))
					Expect(withObfuscatedValues).To(BeTrue())

					Expect(testUI.Out).To(Say(`name:\s+%s`, "some-app"))
					Expect(testUI.Out).To(Say(`type:\s+aba`))
					Expect(testUI.Out).To(Say(`instances:\s+0/0`))
					Expect(testUI.Out).To(Say(`memory usage:\s+32M`))
					Expect(testUI.Out).To(Say(`start command:\s+some-command-1`))
					Expect(testUI.Out).To(Say(`type:\s+console`))
					Expect(testUI.Out).To(Say(`instances:\s+0/0`))
					Expect(testUI.Out).To(Say(`memory usage:\s+16M`))
					Expect(testUI.Out).To(Say(`start command:\s+some-command-2`))

					Expect(testUI.Err).To(Say("combo-summary-warning"))
				})
			})
		})
	})
})