stembuild: packagers write to logger

Replace direct access to `os.Stderr` to quiet tests

Author: aramprice

stembuild/package_stemcell/packager/vcenter_packager.go

@@ -2,7 +2,6 @@ package packager
 
 import (
 	"errors"
-	"fmt"
 	"os"
 	"path"
 	"path/filepath"
@@ -57,7 +56,7 @@ func (v VCenterPackager) Package() error {
 		return errors.New("failed to export the prepared VM")
 	}
 
-	fmt.Println("Converting VMDK into stemcell")
+	v.Logger.Printf("Converting VMDK into stemcell")
 	vmName := path.Base(v.SourceConfig.VmInventoryPath)
 	shaSum, err := TarGenerator(filepath.Join(stemcellDir, "image"), filepath.Join(workingDir, vmName)) //nolint:ineffassign,staticcheck
 	manifestContents := CreateManifest(v.OutputConfig.Os, v.OutputConfig.StemcellVersion, shaSum)
@@ -70,7 +69,7 @@ func (v VCenterPackager) Package() error {
 	stemcellFilename := StemcellFilename(v.OutputConfig.StemcellVersion, v.OutputConfig.Os)
 	_, err = TarGenerator(filepath.Join(v.OutputConfig.OutputDir, stemcellFilename), stemcellDir) //nolint:ineffassign,staticcheck
 
-	fmt.Printf("Stemcell successfully created: %s\n", stemcellFilename)
+	v.Logger.Printf("Stemcell successfully created: %s\n", stemcellFilename)
 	return nil
 }
 

stembuild/package_stemcell/packager/vcenter_packager_test.go

@@ -12,6 +12,7 @@ import (
 	"path"
 	"path/filepath"
 
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/colorlogger"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/filesystem"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/package_stemcell/config"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/package_stemcell/packager"
@@ -22,11 +23,13 @@ import (
 )
 
 var _ = Describe("VcenterPackager", func() {
-
-	var outputDir string
-	var sourceConfig config.SourceConfig
-	var outputConfig config.OutputConfig
-	var fakeVcenterClient *packagerfakes.FakeIaasClient
+	var (
+		outputDir         string
+		sourceConfig      config.SourceConfig
+		outputConfig      config.OutputConfig
+		fakeVcenterClient *packagerfakes.FakeIaasClient
+		vcenterPackager   *packager.VCenterPackager
+	)
 
 	BeforeEach(func() {
 		// Revert to manual cleanup which fails non-catastrophically on windows
@@ -36,6 +39,14 @@ var _ = Describe("VcenterPackager", func() {
 		sourceConfig = config.SourceConfig{Password: "password", URL: "url", Username: "username", VmInventoryPath: "path/valid-vm-name"}
 		outputConfig = config.OutputConfig{Os: "2019", StemcellVersion: "2019.00", OutputDir: outputDir}
 		fakeVcenterClient = &packagerfakes.FakeIaasClient{}
+		logger := colorlogger.New(0, false, GinkgoWriter)
+
+		vcenterPackager = &packager.VCenterPackager{
+			SourceConfig: sourceConfig,
+			OutputConfig: outputConfig,
+			Client:       fakeVcenterClient,
+			Logger:       logger,
+		}
 	})
 
 	AfterEach(func() {
@@ -49,20 +60,19 @@ var _ = Describe("VcenterPackager", func() {
 	Context("ValidateSourceParameters", func() {
 		It("returns an error if the vCenter url is invalid", func() {
 			fakeVcenterClient.ValidateUrlReturns(errors.New("vcenter client url error"))
-			packager := packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
 
-			err := packager.ValidateSourceParameters()
+			err := vcenterPackager.ValidateSourceParameters()
 
 			Expect(err).To(HaveOccurred())
 			Expect(fakeVcenterClient.ValidateUrlCallCount()).To(Equal(1))
 			Expect(err.Error()).To(Equal("vcenter client url error"))
 
 		})
+
 		It("returns an error if the vCenter credentials are not valid", func() {
 			fakeVcenterClient.ValidateCredentialsReturns(errors.New("vcenter client credential error"))
-			packager := packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
 
-			err := packager.ValidateSourceParameters()
+			err := vcenterPackager.ValidateSourceParameters()
 
 			Expect(err).To(HaveOccurred())
 			Expect(fakeVcenterClient.ValidateCredentialsCallCount()).To(Equal(1))
@@ -71,42 +81,44 @@ var _ = Describe("VcenterPackager", func() {
 
 		It("returns an error if VM given does not exist ", func() {
 			fakeVcenterClient.FindVMReturns(errors.New("vcenter client vm error"))
-			packager := packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
 
-			err := packager.ValidateSourceParameters()
+			err := vcenterPackager.ValidateSourceParameters()
 
 			Expect(err).To(HaveOccurred())
 			Expect(fakeVcenterClient.FindVMCallCount()).To(Equal(1))
 			Expect(err.Error()).To(Equal("vcenter client vm error"))
 		})
-		It("returns no error if all source parameters are valid", func() {
-			packager := packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
 
-			err := packager.ValidateSourceParameters()
+		It("returns no error if all source parameters are valid", func() {
+			err := vcenterPackager.ValidateSourceParameters()
 
 			Expect(err).NotTo(HaveOccurred())
 		})
 	})
+
 	Context("ValidateFreeSpace", func() {
 		It("is a NOOP", func() {
-			packager := packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
-			err := packager.ValidateFreeSpaceForPackage(&filesystem.OSFileSystem{})
+			err := vcenterPackager.ValidateFreeSpaceForPackage(&filesystem.OSFileSystem{})
 
 			Expect(err).To(Not(HaveOccurred()))
 		})
 	})
 
 	Describe("Package", func() {
-		var vcenterPackager *packager.VCenterPackager
-
 		AfterEach(func() {
-			os.RemoveAll("./valid-vm-name") //nolint:errcheck
-			os.RemoveAll("image")           //nolint:errcheck
+			ovfName := "./valid-vm-name"
+			err := os.RemoveAll(ovfName)
+			if err != nil {
+				By(fmt.Sprintf("removing '%s' failed: %s", ovfName, err))
+			}
+			imageFile := "image"
+			err = os.RemoveAll(imageFile)
+			if err != nil {
+				By(fmt.Sprintf("removing '%s' failed: %s", imageFile, err))
+			}
 		})
 
 		BeforeEach(func() {
-			vcenterPackager = &packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
-
 			fakeVcenterClient.ExportVMStub = func(vmInventoryPath string, destination string) error {
 				vmName := path.Base(vmInventoryPath)
 				os.Mkdir(filepath.Join(destination, vmName), 0777) //nolint:errcheck
@@ -125,8 +137,8 @@ var _ = Describe("VcenterPackager", func() {
 			stemcellFilename := packager.StemcellFilename(vcenterPackager.OutputConfig.StemcellVersion, vcenterPackager.OutputConfig.Os)
 			stemcellFile := filepath.Join(vcenterPackager.OutputConfig.OutputDir, stemcellFilename)
 			_, err = os.Stat(stemcellFile)
-
 			Expect(err).NotTo(HaveOccurred())
+
 			var actualStemcellManifestContent string
 			expectedManifestContent := `---
 name: bosh-vsphere-esxi-windows2019-go_agent
@@ -145,6 +157,7 @@ stemcell_formats:
 			gzr, err := gzip.NewReader(fileReader)
 			Expect(err).ToNot(HaveOccurred())
 			defer gzr.Close() //nolint:errcheck
+
 			tarfileReader := tar.NewReader(gzr)
 			count := 0
 
@@ -173,7 +186,6 @@ stemcell_formats:
 					expectedManifestContent = fmt.Sprintf(expectedManifestContent, actualSha1.Sum(nil))
 
 				default:
-
 					Fail(fmt.Sprintf("Found unknown file: %s", filepath.Base(header.Name)))
 				}
 			}
@@ -229,9 +241,8 @@ stemcell_formats:
 		})
 
 		It("Returns a error message if exporting the VM fails", func() {
-			packager := packager.VCenterPackager{SourceConfig: sourceConfig, OutputConfig: outputConfig, Client: fakeVcenterClient}
 			fakeVcenterClient.ExportVMReturns(errors.New("some client error"))
-			err := packager.Package()
+			err := vcenterPackager.Package()
 
 			Expect(fakeVcenterClient.ExportVMCallCount()).To(Equal(1))
 			vmPath, _ := fakeVcenterClient.ExportVMArgsForCall(0)

stembuild/package_stemcell/packager/vmdk_packager.go

@@ -332,26 +332,25 @@ func (c *VmdkPackager) catchInterruptSignal() {
 	for sig := range ch {
 		c.Logger.Printf("received signal: %s", sig)
 		if stopping {
-			fmt.Fprintf(os.Stderr, "received second (%s) signal - exiting now\n", sig) //nolint:errcheck
-			c.Cleanup()                                                                // remove temp dir
+			c.Logger.Printf("received second (%s) signal - exiting now\n", sig)
+			c.Cleanup()
 			os.Exit(1)
 		}
 		stopping = true
-		fmt.Fprintf(os.Stderr, "received (%s) signal cleaning up\n", sig) //nolint:errcheck
+		c.Logger.Printf("received (%s) signal cleaning up\n", sig)
 		c.StopConfig()
 	}
 }
 
 func (c *VmdkPackager) Package() error {
-
 	go c.catchInterruptSignal()
 
 	start := time.Now()
 
 	stemcellPath, err := c.ConvertVMDK()
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "Error: %s\n", err) //nolint:errcheck
-		c.Cleanup()                                // remove temp dir
+		c.Logger.Printf("Error: %s\n", err)
+		c.Cleanup()
 		return err
 	}