github.com/YousefHaggyHeroku/pack@v1.5.5/internal/builder/inspect_test.go

package builder_test

import (
	"errors"
	"testing"

	"github.com/buildpacks/lifecycle/api"

	pubbldr "github.com/YousefHaggyHeroku/pack/builder"
	"github.com/YousefHaggyHeroku/pack/config"
	"github.com/YousefHaggyHeroku/pack/internal/builder"
	"github.com/YousefHaggyHeroku/pack/internal/builder/fakes"
	"github.com/YousefHaggyHeroku/pack/internal/dist"
	h "github.com/YousefHaggyHeroku/pack/testhelpers"

	"github.com/heroku/color"
	"github.com/sclevine/spec"
	"github.com/sclevine/spec/report"
)

const (
	testBuilderName        = "test-builder"
	testBuilderDescription = "Test Builder Description"
	testStackID            = "test-builder-stack-id"
	testRunImage           = "test/run-image"
)

var (
	testTopNestedBuildpack = dist.BuildpackInfo{
		ID:      "test.top.nested",
		Version: "test.top.nested.version",
	}
	testNestedBuildpack = dist.BuildpackInfo{
		ID:       "test.nested",
		Version:  "test.nested.version",
		Homepage: "http://geocities.com/top-bp",
	}
	testBuildpack = dist.BuildpackInfo{
		ID:      "test.bp.two",
		Version: "test.bp.two.version",
	}
	testBuildpacks = []dist.BuildpackInfo{
		testTopNestedBuildpack,
		testNestedBuildpack,
		testBuildpack,
	}
	testLifecycleInfo = builder.LifecycleInfo{
		Version: builder.VersionMustParse("1.2.3"),
	}
	testBuildpackVersions = builder.APIVersions{
		Deprecated: builder.APISet{api.MustParse("0.1")},
		Supported:  builder.APISet{api.MustParse("1.2"), api.MustParse("1.3")},
	}
	testPlatformVersions = builder.APIVersions{
		Supported: builder.APISet{api.MustParse("2.3"), api.MustParse("2.4")},
	}
	inspectTestLifecycle = builder.LifecycleMetadata{
		LifecycleInfo: testLifecycleInfo,
		APIs: builder.LifecycleAPIs{
			Buildpack: testBuildpackVersions,
			Platform:  testPlatformVersions,
		},
	}
	testCreatorData = builder.CreatorMetadata{
		Name:    "pack",
		Version: "1.2.3",
	}
	testMetadata = builder.Metadata{
		Description: testBuilderDescription,
		Buildpacks:  testBuildpacks,
		Stack:       testStack,
		Lifecycle:   inspectTestLifecycle,
		CreatedBy:   testCreatorData,
	}
	testMixins          = []string{"build:mixinA", "mixinX", "mixinY"}
	expectedTestMixins  = []string{"mixinX", "mixinY", "build:mixinA"}
	testRunImageMirrors = []string{"test/first-run-image-mirror", "test/second-run-image-mirror"}
	testStack           = builder.StackMetadata{
		RunImage: builder.RunImageMetadata{
			Image:   testRunImage,
			Mirrors: testRunImageMirrors,
		},
	}
	testOrder = dist.Order{
		dist.OrderEntry{Group: []dist.BuildpackRef{
			{BuildpackInfo: testBuildpack, Optional: false},
		}},
		dist.OrderEntry{Group: []dist.BuildpackRef{
			{BuildpackInfo: testNestedBuildpack, Optional: false},
			{BuildpackInfo: testTopNestedBuildpack, Optional: true},
		}},
	}
	testLayers = dist.BuildpackLayers{
		"test.top.nested": {
			"test.top.nested.version": {
				API:         api.MustParse("0.2"),
				Order:       testOrder,
				LayerDiffID: "sha256:test.top.nested.sha256",
				Homepage:    "http://geocities.com/top-bp",
			},
		},
		"test.bp.two": {
			"test.bp.two.version": {
				API:         api.MustParse("0.2"),
				Stacks:      []dist.Stack{{ID: "test.stack.id"}},
				LayerDiffID: "sha256:test.bp.two.sha256",
				Homepage:    "http://geocities.com/cool-bp",
			},
		},
	}
	expectedTestLifecycle = builder.LifecycleDescriptor{
		Info: testLifecycleInfo,
		API: builder.LifecycleAPI{
			BuildpackVersion: api.MustParse("0.1"),
			PlatformVersion:  api.MustParse("2.3"),
		},
		APIs: builder.LifecycleAPIs{
			Buildpack: testBuildpackVersions,
			Platform:  testPlatformVersions,
		},
	}
	expectedDetectionTestOrder = pubbldr.DetectionOrder{
		{
			BuildpackRef: dist.BuildpackRef{
				BuildpackInfo: testBuildpack,
			},
		},
		{
			BuildpackRef: dist.BuildpackRef{
				BuildpackInfo: testTopNestedBuildpack,
			},
			GroupDetectionOrder: pubbldr.DetectionOrder{
				{
					BuildpackRef: dist.BuildpackRef{
						BuildpackInfo: testNestedBuildpack,
					},
				},
			},
		},
	}
)

