File: build_context.go

package info (click to toggle)
singularity-container 4.0.3%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 21,672 kB
  • sloc: asm: 3,857; sh: 2,125; ansic: 1,677; awk: 414; makefile: 110; python: 99
file content (240 lines) | stat: -rw-r--r-- 6,885 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// Copyright (c) 2022-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.

package client

import (
	"bytes"
	"compress/gzip"
	"context"
	"crypto/sha256"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"io/fs"
	"net/http"
	"net/url"
	"os"
)

// writeArchive writes a compressed archive containing paths read from fsys to w.
//
// Paths must be specified in the rootless format specified by the io/fs package. If a path
// contains a glob, it will be evaluated as per fs.Glob. If a path specifies a directory, its
// contents will be walked as per fs.WalkDir.
func writeArchive(w io.Writer, fsys fs.FS, paths []string) error {
	gw := gzip.NewWriter(w)
	defer gw.Close()

	ar := newArchiver(fsys, gw)
	defer ar.Close()

	for _, path := range paths {
		if err := ar.WriteFiles(path); err != nil {
			return err
		}
	}

	return nil
}

var errContextAlreadyPresent = errors.New("build context already present")

// getBuildContextUploadLocation obtains an upload location for a build context.
//
// If errContextAlreadyPresent is returned, (re)upload of build context is not required.
func (c *Client) getBuildContextUploadLocation(ctx context.Context, size int64, digest string) (*url.URL, error) {
	ref := &url.URL{
		Path: "v1/build-context",
	}

	body := struct {
		Size   int64  `json:"size"`
		Digest string `json:"digest"`
	}{
		Size:   size,
		Digest: digest,
	}

	b, err := json.Marshal(body)
	if err != nil {
		return nil, fmt.Errorf("failed to marshal request: %w", err)
	}

	req, err := c.newRequest(ctx, http.MethodPost, ref, bytes.NewReader(b))
	if err != nil {
		return nil, fmt.Errorf("%w", err)
	}
	req.Header.Set("Content-Type", "application/json")

	res, err := c.buildContextHTTPClient.Do(req)
	if err != nil {
		return nil, fmt.Errorf("%w", err)
	}
	defer res.Body.Close()

	if res.StatusCode/100 != 2 { // non-2xx status code
		return nil, fmt.Errorf("%w", errorFromResponse(res))
	}

	if res.Header.Get("Location") == "" {
		// "Location" header is not present; build context does not need to be uploaded
		return nil, errContextAlreadyPresent
	}

	return url.Parse(res.Header.Get("Location"))
}

// putBuildContext uploads the build context read from r to the specified location.
func (c *Client) putBuildContext(ctx context.Context, loc *url.URL, r io.Reader, size int64) error {
	req, err := c.newRequest(ctx, http.MethodPut, loc, r)
	if err != nil {
		return err
	}
	req.Header.Set("Content-Type", "application/octet-stream")
	req.Header.Del("Authorization")

	req.ContentLength = size

	res, err := c.buildContextHTTPClient.Do(req)
	if err != nil {
		return fmt.Errorf("%w", err)
	}
	defer res.Body.Close()

	if res.StatusCode/100 != 2 {
		return fmt.Errorf("%w", errorFromResponse(res))
	}
	return nil
}

// uploadBuildContext generates an archive in rw containing the files at the specified paths in
// fsys, and uploads it to the Build Service.
//
// Paths must be specified in the rootless format specified by the io/fs package. If a path
// contains a glob, it will be evaluated as per fs.Glob. If a path specifies a directory, its
// contents will be walked as per fs.WalkDir.
func (c *Client) uploadBuildContext(ctx context.Context, rw io.ReadWriteSeeker, fsys fs.FS, paths []string) (digest string, err error) {
	// Write a compressed archive and accumulate its digest.
	h := sha256.New()
	if err := writeArchive(io.MultiWriter(rw, h), fsys, paths); err != nil {
		return "", fmt.Errorf("failed to write archive: %w", err)
	}

	// Obtain size of build context.
	size, err := rw.Seek(0, io.SeekCurrent)
	if err != nil {
		return "", fmt.Errorf("failed to seek: %w", err)
	}

	// Calculate digest of build context.
	digest = fmt.Sprintf("sha256.%x", h.Sum(nil))

	// Get the build context upload location.
	loc, err := c.getBuildContextUploadLocation(ctx, size, digest)
	if err != nil {
		if errors.Is(err, errContextAlreadyPresent) {
			return digest, nil
		}
		return "", fmt.Errorf("failed to get build context upload location: %w", err)
	}

	// Seek to the beginning of the build context file.
	if _, err := rw.Seek(0, io.SeekStart); err != nil {
		return "", fmt.Errorf("failed to seek: %w", err)
	}

	// Upload build context.
	if err := c.putBuildContext(ctx, loc, rw, size); err != nil {
		return "", fmt.Errorf("failed to upload build context: %w", err)
	}

	return digest, nil
}

type uploadBuildContextOptions struct {
	fsys fs.FS
}

type UploadBuildContextOption func(*uploadBuildContextOptions) error

// optUploadBuildContextFS sets fsys as the source filesystem to use when constructing the build
// context archive.
func optUploadBuildContextFS(fsys fs.FS) UploadBuildContextOption {
	return func(uo *uploadBuildContextOptions) error {
		uo.fsys = fsys
		return nil
	}
}

var errNoPathsSpecified = errors.New("no paths specified for build context")

// UploadBuildContext generates an archive containing the files at the specified paths, and uploads
// it to the Build Service. When the build context is no longer required, DeleteBuildContext should
// be called to notify the Build Service.
//
// Paths must be specified in the rootless format specified by the io/fs package. If a path
// contains a glob, it will be evaluated as per fs.Glob. If a path specifies a directory, its
// contents will be walked as per fs.WalkDir.
func (c *Client) UploadBuildContext(ctx context.Context, paths []string, opts ...UploadBuildContextOption) (digest string, err error) {
	uo := uploadBuildContextOptions{
		fsys: os.DirFS("/"),
	}

	for _, opt := range opts {
		if err := opt(&uo); err != nil {
			return "", fmt.Errorf("%w", err)
		}
	}

	if len(paths) == 0 {
		return "", errNoPathsSpecified
	}

	f, err := os.CreateTemp("", "scs-build-context-*")
	if err != nil {
		return "", fmt.Errorf("%w", err)
	}
	defer os.Remove(f.Name())

	return c.uploadBuildContext(ctx, f, uo.fsys, paths)
}

type deleteBuildContextOptions struct{}

type DeleteBuildContextOption func(*deleteBuildContextOptions) error

// DeleteBuildContext deletes the build context with the specified digest from the Build Service.
func (c *Client) DeleteBuildContext(ctx context.Context, digest string, opts ...DeleteBuildContextOption) error {
	do := deleteBuildContextOptions{}

	for _, opt := range opts {
		if err := opt(&do); err != nil {
			return fmt.Errorf("%w", err)
		}
	}

	ref := &url.URL{
		Path: "v1/build-context/" + digest,
	}

	req, err := c.newRequest(ctx, http.MethodDelete, ref, nil)
	if err != nil {
		return fmt.Errorf("%w", err)
	}

	res, err := c.buildContextHTTPClient.Do(req)
	if err != nil {
		return fmt.Errorf("%w", err)
	}
	defer res.Body.Close()

	if res.StatusCode/100 != 2 { // non-2xx status code
		return fmt.Errorf("%w", errorFromResponse(res))
	}

	return nil
}