appdynamics_test.go

package hooks_test

import (
	"bytes"
	"os"

	"github.com/cloudfoundry/python-buildpack/src/python/hooks"

	"path/filepath"

	"fmt"

	"github.com/cloudfoundry/libbuildpack"
	"github.com/cloudfoundry/libbuildpack/ansicleaner"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
)

const buildOrder = "9"

var _ = Describe("Appdynamics", func() {
	var (
		err         error
		buildDir    string
		depsDir     string
		stager      *libbuildpack.Stager
		buffer      *bytes.Buffer
		appdynamics hooks.AppdynamicsHook
	)

	BeforeEach(func() {
		buildDir, err = os.MkdirTemp("", "python-buildpack.build.")
		Expect(err).NotTo(HaveOccurred())
		DeferCleanup(os.RemoveAll, buildDir)

		depsDir, err = os.MkdirTemp("", "python-buildpack.deps.")
		Expect(err).NotTo(HaveOccurred())
		DeferCleanup(os.RemoveAll, depsDir)

		buffer = new(bytes.Buffer)
		logger := libbuildpack.NewLogger(ansicleaner.New(buffer))

		args := []string{buildDir, "", depsDir, buildOrder}
		stager = libbuildpack.NewStager(args, logger, &libbuildpack.Manifest{})

		command := &libbuildpack.Command{}

		appdynamics = hooks.AppdynamicsHook{
			Log:     logger,
			Command: command,
		}
	})

	Context("GenerateStartUpCommand", func() {
		It("Returns the command when it is provided in the correct format", func() {
			startCommand := "web: python flask.py"
			ModifiedCommand, err := appdynamics.GenerateStartUpCommand(startCommand)
			Expect(ModifiedCommand).To(Equal("web: pyagent run --  python flask.py"))
			Expect(err).NotTo(HaveOccurred())
		})

		It("Returns an error when provided the wrong format", func() {
			startCommand := "python flask.py"
			_, err := appdynamics.GenerateStartUpCommand(startCommand)
			Expect(err).To(MatchError("improper format found in Procfile"))
		})

	})

	Context("RewriteProcFile", func() {
		var (
			err         error
			tempProcDir string
		)
		BeforeEach(func() {
			tempProcDir, err = os.MkdirTemp("", "Procfiles")
			DeferCleanup(os.RemoveAll, tempProcDir)
		})

		It("rewrites the procfile with pyagent", func() {
			Expect(os.WriteFile(filepath.Join(tempProcDir, "Procfile"), []byte("web: python app.py"), 0666)).To(Succeed())
			Expect(err).NotTo(HaveOccurred())

			err = appdynamics.RewriteProcFile(filepath.Join(tempProcDir, "Procfile"))
			Expect(err).NotTo(HaveOccurred())
			startCommand, err := os.ReadFile(filepath.Join(tempProcDir, "Procfile"))
			Expect(err).NotTo(HaveOccurred())
			Expect(string(startCommand)).To(Equal("web: pyagent run --  python app.py"))
		})

		It("Errors when Procfile doesn't exist", func() {
			err := appdynamics.RewriteProcFile("/doesnt/exist")
			Expect(err).To(MatchError("Error reading file /doesnt/exist: open /doesnt/exist: no such file or directory"))
		})

		It("Errors with Procfile with wrong format", func() {
			Expect(os.WriteFile(filepath.Join(tempProcDir, "WrongFormatProcFile"), []byte("python app.py"), 0666)).To(Succeed())
			Expect(err).NotTo(HaveOccurred())

			err = appdynamics.RewriteProcFile(filepath.Join(tempProcDir, "WrongFormatProcFile"))
			Expect(err).To(MatchError("improper format found in Procfile"))
		})
	})

	Context("RewriteRequirementsFile when requirements.txt is not packaged", func() {
		It("creates requirements.txt", func() {
			Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).ToNot(BeTrue())
			err := appdynamics.RewriteRequirementsFile(stager)
			Expect(err).NotTo(HaveOccurred())
			Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).To(BeTrue())
			packagesList, err := os.ReadFile(filepath.Join(buildDir, "requirements.txt"))
			Expect(err).NotTo(HaveOccurred())
			Expect(string(packagesList)).To(Equal("appdynamics"))
		})
	})

	Context("RewriteRequirementsFile when requirements.txt is packaged", func() {
		BeforeEach(func() {
			Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).ToNot(BeTrue())
			procFile := filepath.Join(buildDir, "requirements.txt")
			f, err := os.OpenFile(procFile, os.O_CREATE|os.O_WRONLY, 0644)
			Expect(err).NotTo(HaveOccurred())
			defer f.Close()
			_, err = f.WriteString("Flask")
			Expect(err).NotTo(HaveOccurred())
			DeferCleanup(os.Remove, filepath.Join(buildDir, "requirements.txt"))
		})

		It("rewrites requirements.txt", func() {
			Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).To(BeTrue())
			err := appdynamics.RewriteRequirementsFile(stager)
			Expect(err).NotTo(HaveOccurred())
			packages, err := os.ReadFile(filepath.Join(buildDir, "requirements.txt"))
			Expect(string(packages)).To(Equal("Flask\nappdynamics"))
		})
	})

	Context("GenerateAppdynamicsScript", func() {
		It("Generates script from Env map", func() {
			envVal := map[string]string{
				"APPD_KEY_1": "APPD_VAL_1",
				"APPD_KEY_2": "APPD_VAL_2",
			}
			script := appdynamics.GenerateAppdynamicsScript(envVal)
			expectedScript := `# Autogenerated Appdynamics Script

export APPD_KEY_1=APPD_VAL_1
export APPD_KEY_2=APPD_VAL_2`
			Expect(script).To(Equal(expectedScript))
		})
	})

	Context("CreateAppDynamicsEnv", func() {
		It("Generates script from Env map", func() {
			envVal := map[string]string{
				"APPD_KEY_1": "APPD_VAL_1",
				"APPD_KEY_2": "APPD_VAL_2",
			}
			appdynamics.CreateAppDynamicsEnv(stager, envVal)
			appdynamicsShellScript := filepath.Join(stager.DepDir(), "profile.d", "appdynamics.sh")
			Expect(libbuildpack.FileExists(appdynamicsShellScript)).To(BeTrue())
			expectedScript := `# Autogenerated Appdynamics Script

export APPD_KEY_1=APPD_VAL_1
export APPD_KEY_2=APPD_VAL_2`
			script, err := os.ReadFile(appdynamicsShellScript)
			Expect(err).NotTo(HaveOccurred())
			Expect(string(script)).To(Equal(expectedScript))
		})
	})

	Context("BeforeCompile when VCAP_SERVICES is not present", func() {
		BeforeEach(func() {
			Expect(os.Getenv("VCAP_SERVICES")).To(Equal(""))
			Expect(os.WriteFile(filepath.Join(buildDir, "Procfile"), []byte("web: python app.py"), 0644)).To(Succeed())
			Expect(err).NotTo(HaveOccurred())
			DeferCleanup(os.Remove, filepath.Join(buildDir, "Procfile"))
		})

		It("VCAP_SERVICES is not present", func() {
			err := appdynamics.BeforeCompile(stager)
			Expect(err).NotTo(HaveOccurred())
			Expect(libbuildpack.FileExists(filepath.Join(stager.DepDir(), "profile.d", "appdynamics.sh"))).To(BeFalse())
			Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).To(BeFalse())
			procCommand, err := os.ReadFile(filepath.Join(buildDir, "Procfile"))
			Expect(err).NotTo(HaveOccurred())
			Expect(string(procCommand)).To(Equal("web: python app.py"))
		})
	})

	Context("BeforeCompile when VCAP_SERVICES has no appdynamics", func() {
		BeforeEach(func() {
			Expect(os.Getenv("VCAP_SERVICES")).To(Equal(""))
			os.Setenv("VCAP_SERVICES", `{"service": [{"credentials": {"login": "name"}, "name": "443"}]}`)
			Expect(os.WriteFile(filepath.Join(buildDir, "Procfile"), []byte("web: python app.py"), 0644)).To(Succeed())
			Expect(err).NotTo(HaveOccurred())
			DeferCleanup(os.Remove, filepath.Join(buildDir, "Procfile"))
			DeferCleanup(os.Unsetenv, "VCAP_SERVICES")
		})

		It("VCAP_SERVICES has no appdynamics", func() {
			err := appdynamics.BeforeCompile(stager)
			Expect(err).NotTo(HaveOccurred())
			Expect(libbuildpack.FileExists(filepath.Join(stager.DepDir(), "profile.d", "appdynamics.sh"))).To(BeFalse())
			Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).To(BeFalse())
			procCommand, err := os.ReadFile(filepath.Join(buildDir, "Procfile"))
			Expect(err).NotTo(HaveOccurred())
			Expect(string(procCommand)).To(Equal("web: python app.py"))
		})
	})

	for _, serviceName := range []string{"appdynamics", "app-dynamics", "appdynamics-and-some-more-text"} {
		Context("BeforeCompile when VCAP_SERVICES has appdynamics", func() {
			serviceName := serviceName
			BeforeEach(func() {
				os.Setenv("VCAP_SERVICES",
					`{"`+serviceName+`": [{"instance_name": "plan-instance", "tags": [], "name": "plan", "syslog_drain_url": null, "binding_name": null, "credentials": {"host-name": "controller.test.com", "plan-name": "plan", "guid": "guid", "plan-description": "plan", "ssl-enabled": false, "account-access-key": "key", "account-name": "account-name", "port": "7777"}, "label": "appdynamics"}]}`)
				os.Setenv("VCAP_APPLICATION", `{"application_id": "applicationId", "name": "test",  "application_name": "test"}`)
				os.Setenv("APPD_TIER_NAME", "tier")
				os.Setenv("APPD_NODE_NAME", "node")

				Expect(os.WriteFile(filepath.Join(buildDir, "Procfile"), []byte("web: python app.py"), 0644)).To(Succeed())
				Expect(err).NotTo(HaveOccurred())
				DeferCleanup(os.Unsetenv, "VCAP_SERVICES")
			})

			It(fmt.Sprintf("VCAP_SERVICES has %s", serviceName), func() {
				err := appdynamics.BeforeCompile(stager)
				Expect(err).NotTo(HaveOccurred())

				Expect(libbuildpack.FileExists(filepath.Join(stager.DepDir(), "profile.d", "appdynamics.sh"))).To(BeTrue())
				appdynamicsInfo, err := os.ReadFile(filepath.Join(stager.DepDir(), "profile.d", "appdynamics.sh"))
				expectedInfo := `# Autogenerated Appdynamics Script

export APPD_ACCOUNT_ACCESS_KEY=key
export APPD_ACCOUNT_NAME=account-name
export APPD_APP_NAME=test
export APPD_CONTROLLER_HOST=controller.test.com
export APPD_CONTROLLER_PORT=7777
export APPD_NODE_NAME=node
export APPD_SSL_ENABLED=off
export APPD_TIER_NAME=tier`
				Expect(string(appdynamicsInfo)).To(Equal(expectedInfo))
				Expect(err).NotTo(HaveOccurred())

				Expect(libbuildpack.FileExists(filepath.Join(buildDir, "requirements.txt"))).To(BeTrue())
				packages, err := os.ReadFile(filepath.Join(buildDir, "requirements.txt"))
				Expect(err).NotTo(HaveOccurred())
				Expect(string(packages)).To(Equal("appdynamics"))

				procCommand, err := os.ReadFile(filepath.Join(buildDir, "Procfile"))
				Expect(err).NotTo(HaveOccurred())
				Expect(string(procCommand)).To(Equal("web: pyagent run --  python app.py"))
			})
		})
	}
})