func TestInspect(t *testing.T) {
	color.Disable(true)
	defer color.Disable(false)
	spec.Run(t, "testInspect", testInspect, spec.Parallel(), spec.Report(report.Terminal{}))
}

func testInspect(t *testing.T, when spec.G, it spec.S) {
	when("Inspect", func() {
		var assert = h.NewAssertionManager(t)

		it("calls Fetch on inspectableFetcher with expected arguments", func() {
			fetcher := newDefaultInspectableFetcher()

			inspector := builder.NewInspector(fetcher, newDefaultLabelManagerFactory(), newDefaultDetectionCalculator())
			_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)
			assert.Nil(err)

			assert.Equal(fetcher.CallCount, 1)
			assert.Equal(fetcher.ReceivedName, testBuilderName)
			assert.Equal(fetcher.ReceivedDaemon, true)
			assert.Equal(fetcher.ReceivedPullPolicy, config.PullNever)
		})

		it("instantiates a builder label manager with the correct inspectable", func() {
			inspectable := newNoOpInspectable()

			fetcher := &fakes.FakeInspectableFetcher{
				InspectableToReturn: inspectable,
			}

			labelManagerFactory := newDefaultLabelManagerFactory()

			inspector := builder.NewInspector(fetcher, labelManagerFactory, newDefaultDetectionCalculator())
			_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)
			assert.Nil(err)

			assert.Equal(labelManagerFactory.ReceivedInspectable, inspectable)
		})

		it("calls `Order` on detectionCalculator with expected arguments", func() {
			detectionOrderCalculator := newDefaultDetectionCalculator()

			inspector := builder.NewInspector(
				newDefaultInspectableFetcher(),
				newDefaultLabelManagerFactory(),
				detectionOrderCalculator,
			)
			_, err := inspector.Inspect(testBuilderName, true, 3)
			assert.Nil(err)

			assert.Equal(detectionOrderCalculator.ReceivedTopOrder, testOrder)
			assert.Equal(detectionOrderCalculator.ReceivedLayers, testLayers)
			assert.Equal(detectionOrderCalculator.ReceivedDepth, 3)
		})

		it("returns Info object with expected fields", func() {
			fetcher := newDefaultInspectableFetcher()

			inspector := builder.NewInspector(fetcher, newDefaultLabelManagerFactory(), newDefaultDetectionCalculator())
			info, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)
			assert.Nil(err)

			assert.Equal(info.Description, testBuilderDescription)
			assert.Equal(info.StackID, testStackID)
			assert.Equal(info.Mixins, expectedTestMixins)
			assert.Equal(info.RunImage, testRunImage)
			assert.Equal(info.RunImageMirrors, testRunImageMirrors)
			assert.Equal(info.Buildpacks, testBuildpacks)
			assert.Equal(info.Order, expectedDetectionTestOrder)
			assert.Equal(info.BuildpackLayers, testLayers)
			assert.Equal(info.Lifecycle, expectedTestLifecycle)
			assert.Equal(info.CreatedBy, testCreatorData)
		})

		when("there are duplicated buildpacks in metadata", func() {
			it("returns deduplicated buildpacks", func() {
				metadata := builder.Metadata{
					Description: testBuilderDescription,
					Buildpacks: []dist.BuildpackInfo{
						testTopNestedBuildpack,
						testNestedBuildpack,
						testTopNestedBuildpack,
					},
				}
				labelManager := newLabelManager(returnForMetadata(metadata))

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newLabelManagerFactory(labelManager),
					newDefaultDetectionCalculator(),
				)
				info, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)

				assert.Nil(err)
				assert.Equal(info.Buildpacks, []dist.BuildpackInfo{testTopNestedBuildpack, testNestedBuildpack})
			})
		})

		when("label manager returns an error for `Metadata`", func() {
			it("returns the wrapped error", func() {
				expectedBaseError := errors.New("failed to parse")

				labelManager := newLabelManager(errorForMetadata(expectedBaseError))

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newLabelManagerFactory(labelManager),
					newDefaultDetectionCalculator(),
				)
				_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)

				assert.ErrorWithMessage(err, "reading image metadata: failed to parse")
			})
		})

		when("label manager returns an error for `StackID`", func() {
			it("returns the wrapped error", func() {
				expectedBaseError := errors.New("label not found")

				labelManager := newLabelManager(errorForStackID(expectedBaseError))

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newLabelManagerFactory(labelManager),
					newDefaultDetectionCalculator(),
				)
				_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)

				assert.ErrorWithMessage(err, "reading image stack id: label not found")
			})
		})

		when("label manager returns an error for `Mixins`", func() {
			it("returns the wrapped error", func() {
				expectedBaseError := errors.New("label not found")

				labelManager := newLabelManager(errorForMixins(expectedBaseError))

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newLabelManagerFactory(labelManager),
					newDefaultDetectionCalculator(),
				)
				_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)

				assert.ErrorWithMessage(err, "reading image mixins: label not found")
			})
		})

		when("label manager returns an error for `Order`", func() {
			it("returns the wrapped error", func() {
				expectedBaseError := errors.New("label not found")

				labelManager := newLabelManager(errorForOrder(expectedBaseError))

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newLabelManagerFactory(labelManager),
					newDefaultDetectionCalculator(),
				)
				_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)

				assert.ErrorWithMessage(err, "reading image order: label not found")
			})
		})

		when("label manager returns an error for `BuildpackLayers`", func() {
			it("returns the wrapped error", func() {
				expectedBaseError := errors.New("label not found")

				labelManager := newLabelManager(errorForBuildpackLayers(expectedBaseError))

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newLabelManagerFactory(labelManager),
					newDefaultDetectionCalculator(),
				)
				_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionNone)

				assert.ErrorWithMessage(err, "reading image buildpack layers: label not found")
			})
		})

		when("detection calculator returns an error for `Order`", func() {
			it("returns the wrapped error", func() {
				expectedBaseError := errors.New("couldn't read label")

				inspector := builder.NewInspector(
					newDefaultInspectableFetcher(),
					newDefaultLabelManagerFactory(),
					newDetectionCalculator(errorForDetectionOrder(expectedBaseError)),
				)
				_, err := inspector.Inspect(testBuilderName, true, pubbldr.OrderDetectionMaxDepth)

				assert.ErrorWithMessage(err, "calculating detection order: couldn't read label")
			})
		})
	})
}

