github.com/wanddynosios/cli/v8@v8.7.9-0.20240221182337-1a92e3a7017f/api/cloudcontroller/ccv3/job_test.go

package ccv3_test

import (
	"fmt"
	"net/http"
	"time"

	"code.cloudfoundry.org/cli/api/cloudcontroller/ccerror"
	. "code.cloudfoundry.org/cli/api/cloudcontroller/ccv3"
	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv3/ccv3fakes"
	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv3/constant"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/ginkgo/extensions/table"
	. "github.com/onsi/gomega"
	. "github.com/onsi/gomega/ghttp"
)

var _ = Describe("Job", func() {
	var client *Client

	Describe("Job", func() {
		DescribeTable("IsComplete",
			func(status constant.JobState, expected bool) {
				job := Job{State: status}
				Expect(job.IsComplete()).To(Equal(expected))
			},

			Entry("when failed, it returns false", constant.JobFailed, false),
			Entry("when complete, it returns true", constant.JobComplete, true),
			Entry("when processing, it returns false", constant.JobProcessing, false),
		)

		DescribeTable("HasFailed",
			func(status constant.JobState, expected bool) {
				job := Job{State: status}
				Expect(job.HasFailed()).To(Equal(expected))
			},

			Entry("when failed, it returns true", constant.JobFailed, true),
			Entry("when complete, it returns false", constant.JobComplete, false),
			Entry("when processing, it returns false", constant.JobProcessing, false),
		)

		Describe("IsAt", func() {
			It("returns true when status matches", func() {
				job := Job{State: constant.JobComplete}
				Expect(job.IsAt(constant.JobComplete)).To(BeTrue())
				job = Job{State: constant.JobFailed}
				Expect(job.IsAt(constant.JobFailed)).To(BeTrue())
				job = Job{State: constant.JobProcessing}
				Expect(job.IsAt(constant.JobProcessing)).To(BeTrue())
				job = Job{State: constant.JobPolling}
				Expect(job.IsAt(constant.JobPolling)).To(BeTrue())
			})
			It("returns false when status does not match", func() {
				job := Job{State: constant.JobComplete}
				Expect(job.IsAt(constant.JobFailed)).To(BeFalse())
				Expect(job.IsAt(constant.JobProcessing)).To(BeFalse())
				Expect(job.IsAt(constant.JobPolling)).To(BeFalse())
				job = Job{State: constant.JobPolling}
				Expect(job.IsAt(constant.JobFailed)).To(BeFalse())
				Expect(job.IsAt(constant.JobProcessing)).To(BeFalse())
				Expect(job.IsAt(constant.JobComplete)).To(BeFalse())
			})
		})

		DescribeTable("Errors converts JobErrorDetails",
			func(code int, expectedErrType error) {
				rawErr := JobErrorDetails{
					Code:   constant.JobErrorCode(code),
					Detail: fmt.Sprintf("code %d", code),
					Title:  "some-err-title",
				}

				job := Job{
					GUID:      "some-job-guid",
					RawErrors: []JobErrorDetails{rawErr},
				}

				Expect(job.Errors()).To(HaveLen(1))
				Expect(job.Errors()[0]).To(MatchError(expectedErrType))
			},

			Entry("BuildpackNameStackTaken", 290000, ccerror.BuildpackAlreadyExistsForStackError{Message: "code 290000"}),
			Entry("BuildpackInvalid", 290003, ccerror.BuildpackInvalidError{Message: "code 290003"}),
			Entry("BuildpackStacksDontMatch", 390011, ccerror.BuildpackStacksDontMatchError{Message: "code 390011"}),
			Entry("BuildpackStackDoesNotExist", 390012, ccerror.BuildpackStackDoesNotExistError{Message: "code 390012"}),
			Entry("BuildpackZipError", 390013, ccerror.BuildpackZipInvalidError{Message: "code 390013"}),
			Entry("V3JobFailedError", 1111111, ccerror.V3JobFailedError{JobGUID: "some-job-guid", Code: constant.JobErrorCode(1111111), Detail: "code 1111111", Title: "some-err-title"}),
		)
	})

	Describe("GetJob", func() {
		var (
			jobLocation JobURL

			job        Job
			warnings   Warnings
			executeErr error
		)

		BeforeEach(func() {
			client, _ = NewTestClient()
			jobLocation = JobURL(fmt.Sprintf("%s/some-job-location", server.URL()))
		})

		JustBeforeEach(func() {
			job, warnings, executeErr = client.GetJob(jobLocation)
		})

		When("no errors are encountered", func() {
			BeforeEach(func() {
				jsonResponse := `{
						"guid": "job-guid",
						"created_at": "2016-06-08T16:41:27Z",
						"updated_at": "2016-06-08T16:41:27Z",
						"operation": "app.delete",
						"state": "PROCESSING",
						"warnings": [{"detail": "a warning"}, {"detail": "another warning"}],
						"links": {
							"self": {
								"href": "/v3/jobs/job-guid"
							}
						}
					}
				}`

				server.AppendHandlers(
					CombineHandlers(
						VerifyRequest(http.MethodGet, "/some-job-location"),
						RespondWith(http.StatusOK, jsonResponse, http.Header{"X-Cf-Warnings": {"warning-1, warning-2"}}),
					))
			})

			It("returns job with all warnings", func() {
				Expect(executeErr).NotTo(HaveOccurred())
				Expect(warnings).To(ConsistOf(Warnings{"warning-1", "warning-2", "a warning", "another warning"}))
				Expect(job.GUID).To(Equal("job-guid"))
				Expect(job.State).To(Equal(constant.JobProcessing))
			})
		})

		When("the job fails", func() {
			BeforeEach(func() {
				jsonResponse := `{
						"guid": "job-guid",
						"created_at": "2016-06-08T16:41:27Z",
						"updated_at": "2016-06-08T16:41:27Z",
						"operation": "delete",
						"state": "FAILED",
						"errors": [
							{
								"detail": "blah blah",
								"title": "CF-JobFail",
								"code": 1234
							}
						],
						"links": {
							"self": {
								"href": "/v3/jobs/job-guid"
							}
						}
					}`

				server.AppendHandlers(
					CombineHandlers(
						VerifyRequest(http.MethodGet, "/some-job-location"),
						RespondWith(http.StatusOK, jsonResponse, http.Header{"X-Cf-Warnings": {"warning-1, warning-2"}}),
					))
			})

			It("returns job with all warnings", func() {
				Expect(executeErr).NotTo(HaveOccurred())
				Expect(warnings).To(ConsistOf(Warnings{"warning-1", "warning-2"}))
				Expect(job.GUID).To(Equal("job-guid"))
				Expect(job.State).To(Equal(constant.JobFailed))
				Expect(job.RawErrors[0].Detail).To(Equal("blah blah"))
				Expect(job.RawErrors[0].Title).To(Equal("CF-JobFail"))
				Expect(job.RawErrors[0].Code).To(BeEquivalentTo(1234))
			})
		})
	})

	When("Polling jobs", func() {
		var (
			jobLocation JobURL

			warnings   Warnings
			executeErr error

			startTime time.Time

			jobPollingTimeout time.Duration
			fakeClock         *ccv3fakes.FakeClock
		)

		appendHandler := func(state string, warnings Warnings) {
			server.AppendHandlers(
				CombineHandlers(
					VerifyRequest(http.MethodGet, "/some-job-location"),
					RespondWith(http.StatusAccepted, fmt.Sprintf(`
						{
							"guid": "job-guid",
							"created_at": "2016-06-08T16:41:27Z",
							"updated_at": "2016-06-08T16:41:27Z",
							"operation": "app.delete",
							"state": "%s",
							"links": {
								"self": {
									"href": "/v3/jobs/job-guid"
								}
							}
						}`, state), http.Header{"X-Cf-Warnings": warnings}),
				),
			)
		}

		appendFailureHandler := func(message string, code constant.JobErrorCode, warnings Warnings) {
			server.AppendHandlers(
				CombineHandlers(
					VerifyRequest(http.MethodGet, "/some-job-location"),
					RespondWith(http.StatusOK, fmt.Sprintf(`{
							"guid": "job-guid",
							"created_at": "2016-06-08T16:41:27Z",
							"updated_at": "2016-06-08T16:41:27Z",
							"operation": "app.delete",
							"state": "FAILED",
							"errors": [ {
								"detail": "%s",
								"code": %d
							} ],
							"links": {
								"self": {
									"href": "/v3/jobs/job-guid"
								}
							}
						}`, message, code), http.Header{"X-Cf-Warnings": warnings}),
				),
			)
		}

		itSkipsEmptyURLs := func() {
			When("the job URL is empty", func() {
				BeforeEach(func() {
					jobLocation = ""
				})

				It("immediately succeeds", func() {
					Expect(executeErr).ToNot(HaveOccurred())
					Expect(warnings).To(BeEmpty())
				})
			})
		}

		itFinishesWhenCompleteOrFailed := func() {
			When("the job starts queued and then finishes successfully", func() {
				BeforeEach(func() {
					appendHandler("PROCESSING", Warnings{"warning-1"})
					appendHandler("PROCESSING", Warnings{"warning-2"})
					appendHandler("COMPLETE", Warnings{"warning-3", "warning-4"})
				})

				It("should poll until completion", func() {
					Expect(executeErr).ToNot(HaveOccurred())
					Expect(warnings).To(ConsistOf("warning-1", "warning-2", "warning-3", "warning-4"))
				})
			})

			When("the job starts queued and then fails", func() {
				BeforeEach(func() {
					appendHandler("PROCESSING", Warnings{"warning-1"})
					appendHandler("PROCESSING", Warnings{"warning-2", "warning-3"})
				})
				Context("with an error", func() {
					BeforeEach(func() {
						appendFailureHandler("some-message", constant.JobErrorCodeBuildpackAlreadyExistsForStack, Warnings{"warning-4"})
					})
					It("returns the first error", func() {
						Expect(executeErr).To(MatchError(ccerror.BuildpackAlreadyExistsForStackError{
							Message: "some-message",
						}))
						Expect(warnings).To(ConsistOf("warning-1", "warning-2", "warning-3", "warning-4"))
					})
				})
				Context("without an error", func() {
					BeforeEach(func() {
						server.AppendHandlers(
							CombineHandlers(
								VerifyRequest(http.MethodGet, "/some-job-location"),
								RespondWith(http.StatusOK, `{
							"guid": "job-guid",
							"created_at": "2016-06-08T16:41:27Z",
							"updated_at": "2016-06-08T16:41:27Z",
							"operation": "app.delete",
							"state": "FAILED",
							"errors": null,
							"links": {
								"self": {
									"href": "/v3/jobs/job-guid"
								}
							}
						}`, http.Header{"X-Cf-Warnings": []string{"warning-4"}}),
							),
						)
					})

					It("returns the JobFailedNoErrorError", func() {
						Expect(executeErr).To(MatchError(ccerror.JobFailedNoErrorError{
							JobGUID: "job-guid",
						}))
						Expect(warnings).To(ConsistOf("warning-1", "warning-2", "warning-3", "warning-4"))
					})
				})
			})

		}

		itRespectsTimeouts := func() {
			Context("polling timeouts", func() {
				When("the job runs longer than the OverallPollingTimeout", func() {
					BeforeEach(func() {
						jobPollingTimeout = 100 * time.Millisecond
						client, fakeClock = NewTestClient(Config{
							JobPollingTimeout: jobPollingTimeout,
						})

						clockTime := time.Now()
						fakeClock.NowReturnsOnCall(0, clockTime)
						fakeClock.NowReturnsOnCall(1, clockTime)
						fakeClock.NowReturnsOnCall(2, clockTime.Add(60*time.Millisecond))
						fakeClock.NowReturnsOnCall(3, clockTime.Add(60*time.Millisecond*2))

						appendHandler("PROCESSING", Warnings{"warning-1"})
						appendHandler("PROCESSING", Warnings{"warning-2", "warning-3"})
						appendHandler("FINISHED", Warnings{"warning-4"})
					})

					It("raises a JobTimeoutError", func() {
						Expect(executeErr).To(MatchError(ccerror.JobTimeoutError{
							Timeout: jobPollingTimeout,
							JobGUID: "job-guid",
						}))
						Expect(warnings).To(ConsistOf("warning-1", "warning-2", "warning-3"))
					})

					// Fuzzy test to ensure that the overall function time isn't [far]
					// greater than the OverallPollingTimeout. Since this is partially
					// dependent on the speed of the system, the expectation is that the
					// function *should* never exceed three times the timeout.
					It("does not run [too much] longer than the timeout", func() {
						endTime := time.Now()
						Expect(executeErr).To(HaveOccurred())

						// If the jobPollingTimeout is less than the PollingInterval,
						// then the margin may be too small, we should not allow the
						// jobPollingTimeout to be set to less than the PollingInterval
						Expect(endTime).To(BeTemporally("~", startTime, 3*jobPollingTimeout))
					})
				})
			})
		}

		BeforeEach(func() {
			client, _ = NewTestClient(Config{JobPollingTimeout: time.Minute})
			jobLocation = JobURL(fmt.Sprintf("%s/some-job-location", server.URL()))
		})

		Describe("PollJob", func() {
			JustBeforeEach(func() {
				startTime = time.Now()
				warnings, executeErr = client.PollJob(jobLocation)
			})

			itSkipsEmptyURLs()
			itFinishesWhenCompleteOrFailed()
			itRespectsTimeouts()
		})

		Describe("PollJobForState", func() {
			JustBeforeEach(func() {
				startTime = time.Now()
				warnings, executeErr = client.PollJobForState(jobLocation, constant.JobPolling)
			})

			itSkipsEmptyURLs()
			itFinishesWhenCompleteOrFailed()
			itRespectsTimeouts()

			When("Job reaches the required state", func() {
				BeforeEach(func() {
					appendHandler("PROCESSING", Warnings{"warning-1"})
					appendHandler("PROCESSING", Warnings{"warning-2"})
					appendHandler("POLLING", Warnings{"warning-3"})
				})

				It("should poll until the desired state", func() {
					Expect(executeErr).ToNot(HaveOccurred())
					Expect(warnings).To(ConsistOf("warning-1", "warning-2", "warning-3"))
				})
			})
		})

		Describe("PollJobToEventStream", func() {
			var stream chan PollJobEvent

			JustBeforeEach(func() {
				startTime = time.Now()
				stream = client.PollJobToEventStream(jobLocation)
			})

			When("the job URL is empty", func() {
				BeforeEach(func() {
					jobLocation = ""
				})

				It("closes the channel without events", func() {
					Consistently(stream).ShouldNot(Receive())
					Eventually(stream).Should(BeClosed())
				})
			})

			When("the job starts queued and then finishes successfully", func() {
				BeforeEach(func() {
					appendHandler("PROCESSING", Warnings{"warning-1"})
					appendHandler("PROCESSING", Warnings{"warning-2"})
					appendHandler("COMPLETE", Warnings{"warning-3", "warning-4"})
				})

				It("should poll until completion", func() {
					Eventually(stream).Should(Receive(Equal(PollJobEvent{
						State:    constant.JobProcessing,
						Err:      nil,
						Warnings: Warnings{"warning-1"},
					})))
					Eventually(stream).Should(Receive(Equal(PollJobEvent{
						State:    constant.JobProcessing,
						Err:      nil,
						Warnings: Warnings{"warning-2"},
					})))
					Eventually(stream).Should(Receive(Equal(PollJobEvent{
						State:    constant.JobComplete,
						Err:      nil,
						Warnings: Warnings{"warning-3", "warning-4"},
					})))
					Eventually(stream).Should(BeClosed())
				})
			})

			When("the job starts queued and then fails", func() {
				BeforeEach(func() {
					appendHandler("PROCESSING", Warnings{"warning-1"})
					appendHandler("PROCESSING", Warnings{"warning-2", "warning-3"})
					appendFailureHandler("some-message", constant.JobErrorCodeBuildpackAlreadyExistsForStack, Warnings{"warning-4"})
				})

				It("returns the first error", func() {
					Eventually(stream).Should(Receive(Equal(PollJobEvent{
						State:    constant.JobProcessing,
						Err:      nil,
						Warnings: Warnings{"warning-1"},
					})))
					Eventually(stream).Should(Receive(Equal(PollJobEvent{
						State:    constant.JobProcessing,
						Err:      nil,
						Warnings: Warnings{"warning-2", "warning-3"},
					})))
					Eventually(stream).Should(Receive(Equal(PollJobEvent{
						State:    constant.JobFailed,
						Err:      ccerror.BuildpackAlreadyExistsForStackError{Message: "some-message"},
						Warnings: Warnings{"warning-4"},
					})))
					Eventually(stream).Should(BeClosed())
				})
			})

			Context("polling timeouts", func() {
				When("the job runs longer than the OverallPollingTimeout", func() {
					BeforeEach(func() {
						jobPollingTimeout = 100 * time.Millisecond
						client, fakeClock = NewTestClient(Config{
							JobPollingTimeout: jobPollingTimeout,
						})

						clockTime := time.Now()
						fakeClock.NowReturnsOnCall(0, clockTime)
						fakeClock.NowReturnsOnCall(1, clockTime)
						fakeClock.NowReturnsOnCall(2, clockTime.Add(60*time.Millisecond))
						fakeClock.NowReturnsOnCall(3, clockTime.Add(60*time.Millisecond*2))

						appendHandler("PROCESSING", Warnings{"warning-1"})
						appendHandler("PROCESSING", Warnings{"warning-2", "warning-3"})
						appendHandler("PROCESSING", Warnings{"warning-4"})
					})

					It("returns a JobTimeoutError", func() {
						Eventually(stream).Should(Receive(Equal(PollJobEvent{
							State: constant.JobProcessing,
							Err: ccerror.JobTimeoutError{
								Timeout: jobPollingTimeout,
								JobGUID: "job-guid",
							},
							Warnings: Warnings{"warning-4"},
						})))
						Eventually(stream).Should(BeClosed())
					})

					// Fuzzy test to ensure that the overall function time isn't [far]
					// greater than the OverallPollingTimeout. Since this is partially
					// dependent on the speed of the system, the expectation is that the
					// function *should* never exceed three times the timeout.
					It("does not run [too much] longer than the timeout", func() {
						Eventually(stream).Should(BeClosed())
						endTime := time.Now()

						// If the jobPollingTimeout is less than the PollingInterval,
						// then the margin may be too small, we should not allow the
						// jobPollingTimeout to be set to less than the PollingInterval
						Expect(endTime).To(BeTemporally("~", startTime, 3*jobPollingTimeout))
					})
				})
			})
		})
	})
})