Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add support for pack to extend base images using daemon #1791

Draft
wants to merge 34 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
ca07b65
add helper functions for extend using daemon
itsdarshankumar Jun 2, 2023
abdf62c
add buildImage by daemon
itsdarshankumar Jun 2, 2023
5c460c5
extract layers and extend the export phase
itsdarshankumar Jun 11, 2023
8710e46
implements build image extension by daemon
itsdarshankumar Jun 25, 2023
88c8fbd
adds execution measurement
itsdarshankumar Jun 25, 2023
b8295c5
adds mockDaemon and unit test
itsdarshankumar Aug 6, 2023
98fd87d
add tests for multiple buildextend
itsdarshankumar Aug 16, 2023
4ad4631
adds functionality to fetch args from config
itsdarshankumar Aug 17, 2023
9466204
remove run extend
itsdarshankumar Aug 23, 2023
0e2fce6
remove profiling and add comments
itsdarshankumar Aug 23, 2023
c8ac171
Merge changes from main branch
itsdarshankumar Aug 23, 2023
888d1a8
fix logger for daemon extend
itsdarshankumar Aug 26, 2023
f935dd2
fix tests
itsdarshankumar Aug 26, 2023
38d0278
add tarwriter for single file and include workspace in context
itsdarshankumar Aug 30, 2023
b69ddad
Merge changes from main branch
itsdarshankumar Aug 30, 2023
aa78c43
skip test for windows
itsdarshankumar Aug 30, 2023
57f88a2
remove redundant logs
itsdarshankumar Aug 30, 2023
72c6fde
add tests for helper functions
itsdarshankumar Oct 8, 2023
02858bf
Merge branch 'main' into run-extend
itsdarshankumar Oct 8, 2023
d33f1df
Merge branch 'main' into run-extend
natalieparellano Nov 14, 2023
40ca4f6
Merge branch 'buildpacks:main' into run-extend
itsdarshankumar Dec 15, 2023
3ca6ad1
adds test for file-to-tar and fixes loggers
itsdarshankumar Dec 15, 2023
e401acd
fixes linting of imports
itsdarshankumar Dec 15, 2023
cd7ee2e
Merge branch 'main' into run-extend
natalieparellano Dec 20, 2023
77a2c5c
Merge branch 'main' into run-extend
itsdarshankumar Dec 25, 2023
147699b
adds warnings over UID and GID
itsdarshankumar Dec 26, 2023
1311893
adds note in help and phase to notifiy the nomenclature
itsdarshankumar Dec 26, 2023
3e64a54
remove kaniko caching for build extend
itsdarshankumar Dec 26, 2023
bb255dc
update subsequent changes in UID and GID to config
itsdarshankumar Dec 26, 2023
c560e9f
fix tests
itsdarshankumar Dec 26, 2023
7cf7e08
remove redundant tests
itsdarshankumar Dec 26, 2023
b416335
Merge branch 'main' into run-extend
natalieparellano Jan 22, 2024
3b52e66
Merge branch 'main' into run-extend
itsdarshankumar Feb 11, 2024
abb040c
Merge branch 'main' into run-extend
itsdarshankumar Mar 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions internal/build/docker.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (
specs "github.com/opencontainers/image-spec/specs-go/v1"
)

//go:generate mockgen -package mockdocker -destination ./mockdocker/mockDockerClient.go github.com/buildpacks/pack/internal/build DockerClient

