Skip to content
This repository was archived by the owner on Jan 20, 2021. It is now read-only.

Commit 0296797

Browse files
dnephindnephin
committed
Extract squash and tagging from the Dockerfile builder.
Remove pathCache and replace it with syncmap Cleanup NewBuilder Create an api/server/backend/build Extract BuildTagger Signed-off-by: Daniel Nephin <[email protected]>
1 parent f07811f commit 0296797

15 files changed

Lines changed: 337 additions & 259 deletions

File tree

‎api/server/backend/build/backend.go‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
package build
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/docker/distribution/reference"
7+
"github.com/docker/docker/api/types/backend"
8+
"github.com/docker/docker/builder"
9+
"github.com/docker/docker/builder/dockerfile"
10+
"github.com/docker/docker/image"
11+
"github.com/docker/docker/pkg/stringid"
12+
"github.com/pkg/errors"
13+
"golang.org/x/net/context"
14+
)
15+
16+
// ImageComponent provides an interface for working with images
17+
type ImageComponent interface {
18+
SquashImage(from string, to string) (string, error)
19+
TagImageWithReference(image.ID, reference.Named) error
20+
}
21+
22+
// Backend provides build functionality to the API router
23+
type Backend struct {
24+
manager *dockerfile.BuildManager
25+
imageComponent ImageComponent
26+
}
27+
28+
// NewBackend creates a new build backend from components
29+
func NewBackend(components ImageComponent, builderBackend builder.Backend) *Backend {
30+
manager := dockerfile.NewBuildManager(builderBackend)
31+
return &Backend{imageComponent: components, manager: manager}
32+
}
33+
34+
// Build builds an image from a Source
35+
func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string, error) {
36+
options := config.Options
37+
tagger, err := NewTagger(b.imageComponent, config.ProgressWriter.StdoutFormatter, options.Tags)
38+
if err != nil {
39+
return "", err
40+
}
41+
42+
build, err := b.manager.Build(ctx, config)
43+
if err != nil {
44+
return "", err
45+
}
46+
47+
var imageID = build.ImageID
48+
if options.Squash {
49+
if imageID, err = squashBuild(build, b.imageComponent); err != nil {
50+
return "", err
51+
}
52+
}
53+
54+
stdout := config.ProgressWriter.StdoutFormatter
55+
fmt.Fprintf(stdout, "Successfully built %s\n", stringid.TruncateID(imageID))
56+
err = tagger.TagImages(image.ID(imageID))
57+
return imageID, err
58+
}
59+
60+
func squashBuild(build *builder.Result, imageComponent ImageComponent) (string, error) {
61+
var fromID string
62+
if build.FromImage != nil {
63+
fromID = build.FromImage.ImageID()
64+
}
65+
imageID, err := imageComponent.SquashImage(build.ImageID, fromID)
66+
if err != nil {
67+
return "", errors.Wrap(err, "error squashing image")
68+
}
69+
return imageID, nil
70+
}

