/
blob_cache.go
219 lines (203 loc) · 7.63 KB
/
blob_cache.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
package plumbing
import (
"log"
"gopkg.in/src-d/go-git.v4"
"gopkg.in/src-d/go-git.v4/config"
"gopkg.in/src-d/go-git.v4/plumbing"
"gopkg.in/src-d/go-git.v4/plumbing/object"
"gopkg.in/src-d/go-git.v4/utils/merkletrie"
"gopkg.in/src-d/hercules.v4/internal"
"gopkg.in/src-d/hercules.v4/internal/core"
)
// BlobCache loads the blobs which correspond to the changed files in a commit.
// It is a PipelineItem.
// It must provide the old and the new objects; "blobCache" rotates and allows to not load
// the same blobs twice. Outdated objects are removed so "blobCache" never grows big.
type BlobCache struct {
core.NoopMerger
// Specifies how to handle the situation when we encounter a git submodule - an object
// without the blob. If true, we look inside .gitmodules and if we don't find it,
// raise an error. If false, we do not look inside .gitmodules and always succeed.
FailOnMissingSubmodules bool
repository *git.Repository
cache map[plumbing.Hash]*object.Blob
}
const (
// ConfigBlobCacheFailOnMissingSubmodules is the name of the configuration option for
// BlobCache.Configure() to check if the referenced submodules are registered in .gitignore.
ConfigBlobCacheFailOnMissingSubmodules = "BlobCache.FailOnMissingSubmodules"
// DependencyBlobCache identifies the dependency provided by BlobCache.
DependencyBlobCache = "blob_cache"
)
// Name of this PipelineItem. Uniquely identifies the type, used for mapping keys, etc.
func (blobCache *BlobCache) Name() string {
return "BlobCache"
}
// Provides returns the list of names of entities which are produced by this PipelineItem.
// Each produced entity will be inserted into `deps` of dependent Consume()-s according
// to this list. Also used by core.Registry to build the global map of providers.
func (blobCache *BlobCache) Provides() []string {
arr := [...]string{DependencyBlobCache}
return arr[:]
}
// Requires returns the list of names of entities which are needed by this PipelineItem.
// Each requested entity will be inserted into `deps` of Consume(). In turn, those
// entities are Provides() upstream.
func (blobCache *BlobCache) Requires() []string {
arr := [...]string{DependencyTreeChanges}
return arr[:]
}
// ListConfigurationOptions returns the list of changeable public properties of this PipelineItem.
func (blobCache *BlobCache) ListConfigurationOptions() []core.ConfigurationOption {
options := [...]core.ConfigurationOption{{
Name: ConfigBlobCacheFailOnMissingSubmodules,
Description: "Specifies whether to panic if any referenced submodule does " +
"not exist in .gitmodules and thus the corresponding Git object cannot be loaded. " +
"Override this if you want to ensure that your repository is integral. ",
Flag: "fail-on-missing-submodules",
Type: core.BoolConfigurationOption,
Default: false}}
return options[:]
}
// Configure sets the properties previously published by ListConfigurationOptions().
func (blobCache *BlobCache) Configure(facts map[string]interface{}) {
if val, exists := facts[ConfigBlobCacheFailOnMissingSubmodules].(bool); exists {
blobCache.FailOnMissingSubmodules = val
}
}
// Initialize resets the temporary caches and prepares this PipelineItem for a series of Consume()
// calls. The repository which is going to be analysed is supplied as an argument.
func (blobCache *BlobCache) Initialize(repository *git.Repository) {
blobCache.repository = repository
blobCache.cache = map[plumbing.Hash]*object.Blob{}
}
// Consume runs this PipelineItem on the next commit data.
// `deps` contain all the results from upstream PipelineItem-s as requested by Requires().
// Additionally, DependencyCommit is always present there and represents
// the analysed *object.Commit. This function returns the mapping with analysis
// results. The keys must be the same as in Provides(). If there was an error,
// nil is returned.
func (blobCache *BlobCache) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
commit := deps[core.DependencyCommit].(*object.Commit)
changes := deps[DependencyTreeChanges].(object.Changes)
cache := map[plumbing.Hash]*object.Blob{}
newCache := map[plumbing.Hash]*object.Blob{}
for _, change := range changes {
action, err := change.Action()
if err != nil {
log.Printf("no action in %s\n", change.To.TreeEntry.Hash)
return nil, err
}
var exists bool
var blob *object.Blob
switch action {
case merkletrie.Insert:
blob, err = blobCache.getBlob(&change.To, commit.File)
if err != nil {
log.Printf("file to %s %s\n",
change.To.Name, change.To.TreeEntry.Hash)
} else {
cache[change.To.TreeEntry.Hash] = blob
newCache[change.To.TreeEntry.Hash] = blob
}
case merkletrie.Delete:
cache[change.From.TreeEntry.Hash], exists =
blobCache.cache[change.From.TreeEntry.Hash]
if !exists {
cache[change.From.TreeEntry.Hash], err =
blobCache.getBlob(&change.From, commit.File)
if err != nil {
if err.Error() != plumbing.ErrObjectNotFound.Error() {
log.Printf("file from %s %s\n", change.From.Name,
change.From.TreeEntry.Hash)
} else {
cache[change.From.TreeEntry.Hash], err =
internal.CreateDummyBlob(change.From.TreeEntry.Hash)
}
}
}
case merkletrie.Modify:
blob, err = blobCache.getBlob(&change.To, commit.File)
if err != nil {
log.Printf("file to %s\n", change.To.Name)
} else {
cache[change.To.TreeEntry.Hash] = blob
newCache[change.To.TreeEntry.Hash] = blob
}
cache[change.From.TreeEntry.Hash], exists =
blobCache.cache[change.From.TreeEntry.Hash]
if !exists {
cache[change.From.TreeEntry.Hash], err =
blobCache.getBlob(&change.From, commit.File)
if err != nil {
log.Printf("file from %s\n", change.From.Name)
}
}
}
if err != nil {
return nil, err
}
}
blobCache.cache = newCache
return map[string]interface{}{DependencyBlobCache: cache}, nil
}
// Fork clones this PipelineItem.
func (blobCache *BlobCache) Fork(n int) []core.PipelineItem {
caches := make([]core.PipelineItem, n)
for i := 0; i < n; i++ {
cache := map[plumbing.Hash]*object.Blob{}
for k, v := range blobCache.cache {
cache[k] = v
}
caches[i] = &BlobCache{
FailOnMissingSubmodules: blobCache.FailOnMissingSubmodules,
repository: blobCache.repository,
cache: cache,
}
}
return caches
}
// FileGetter defines a function which loads the Git file by
// the specified path. The state can be arbitrary though here it always
// corresponds to the currently processed commit.
type FileGetter func(path string) (*object.File, error)
// Returns the blob which corresponds to the specified ChangeEntry.
func (blobCache *BlobCache) getBlob(entry *object.ChangeEntry, fileGetter FileGetter) (
*object.Blob, error) {
blob, err := blobCache.repository.BlobObject(entry.TreeEntry.Hash)
if err != nil {
if err.Error() != plumbing.ErrObjectNotFound.Error() {
log.Printf("getBlob(%s)\n", entry.TreeEntry.Hash.String())
return nil, err
}
if entry.TreeEntry.Mode != 0160000 {
// this is not a submodule
return nil, err
} else if !blobCache.FailOnMissingSubmodules {
return internal.CreateDummyBlob(entry.TreeEntry.Hash)
}
file, errModules := fileGetter(".gitmodules")
if errModules != nil {
return nil, errModules
}
contents, errModules := file.Contents()
if errModules != nil {
return nil, errModules
}
modules := config.NewModules()
errModules = modules.Unmarshal([]byte(contents))
if errModules != nil {
return nil, errModules
}
_, exists := modules.Submodules[entry.Name]
if exists {
// we found that this is a submodule
return internal.CreateDummyBlob(entry.TreeEntry.Hash)
}
return nil, err
}
return blob, nil
}
func init() {
core.Registry.Register(&BlobCache{})
}