/
pipeline.go
728 lines (683 loc) · 24 KB
/
pipeline.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
package core
import (
"bufio"
"fmt"
"io"
"io/ioutil"
"log"
"os"
"path/filepath"
"sort"
"strings"
"time"
"github.com/pkg/errors"
"gopkg.in/src-d/go-git.v4"
"gopkg.in/src-d/go-git.v4/plumbing"
"gopkg.in/src-d/go-git.v4/plumbing/object"
"gopkg.in/src-d/go-git.v4/plumbing/storer"
"gopkg.in/src-d/hercules.v5/internal/pb"
"gopkg.in/src-d/hercules.v5/internal/toposort"
)
// ConfigurationOptionType represents the possible types of a ConfigurationOption's value.
type ConfigurationOptionType int
const (
// BoolConfigurationOption reflects the boolean value type.
BoolConfigurationOption ConfigurationOptionType = iota
// IntConfigurationOption reflects the integer value type.
IntConfigurationOption
// StringConfigurationOption reflects the string value type.
StringConfigurationOption
// FloatConfigurationOption reflects a floating point value type.
FloatConfigurationOption
// StringsConfigurationOption reflects the array of strings value type.
StringsConfigurationOption
)
// String() returns an empty string for the boolean type, "int" for integers and "string" for
// strings. It is used in the command line interface to show the argument's type.
func (opt ConfigurationOptionType) String() string {
switch opt {
case BoolConfigurationOption:
return ""
case IntConfigurationOption:
return "int"
case StringConfigurationOption:
return "string"
case FloatConfigurationOption:
return "float"
case StringsConfigurationOption:
return "string"
}
log.Panicf("Invalid ConfigurationOptionType value %d", opt)
return ""
}
// ConfigurationOption allows for the unified, retrospective way to setup PipelineItem-s.
type ConfigurationOption struct {
// Name identifies the configuration option in facts.
Name string
// Description represents the help text about the configuration option.
Description string
// Flag corresponds to the CLI token with "--" prepended.
Flag string
// Type specifies the kind of the configuration option's value.
Type ConfigurationOptionType
// Default is the initial value of the configuration option.
Default interface{}
}
// FormatDefault converts the default value of ConfigurationOption to string.
// Used in the command line interface to show the argument's default value.
func (opt ConfigurationOption) FormatDefault() string {
if opt.Type == StringsConfigurationOption {
return fmt.Sprintf("\"%s\"", strings.Join(opt.Default.([]string), ","))
}
if opt.Type != StringConfigurationOption {
return fmt.Sprint(opt.Default)
}
return fmt.Sprintf("\"%s\"", opt.Default)
}
// PipelineItem is the interface for all the units in the Git commits analysis pipeline.
type PipelineItem interface {
// Name returns the name of the analysis.
Name() string
// Provides returns the list of keys of reusable calculated entities.
// Other items may depend on them.
Provides() []string
// Requires returns the list of keys of needed entities which must be supplied in Consume().
Requires() []string
// ListConfigurationOptions returns the list of available options which can be consumed by Configure().
ListConfigurationOptions() []ConfigurationOption
// Configure performs the initial setup of the object by applying parameters from facts.
// It allows to create PipelineItems in a universal way.
Configure(facts map[string]interface{})
// Initialize prepares and resets the item. Consume() requires Initialize()
// to be called at least once beforehand.
Initialize(*git.Repository)
// Consume processes the next commit.
// deps contains the required entities which match Depends(). Besides, it always includes
// DependencyCommit and DependencyIndex.
// Returns the calculated entities which match Provides().
Consume(deps map[string]interface{}) (map[string]interface{}, error)
// Fork clones the item the requested number of times. The data links between the clones
// are up to the implementation. Needed to handle Git branches. See also Merge().
// Returns a slice with `n` fresh clones. In other words, it does not include the original item.
Fork(n int) []PipelineItem
// Merge combines several branches together. Each is supposed to have been created with Fork().
// The result is stored in the called item, thus this function returns nothing.
// Merge() must update all the branches, not only self. When several branches merge, some of
// them may continue to live, hence this requirement.
Merge(branches []PipelineItem)
}
// FeaturedPipelineItem enables switching the automatic insertion of pipeline items on or off.
type FeaturedPipelineItem interface {
PipelineItem
// Features returns the list of names which enable this item to be automatically inserted
// in Pipeline.DeployItem().
Features() []string
}
// LeafPipelineItem corresponds to the top level pipeline items which produce the end results.
type LeafPipelineItem interface {
PipelineItem
// Flag returns the cmdline switch to run the analysis. Should be dash-lower-case
// without the leading dashes.
Flag() string
// Description returns the text which explains what the analysis is doing.
// Should start with a capital letter and end with a dot.
Description() string
// Finalize returns the result of the analysis.
Finalize() interface{}
// Serialize encodes the object returned by Finalize() to YAML or Protocol Buffers.
Serialize(result interface{}, binary bool, writer io.Writer) error
}
// ResultMergeablePipelineItem specifies the methods to combine several analysis results together.
type ResultMergeablePipelineItem interface {
LeafPipelineItem
// Deserialize loads the result from Protocol Buffers blob.
Deserialize(pbmessage []byte) (interface{}, error)
// MergeResults joins two results together. Common-s are specified as the global state.
MergeResults(r1, r2 interface{}, c1, c2 *CommonAnalysisResult) interface{}
}
// CommonAnalysisResult holds the information which is always extracted at Pipeline.Run().
type CommonAnalysisResult struct {
// BeginTime is the time of the first commit in the analysed sequence.
BeginTime int64
// EndTime is the time of the last commit in the analysed sequence.
EndTime int64
// CommitsNumber is the number of commits in the analysed sequence.
CommitsNumber int
// RunTime is the duration of Pipeline.Run().
RunTime time.Duration
// RunTimePerItem is the time elapsed by each PipelineItem.
RunTimePerItem map[string]float64
}
// BeginTimeAsTime converts the UNIX timestamp of the beginning to Go time.
func (car *CommonAnalysisResult) BeginTimeAsTime() time.Time {
return time.Unix(car.BeginTime, 0)
}
// EndTimeAsTime converts the UNIX timestamp of the ending to Go time.
func (car *CommonAnalysisResult) EndTimeAsTime() time.Time {
return time.Unix(car.EndTime, 0)
}
// Merge combines the CommonAnalysisResult with an other one.
// We choose the earlier BeginTime, the later EndTime, sum the number of commits and the
// elapsed run times.
func (car *CommonAnalysisResult) Merge(other *CommonAnalysisResult) {
if car.EndTime == 0 || other.BeginTime == 0 {
panic("Merging with an uninitialized CommonAnalysisResult")
}
if other.BeginTime < car.BeginTime {
car.BeginTime = other.BeginTime
}
if other.EndTime > car.EndTime {
car.EndTime = other.EndTime
}
car.CommitsNumber += other.CommitsNumber
car.RunTime += other.RunTime
for key, val := range other.RunTimePerItem {
car.RunTimePerItem[key] += val
}
}
// FillMetadata copies the data to a Protobuf message.
func (car *CommonAnalysisResult) FillMetadata(meta *pb.Metadata) *pb.Metadata {
meta.BeginUnixTime = car.BeginTime
meta.EndUnixTime = car.EndTime
meta.Commits = int32(car.CommitsNumber)
meta.RunTime = car.RunTime.Nanoseconds() / 1e6
meta.RunTimePerItem = car.RunTimePerItem
return meta
}
// Metadata is defined in internal/pb/pb.pb.go - header of the binary file.
type Metadata = pb.Metadata
// MetadataToCommonAnalysisResult copies the data from a Protobuf message.
func MetadataToCommonAnalysisResult(meta *Metadata) *CommonAnalysisResult {
return &CommonAnalysisResult{
BeginTime: meta.BeginUnixTime,
EndTime: meta.EndUnixTime,
CommitsNumber: int(meta.Commits),
RunTime: time.Duration(meta.RunTime * 1e6),
RunTimePerItem: meta.RunTimePerItem,
}
}
// Pipeline is the core Hercules entity which carries several PipelineItems and executes them.
// See the extended example of how a Pipeline works in doc.go
type Pipeline struct {
// OnProgress is the callback which is invoked in Analyse() to output it's
// progress. The first argument is the number of complete steps and the
// second is the total number of steps.
OnProgress func(int, int)
// Repository points to the analysed Git repository struct from go-git.
repository *git.Repository
// Items are the registered building blocks in the pipeline. The order defines the
// execution sequence.
items []PipelineItem
// The collection of parameters to create items.
facts map[string]interface{}
// Feature flags which enable the corresponding items.
features map[string]bool
}
const (
// ConfigPipelineDumpPath is the name of the Pipeline configuration option (Pipeline.Initialize())
// which enables saving the items DAG to the specified file.
ConfigPipelineDumpPath = "Pipeline.DumpPath"
// ConfigPipelineDryRun is the name of the Pipeline configuration option (Pipeline.Initialize())
// which disables Configure() and Initialize() invocation on each PipelineItem during the
// Pipeline initialization.
// Subsequent Run() calls are going to fail. Useful with ConfigPipelineDumpPath=true.
ConfigPipelineDryRun = "Pipeline.DryRun"
// ConfigPipelineCommits is the name of the Pipeline configuration option (Pipeline.Initialize())
// which allows to specify the custom commit sequence. By default, Pipeline.Commits() is used.
ConfigPipelineCommits = "commits"
// DependencyCommit is the name of one of the three items in `deps` supplied to PipelineItem.Consume()
// which always exists. It corresponds to the currently analyzed commit.
DependencyCommit = "commit"
// DependencyIndex is the name of one of the three items in `deps` supplied to PipelineItem.Consume()
// which always exists. It corresponds to the currently analyzed commit's index.
DependencyIndex = "index"
// DependencyIsMerge is the name of one of the three items in `deps` supplied to PipelineItem.Consume()
// which always exists. It indicates whether the analyzed commit is a merge commit.
// Checking the number of parents is not correct - we remove the back edges during the DAG simplification.
DependencyIsMerge = "is_merge"
)
// NewPipeline initializes a new instance of Pipeline struct.
func NewPipeline(repository *git.Repository) *Pipeline {
return &Pipeline{
repository: repository,
items: []PipelineItem{},
facts: map[string]interface{}{},
features: map[string]bool{},
}
}
// GetFact returns the value of the fact with the specified name.
func (pipeline *Pipeline) GetFact(name string) interface{} {
return pipeline.facts[name]
}
// SetFact sets the value of the fact with the specified name.
func (pipeline *Pipeline) SetFact(name string, value interface{}) {
pipeline.facts[name] = value
}
// GetFeature returns the state of the feature with the specified name (enabled/disabled) and
// whether it exists. See also: FeaturedPipelineItem.
func (pipeline *Pipeline) GetFeature(name string) (bool, bool) {
val, exists := pipeline.features[name]
return val, exists
}
// SetFeature sets the value of the feature with the specified name.
// See also: FeaturedPipelineItem.
func (pipeline *Pipeline) SetFeature(name string) {
pipeline.features[name] = true
}
// SetFeaturesFromFlags enables the features which were specified through the command line flags
// which belong to the given PipelineItemRegistry instance.
// See also: AddItem().
func (pipeline *Pipeline) SetFeaturesFromFlags(registry ...*PipelineItemRegistry) {
var ffr *PipelineItemRegistry
if len(registry) == 0 {
ffr = Registry
} else if len(registry) == 1 {
ffr = registry[0]
} else {
panic("Zero or one registry is allowed to be passed.")
}
for _, feature := range ffr.featureFlags.Flags {
pipeline.SetFeature(feature)
}
}
// DeployItem inserts a PipelineItem into the pipeline. It also recursively creates all of it's
// dependencies (PipelineItem.Requires()). Returns the same item as specified in the arguments.
func (pipeline *Pipeline) DeployItem(item PipelineItem) PipelineItem {
fpi, ok := item.(FeaturedPipelineItem)
if ok {
for _, f := range fpi.Features() {
pipeline.SetFeature(f)
}
}
queue := []PipelineItem{}
queue = append(queue, item)
added := map[string]PipelineItem{}
for _, item := range pipeline.items {
added[item.Name()] = item
}
added[item.Name()] = item
pipeline.AddItem(item)
for len(queue) > 0 {
head := queue[0]
queue = queue[1:]
for _, dep := range head.Requires() {
for _, sibling := range Registry.Summon(dep) {
if _, exists := added[sibling.Name()]; !exists {
disabled := false
// If this item supports features, check them against the activated in pipeline.features
if fpi, matches := sibling.(FeaturedPipelineItem); matches {
for _, feature := range fpi.Features() {
if !pipeline.features[feature] {
disabled = true
break
}
}
}
if disabled {
continue
}
added[sibling.Name()] = sibling
queue = append(queue, sibling)
pipeline.AddItem(sibling)
}
}
}
}
return item
}
// AddItem inserts a PipelineItem into the pipeline. It does not check any dependencies.
// See also: DeployItem().
func (pipeline *Pipeline) AddItem(item PipelineItem) PipelineItem {
pipeline.items = append(pipeline.items, item)
return item
}
// RemoveItem deletes a PipelineItem from the pipeline. It leaves all the rest of the items intact.
func (pipeline *Pipeline) RemoveItem(item PipelineItem) {
for i, reg := range pipeline.items {
if reg == item {
pipeline.items = append(pipeline.items[:i], pipeline.items[i+1:]...)
return
}
}
}
// Len returns the number of items in the pipeline.
func (pipeline *Pipeline) Len() int {
return len(pipeline.items)
}
// Commits returns the list of commits from the history similar to `git log` over the HEAD.
// `firstParent` specifies whether to leave only the first parent after each merge
// (`git log --first-parent`) - effectively decreasing the accuracy but increasing performance.
func (pipeline *Pipeline) Commits(firstParent bool) ([]*object.Commit, error) {
var result []*object.Commit
repository := pipeline.repository
head, err := repository.Head()
if err != nil {
if err == plumbing.ErrReferenceNotFound {
refs, errr := repository.References()
if errr != nil {
return nil, errors.Wrap(errr, "unable to list the references")
}
refs.ForEach(func(ref *plumbing.Reference) error {
if strings.HasPrefix(ref.Name().String(), "refs/heads/HEAD/") {
head = ref
return storer.ErrStop
}
return nil
})
}
if head == nil && err != nil {
return nil, errors.Wrap(err, "unable to collect the commit history")
}
}
if firstParent {
commit, err := repository.CommitObject(head.Hash())
if err != nil {
panic(err)
}
// the first parent matches the head
for ; err != io.EOF; commit, err = commit.Parents().Next() {
if err != nil {
panic(err)
}
result = append(result, commit)
}
// reverse the order
for i, j := 0, len(result)-1; i < j; i, j = i+1, j-1 {
result[i], result[j] = result[j], result[i]
}
return result, nil
}
cit, err := repository.Log(&git.LogOptions{From: head.Hash()})
if err != nil {
return nil, errors.Wrap(err, "unable to collect the commit history")
}
defer cit.Close()
cit.ForEach(func(commit *object.Commit) error {
result = append(result, commit)
return nil
})
return result, nil
}
type sortablePipelineItems []PipelineItem
func (items sortablePipelineItems) Len() int {
return len(items)
}
func (items sortablePipelineItems) Less(i, j int) bool {
return items[i].Name() < items[j].Name()
}
func (items sortablePipelineItems) Swap(i, j int) {
items[i], items[j] = items[j], items[i]
}
func (pipeline *Pipeline) resolve(dumpPath string) {
graph := toposort.NewGraph()
sort.Sort(sortablePipelineItems(pipeline.items))
name2item := map[string]PipelineItem{}
ambiguousMap := map[string][]string{}
nameUsages := map[string]int{}
for _, item := range pipeline.items {
nameUsages[item.Name()]++
}
counters := map[string]int{}
for _, item := range pipeline.items {
name := item.Name()
if nameUsages[name] > 1 {
index := counters[item.Name()] + 1
counters[item.Name()] = index
name = fmt.Sprintf("%s_%d", item.Name(), index)
}
graph.AddNode(name)
name2item[name] = item
for _, key := range item.Provides() {
key = "[" + key + "]"
graph.AddNode(key)
if graph.AddEdge(name, key) > 1 {
if ambiguousMap[key] != nil {
fmt.Fprintln(os.Stderr, "Pipeline:")
for _, item2 := range pipeline.items {
if item2 == item {
fmt.Fprint(os.Stderr, "> ")
}
fmt.Fprint(os.Stderr, item2.Name(), " [")
for i, key2 := range item2.Provides() {
fmt.Fprint(os.Stderr, key2)
if i < len(item.Provides())-1 {
fmt.Fprint(os.Stderr, ", ")
}
}
fmt.Fprintln(os.Stderr, "]")
}
panic("Failed to resolve pipeline dependencies: ambiguous graph.")
}
ambiguousMap[key] = graph.FindParents(key)
}
}
}
counters = map[string]int{}
for _, item := range pipeline.items {
name := item.Name()
if nameUsages[name] > 1 {
index := counters[item.Name()] + 1
counters[item.Name()] = index
name = fmt.Sprintf("%s_%d", item.Name(), index)
}
for _, key := range item.Requires() {
key = "[" + key + "]"
if graph.AddEdge(key, name) == 0 {
log.Panicf("Unsatisfied dependency: %s -> %s", key, item.Name())
}
}
}
// Try to break the cycles in some known scenarios.
if len(ambiguousMap) > 0 {
var ambiguous []string
for key := range ambiguousMap {
ambiguous = append(ambiguous, key)
}
sort.Strings(ambiguous)
bfsorder := graph.BreadthSort()
bfsindex := map[string]int{}
for i, s := range bfsorder {
bfsindex[s] = i
}
for len(ambiguous) > 0 {
key := ambiguous[0]
ambiguous = ambiguous[1:]
pair := ambiguousMap[key]
inheritor := pair[1]
if bfsindex[pair[1]] < bfsindex[pair[0]] {
inheritor = pair[0]
}
removed := graph.RemoveEdge(key, inheritor)
cycle := map[string]bool{}
for _, node := range graph.FindCycle(key) {
cycle[node] = true
}
if len(cycle) == 0 {
cycle[inheritor] = true
}
if removed {
graph.AddEdge(key, inheritor)
}
graph.RemoveEdge(inheritor, key)
graph.ReindexNode(inheritor)
// for all nodes key links to except those in cycle, put the link from inheritor
for _, node := range graph.FindChildren(key) {
if _, exists := cycle[node]; !exists {
graph.AddEdge(inheritor, node)
graph.RemoveEdge(key, node)
}
}
graph.ReindexNode(key)
}
}
var graphCopy *toposort.Graph
if dumpPath != "" {
graphCopy = graph.Copy()
}
strplan, ok := graph.Toposort()
if !ok {
panic("Failed to resolve pipeline dependencies: unable to topologically sort the items.")
}
pipeline.items = make([]PipelineItem, 0, len(pipeline.items))
for _, key := range strplan {
if item, ok := name2item[key]; ok {
pipeline.items = append(pipeline.items, item)
}
}
if dumpPath != "" {
// If there is a floating difference, uncomment this:
// fmt.Fprint(os.Stderr, graphCopy.DebugDump())
ioutil.WriteFile(dumpPath, []byte(graphCopy.Serialize(strplan)), 0666)
absPath, _ := filepath.Abs(dumpPath)
log.Printf("Wrote the DAG to %s\n", absPath)
}
}
// Initialize prepares the pipeline for the execution (Run()). This function
// resolves the execution DAG, Configure()-s and Initialize()-s the items in it in the
// topological dependency order. `facts` are passed inside Configure(). They are mutable.
func (pipeline *Pipeline) Initialize(facts map[string]interface{}) {
if facts == nil {
facts = map[string]interface{}{}
}
if _, exists := facts[ConfigPipelineCommits]; !exists {
var err error
facts[ConfigPipelineCommits], err = pipeline.Commits(false)
if err != nil {
log.Panicf("failed to list the commits: %v", err)
}
}
dumpPath, _ := facts[ConfigPipelineDumpPath].(string)
pipeline.resolve(dumpPath)
if dryRun, _ := facts[ConfigPipelineDryRun].(bool); dryRun {
return
}
for _, item := range pipeline.items {
item.Configure(facts)
}
for _, item := range pipeline.items {
item.Initialize(pipeline.repository)
}
}
// Run method executes the pipeline.
//
// `commits` is a slice with the git commits to analyse. Multiple branches are supported.
//
// Returns the mapping from each LeafPipelineItem to the corresponding analysis result.
// There is always a "nil" record with CommonAnalysisResult.
func (pipeline *Pipeline) Run(commits []*object.Commit) (map[LeafPipelineItem]interface{}, error) {
startRunTime := time.Now()
onProgress := pipeline.OnProgress
if onProgress == nil {
onProgress = func(int, int) {}
}
plan := prepareRunPlan(commits)
progressSteps := len(plan) + 2
branches := map[int][]PipelineItem{}
// we will need rootClone if there is more than one root branch
rootClone := cloneItems(pipeline.items, 1)[0]
var newestTime int64
runTimePerItem := map[string]float64{}
commitIndex := 0
for index, step := range plan {
onProgress(index+1, progressSteps)
firstItem := step.Items[0]
switch step.Action {
case runActionCommit:
state := map[string]interface{}{
DependencyCommit: step.Commit,
DependencyIndex: commitIndex,
DependencyIsMerge: (index > 0 &&
plan[index-1].Action == runActionCommit &&
plan[index-1].Commit.Hash == step.Commit.Hash) ||
(index < (len(plan)-1) &&
plan[index+1].Action == runActionCommit &&
plan[index+1].Commit.Hash == step.Commit.Hash),
}
for _, item := range branches[firstItem] {
startTime := time.Now()
update, err := item.Consume(state)
runTimePerItem[item.Name()] += time.Now().Sub(startTime).Seconds()
if err != nil {
log.Printf("%s failed on commit #%d (%d) %s\n",
item.Name(), commitIndex+1, index+1, step.Commit.Hash.String())
return nil, err
}
for _, key := range item.Provides() {
val, ok := update[key]
if !ok {
log.Panicf("%s: Consume() did not return %s", item.Name(), key)
}
state[key] = val
}
}
commitTime := step.Commit.Committer.When.Unix()
if commitTime > newestTime {
newestTime = commitTime
}
commitIndex++
case runActionFork:
for i, clone := range cloneItems(branches[firstItem], len(step.Items)-1) {
branches[step.Items[i+1]] = clone
}
case runActionMerge:
merged := make([][]PipelineItem, len(step.Items))
for i, b := range step.Items {
merged[i] = branches[b]
}
mergeItems(merged)
case runActionEmerge:
if firstItem == rootBranchIndex {
branches[firstItem] = pipeline.items
} else {
branches[firstItem] = cloneItems(rootClone, 1)[0]
}
case runActionDelete:
delete(branches, firstItem)
}
}
onProgress(len(plan)+1, progressSteps)
result := map[LeafPipelineItem]interface{}{}
for index, item := range getMasterBranch(branches) {
if casted, ok := item.(LeafPipelineItem); ok {
result[pipeline.items[index].(LeafPipelineItem)] = casted.Finalize()
}
}
onProgress(progressSteps, progressSteps)
result[nil] = &CommonAnalysisResult{
BeginTime: plan[0].Commit.Committer.When.Unix(),
EndTime: newestTime,
CommitsNumber: len(commits),
RunTime: time.Since(startRunTime),
RunTimePerItem: runTimePerItem,
}
return result, nil
}
// LoadCommitsFromFile reads the file by the specified FS path and generates the sequence of commits
// by interpreting each line as a Git commit hash.
func LoadCommitsFromFile(path string, repository *git.Repository) ([]*object.Commit, error) {
var file io.ReadCloser
if path != "-" {
var err error
file, err = os.Open(path)
if err != nil {
return nil, err
}
defer file.Close()
} else {
file = os.Stdin
}
scanner := bufio.NewScanner(file)
var commits []*object.Commit
for scanner.Scan() {
hash := plumbing.NewHash(scanner.Text())
if len(hash) != 20 {
return nil, errors.New("invalid commit hash " + scanner.Text())
}
commit, err := repository.CommitObject(hash)
if err != nil {
return nil, err
}
commits = append(commits, commit)
}
return commits, nil
}