func newDefaultInspectableFetcher() *fakes.FakeInspectableFetcher {
	return &fakes.FakeInspectableFetcher{
		InspectableToReturn: newNoOpInspectable(),
	}
}

func newNoOpInspectable() *fakes.FakeInspectable {
	return &fakes.FakeInspectable{}
}

func newDefaultLabelManagerFactory() *fakes.FakeLabelManagerFactory {
	return newLabelManagerFactory(newDefaultLabelManager())
}

func newLabelManagerFactory(manager builder.LabelInspector) *fakes.FakeLabelManagerFactory {
	return fakes.NewFakeLabelManagerFactory(manager)
}

func newDefaultLabelManager() *fakes.FakeLabelManager {
	return &fakes.FakeLabelManager{
		ReturnForMetadata:        testMetadata,
		ReturnForStackID:         testStackID,
		ReturnForMixins:          testMixins,
		ReturnForOrder:           testOrder,
		ReturnForBuildpackLayers: testLayers,
	}
}

type labelManagerModifier func(manager *fakes.FakeLabelManager)

func returnForMetadata(metadata builder.Metadata) labelManagerModifier {
	return func(manager *fakes.FakeLabelManager) {
		manager.ReturnForMetadata = metadata
	}
}

func errorForMetadata(err error) labelManagerModifier {
	return func(manager *fakes.FakeLabelManager) {
		manager.ErrorForMetadata = err
	}
}

func errorForStackID(err error) labelManagerModifier {
	return func(manager *fakes.FakeLabelManager) {
		manager.ErrorForStackID = err
	}
}

func errorForMixins(err error) labelManagerModifier {
	return func(manager *fakes.FakeLabelManager) {
		manager.ErrorForMixins = err
	}
}

func errorForOrder(err error) labelManagerModifier {
	return func(manager *fakes.FakeLabelManager) {
		manager.ErrorForOrder = err
	}
}

func errorForBuildpackLayers(err error) labelManagerModifier {
	return func(manager *fakes.FakeLabelManager) {
		manager.ErrorForBuildpackLayers = err
	}
}

func newLabelManager(modifiers ...labelManagerModifier) *fakes.FakeLabelManager {
	manager := newDefaultLabelManager()

	for _, mod := range modifiers {
		mod(manager)
	}

	return manager
}

func newDefaultDetectionCalculator() *fakes.FakeDetectionCalculator {
	return &fakes.FakeDetectionCalculator{
		ReturnForOrder: expectedDetectionTestOrder,
	}
}

type detectionCalculatorModifier func(calculator *fakes.FakeDetectionCalculator)

func errorForDetectionOrder(err error) detectionCalculatorModifier {
	return func(calculator *fakes.FakeDetectionCalculator) {
		calculator.ErrorForOrder = err
	}
}

func newDetectionCalculator(modifiers ...detectionCalculatorModifier) *fakes.FakeDetectionCalculator {
	calculator := newDefaultDetectionCalculator()

	for _, mod := range modifiers {
		mod(calculator)
	}

	return calculator
}