‎api/server/backend/build/tag.go‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
package build
2+
3+
import (
4+
"fmt"
5+
"io"
6+
7+
"github.com/docker/distribution/reference"
8+
"github.com/docker/docker/image"
9+
"github.com/pkg/errors"
10+
)
11+
12+
// Tagger is responsible for tagging an image created by a builder
13+
type Tagger struct {
14+
imageComponent ImageComponent
15+
stdout io.Writer
16+
repoAndTags []reference.Named
17+
}
18+
19+
// NewTagger returns a new Tagger for tagging the images of a build.
20+
// If any of the names are invalid tags an error is returned.
21+
func NewTagger(backend ImageComponent, stdout io.Writer, names []string) (*Tagger, error) {
22+
reposAndTags, err := sanitizeRepoAndTags(names)
23+
if err != nil {
24+
return nil, err
25+
}
26+
return &Tagger{
27+
imageComponent: backend,
28+
stdout: stdout,
29+
repoAndTags: reposAndTags,
30+
}, nil
31+
}
32+
33+
// TagImages creates image tags for the imageID
34+
func (bt *Tagger) TagImages(imageID image.ID) error {
35+
for _, rt := range bt.repoAndTags {
36+
if err := bt.imageComponent.TagImageWithReference(imageID, rt); err != nil {
37+
return err
38+
}
39+
fmt.Fprintf(bt.stdout, "Successfully tagged %s\n", reference.FamiliarString(rt))
40+
}
41+
return nil
42+
}
43+
44+
// sanitizeRepoAndTags parses the raw "t" parameter received from the client
45+
// to a slice of repoAndTag.
46+
// It also validates each repoName and tag.
47+
func sanitizeRepoAndTags(names []string) ([]reference.Named, error) {
48+
var (
49+
repoAndTags []reference.Named
50+
// This map is used for deduplicating the "-t" parameter.
51+
uniqNames = make(map[string]struct{})
52+
)
53+
for _, repo := range names {
54+
if repo == "" {
55+
continue
56+
}
57+
58+
ref, err := reference.ParseNormalizedNamed(repo)
59+
if err != nil {
60+
return nil, err
61+
}
62+
63+
if _, isCanonical := ref.(reference.Canonical); isCanonical {
64+
return nil, errors.New("build tag cannot contain a digest")
65+
}
66+
67+
ref = reference.TagNameOnly(ref)
68+
69+
nameWithTag := ref.String()
70+
71+
if _, exists := uniqNames[nameWithTag]; !exists {
72+
uniqNames[nameWithTag] = struct{}{}
73+
repoAndTags = append(repoAndTags, ref)
74+
}
75+
}
76+
return repoAndTags, nil
77+
}

‎api/server/router/build/backend.go‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
package build
22

33
import (
4-
"io"
5-
6-
"github.com/docker/docker/api/types"
74
"github.com/docker/docker/api/types/backend"
85
"golang.org/x/net/context"
96
)
107

118
// Backend abstracts an image builder whose only purpose is to build an image referenced by an imageID.
129
type Backend interface {
13-
// BuildFromContext builds a Docker image referenced by an imageID string.
14-
//
15-
// Note: Tagging an image should not be done by a Builder, it should instead be done
16-
// by the caller.
17-
//
10+
// Build a Docker image returning the id of the image
1811
// TODO: make this return a reference instead of string
19-
BuildFromContext(ctx context.Context, src io.ReadCloser, buildOptions *types.ImageBuildOptions, pg backend.ProgressWriter) (string, error)
12+
Build(context.Context, backend.BuildConfig) (string, error)
13+
}
14+
15+
type experimentalProvider interface {
16+
HasExperimental() bool
2017
}

‎api/server/router/build/build.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@ import "github.com/docker/docker/api/server/router"
55
// buildRouter is a router to talk with the build controller
66
type buildRouter struct {
77
backend Backend
8+
daemon experimentalProvider
89
routes []router.Route
910
}
1011

