blue_green_deploy_test.go

package main_test

import (
	"bytes"
	"errors"
	"strings"

	"code.cloudfoundry.org/cli/plugin/models"
	"code.cloudfoundry.org/cli/plugin/pluginfakes"
	"fmt"
	. "github.com/bluemixgaragelondon/cf-blue-green-deploy"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

var _ = Describe("BlueGreenDeploy", func() {
	var (
		bgdExitsWithErrors []error
		bgdOut             *bytes.Buffer
		connection         *pluginfakes.FakeCliConnection
		p                  BlueGreenDeploy
		testErrorFunc      func(message string, err error)
	)

	BeforeEach(func() {
		bgdExitsWithErrors = []error{}
		testErrorFunc = func(message string, err error) {
			bgdExitsWithErrors = append(bgdExitsWithErrors, err)
		}
		bgdOut = &bytes.Buffer{}

		connection = &pluginfakes.FakeCliConnection{}
		p = BlueGreenDeploy{Connection: connection, ErrorFunc: testErrorFunc, Out: bgdOut}
	})

	Describe("maps routes", func() {
		var (
			manifestApp plugin_models.GetAppModel
		)

		BeforeEach(func() {
			manifestApp = plugin_models.GetAppModel{
				Name: "new",
				Routes: []plugin_models.GetApp_RouteSummary{
					{Host: "host", Domain: plugin_models.GetApp_DomainFields{Name: "example.com"}},
					{Host: "host", Domain: plugin_models.GetApp_DomainFields{Name: "example.net"}},
				},
			}
		})

		It("maps all", func() {
			p.MapRoutesToApp(manifestApp.Name, manifestApp.Routes...)

			cfCommands := getAllCfCommands(connection)

			Expect(cfCommands).To(Equal([]string{
				"map-route new example.com -n host",
				"map-route new example.net -n host",
			}))
		})
	})

	Describe("remove routes from old app", func() {
		var (
			oldApp plugin_models.GetAppModel
		)

		BeforeEach(func() {
			oldApp = plugin_models.GetAppModel{
				Name: "old",
				Routes: []plugin_models.GetApp_RouteSummary{
					{Host: "live", Domain: plugin_models.GetApp_DomainFields{Name: "mybluemix.net"}},
					{Host: "live", Domain: plugin_models.GetApp_DomainFields{Name: "example.com"}},
				},
			}
		})

		It("unmaps all routes from the old app", func() {
			p.UnmapRoutesFromApp(oldApp.Name, oldApp.Routes...)

			cfCommands := getAllCfCommands(connection)

			Expect(cfCommands).To(Equal([]string{
				"unmap-route old mybluemix.net -n live",
				"unmap-route old example.com -n live",
			}))
		})

		It("unmaps routes from old app with paths", func() {
			oldApp = plugin_models.GetAppModel{
				Name: "old",
				Routes: []plugin_models.GetApp_RouteSummary{
					{Host: "live", Domain: plugin_models.GetApp_DomainFields{Name: "mybluemix.net"}, Path: "my/context/path1"},
					{Host: "live", Domain: plugin_models.GetApp_DomainFields{Name: "example.com"}, Path: "my/context/path2"},
				},
			}
			p.UnmapRoutesFromApp(oldApp.Name, oldApp.Routes...)

			cfCommands := getAllCfCommands(connection)

			Expect(cfCommands).To(Equal([]string{
				"unmap-route old mybluemix.net -n live --path my/context/path1",
				"unmap-route old example.com -n live --path my/context/path2",
			}))
		})
	})

	Describe("checks ssh enablement", func() {
		Context("when ssh support is disabled", func() {
			BeforeEach(func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return []string{fmt.Sprintf("ssh support is disabled for '%s'", args[0])}, nil
				}
			})

			It("returns false", func() {
				result := p.CheckSshEnablement("test-app")

				Expect(result).To(BeFalse())
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"ssh-enabled test-app",
				}))
			})
		})

		Context("when ssh support is enabled", func() {
			BeforeEach(func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return []string{fmt.Sprintf("ssh support is enabled for '%s'", args[0])}, nil
				}
			})

			It("returns true", func() {
				result := p.CheckSshEnablement("test-app")

				Expect(result).To(BeTrue())
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"ssh-enabled test-app",
				}))
			})
		})

		Context("when cf cli errors", func() {
			BeforeEach(func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return nil, errors.New("failed to check ssh enablement status")
				}
			})

			It("it reports the error", func() {
				p.CheckSshEnablement("test-app")
				Expect(bgdExitsWithErrors[0]).To(MatchError("failed to check ssh enablement status"))
			})
		})
	})

	Describe("set ssh access", func() {
		Context("when it just works", func() {
			It("enables ssh", func() {
				p.SetSshAccess("test-app", true)

				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"enable-ssh test-app",
				}))
			})
			It("disables ssh", func() {
				p.SetSshAccess("test-app", false)

				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"disable-ssh test-app",
				}))
			})
		})
		Context("when cf enable-ssh errors", func() {
			BeforeEach(func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return nil, errors.New("failed to enable ssh")
				}
			})

			It("it reports the error", func() {
				p.SetSshAccess("test-app", true)
				Expect(bgdExitsWithErrors[0]).To(MatchError("failed to enable ssh"))
			})
		})
		Context("when cf disable-ssh errors", func() {
			BeforeEach(func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return nil, errors.New("failed to disable ssh")
				}
			})

			It("it reports the error", func() {
				p.SetSshAccess("test-app", false)
				Expect(bgdExitsWithErrors[0]).To(MatchError("failed to disable ssh"))
			})
		})
	})

	Describe("renaming an app", func() {
		var app string

		BeforeEach(func() {
			app = "foo"
		})

		It("renames the app", func() {
			p.RenameApp(app, "bar")
			cfCommands := getAllCfCommands(connection)

			Expect(cfCommands).To(ContainElement(
				"rename foo bar",
			))
		})

		Context("when renaming the app fails", func() {
			It("calls the error callback", func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return nil, errors.New("failed to rename app")
				}
				p.RenameApp(app, "bar")

				Expect(bgdExitsWithErrors[0]).To(MatchError("failed to rename app"))
			})
		})
	})

	Describe("delete old apps", func() {
		var (
			apps []plugin_models.GetAppsModel
		)

		Context("with live and old apps", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name-old"},
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("only deletes the old apps", func() {
				p.DeleteAllAppsExceptLiveApp("app-name")
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"delete app-name-old -f -r",
				}))
			})

			Context("when the deletion of an app fails", func() {
				BeforeEach(func() {
					connection.CliCommandStub = func(args ...string) ([]string, error) {
						return nil, errors.New("failed to delete app")
					}
				})

				It("returns an error", func() {
					p.DeleteAllAppsExceptLiveApp("app-name")
					Expect(bgdExitsWithErrors[0]).To(HaveOccurred())
				})
			})
		})

		Context("with live and failed apps", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name-failed"},
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("only deletes the failed apps", func() {
				p.DeleteAllAppsExceptLiveApp("app-name")
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"delete app-name-failed -f -r",
				}))
			})
		})

		Context("with live and new apps", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name-new"},
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("only deletes the new apps", func() {
				p.DeleteAllAppsExceptLiveApp("app-name")
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"delete app-name-new -f -r",
				}))
			})
		})

		Context("when there is no old version deployed", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("succeeds", func() {
				p.DeleteAllAppsExceptLiveApp("app-name")
				Expect(bgdExitsWithErrors).To(HaveLen(0))
			})

			It("deletes nothing", func() {
				p.DeleteAllAppsExceptLiveApp("app-name")
				Expect(connection.CliCommandCallCount()).To(Equal(0))
			})
		})
	})

	Describe("delete old apps (but not failed ones)", func() {
		var (
			apps []plugin_models.GetAppsModel
		)

		Context("with live and old apps", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name-old"},
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("only deletes the old apps", func() {
				p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"delete app-name-old -f -r",
				}))
			})

			Context("when the deletion of an app fails", func() {
				BeforeEach(func() {
					connection.CliCommandStub = func(args ...string) ([]string, error) {
						return nil, errors.New("failed to delete app")
					}
				})

				It("returns an error", func() {
					p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
					Expect(bgdExitsWithErrors[0]).To(HaveOccurred())
				})
			})
		})

		Context("with live and failed apps", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name-failed"},
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("succeeds", func() {
				p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
				Expect(bgdExitsWithErrors).To(HaveLen(0))
			})

			It("deletes nothing", func() {
				p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
				Expect(connection.CliCommandCallCount()).To(Equal(0))
			})
		})

		Context("with live and new apps", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name-new"},
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("only deletes the new apps", func() {
				p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"delete app-name-new -f -r",
				}))
			})
		})

		Context("when there is no old version deployed", func() {
			BeforeEach(func() {
				apps = []plugin_models.GetAppsModel{
					{Name: "app-name"},
				}
				connection.GetAppsReturns(apps, nil)
			})

			It("succeeds", func() {
				p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
				Expect(bgdExitsWithErrors).To(HaveLen(0))
			})

			It("deletes nothing", func() {
				p.DeleteAllAppsExceptLiveAndFailedApp("app-name")
				Expect(connection.CliCommandCallCount()).To(Equal(0))
			})
		})
	})

	Describe("deleting apps", func() {
		Context("when there is an old version deployed", func() {
			apps := []plugin_models.GetAppsModel{
				{Name: "app-name-old"},
				{Name: "app-name-old"},
			}

			It("deletes the apps", func() {
				p.DeleteAppVersions(apps)
				cfCommands := getAllCfCommands(connection)

				Expect(cfCommands).To(Equal([]string{
					"delete app-name-old -f -r",
					"delete app-name-old -f -r",
				}))
			})

			Context("when the deletion of an app fails", func() {
				BeforeEach(func() {
					connection.CliCommandStub = func(args ...string) ([]string, error) {
						return nil, errors.New("failed to delete app")
					}
				})

				It("returns an error", func() {
					p.DeleteAppVersions(apps)
					Expect(bgdExitsWithErrors[0]).To(HaveOccurred())
				})
			})
		})

		Context("when there is no old version deployed", func() {
			apps := []plugin_models.GetAppsModel{}

			It("succeeds", func() {
				p.DeleteAppVersions(apps)
				Expect(bgdExitsWithErrors).To(HaveLen(0))
			})

			It("deletes nothing", func() {
				p.DeleteAppVersions(apps)
				Expect(connection.CliCommandCallCount()).To(Equal(0))
			})
		})
	})

	Describe("getting the scale parameters", func() {
		Context("for a running app", func() {
			appName := "existing app"
			var instanceCount int = 3
			var memory int64 = 9001
			var diskQuota int64 = 100
			BeforeEach(func() {
				appModel := plugin_models.GetAppModel{
					InstanceCount: instanceCount,
					Memory:        memory,
					DiskQuota:     diskQuota,
				}
				connection.GetAppReturns(appModel, nil)
			})
			It("reads the app data and returns the scale parameters", func() {
				scaleParameters, _ := p.GetScaleParameters(appName)
				Expect(scaleParameters.InstanceCount).To(Equal(instanceCount))
				Expect(scaleParameters.Memory).To(Equal(memory))
				Expect(scaleParameters.DiskQuota).To(Equal(diskQuota))
			})
		})
		Context("for an app that does not exist", func() {
			appName := "invalid app"
			BeforeEach(func() {
				appModel := plugin_models.GetAppModel{}
				connection.GetAppReturns(appModel, errors.New("App was not found"))
			})
			It("returns an empty struct and an error value", func() {
				scaleParameters, error := p.GetScaleParameters(appName)
				Expect(error).ToNot(Equal(nil))
				Expect(scaleParameters.InstanceCount).To(Equal(0))
				Expect(scaleParameters.Memory).To(Equal(int64(0)))
				Expect(scaleParameters.DiskQuota).To(Equal(int64(0)))
			})
		})
	})

	Describe("pushing a new app", func() {
		newApp := "app-name-new"
		newRoute := plugin_models.GetApp_RouteSummary{Host: newApp, Domain: plugin_models.GetApp_DomainFields{Name: "example.com"}}
		scaleParameters := ScaleParameters{}

		It("pushes an app with new appended to its name", func() {
			p.PushNewApp(newApp, newRoute, "", scaleParameters)

			Expect(strings.Join(connection.CliCommandArgsForCall(0), " ")).
				To(MatchRegexp(`^push app-name-new`))
		})

		It("uses the generated name for the route", func() {
			p.PushNewApp(newApp, newRoute, "", scaleParameters)

			Expect(strings.Join(connection.CliCommandArgsForCall(0), " ")).
				To(MatchRegexp(`-n app-name-new`))
		})

		It("pushes with the default cf domain", func() {
			p.PushNewApp(newApp, newRoute, "", scaleParameters)

			Expect(strings.Join(connection.CliCommandArgsForCall(0), " ")).
				To(MatchRegexp(`-d example.com`))
		})

		It("pushes with the specified manifest, if present", func() {
			manifestPath := "./manifest-tst.yml"
			p.PushNewApp(newApp, newRoute, manifestPath, scaleParameters)

			Expect(strings.Join(connection.CliCommandArgsForCall(0), " ")).
				To(MatchRegexp(`-f ./manifest-tst.yml`))
		})

		It("pushes without a manifest arg, if no manifest in deployer", func() {
			p.PushNewApp(newApp, newRoute, "", scaleParameters)

			Expect(strings.Join(connection.CliCommandArgsForCall(0), " ")).
				To(Not(MatchRegexp(`-f `)))
		})

		It("pushes using the scale values of the old app", func() {
			liveAppModel := plugin_models.GetAppModel{
				Memory:        int64(32),
				DiskQuota:     int64(700),
				InstanceCount: 27,
			}
			connection.GetAppReturns(liveAppModel, nil)

			p.PushNewApp(newApp, newRoute, "", ScaleParameters{})

			commandString := strings.Join(connection.CliCommandArgsForCall(0), " ")
			Expect(commandString).To(MatchRegexp(`-m 32M`))
			Expect(commandString).To(MatchRegexp(`-k 700M`))
			Expect(commandString).To(MatchRegexp(`-i 27`))
		})

		It("uses the manifest memory field if there is a live app running", func() {
			liveAppModel := plugin_models.GetAppModel{
				Memory:        int64(16),
				DiskQuota:     int64(500),
				InstanceCount: 6,
			}
			connection.GetAppReturns(liveAppModel, nil)
			manifestScaleParameters := ScaleParameters{
				Memory: int64(32),
			}
			p.PushNewApp(newApp, newRoute, "", manifestScaleParameters)
			commandString := strings.Join(connection.CliCommandArgsForCall(0), " ")
			Expect(commandString).To(MatchRegexp(`-m 32M`))
			Expect(commandString).To(MatchRegexp(`-k 500M`))
			Expect(commandString).To(MatchRegexp(`-i 6`))
		})

		Context("when some scale parameter values are zero", func() {
			It("pushes using only the defined parameters", func() {
				scaleParameters = ScaleParameters{
					InstanceCount: 0,
					Memory:        32,
					DiskQuota:     0,
				}
				p.PushNewApp(newApp, newRoute, "", scaleParameters)

				commandString := strings.Join(connection.CliCommandArgsForCall(0), " ")
				Expect(commandString).To(MatchRegexp(`-m`))
				Expect(commandString).ToNot(MatchRegexp(`-k`))
				Expect(commandString).ToNot(MatchRegexp(`-i`))
			})
		})

		Context("when the push fails", func() {
			BeforeEach(func() {
				connection.CliCommandStub = func(args ...string) ([]string, error) {
					return nil, errors.New("failed to push app")
				}
			})

			It("returns an error", func() {
				p.PushNewApp(newApp, newRoute, "", scaleParameters)

				Expect(bgdExitsWithErrors[0]).To(MatchError("failed to push app"))
			})
		})
	})

	Describe("live app", func() {
		liveApp := plugin_models.GetAppModel{Name: "app-name"}

		Context("with live and old apps", func() {
			It("returns the live app", func() {
				connection.GetAppReturns(liveApp, nil)

				name, _ := p.LiveApp("app-name")
				Expect(name).To(Equal(liveApp.Name))
			})
		})

		Context("with no apps", func() {
			It("returns an empty app name", func() {
				connection.GetAppReturns(plugin_models.GetAppModel{}, errors.New("an error for no apps"))

				name, _ := p.LiveApp("app-name")
				Expect(name).To(BeEmpty())
			})
		})
	})

	Describe("app filter", func() {
		Context("when there are 2 old versions and 1 non-old version", func() {
			var (
				appList []plugin_models.GetAppsModel
				oldApps []plugin_models.GetAppsModel
			)

			BeforeEach(func() {
				appList = []plugin_models.GetAppsModel{
					{Name: "foo-old"},
					{Name: "foo-old"},
					{Name: "foo"},
					{Name: "bar-foo-old"},
					{Name: "foo-older"},
				}
				oldApps = p.GetOldApps("foo", appList)
			})

			Describe("old app list", func() {
				It("returns all apps that have the same name, with a valid timestamp and -old suffix", func() {
					Expect(oldApps).To(ContainElement(appList[0]))
					Expect(oldApps).To(ContainElement(appList[1]))
				})

				It("doesn't return any apps that don't have a -old suffix", func() {
					Expect(oldApps).ToNot(ContainElement(appList[2]))
				})

				It("doesn't return elements that have an additional prefix before the app name", func() {
					Expect(oldApps).ToNot(ContainElement(appList[3]))
				})

				It("doesn't return elements that have an additional suffix after -old", func() {
					Expect(oldApps).ToNot(ContainElement(appList[4]))
				})
			})
		})
	})

	Describe("smoke test runner", func() {
		It("returns stdout", func() {
			_ = p.RunSmokeTests("test/support/smoke-test-script", "app.mybluemix.net")
			Expect(bgdOut.String()).To(ContainSubstring("STDOUT"))
		})

		It("returns stderr", func() {
			_ = p.RunSmokeTests("test/support/smoke-test-script", "app.mybluemix.net")
			Expect(bgdOut.String()).To(ContainSubstring("STDERR"))
		})

		It("passes app FQDN as first argument", func() {
			_ = p.RunSmokeTests("test/support/smoke-test-script", "app.mybluemix.net")
			Expect(bgdOut.String()).To(ContainSubstring("App FQDN is: app.mybluemix.net"))
		})

		Context("when script doesn't exist", func() {
			It("fails with useful error", func() {
				_ = p.RunSmokeTests("inexistent-smoke-test-script", "app.mybluemix.net")
				Expect(bgdExitsWithErrors[0].Error()).To(ContainSubstring("executable file not found"))
			})
		})

		Context("when script isn't executable", func() {
			It("fails with useful error", func() {
				_ = p.RunSmokeTests("test/support/nonexec-smoke-test-script", "app.mybluemix.net")
				Expect(bgdExitsWithErrors[0].Error()).To(ContainSubstring("permission denied"))
			})
		})

		Context("when script fails", func() {
			var passSmokeTest bool

			BeforeEach(func() {
				passSmokeTest = p.RunSmokeTests("test/support/smoke-test-script", "FORCE-SMOKE-TEST-FAILURE")
			})

			It("returns false", func() {
				Expect(passSmokeTest).To(Equal(false))
			})

			It("doesn't fail", func() {
				Expect(bgdExitsWithErrors).To(HaveLen(0))
			})
		})
	})

})

func getAllCfCommands(connection *pluginfakes.FakeCliConnection) (commands []string) {
	commands = []string{}
	for i := 0; i < connection.CliCommandCallCount(); i++ {
		args := connection.CliCommandArgsForCall(i)
		commands = append(commands, strings.Join(args, " "))
	}
	return
}