Skip to content

Commit

Permalink
Merge pull request #450 from buildpacks/feature/304-builder-buildpacks
Browse files Browse the repository at this point in the history 
Allow for the inclusion of buildpacks in builder when an additional buildpacks
  • Loading branch information
@jromero
jromero authored Jan 23, 2020
2 parents 1a4f907 + a0d0725 commit 93436c3
Show file tree
Hide file tree
Showing 7 changed files with 576 additions and 92 deletions.
139 changes: 113 additions & 26 deletions build.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"os"
"path/filepath"
"runtime"
"sort"
"strings"

"github.com/buildpacks/imgutil"
Expand Down Expand Up @@ -56,6 +57,8 @@ type ContainerConfig struct {
Network string
}

const fromBuilderPrefix = "from=builder"

func (c *Client) Build(ctx context.Context, opts BuildOptions) error {
imageRef, err := c.parseTagReference(opts.Image)
if err != nil {
Expand Down Expand Up @@ -95,7 +98,7 @@ func (c *Client) Build(ctx context.Context, opts BuildOptions) error {
return err
}

fetchedBPs, group, err := c.processBuildpacks(ctx, opts.Buildpacks)
fetchedBPs, order, err := c.processBuildpacks(ctx, bldr.Order(), opts.Buildpacks)
if err != nil {
return err
}
Expand All @@ -104,7 +107,7 @@ func (c *Client) Build(ctx context.Context, opts BuildOptions) error {
return errors.Wrap(err, "validating stack mixins")
}

ephemeralBuilder, err := c.createEphemeralBuilder(rawBuilderImage, opts.Env, group, fetchedBPs)
ephemeralBuilder, err := c.createEphemeralBuilder(rawBuilderImage, opts.Env, order, fetchedBPs)
if err != nil {
return err
}
Expand Down Expand Up @@ -231,6 +234,8 @@ func assembleAvailableMixins(buildMixins, runMixins []string) []string {
return append(common, append(buildOnly, runOnly...)...)
}

// allBuildpacks aggregates all buildpacks declared on the image with additional buildpacks passed in. They are sorted
// by ID then Version.
func allBuildpacks(builderImage imgutil.Image, additionalBuildpacks []dist.Buildpack) ([]dist.BuildpackDescriptor, error) {
var all []dist.BuildpackDescriptor
var bpLayers dist.BuildpackLayers
Expand All @@ -253,6 +258,14 @@ func allBuildpacks(builderImage imgutil.Image, additionalBuildpacks []dist.Build
for _, bp := range additionalBuildpacks {
all = append(all, bp.Descriptor())
}

sort.Slice(all, func(i, j int) bool {
if all[i].Info.ID != all[j].Info.ID {
return all[i].Info.ID < all[j].Info.ID
}
return all[i].Info.Version < all[j].Info.Version
})

return all, nil
}

Expand Down Expand Up @@ -325,45 +338,119 @@ func (c *Client) processProxyConfig(config *ProxyConfig) ProxyConfig {
}
}

func (c *Client) processBuildpacks(ctx context.Context, buildpacks []string) ([]dist.Buildpack, dist.OrderEntry, error) {
group := dist.OrderEntry{Group: []dist.BuildpackRef{}}
var bps []dist.Buildpack
for _, bp := range buildpacks {
if isBuildpackID(bp) {
// processBuildpacks computes an order group based on the existing builder order and declared buildpacks. Additionally,
// it returns buildpacks that should be added to the builder.
//
// Visual examples:
//
// BUILDER ORDER
// ----------
// - group:
// - A
// - B
// - group:
// - A
//
// WITH DECLARED: "from=builder", X
// ----------
// - group:
// - A
// - B
// - X
// - group:
// - A
// - X
//
// WITH DECLARED: X, "from=builder", Y
// ----------
// - group:
// - X
// - A
// - B
// - Y
// - group:
// - X
// - A
// - Y
//
// WITH DECLARED: X
// ----------
// - group:
// - X
//
// WITH DECLARED: A
// ----------
// - group:
// - A
func (c *Client) processBuildpacks(ctx context.Context, builderOrder dist.Order, declaredBPs []string) (fetchedBPs []dist.Buildpack, order dist.Order, err error) {
order = dist.Order{{Group: []dist.BuildpackRef{}}}
for _, bp := range declaredBPs {
switch {
case bp == fromBuilderPrefix:
switch {
case len(order) == 0 || len(order[0].Group) == 0:
order = builderOrder
case len(order) > 1:
// This should only ever be possible if they are using from=builder twice which we don't allow
return nil, nil, errors.New("buildpacks from builder can only be defined once")
default:
newOrder := dist.Order{}
groupToAdd := order[0].Group
for _, bOrderEntry := range builderOrder {
newEntry := dist.OrderEntry{Group: append(groupToAdd, bOrderEntry.Group...)}
newOrder = append(newOrder, newEntry)
}

order = newOrder
}
case isBuildpackID(bp):
id, version := c.parseBuildpack(bp)
group.Group = append(group.Group, dist.BuildpackRef{
BuildpackInfo: dist.BuildpackInfo{
ID: id,
Version: version,
},
order = appendBuildpackToOrder(order, dist.BuildpackInfo{
ID: id,
Version: version,
})
} else {
default:
err := ensureBPSupport(bp)
if err != nil {
return nil, dist.OrderEntry{}, errors.Wrapf(err, "checking buildpack path")
return fetchedBPs, order, errors.Wrapf(err, "checking support")
}

blob, err := c.downloader.Download(ctx, bp)
if err != nil {
return nil, dist.OrderEntry{}, errors.Wrapf(err, "downloading buildpack from %s", style.Symbol(bp))
return fetchedBPs, order, errors.Wrapf(err, "downloading buildpack from %s", style.Symbol(bp))
}

fetchedBP, err := dist.BuildpackFromRootBlob(blob)
if err != nil {
return nil, dist.OrderEntry{}, errors.Wrapf(err, "creating buildpack from %s", style.Symbol(bp))
return fetchedBPs, order, errors.Wrapf(err, "creating buildpack from %s", style.Symbol(bp))
}

bps = append(bps, fetchedBP)

group.Group = append(group.Group, dist.BuildpackRef{
BuildpackInfo: fetchedBP.Descriptor().Info,
})
fetchedBPs = append(fetchedBPs, fetchedBP)
order = appendBuildpackToOrder(order, fetchedBP.Descriptor().Info)
}
}
return bps, group, nil

return fetchedBPs, order, nil
}

func appendBuildpackToOrder(order dist.Order, bpInfo dist.BuildpackInfo) (newOrder dist.Order) {
for _, orderEntry := range order {
newEntry := orderEntry
newEntry.Group = append(newEntry.Group, dist.BuildpackRef{
BuildpackInfo: bpInfo,
Optional: false,
})
newOrder = append(newOrder, newEntry)
}

return newOrder
}

func isBuildpackID(bp string) bool {
if strings.HasPrefix(bp, fromBuilderPrefix+":") {
return true
}

if !paths.IsURI(bp) {
if _, err := os.Stat(bp); err != nil {
return true
Expand Down Expand Up @@ -404,7 +491,7 @@ func ensureBPSupport(bpPath string) (err error) {
}

func (c *Client) parseBuildpack(bp string) (string, string) {
parts := strings.Split(bp, "@")
parts := strings.Split(strings.TrimPrefix(bp, fromBuilderPrefix+":"), "@")
if len(parts) == 2 {
if parts[1] == "latest" {
c.logger.Warn("@latest syntax is deprecated, will not work in future releases")
Expand All @@ -417,7 +504,7 @@ func (c *Client) parseBuildpack(bp string) (string, string) {
return parts[0], ""
}

func (c *Client) createEphemeralBuilder(rawBuilderImage imgutil.Image, env map[string]string, group dist.OrderEntry, buildpacks []dist.Buildpack) (*builder.Builder, error) {
func (c *Client) createEphemeralBuilder(rawBuilderImage imgutil.Image, env map[string]string, order dist.Order, buildpacks []dist.Buildpack) (*builder.Builder, error) {
origBuilderName := rawBuilderImage.Name()
bldr, err := builder.New(rawBuilderImage, fmt.Sprintf("pack.local/builder/%x:latest", randString(10)))
if err != nil {
Expand All @@ -430,9 +517,9 @@ func (c *Client) createEphemeralBuilder(rawBuilderImage imgutil.Image, env map[s
c.logger.Debugf("Adding buildpack %s version %s to builder", style.Symbol(bpInfo.ID), style.Symbol(bpInfo.Version))
bldr.AddBuildpack(bp)
}
if len(group.Group) > 0 {
if len(order) > 0 && len(order[0].Group) > 0 {
c.logger.Debug("Setting custom order")
bldr.SetOrder([]dist.OrderEntry{group})
bldr.SetOrder(order)
}

if err := bldr.Save(c.logger); err != nil {
Expand Down
Loading

0 comments on commit 93436c3

Please sign in to comment.