1112
// NewRouter initializes a new build router
12-
func NewRouter(b Backend) router.Router {
13-
r := &buildRouter{
14-
backend: b,
15-
}
13+
func NewRouter(b Backend, d experimentalProvider) router.Router {
14+
r := &buildRouter{backend: b, daemon: d}
1615
r.initRoutes()
1716
return r
1817
}

‎api/server/router/build/build_routes.go‎

Lines changed: 59 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"sync"
1414

1515
"github.com/Sirupsen/logrus"
16+
apierrors "github.com/docker/docker/api/errors"
1617
"github.com/docker/docker/api/server/httputils"
1718
"github.com/docker/docker/api/types"
1819
"github.com/docker/docker/api/types/backend"
@@ -22,6 +23,7 @@ import (
2223
"github.com/docker/docker/pkg/progress"
2324
"github.com/docker/docker/pkg/streamformatter"
2425
units "github.com/docker/go-units"
26+
"github.com/pkg/errors"
2527
"golang.org/x/net/context"
2628
)
2729

@@ -87,9 +89,6 @@ func newImageBuildOptions(ctx context.Context, r *http.Request) (*types.ImageBui
8789
options.Ulimits = buildUlimits
8890
}
8991

90-
var buildArgs = map[string]*string{}
91-
buildArgsJSON := r.FormValue("buildargs")
92-
9392
// Note that there are two ways a --build-arg might appear in the
9493
// json of the query param:
9594
// "foo":"bar"
@@ -102,25 +101,27 @@ func newImageBuildOptions(ctx context.Context, r *http.Request) (*types.ImageBui
102101
// the fact they mentioned it, we need to pass that along to the builder
103102
// so that it can print a warning about "foo" being unused if there is
104103
// no "ARG foo" in the Dockerfile.
104+
buildArgsJSON := r.FormValue("buildargs")
105105
if buildArgsJSON != "" {
106+
var buildArgs = map[string]*string{}
106107
if err := json.Unmarshal([]byte(buildArgsJSON), &buildArgs); err != nil {
107108
return nil, err
108109
}
109110
options.BuildArgs = buildArgs
110111
}
111112

112-
var labels = map[string]string{}
113113
labelsJSON := r.FormValue("labels")
114114
if labelsJSON != "" {
115+
var labels = map[string]string{}
115116
if err := json.Unmarshal([]byte(labelsJSON), &labels); err != nil {
116117
return nil, err
117118
}
118119
options.Labels = labels
119120
}
120121

121-
var cacheFrom = []string{}
122122
cacheFromJSON := r.FormValue("cachefrom")
123123
if cacheFromJSON != "" {
124+
var cacheFrom = []string{}
124125
if err := json.Unmarshal([]byte(cacheFromJSON), &cacheFrom); err != nil {
125126
return nil, err
126127
}
@@ -130,33 +131,8 @@ func newImageBuildOptions(ctx context.Context, r *http.Request) (*types.ImageBui
130131
return options, nil
131132
}
132133

133-
type syncWriter struct {
134-
w io.Writer
135-
mu sync.Mutex
136-
}
137-
138-
func (s *syncWriter) Write(b []byte) (count int, err error) {
139-
s.mu.Lock()
140-
count, err = s.w.Write(b)
141-
s.mu.Unlock()
142-
return
143-
}
144-
145134
func (br *buildRouter) postBuild(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
146-
var (
147-
authConfigs = map[string]types.AuthConfig{}
148-
authConfigsEncoded = r.Header.Get("X-Registry-Config")
149-
notVerboseBuffer = bytes.NewBuffer(nil)
150-
)
151-
152-
if authConfigsEncoded != "" {
153-
authConfigsJSON := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authConfigsEncoded))
154-
if err := json.NewDecoder(authConfigsJSON).Decode(&authConfigs); err != nil {
155-
// for a pull it is not an error if no auth was given
156-
// to increase compatibility with the existing api it is defaulting
157-
// to be empty.
158-
}
159-
}
135+
var notVerboseBuffer = bytes.NewBuffer(nil)
160136

161137
w.Header().Set("Content-Type", "application/json")
162138

@@ -183,7 +159,12 @@ func (br *buildRouter) postBuild(ctx context.Context, w http.ResponseWriter, r *
183159
if err != nil {
184160
return errf(err)
185161
}
186-
buildOptions.AuthConfigs = authConfigs
162+
buildOptions.AuthConfigs = getAuthConfigs(r.Header)
163+
164+
if buildOptions.Squash && !br.daemon.HasExperimental() {
165+
return apierrors.NewBadRequestError(
166+
errors.New("squash is only supported with experimental mode"))
167+
}
187168

188169
// Currently, only used if context is from a remote url.
189170
// Look at code in DetectContextFromRemoteURL for more information.
@@ -199,18 +180,12 @@ func (br *buildRouter) postBuild(ctx context.Context, w http.ResponseWriter, r *
199180
if buildOptions.SuppressOutput {
200181
out = notVerboseBuffer
201182
}
202-
out = &syncWriter{w: out}
203-
stdout := &streamformatter.StdoutFormatter{Writer: out, StreamFormatter: sf}
204-
stderr := &streamformatter.StderrFormatter{Writer: out, StreamFormatter: sf}
205-
206-
pg := backend.ProgressWriter{
207-
Output: out,
208-
StdoutFormatter: stdout,
209-
StderrFormatter: stderr,
210-
ProgressReaderFunc: createProgressReader,
211-
}
212183

213-
imgID, err := br.backend.BuildFromContext(ctx, r.Body, buildOptions, pg)
184+
imgID, err := br.backend.Build(ctx, backend.BuildConfig{
185+
Source: r.Body,
186+
Options: buildOptions,
187+
ProgressWriter: buildProgressWriter(out, sf, createProgressReader),
188+
})
214189
if err != nil {
215190
return errf(err)
216191
}
@@ -219,8 +194,47 @@ func (br *buildRouter) postBuild(ctx context.Context, w http.ResponseWriter, r *
219194
// should be just the image ID and we'll print that to stdout.
220195
if buildOptions.SuppressOutput {
221196
stdout := &streamformatter.StdoutFormatter{Writer: output, StreamFormatter: sf}
222-
fmt.Fprintf(stdout, "%s\n", string(imgID))
197+
fmt.Fprintln(stdout, imgID)
223198
}
224-
225199
return nil
226200
}
201+
202+
func getAuthConfigs(header http.Header) map[string]types.AuthConfig {
203+
authConfigs := map[string]types.AuthConfig{}
204+
authConfigsEncoded := header.Get("X-Registry-Config")
205+
206+
if authConfigsEncoded == "" {
207+
return authConfigs
208+
}
209+
210+
authConfigsJSON := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authConfigsEncoded))
211+
// Pulling an image does not error when no auth is provided so to remain
212+
// consistent with the existing api decode errors are ignored
213+
json.NewDecoder(authConfigsJSON).Decode(&authConfigs)
214+
return authConfigs
215+
}
216+
217+
type syncWriter struct {
218+
w io.Writer
219+
mu sync.Mutex
220+
}
221+
222+
func (s *syncWriter) Write(b []byte) (count int, err error) {
223+
s.mu.Lock()
224+
count, err = s.w.Write(b)
225+
s.mu.Unlock()
226+
return
227+
}
228+
229+
func buildProgressWriter(out io.Writer, sf *streamformatter.StreamFormatter, createProgressReader func(io.ReadCloser) io.ReadCloser) backend.ProgressWriter {
230+
out = &syncWriter{w: out}
231+
stdout := &streamformatter.StdoutFormatter{Writer: out, StreamFormatter: sf}
232+
stderr := &streamformatter.StderrFormatter{Writer: out, StreamFormatter: sf}
233+
234+
return backend.ProgressWriter{
235+
Output: out,
236+
StdoutFormatter: stdout,
237+
StderrFormatter: stderr,
238+
ProgressReaderFunc: createProgressReader,
239+
}
240+
}

‎api/types/backend/backend.go‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import (
66
"time"
77

88
"github.com/docker/docker/api/types"
9-
"github.com/docker/docker/pkg/streamformatter"
109
)
1110

1211
// ContainerAttachConfig holds the streams to use when connecting to a container to view logs.
@@ -99,11 +98,3 @@ type ContainerCommitConfig struct {
9998
types.ContainerCommitConfig
10099
Changes []string
101100
}
102-
103-
// ProgressWriter is a data object to transport progress streams to the client
104-
type ProgressWriter struct {
105-
Output io.Writer
106-
StdoutFormatter *streamformatter.StdoutFormatter
107-
StderrFormatter *streamformatter.StderrFormatter
108-
ProgressReaderFunc func(io.ReadCloser) io.ReadCloser
109-
}

0 commit comments

Comments
 (0)