mirrored from https://chromium.googlesource.com/infra/luci/luci-go
-
Notifications
You must be signed in to change notification settings - Fork 43
/
archive.go
220 lines (202 loc) · 6.7 KB
/
archive.go
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
// Copyright 2015 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package lib
import (
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"os"
"sort"
"time"
"github.com/maruel/subcommands"
"go.chromium.org/luci/client/archiver"
"go.chromium.org/luci/client/isolated"
"go.chromium.org/luci/common/errors"
isol "go.chromium.org/luci/common/isolated"
"go.chromium.org/luci/common/system/signals"
)
// CmdArchive returns an object for the `archive` subcommand.
func CmdArchive(options CommandOptions) *subcommands.Command {
return &subcommands.Command{
UsageLine: "archive <options>...",
ShortDesc: "creates a .isolated file and uploads the tree to an isolate server",
LongDesc: `Given a list of files and directories, creates a .isolated file and uploads the
tree to to an isolate server.
When specifying directories and files, you must also specify a current working
directory for that file or directory. The current working directory will not
be included in the archived path. For example, to isolate './usr/foo/bar' and
have it appear as 'foo/bar' in the .isolated, specify '-files ./usr:foo/bar' or
'-files usr:foo/bar'. When the .isolated is then downloaded, it will then appear
under 'foo/bar' in the desired directory.
Note that '.' may be omitted in general, so to upload 'foo' from the current
working directory, '-files :foo' is sufficient.`,
CommandRun: func() subcommands.CommandRun {
c := archiveRun{
CommandOptions: options,
}
c.commonFlags.Init(options.DefaultAuthOpts)
c.Flags.Var(&c.dirs, "dirs", "Directory(ies) to archive. Specify as <working directory>:<relative path to dir>")
c.Flags.Var(&c.files, "files", "Individual file(s) to archive. Specify as <working directory>:<relative path to file>")
c.Flags.StringVar(&c.dumpHash, "dump-hash", "",
"Write the composite isolated hash to a file")
c.Flags.StringVar(&c.isolated, "isolated", "",
"Write the composite isolated to a file")
c.Flags.StringVar(&c.dumpStatsJSON, "dump-stats-json", "",
"Write the upload stats to this file as JSON")
return &c
},
}
}
type archiveRun struct {
commonFlags
CommandOptions
dirs isolated.ScatterGather
files isolated.ScatterGather
dumpHash string
isolated string
dumpStatsJSON string
}
func (c *archiveRun) Parse(a subcommands.Application, args []string) error {
if err := c.commonFlags.Parse(); err != nil {
return err
}
if len(args) != 0 {
return errors.Reason("position arguments not expected").Err()
}
return nil
}
// Does the archive by uploading to isolate-server, then return the archive stats and error.
func (c *archiveRun) doArchive(a subcommands.Application, args []string) (stats *archiver.Stats, err error) {
ctx, cancel := context.WithCancel(c.defaultFlags.MakeLoggingContext(os.Stderr))
signals.HandleInterrupt(cancel)
isolatedClient, isolErr := c.createIsolatedClient(ctx, c.CommandOptions)
if isolErr != nil {
err = errors.Annotate(isolErr, "failed to create isolated client").Err()
return
}
var out io.Writer = os.Stdout
if c.defaultFlags.Quiet {
out = ioutil.Discard
}
arch := archiver.New(ctx, isolatedClient, out)
defer func() {
// This waits for all uploads.
if cerr := arch.Close(); err == nil {
err = cerr
}
// We must take the stats until after all the uploads have finished
if err == nil {
stats = arch.Stats()
}
}()
opts := isolated.ArchiveOptions{
Files: c.files,
Dirs: c.dirs,
Isolated: c.isolated,
}
if len(c.isolated) != 0 {
var dumpIsolated *os.File
dumpIsolated, err = os.Create(c.isolated)
if err != nil {
return
}
// This is OK to close before arch because isolated.Archive
// does the writing (it's not handed off elsewhere).
defer dumpIsolated.Close()
opts.LeakIsolated = dumpIsolated
}
item := isolated.Archive(ctx, arch, &opts)
if err = item.Error(); err != nil {
return
}
item.WaitForHashed()
if len(c.dumpHash) != 0 {
if err = ioutil.WriteFile(c.dumpHash, []byte(item.Digest()), 0644); err != nil {
return
}
}
return
}
func (c *archiveRun) postprocessStats(stats *archiver.Stats, start time.Time) error {
if !c.defaultFlags.Quiet {
duration := time.Since(start)
fmt.Fprintf(os.Stderr, "Hits : %5d (%s)\n", stats.TotalHits(), stats.TotalBytesHits())
fmt.Fprintf(os.Stderr, "Misses : %5d (%s)\n", stats.TotalMisses(), stats.TotalBytesPushed())
fmt.Fprintf(os.Stderr, "Duration: %s\n", duration.Round(time.Millisecond))
}
if c.dumpStatsJSON != "" {
return dumpStatsJSON(c.dumpStatsJSON, stats)
}
return nil
}
func (c *archiveRun) Run(a subcommands.Application, args []string, _ subcommands.Env) int {
if err := c.Parse(a, args); err != nil {
fmt.Fprintf(a.GetErr(), "%s: %s\n", a.GetName(), err)
return 1
}
cl, err := c.defaultFlags.StartTracing()
if err != nil {
fmt.Fprintf(a.GetErr(), "%s: %s\n", a.GetName(), err)
return 1
}
defer cl.Close()
defer c.profilerFlags.Stop()
start := time.Now()
stats, err := c.doArchive(a, args)
if err != nil {
fmt.Fprintf(a.GetErr(), "%s: %s\n", a.GetName(), err)
return 1
}
if err := c.postprocessStats(stats, start); err != nil {
fmt.Fprintf(a.GetErr(), "%s: %s\n", a.GetName(), err)
return 1
}
return 0
}
func dumpStatsJSON(jsonPath string, stats *archiver.Stats) error {
hits := make([]int64, len(stats.Hits))
for i, h := range stats.Hits {
hits[i] = int64(h)
}
sort.Slice(hits, func(i, j int) bool { return hits[i] < hits[j] })
itemsHot, err := isol.Pack(hits)
if err != nil {
return errors.Annotate(err, "failed to pack itemsHot").Err()
}
pushed := make([]int64, len(stats.Pushed))
for i, p := range stats.Pushed {
pushed[i] = int64(p.Size)
}
sort.Slice(pushed, func(i, j int) bool { return pushed[i] < pushed[j] })
itemsCold, err := isol.Pack(pushed)
if err != nil {
return errors.Annotate(err, "failed to pack itemsCold").Err()
}
statsJSON, err := json.Marshal(struct {
ItemsCold []byte `json:"items_cold"`
ItemsHot []byte `json:"items_hot"`
}{
ItemsCold: itemsCold,
ItemsHot: itemsHot,
})
if err != nil {
return errors.Annotate(err, "failed to marshal result json").Err()
}
if err := ioutil.WriteFile(jsonPath, statsJSON, 0664); err != nil {
return errors.Annotate(err, "failed to write stats json to %s", jsonPath).Err()
}
return nil
}