type DockerClient interface {
ImageRemove(ctx context.Context, image string, options types.ImageRemoveOptions) ([]image.DeleteResponse, error)
VolumeRemove(ctx context.Context, volumeID string, force bool) error
Expand All @@ -23,6 +25,9 @@ type DockerClient interface {
ContainerInspect(ctx context.Context, container string) (types.ContainerJSON, error)
ContainerRemove(ctx context.Context, container string, options containertypes.RemoveOptions) error
CopyToContainer(ctx context.Context, container, path string, content io.Reader, options types.CopyToContainerOptions) error
ImageBuild(ctx context.Context, buildContext io.Reader, options types.ImageBuildOptions) (types.ImageBuildResponse, error)
ImageInspectWithRaw(ctx context.Context, image string) (types.ImageInspect, []byte, error)
ImageSave(ctx context.Context, imageIDs []string) (io.ReadCloser, error)
}

var _ DockerClient = dockerClient.CommonAPIClient(nil)
174 changes: 174 additions & 0 deletions internal/build/extend_build_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
package build_test

import (
"bytes"
"context"
"io"
"path/filepath"
"runtime"
"strconv"
"strings"
"testing"

"github.com/apex/log"
"github.com/buildpacks/lifecycle/buildpack"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/container"
"github.com/golang/mock/gomock"
"github.com/heroku/color"
"github.com/sclevine/spec"
"github.com/sclevine/spec/report"

"github.com/buildpacks/pack/internal/build"
"github.com/buildpacks/pack/internal/build/fakes"
mockdocker "github.com/buildpacks/pack/internal/build/mockdocker"
"github.com/buildpacks/pack/pkg/logging"
h "github.com/buildpacks/pack/testhelpers"
)

func TestBuildDockerfiles(t *testing.T) {
color.Disable(true)
defer color.Disable(false)
spec.Run(t, "buildExtendByDocker", testBuildDockerfiles, spec.Report(report.Terminal{}), spec.Sequential())
}

const (
argUserID = "user_id"
argGroupID = "group_id"
)

func testBuildDockerfiles(t *testing.T, when spec.G, it spec.S) {
var (
mockDockerClient *mockdocker.MockDockerClient
mockController *gomock.Controller
lifecycle *build.LifecycleExecution
tmpDir string

// lifecycle options
providedClearCache bool
providedPublish bool
providedBuilderImage = "some-registry.com/some-namespace/some-builder-name"
extendedBuilderImage = "some-registry.com/some-namespace/some-builder-name-extended"
configureDefaultTestLifecycle func(opts *build.LifecycleOptions)
lifecycleOps []func(*build.LifecycleOptions)
)

it.Before(func() {
h.SkipIf(t, runtime.GOOS == "windows", "extensions not supported on windows")
var err error
mockController = gomock.NewController(t)
mockDockerClient = mockdocker.NewMockDockerClient(mockController)
h.AssertNil(t, err)

configureDefaultTestLifecycle = func(opts *build.LifecycleOptions) {
opts.BuilderImage = providedBuilderImage
opts.ClearCache = providedClearCache
opts.Publish = providedPublish
}

lifecycleOps = []func(*build.LifecycleOptions){configureDefaultTestLifecycle}
})

when("Extend Build Image By Docker", func() {
it("should extend build image using 1 extension", func() {
itsdarshankumar marked this conversation as resolved.
Show resolved Hide resolved
// set tmp directory
tmpDir = filepath.Join(".", "testdata", "fake-tmp", "build-extension", "single")
lifecycle = getTestLifecycleExec(t, true, tmpDir, mockDockerClient, lifecycleOps...)
dockerfile := build.DockerfileInfo{
Info: &buildpack.DockerfileInfo{
Path: filepath.Join(".", "testdata", "fake-tmp", "build-extension", "single", "build", "samples_test", "Dockerfile"),
},
}
expectedBuilder := lifecycle.Builder()
expectedBuildContext, _ := dockerfile.
CreateBuildContext(lifecycle.AppPath(), lifecycle.GetLogger())
// Set up expected Build Args
UID := strconv.Itoa(expectedBuilder.UID())
GID := strconv.Itoa(expectedBuilder.GID())
expectedbuildArguments := map[string]*string{}
expectedbuildArguments["base_image"] = &providedBuilderImage
expectedbuildArguments[argUserID] = &UID
expectedbuildArguments[argGroupID] = &GID
expectedBuildOptions := types.ImageBuildOptions{
Context: expectedBuildContext,
Dockerfile: "Dockerfile",
Tags: []string{extendedBuilderImage},
Remove: true,
BuildArgs: expectedbuildArguments,
}
mockResponse := types.ImageBuildResponse{
Body: io.NopCloser(strings.NewReader("mock-build-response-body")),
OSType: "linux",
}
mockDockerClient.EXPECT().ImageBuild(gomock.Any(), gomock.Any(), gomock.Any()).Do(func(_ context.Context, buildContext io.Reader, buildOptions types.ImageBuildOptions) {
compBuildOptions(t, expectedBuildOptions, buildOptions)
}).Return(mockResponse, nil).Times(1)
mockDockerClient.EXPECT().ImageInspectWithRaw(gomock.Any(), gomock.Any()).Return(types.ImageInspect{
Config: &container.Config{
User: "root",
},
}, nil, nil).Times(1)
err := lifecycle.ExtendBuildByDaemon(context.Background())
h.AssertNil(t, err)
})

it("should extend build image using multiple extension", func() {
// set tmp directory
tmpDir = filepath.Join(".", "testdata", "fake-tmp", "build-extension", "multi")
lifecycle = getTestLifecycleExec(t, true, tmpDir, mockDockerClient, lifecycleOps...)
mockResponse := types.ImageBuildResponse{
Body: io.NopCloser(strings.NewReader("mock-build-response-body")),
OSType: "linux",
}
mockDockerClient.EXPECT().ImageBuild(gomock.Any(), gomock.Any(), gomock.Any()).Return(mockResponse, nil).Times(2)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally here we'd also want to check that the options provided to the second Dockerfile are correct. Dockerfile and BuildArgs seem to be the most important to test.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@itsdarshankumar please take a look at this suggestion, I think is very valid to make test useful

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes eyes on it :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we still need to do this, no? Have a look at DoAndReturn (we use this a bunch in the lifecycle) as a mechanism for testing some (but not all) inputs. This can be useful since one of the build args is a UUID and we can't predict its value in advance.

mockDockerClient.EXPECT().ImageInspectWithRaw(gomock.Any(), gomock.Any()).Return(types.ImageInspect{
Config: &container.Config{
User: "root",
}}, nil, nil).Times(2)
err := lifecycle.ExtendBuildByDaemon(context.Background())
h.AssertNil(t, err)
})
})
}
func GetTestLifecycleExecErr(t *testing.T, logVerbose bool, tmpDir string, mockDockerClient *mockdocker.MockDockerClient, ops ...func(*build.LifecycleOptions)) (*build.LifecycleExecution, error) {
var outBuf bytes.Buffer
logger := logging.NewLogWithWriters(&outBuf, &outBuf)
if logVerbose {
logger.Level = log.DebugLevel
}
defaultBuilder, err := fakes.NewFakeBuilder()
h.AssertNil(t, err)

opts := build.LifecycleOptions{
AppPath: "some-app-path",
Builder: defaultBuilder,
HTTPProxy: "some-http-proxy",
HTTPSProxy: "some-https-proxy",
NoProxy: "some-no-proxy",
Termui: &fakes.FakeTermui{},
}

for _, op := range ops {
op(&opts)
}

return build.NewLifecycleExecution(logger, mockDockerClient, tmpDir, opts)
}

func getTestLifecycleExec(t *testing.T, logVerbose bool, tmpDir string, mockDockerClient *mockdocker.MockDockerClient, ops ...func(*build.LifecycleOptions)) *build.LifecycleExecution {
t.Helper()

lifecycleExec, err := GetTestLifecycleExecErr(t, logVerbose, tmpDir, mockDockerClient, ops...)
h.AssertNil(t, err)
return lifecycleExec
}

func compBuildOptions(t *testing.T, expectedBuildOptions types.ImageBuildOptions, actualBuildOptions types.ImageBuildOptions) {
t.Helper()
h.AssertEq(t, expectedBuildOptions.Dockerfile, actualBuildOptions.Dockerfile)
h.AssertEq(t, expectedBuildOptions.Tags, actualBuildOptions.Tags)
h.AssertEq(t, expectedBuildOptions.Remove, actualBuildOptions.Remove)
h.AssertEq(t, expectedBuildOptions.BuildArgs["base_image"], actualBuildOptions.BuildArgs["base_image"])
h.AssertEq(t, expectedBuildOptions.BuildArgs[argUserID], actualBuildOptions.BuildArgs[argUserID])
h.AssertEq(t, expectedBuildOptions.BuildArgs[argGroupID], actualBuildOptions.BuildArgs[argGroupID])
}
170 changes: 170 additions & 0 deletions internal/build/helper.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
package build
natalieparellano marked this conversation as resolved.
Show resolved Hide resolved

import (
"archive/tar"
"bytes"
"fmt"
"io"
"os"
"path/filepath"
"strings"

"github.com/BurntSushi/toml"
"github.com/buildpacks/lifecycle/buildpack"
"github.com/buildpacks/lifecycle/cmd"
"github.com/docker/docker/api/types"

"github.com/buildpacks/pack/pkg/archive"
"github.com/buildpacks/pack/pkg/logging"
)

const (
DockerfileKindBuild = "build"
DockerfileKindRun = "run"
)

type Extensions struct {
Extensions []buildpack.GroupElement
}
natalieparellano marked this conversation as resolved.
Show resolved Hide resolved

type DockerfileInfo struct {
Info *buildpack.DockerfileInfo
Args []Arg
}

type Arg struct {
Name string `toml:"name"`
Value string `toml:"value"`
}

type Config struct {
Build BuildConfig `toml:"build"`
Run BuildConfig `toml:"run"`
}

type BuildConfig struct {
Args []Arg `toml:"args"`
}

func (extensions *Extensions) DockerFiles(kind string, path string, logger logging.Logger) ([]DockerfileInfo, error) {
var dockerfiles []DockerfileInfo
for _, ext := range extensions.Extensions {
dockerfile, err := extensions.ReadDockerFile(path, kind, ext.ID)
if err != nil {
return nil, err
}

Check warning on line 55 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L54-L55

Added lines #L54 - L55 were not covered by tests
if dockerfile != nil {
logger.Debugf("Found %s Dockerfile for extension '%s'", kind, ext.ID)
switch kind {
case DockerfileKindBuild:
break
case DockerfileKindRun:
buildpack.ValidateRunDockerfile(dockerfile.Info, logger)
default:
return nil, fmt.Errorf("unknown dockerfile kind: %s", kind)

Check warning on line 64 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L61-L64

Added lines #L61 - L64 were not covered by tests
}
dockerfiles = append(dockerfiles, *dockerfile)
}
}
return dockerfiles, nil
}

func (extensions *Extensions) ReadDockerFile(path string, kind string, extID string) (*DockerfileInfo, error) {
dockerfilePath := filepath.Join(path, kind, escapeID(extID), "Dockerfile")
if _, err := os.Stat(dockerfilePath); err != nil {
return nil, nil
}

Check warning on line 76 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L75-L76

Added lines #L75 - L76 were not covered by tests
configPath := filepath.Join(path, kind, escapeID(extID), "extend-config.toml")
var config Config
_, err := toml.DecodeFile(configPath, &config)
if err != nil {
if !os.IsNotExist(err) {
return nil, err
}

Check warning on line 83 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L82-L83

Added lines #L82 - L83 were not covered by tests
}

var args []Arg
if kind == buildpack.DockerfileKindBuild {
args = config.Build.Args
} else {
args = config.Run.Args
}

Check warning on line 91 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L90-L91

Added lines #L90 - L91 were not covered by tests
return &DockerfileInfo{
Info: &buildpack.DockerfileInfo{
ExtensionID: extID,
Kind: kind,
Path: dockerfilePath,
},
Args: args,
}, nil
}

func (extensions *Extensions) SetExtensions(path string, logger logging.Logger) error {
groupExt, err := readExtensionsGroup(path)
if err != nil {
return fmt.Errorf("reading group: %w", err)
}

Check warning on line 106 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L105-L106

Added lines #L105 - L106 were not covered by tests
for i := range groupExt {
groupExt[i].Extension = true
}
for _, groupEl := range groupExt {
if err = cmd.VerifyBuildpackAPI(groupEl.Kind(), groupEl.String(), groupEl.API, logger); err != nil {
return err
}

Check warning on line 113 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L112-L113

Added lines #L112 - L113 were not covered by tests
}
extensions.Extensions = groupExt
return nil
}

func readExtensionsGroup(path string) ([]buildpack.GroupElement, error) {
var group buildpack.Group
_, err := toml.DecodeFile(filepath.Join(path, "group.toml"), &group)
for e := range group.GroupExtensions {
group.GroupExtensions[e].Extension = true
group.GroupExtensions[e].Optional = true
itsdarshankumar marked this conversation as resolved.
Show resolved Hide resolved
}
return group.GroupExtensions, err
}

func escapeID(id string) string {
return strings.ReplaceAll(id, "/", "_")
}

func (dockerfile *DockerfileInfo) CreateBuildContext(path string, logger logging.Logger) (io.Reader, error) {
defaultFilterFunc := func(file string) bool { return true }
buf := new(bytes.Buffer)
tarWriter := tar.NewWriter(buf)
var completeErr error

defer func() {
if err := tarWriter.Close(); err != nil {
logger.Errorf("Error closing tar writer: %s", err)
completeErr = archive.AggregateError(completeErr, err)
itsdarshankumar marked this conversation as resolved.
Show resolved Hide resolved
}

Check warning on line 143 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L141-L143

Added lines #L141 - L143 were not covered by tests
}()
if err := archive.WriteDirToTar(tarWriter, path, "/workspace", 0, 0, -1, true, false, defaultFilterFunc); err != nil {
tarWriter.Close()
logger.Errorf("Error adding workspace: %s", err)
completeErr = archive.AggregateError(completeErr, err)
}

Check warning on line 149 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L146-L149

Added lines #L146 - L149 were not covered by tests

if err := archive.WriteFileToTar(tarWriter, dockerfile.Info.Path, filepath.Join(".", "Dockerfile"), 0, 0, -1, true); err != nil {
tarWriter.Close()
logger.Errorf("Error adding dockerfile: %s", err)
completeErr = archive.AggregateError(completeErr, err)
}

Check warning on line 155 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L152-L155

Added lines #L152 - L155 were not covered by tests

return buf, completeErr
}

func userFrom(imageInfo types.ImageInspect) (string, string) {
user := strings.Split(imageInfo.Config.User, ":")
if len(user) < 2 {
return imageInfo.Config.User, ""
}
return user[0], user[1]

Check warning on line 165 in internal/build/helper.go

View check run for this annotation

Codecov / codecov/patch

internal/build/helper.go#L165

Added line #L165 was not covered by tests
}

func isRoot(userID string) bool {
return userID == "0" || userID == "root"
}
Loading
Loading