stembuild: packagers use Messenger

rather than accessing STD{OUT,ERR} directly

Author: aramprice

stembuild/commandparser/commandparserfakes/fake_packager_factory.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/messenger"
 	"github.com/google/subcommands"
 
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/colorlogger"
@@ -23,7 +24,7 @@ type OSAndVersionGetter interface {
 
 //counterfeiter:generate . PackagerFactory
 type PackagerFactory interface {
-	NewPackager(sourceConfig config.SourceConfig, outputConfig config.OutputConfig, logger colorlogger.Logger) (Packager, error)
+	NewPackager(sourceConfig config.SourceConfig, outputConfig config.OutputConfig, logger colorlogger.Logger, messenger messenger.Messenger) (Packager, error)
 }
 
 //counterfeiter:generate . Packager
@@ -115,7 +116,6 @@ func (p *PackageCmd) SetFlags(f *flag.FlagSet) {
 }
 
 func (p *PackageCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
-
 	logLevel := colorlogger.NONE
 	if p.GlobalFlags.Debug {
 		logLevel = colorlogger.DEBUG
@@ -130,7 +130,8 @@ func (p *PackageCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{
 	}
 
 	logger := colorlogger.New(logLevel, p.GlobalFlags.Color, os.Stderr)
-	packager, err := p.packagerFactory.NewPackager(p.sourceConfig, p.outputConfig, logger)
+	stembuildMessenger := messenger.NewStembuildMessenger(os.Stdout, os.Stderr)
+	packager, err := p.packagerFactory.NewPackager(p.sourceConfig, p.outputConfig, logger, stembuildMessenger)
 	if err != nil {
 		p.packagerMessenger.CannotCreatePackager(err)
 		return subcommands.ExitFailure

stembuild/commandparser/package_stemcell.go

@@ -62,7 +62,7 @@ var _ = Describe("package_stemcell", func() {
 				Expect(exitStatus).To(Equal(subcommands.ExitSuccess))
 
 				Expect(packagerFactory.NewPackagerCallCount()).To(Equal(1))
-				actualSourceConfig, _, _ := packagerFactory.NewPackagerArgsForCall(0)
+				actualSourceConfig, _, _, _ := packagerFactory.NewPackagerArgsForCall(0)
 				Expect(actualSourceConfig.Vmdk).To(Equal("some_vmdk_file"))
 			})
 
@@ -82,7 +82,7 @@ var _ = Describe("package_stemcell", func() {
 				Expect(exitStatus).To(Equal(subcommands.ExitSuccess))
 
 				Expect(packagerFactory.NewPackagerCallCount()).To(Equal(1))
-				actualSourceConfig, _, _ := packagerFactory.NewPackagerArgsForCall(0)
+				actualSourceConfig, _, _, _ := packagerFactory.NewPackagerArgsForCall(0)
 				Expect(actualSourceConfig.URL).To(Equal("https://vcenter.test"))
 				Expect(actualSourceConfig.Username).To(Equal("test-user"))
 				Expect(actualSourceConfig.Password).To(Equal("verysecure"))
@@ -100,7 +100,7 @@ var _ = Describe("package_stemcell", func() {
 				Expect(exitStatus).To(Equal(subcommands.ExitSuccess))
 
 				Expect(packagerFactory.NewPackagerCallCount()).To(Equal(1))
-				_, actualOutputConfig, _ := packagerFactory.NewPackagerArgsForCall(0)
+				_, actualOutputConfig, _, _ := packagerFactory.NewPackagerArgsForCall(0)
 				Expect(actualOutputConfig.OutputDir).To(Equal("some_output_dir"))
 			})
 
@@ -114,7 +114,7 @@ var _ = Describe("package_stemcell", func() {
 				Expect(exitStatus).To(Equal(subcommands.ExitSuccess))
 
 				Expect(packagerFactory.NewPackagerCallCount()).To(Equal(1))
-				_, actualOutputConfig, _ := packagerFactory.NewPackagerArgsForCall(0)
+				_, actualOutputConfig, _, _ := packagerFactory.NewPackagerArgsForCall(0)
 				Expect(actualOutputConfig.OutputDir).To(Equal("some_output_dir"))
 				Expect(actualOutputConfig.StemcellVersion).To(Equal("2019.2"))
 				Expect(actualOutputConfig.Os).To(Equal("2019"))
@@ -132,7 +132,7 @@ var _ = Describe("package_stemcell", func() {
 				Expect(exitStatus).To(Equal(subcommands.ExitSuccess))
 
 				Expect(packagerFactory.NewPackagerCallCount()).To(Equal(1))
-				_, actualOutputConfig, _ := packagerFactory.NewPackagerArgsForCall(0)
+				_, actualOutputConfig, _, _ := packagerFactory.NewPackagerArgsForCall(0)
 				Expect(actualOutputConfig.StemcellVersion).To(Equal("1803.27.36"))
 
 				Expect(oSAndVersionGetter.GetVersionWithPatchNumberCallCount()).To(Equal(1))

stembuild/commandparser/package_stemcell_test.go

@@ -7,8 +7,13 @@ import (
 	"github.com/pkg/errors"
 )
 
-func write(out io.Writer, message string) {
-	_, err := out.Write([]byte(message))
+type Messenger interface {
+	PrintOut(string)
+	PrintErr(string)
+}
+
+func write(writer io.Writer, message string) {
+	_, err := writer.Write([]byte(message))
 	if err != nil {
 		err = errors.Wrap(err, fmt.Sprintf("Unable to Write(): '%s'", message))
 		panic(err)

stembuild/messenger/messenger.go

@@ -8,12 +8,18 @@ import (
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/commandparser"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/iaas_cli/iaas_clients"
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/messenger"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/package_stemcell/config"
 )
 
 type Factory struct{}
 
-func (f *Factory) NewPackager(sourceConfig config.SourceConfig, outputConfig config.OutputConfig, logger colorlogger.Logger) (commandparser.Packager, error) {
+func (f *Factory) NewPackager(
+	sourceConfig config.SourceConfig,
+	outputConfig config.OutputConfig,
+	logger colorlogger.Logger,
+	messenger messenger.Messenger,
+) (commandparser.Packager, error) {
 	source, err := sourceConfig.GetSource()
 	if err != nil {
 		return nil, err
@@ -35,6 +41,7 @@ func (f *Factory) NewPackager(sourceConfig config.SourceConfig, outputConfig con
 			OutputConfig: outputConfig,
 			Client:       client,
 			Logger:       logger,
+			Messenger:    messenger,
 		}, nil
 	case config.VMDK:
 		options :=
@@ -49,6 +56,7 @@ func (f *Factory) NewPackager(sourceConfig config.SourceConfig, outputConfig con
 			Stop:         make(chan struct{}),
 			BuildOptions: options,
 			Logger:       logger,
+			Messenger:    messenger,
 		}, nil
 	default:
 		return nil, errors.New("unable to determine packager")

stembuild/package_stemcell/packager/factory.go

@@ -1,6 +1,7 @@
 package packager_test
 
 import (
+	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/messenger"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
@@ -17,12 +18,16 @@ var _ = Describe("Factory", func() {
 		OutputDir:       "/tmp/outputDir",
 	}
 
-	var packagerFactory *packager.Factory
-	var logger colorlogger.Logger
+	var (
+		packagerFactory    *packager.Factory
+		logger             colorlogger.Logger
+		stembuildMessenger messenger.Messenger
+	)
 
 	BeforeEach(func() {
 		packagerFactory = &packager.Factory{}
 		logger = colorlogger.New(0, false, GinkgoWriter)
+		stembuildMessenger = messenger.NewStembuildMessenger(GinkgoWriter, GinkgoWriter)
 	})
 
 	Describe("GetPackager", func() {
@@ -32,7 +37,7 @@ var _ = Describe("Factory", func() {
 					Vmdk: "path/to/a/vmdk",
 				}
 
-				actualPackager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger)
+				actualPackager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger, stembuildMessenger)
 				Expect(err).NotTo(HaveOccurred())
 
 				Expect(actualPackager).To(BeAssignableToTypeOf(&packager.VmdkPackager{}))
@@ -49,7 +54,7 @@ var _ = Describe("Factory", func() {
 					VmInventoryPath: "some-vm-inventory-path",
 				}
 
-				actualPackager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger)
+				actualPackager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger, stembuildMessenger)
 				Expect(err).NotTo(HaveOccurred())
 
 				Expect(actualPackager).To(BeAssignableToTypeOf(&packager.VCenterPackager{}))
@@ -64,7 +69,7 @@ var _ = Describe("Factory", func() {
 					VmInventoryPath: "some-vm",
 				}
 
-				packager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger)
+				packager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger, stembuildMessenger)
 				Expect(err).To(HaveOccurred())
 				Expect(err.Error()).To(Equal("configuration provided for VMDK & vCenter sources"))
 				Expect(packager).To(BeNil())
@@ -79,7 +84,7 @@ var _ = Describe("Factory", func() {
 					URL:             "some-url",
 				}
 
-				packager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger)
+				packager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger, stembuildMessenger)
 				Expect(err).To(HaveOccurred())
 				Expect(err.Error()).To(Equal("missing vCenter configurations"))
 				Expect(packager).To(BeNil())
@@ -90,7 +95,7 @@ var _ = Describe("Factory", func() {
 			It("returns an error", func() {
 				sourceConfig := config.SourceConfig{}
 
-				packager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger)
+				packager, err := packagerFactory.NewPackager(sourceConfig, outputConfig, logger, stembuildMessenger)
 				Expect(err).To(HaveOccurred())
 				Expect(err.Error()).To(Equal("no configuration was provided"))
 				Expect(packager).To(BeNil())

stembuild/package_stemcell/packager/factory_test.go

@@ -10,6 +10,7 @@ import (
 
 	"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/messenger"
 	"github.com/cloudfoundry/bosh-windows-stemcell-builder/stembuild/package_stemcell/config"
 )
 
@@ -29,6 +30,7 @@ type VCenterPackager struct {
 	OutputConfig config.OutputConfig
 	Client       IaasClient
 	Logger       colorlogger.Logger
+	Messenger    messenger.Messenger
 }
 
 func (v VCenterPackager) Package() error {
@@ -57,7 +59,7 @@ func (v VCenterPackager) Package() error {
 		return errors.New("failed to export the prepared VM")
 	}
 
-	fmt.Println("Converting VMDK into stemcell")
+	v.Messenger.PrintOut("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 +72,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.Messenger.PrintOut(fmt.Sprintf("Stemcell successfully created: %s\n", stemcellFilename))
 	return nil
 }