github.com/wanddynosios/cli/v8@v8.7.9-0.20240221182337-1a92e3a7017f/actor/v7action/application_feature_test.go

package v7action_test

import (
	"errors"
	"time"

	. "code.cloudfoundry.org/cli/actor/v7action"
	"code.cloudfoundry.org/cli/actor/v7action/v7actionfakes"
	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv3"
	"code.cloudfoundry.org/cli/resources"
	"code.cloudfoundry.org/clock/fakeclock"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

var _ = Describe("Application Feature Actions", func() {
	var (
		actor                     *Actor
		fakeCloudControllerClient *v7actionfakes.FakeCloudControllerClient
		fakeConfig                *v7actionfakes.FakeConfig
		fakeClock                 *fakeclock.FakeClock
	)

	BeforeEach(func() {
		fakeCloudControllerClient = new(v7actionfakes.FakeCloudControllerClient)
		fakeConfig = new(v7actionfakes.FakeConfig)
		fakeClock = fakeclock.NewFakeClock(time.Now())
		actor = NewActor(fakeCloudControllerClient, fakeConfig, nil, nil, nil, fakeClock)
	})

	Describe("GetAppFeature", func() {
		var (
			appGUID    = "some-app-guid"
			warnings   Warnings
			executeErr error
			appFeature resources.ApplicationFeature
		)

		JustBeforeEach(func() {
			appFeature, warnings, executeErr = actor.GetAppFeature(appGUID, "ssh")
		})

		Context("Getting SSH", func() {
			When("it succeeds", func() {
				BeforeEach(func() {
					fakeCloudControllerClient.GetAppFeatureReturns(
						resources.ApplicationFeature{Name: "ssh", Enabled: true},
						ccv3.Warnings{},
						nil,
					)
				})

				It("calls ccv3 to check current ssh ability", func() {
					Expect(fakeCloudControllerClient.GetAppFeatureCallCount()).To(Equal(1))
					appGuid, featureName := fakeCloudControllerClient.GetAppFeatureArgsForCall(0)
					Expect(appGuid).To(Equal(appGUID))
					Expect(featureName).To(Equal("ssh"))
				})

				It("returns an app feature", func() {
					Expect(appFeature.Name).To(Equal("ssh"))
					Expect(appFeature.Enabled).To(BeTrue())
				})

				When("desired enabled state is already, the current state", func() {
					BeforeEach(func() {
						fakeCloudControllerClient.GetAppFeatureReturns(
							resources.ApplicationFeature{Enabled: true},
							ccv3.Warnings{"some-ccv3-warning"},
							nil,
						)
					})

					It("returns a waring", func() {
						Expect(warnings).To(ConsistOf("some-ccv3-warning"))
					})
				})
			})

			When("when the API layer call returns an error", func() {
				BeforeEach(func() {
					fakeCloudControllerClient.GetAppFeatureReturns(
						resources.ApplicationFeature{Enabled: false},
						ccv3.Warnings{"some-get-ssh-warning"},
						errors.New("some-get-ssh-error"),
					)
				})

				It("returns the error and prints warnings", func() {
					Expect(executeErr).To(MatchError("some-get-ssh-error"))
					Expect(warnings).To(ConsistOf("some-get-ssh-warning"))

					Expect(fakeCloudControllerClient.GetAppFeatureCallCount()).To(Equal(1))
				})
			})
		})
	})

	Describe("UpdateAppFeature", func() {
		var (
			app        = resources.Application{Name: "some-app", GUID: "some-app-guid"}
			enabled    = true
			warnings   Warnings
			executeErr error
		)

		JustBeforeEach(func() {
			warnings, executeErr = actor.UpdateAppFeature(app, true, "ssh")
		})

		Context("Getting SSH", func() {
			When("it succeeds", func() {
				It("calls ccv3 to enable ssh", func() {
					Expect(fakeCloudControllerClient.UpdateAppFeatureCallCount()).To(Equal(1))
					actualApp, actualEnabled, featureName := fakeCloudControllerClient.UpdateAppFeatureArgsForCall(0)
					Expect(actualApp).To(Equal(app.GUID))
					Expect(actualEnabled).To(Equal(enabled))
					Expect(featureName).To(Equal("ssh"))
				})

				When("the API layer call is successful", func() {
					BeforeEach(func() {
						fakeCloudControllerClient.UpdateAppFeatureReturns(ccv3.Warnings{"some-update-ssh-warning"}, nil)
					})

					It("does not error", func() {
						Expect(executeErr).ToNot(HaveOccurred())
						Expect(warnings).To(ConsistOf("some-update-ssh-warning"))
					})
				})
			})

			When("when the API layer call returns an error", func() {
				BeforeEach(func() {
					fakeCloudControllerClient.UpdateAppFeatureReturns(
						ccv3.Warnings{"some-update-ssh-warning"},
						errors.New("some-update-ssh-error"),
					)
				})

				It("returns the error and prints warnings", func() {
					Expect(executeErr).To(MatchError("some-update-ssh-error"))
					Expect(warnings).To(ConsistOf("some-update-ssh-warning"))

					Expect(fakeCloudControllerClient.UpdateAppFeatureCallCount()).To(Equal(1))
				})
			})
		})
	})

	Describe("GetSSHEnabled", func() {
		var (
			appGUID    = "some-app-guid"
			warnings   Warnings
			executeErr error
			sshEnabled ccv3.SSHEnabled
		)

		JustBeforeEach(func() {
			sshEnabled, warnings, executeErr = actor.GetSSHEnabled(appGUID)
		})

		When("it succeeds", func() {
			BeforeEach(func() {
				fakeCloudControllerClient.GetSSHEnabledReturns(
					ccv3.SSHEnabled{Reason: "some-reason", Enabled: true},
					ccv3.Warnings{"some-ccv3-warning"},
					nil,
				)
			})

			It("calls ccv3 to check current ssh ability", func() {
				Expect(fakeCloudControllerClient.GetSSHEnabledCallCount()).To(Equal(1))
				appGuid := fakeCloudControllerClient.GetSSHEnabledArgsForCall(0)
				Expect(appGuid).To(Equal(appGUID))
			})

			It("returns an sshEnabled", func() {
				Expect(sshEnabled.Reason).To(Equal("some-reason"))
				Expect(sshEnabled.Enabled).To(BeTrue())
			})

			It("returns a warning", func() {
				Expect(warnings).To(ConsistOf("some-ccv3-warning"))
			})

			When("when it's disabled", func() {
				BeforeEach(func() {
					fakeCloudControllerClient.GetSSHEnabledReturns(
						ccv3.SSHEnabled{Reason: "another-reason", Enabled: false},
						ccv3.Warnings{"some-ccv3-warning"},
						nil,
					)
				})

				It("returns an sshEnabled", func() {
					Expect(sshEnabled.Reason).To(Equal("another-reason"))
					Expect(sshEnabled.Enabled).To(BeFalse())
				})
			})
		})

		When("when the API layer call returns an error", func() {
			BeforeEach(func() {
				fakeCloudControllerClient.GetSSHEnabledReturns(
					ccv3.SSHEnabled{Reason: "some-third-reason", Enabled: false},
					ccv3.Warnings{"some-get-ssh-warning"},
					errors.New("some-get-ssh-error"),
				)
			})

			It("returns the error and prints warnings", func() {
				Expect(executeErr).To(MatchError("some-get-ssh-error"))
				Expect(warnings).To(ConsistOf("some-get-ssh-warning"))

				Expect(fakeCloudControllerClient.GetSSHEnabledCallCount()).To(Equal(1))
			})
		})
	})

	Describe("GetSSHEnabledByAppName", func() {
		var (
			appName    = "some-app-name"
			appGUID    = "some-app-guid"
			spaceGUID  = "some-space-GUID"
			warnings   Warnings
			executeErr error
			sshEnabled ccv3.SSHEnabled
		)

		JustBeforeEach(func() {
			sshEnabled, warnings, executeErr = actor.GetSSHEnabledByAppName(appName, spaceGUID)
		})

		BeforeEach(func() {
			fakeCloudControllerClient.GetApplicationByNameAndSpaceReturns(
				resources.Application{Name: appName, GUID: appGUID},
				ccv3.Warnings{"get-app-warning"},
				nil,
			)

			fakeCloudControllerClient.GetSSHEnabledReturns(
				ccv3.SSHEnabled{Enabled: false, Reason: "globally disabled"},
				ccv3.Warnings{"get-ssh-enabled-warning"},
				nil,
			)
		})

		It("gets the app by name and space guid", func() {
			Expect(executeErr).To(Not(HaveOccurred()))
			Expect(sshEnabled).To(Equal(ccv3.SSHEnabled{Enabled: false, Reason: "globally disabled"}))
			Expect(warnings).To(ConsistOf("get-app-warning", "get-ssh-enabled-warning"))

			Expect(fakeCloudControllerClient.GetApplicationByNameAndSpaceCallCount()).To(Equal(1))
			appNameArg, spaceGUIDArg := fakeCloudControllerClient.GetApplicationByNameAndSpaceArgsForCall(0)
			Expect(appName).To(Equal(appNameArg))
			Expect(spaceGUID).To(Equal(spaceGUIDArg))
		})

		It("calls the API GetSSHEnabled with the expected arguments", func() {
			Expect(executeErr).To(Not(HaveOccurred()))
			Expect(sshEnabled).To(Equal(ccv3.SSHEnabled{Enabled: false, Reason: "globally disabled"}))
			Expect(warnings).To(ConsistOf("get-app-warning", "get-ssh-enabled-warning"))

			Expect(fakeCloudControllerClient.GetSSHEnabledCallCount()).To(Equal(1))
			appGUIDArg := fakeCloudControllerClient.GetSSHEnabledArgsForCall(0)
			Expect(appGUID).To(Equal(appGUIDArg))
		})

		When("getting the app fails", func() {
			BeforeEach(func() {
				fakeCloudControllerClient.GetApplicationByNameAndSpaceReturns(
					resources.Application{},
					ccv3.Warnings{"get-app-warning"},
					errors.New("get-app-error"),
				)
			})

			It("returns the error and warnings", func() {
				Expect(executeErr).To(MatchError("get-app-error"))
				Expect(warnings).To(ConsistOf("get-app-warning"))
			})
		})

		When("checking if SSH is enabled fails", func() {
			BeforeEach(func() {
				fakeCloudControllerClient.GetApplicationByNameAndSpaceReturns(
					resources.Application{Name: appName, GUID: appGUID},
					ccv3.Warnings{"get-app-warning"},
					nil,
				)

				fakeCloudControllerClient.GetSSHEnabledReturns(
					ccv3.SSHEnabled{},
					ccv3.Warnings{"check-ssh-warning"},
					errors.New("check-ssh-error"),
				)
			})

			It("returns the error and warnings", func() {
				Expect(executeErr).To(MatchError("check-ssh-error"))
				Expect(warnings).To(ConsistOf("get-app-warning", "check-ssh-warning"))
			})
		})
	})
})