forked from jfrog/jfrog-client-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
searchutil.go
554 lines (502 loc) · 18.4 KB
/
searchutil.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
package utils
import (
"bufio"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"os"
"path"
"reflect"
"strconv"
"strings"
"sync"
buildinfo "github.com/frlute/build-info-go/entities"
"github.com/jfrog/gofrog/version"
"github.com/frlute/jfrog-client-go/utils/errorutils"
"github.com/frlute/jfrog-client-go/utils/io/content"
"github.com/frlute/jfrog-client-go/utils/io/fileutils"
"github.com/frlute/jfrog-client-go/utils/log"
)
type RequiredArtifactProps int
// This enum defines which properties are required in the result of the aql.
// For example, when performing a copy/move command - the props are not needed, so we set RequiredArtifactProps to NONE.
const (
ALL RequiredArtifactProps = iota
SYMLINK
NONE
)
// Use this function when searching by build without pattern or aql.
// Collect build artifacts and build dependencies separately, then merge the results into one reader.
func SearchBySpecWithBuild(specFile *CommonParams, flags CommonConf) (readerContent *content.ContentReader, err error) {
buildName, buildNumber, err := getBuildNameAndNumberFromBuildIdentifier(specFile.Build, specFile.Project, flags)
if err != nil {
return nil, err
}
aggregatedBuilds, err := getAggregatedBuilds(buildName, buildNumber, specFile.Project, flags)
if err != nil {
return nil, err
}
// The specified build does not exist, so an empty reader is returned.
if len(aggregatedBuilds) == 0 {
return content.NewEmptyContentReader(content.DefaultKey), nil
}
var wg sync.WaitGroup
wg.Add(2)
// Get build artifacts.
var artifactsReader *content.ContentReader
var artErr error
go func() {
defer wg.Done()
if !specFile.ExcludeArtifacts {
artifactsReader, artErr = getBuildArtifactsForBuildSearch(*specFile, flags, aggregatedBuilds)
}
}()
// Get build dependencies.
var dependenciesReader *content.ContentReader
var depErr error
go func() {
defer wg.Done()
if specFile.IncludeDeps {
dependenciesReader, depErr = getBuildDependenciesForBuildSearch(*specFile, flags, aggregatedBuilds)
}
}()
wg.Wait()
if artifactsReader != nil {
defer func(artifactsReader *content.ContentReader) {
err = errors.Join(err, artifactsReader.Close())
}(artifactsReader)
}
if dependenciesReader != nil {
defer func(dependenciesReader *content.ContentReader) {
err = errors.Join(err, dependenciesReader.Close())
}(dependenciesReader)
}
if artErr != nil {
return nil, artErr
}
if depErr != nil {
return nil, depErr
}
readerContent, err = filterBuildArtifactsAndDependencies(artifactsReader, dependenciesReader, specFile, flags, aggregatedBuilds)
return
}
func getBuildDependenciesForBuildSearch(specFile CommonParams, flags CommonConf, builds []Build) (*content.ContentReader, error) {
specFile.Aql = Aql{ItemsFind: createAqlBodyForBuildDependencies(builds)}
executionQuery := BuildQueryFromSpecFile(&specFile, ALL)
return aqlSearch(executionQuery, flags)
}
func getBuildArtifactsForBuildSearch(specFile CommonParams, flags CommonConf, builds []Build) (*content.ContentReader, error) {
specFile.Aql = Aql{ItemsFind: createAqlBodyForBuildArtifacts(builds)}
executionQuery := BuildQueryFromSpecFile(&specFile, ALL)
return aqlSearch(executionQuery, flags)
}
// Search with builds may return duplicated items, as the search is performed by checksums.
// Some are not part of the build and others may be duplicated of the same artifact.
// 1. Save SHA1 values received for build-name.
// 2. Remove artifacts that not are present on the sha1 list
// 3. If we have more than one artifact with the same sha1:
// 3.1 Compare the build-name & build-number among all the artifact with the same sha1.
//
// This will prevent unnecessary search upon all Artifactory:
func filterBuildArtifactsAndDependencies(artifactsReader, dependenciesReader *content.ContentReader, specFile *CommonParams, flags CommonConf, builds []Build) (reader *content.ContentReader, err error) {
if includePropertiesInAqlForSpec(specFile) {
// Don't fetch artifacts' properties from Artifactory.
mergedReader, err := mergeArtifactsAndDependenciesReaders(artifactsReader, dependenciesReader)
if err != nil {
return nil, err
}
defer func(innerReader *content.ContentReader) {
err = errors.Join(err, errorutils.CheckError(innerReader.Close()))
}(mergedReader)
buildArtifactsSha1, err := extractSha1FromAqlResponse(mergedReader)
if err != nil {
return nil, err
}
return filterBuildAqlSearchResults(mergedReader, buildArtifactsSha1, builds)
}
// Artifacts' properties weren't fetched in previous aql, fetch now and add to results.
var buildNames []string
for _, build := range builds {
buildNames = append(buildNames, build.BuildName)
}
readerWithProps, err := searchProps(createAqlBodyForBuildArtifacts(builds), "build.name", buildNames, flags)
if err != nil {
return nil, err
}
defer func() {
err = errors.Join(err, errorutils.CheckError(readerWithProps.Close()))
}()
artifactsSortedReaderWithProps, err := loadMissingProperties(artifactsReader, readerWithProps)
if err != nil {
return nil, err
}
defer func() {
err = errors.Join(err, errorutils.CheckError(artifactsSortedReaderWithProps.Close()))
}()
mergedReader, err := mergeArtifactsAndDependenciesReaders(artifactsSortedReaderWithProps, dependenciesReader)
if err != nil {
return nil, err
}
defer func() {
err = errors.Join(err, errorutils.CheckError(mergedReader.Close()))
}()
buildArtifactsSha1, err := extractSha1FromAqlResponse(mergedReader)
if err != nil {
return nil, err
}
reader, err = filterBuildAqlSearchResults(mergedReader, buildArtifactsSha1, builds)
return
}
func mergeArtifactsAndDependenciesReaders(artifactsReader, dependenciesReader *content.ContentReader) (*content.ContentReader, error) {
var readers []*content.ContentReader
if artifactsReader != nil {
readers = append(readers, artifactsReader)
}
if dependenciesReader != nil {
readers = append(readers, dependenciesReader)
}
return content.MergeReaders(readers, content.DefaultKey)
}
// Perform search by pattern.
func SearchBySpecWithPattern(specFile *CommonParams, flags CommonConf, requiredArtifactProps RequiredArtifactProps) (*content.ContentReader, error) {
// Create AQL according to spec fields.
query, err := CreateAqlBodyForSpecWithPattern(specFile)
if err != nil {
return nil, err
}
specFile.Aql = Aql{ItemsFind: query}
return SearchBySpecWithAql(specFile, flags, requiredArtifactProps)
}
// Use this function when running Aql with pattern
func SearchBySpecWithAql(specFile *CommonParams, flags CommonConf, requiredArtifactProps RequiredArtifactProps) (reader *content.ContentReader, err error) {
// Execute the search according to provided aql in specFile.
var fetchedProps *content.ContentReader
query := BuildQueryFromSpecFile(specFile, requiredArtifactProps)
reader, err = aqlSearch(query, flags)
if err != nil {
return nil, err
}
filteredReader, err := FilterResultsByBuild(specFile, flags, requiredArtifactProps, reader)
if err != nil {
return nil, err
}
if filteredReader != nil {
// This one will close the original reader that was used
// to create the filteredReader (a new pointer will be created by the defer mechanism).
defer func(readerWithProps *content.ContentReader) {
err = errors.Join(err, errorutils.CheckError(readerWithProps.Close()))
}(reader)
// The new reader assignment will not affect the defer statement.
reader = filteredReader
}
fetchedProps, err = fetchProps(specFile, flags, requiredArtifactProps, reader)
if fetchedProps != nil {
// Before returning the new reader, we close the one we used to creat it.
defer func(reader *content.ContentReader) {
err = errors.Join(err, errorutils.CheckError(reader.Close()))
}(reader)
reader = fetchedProps
return
}
// Returns the open filteredReader or the original reader that returned from the AQL search.
return
}
// Filter the results by build, if no build found or items to filter, nil will be returned.
func FilterResultsByBuild(specFile *CommonParams, flags CommonConf, requiredArtifactProps RequiredArtifactProps, reader *content.ContentReader) (*content.ContentReader, error) {
length, err := reader.Length()
if err != nil {
return nil, err
}
if specFile.Build != "" && length > 0 {
// If requiredArtifactProps is not NONE and 'includePropertiesInAqlForSpec' for specFile returned true, results contains properties for artifacts.
resultsArtifactsIncludeProperties := requiredArtifactProps != NONE && includePropertiesInAqlForSpec(specFile)
return filterAqlSearchResultsByBuild(specFile, reader, flags, resultsArtifactsIncludeProperties)
}
return nil, nil
}
// Fetch properties only if:
// 1. Properties weren't included in 'results'.
// AND
// 2. Properties weren't fetched during 'build' filtering
// Otherwise, nil will be returned
func fetchProps(specFile *CommonParams, flags CommonConf, requiredArtifactProps RequiredArtifactProps, reader *content.ContentReader) (*content.ContentReader, error) {
if !includePropertiesInAqlForSpec(specFile) && specFile.Build == "" && requiredArtifactProps != NONE {
var readerWithProps *content.ContentReader
var err error
switch requiredArtifactProps {
case ALL:
readerWithProps, err = searchProps(specFile.Aql.ItemsFind, "*", []string{"*"}, flags)
case SYMLINK:
readerWithProps, err = searchProps(specFile.Aql.ItemsFind, "symlink.dest", []string{"*"}, flags)
}
if err != nil {
return nil, err
}
defer func() {
err = errors.Join(err, errorutils.CheckError(reader.Close()))
}()
return loadMissingProperties(reader, readerWithProps)
}
return nil, nil
}
func aqlSearch(aqlQuery string, flags CommonConf) (*content.ContentReader, error) {
return ExecAqlSaveToFile(aqlQuery, flags)
}
func ExecAql(aqlQuery string, flags CommonConf) (io.ReadCloser, error) {
client := flags.GetJfrogHttpClient()
aqlUrl := flags.GetArtifactoryDetails().GetUrl() + "api/search/aql"
log.Debug("Searching Artifactory using AQL query:\n", aqlQuery)
httpClientsDetails := flags.GetArtifactoryDetails().CreateHttpClientDetails()
resp, err := client.SendPostLeaveBodyOpen(aqlUrl, []byte(aqlQuery), &httpClientsDetails)
if err != nil {
return nil, err
}
if err = errorutils.CheckResponseStatus(resp, http.StatusOK); err != nil {
return nil, err
}
log.Debug("Artifactory response:", resp.Status)
return resp.Body, err
}
func ExecAqlSaveToFile(aqlQuery string, flags CommonConf) (reader *content.ContentReader, err error) {
var body io.ReadCloser
body, err = ExecAql(aqlQuery, flags)
if err != nil {
return
}
defer func() {
if body != nil {
err = errors.Join(err, errorutils.CheckError(body.Close()))
}
}()
log.Debug("Streaming data to file...")
var filePath string
filePath, err = streamToFile(body)
if err != nil {
return
}
log.Debug("Finished streaming data successfully.")
reader = content.NewContentReader(filePath, content.DefaultKey)
return
}
// Save the reader output into a temp file.
// return the file path.
func streamToFile(reader io.Reader) (filePath string, err error) {
var fd *os.File
bufioReader := bufio.NewReaderSize(reader, 65536)
fd, err = fileutils.CreateTempFile()
if err != nil {
return "", err
}
defer func() {
err = errors.Join(err, errorutils.CheckError(fd.Close()))
}()
_, err = io.Copy(fd, bufioReader)
return fd.Name(), errorutils.CheckError(err)
}
func LogSearchResults(numOfArtifacts int) {
msgSuffix := "artifacts."
if numOfArtifacts == 1 {
msgSuffix = "artifact."
}
log.Info("Found", strconv.Itoa(numOfArtifacts), msgSuffix)
}
type AqlSearchResult struct {
Results []ResultItem
}
// Implement this interface to allow creating 'content.ContentReader' items which can be used with 'searchutils' functions.
type SearchBasedContentItem interface {
content.SortableContentItem
GetItemRelativePath() string
GetName() string
GetType() string
}
type ResultItem struct {
Repo string `json:"repo,omitempty"`
Path string `json:"path,omitempty"`
Name string `json:"name,omitempty"`
Created string `json:"created,omitempty"`
Modified string `json:"modified,omitempty"`
Updated string `json:"updated,omitempty"`
CreatedBy string `json:"created_by,omitempty"`
ModifiedBy string `json:"modified_by,omitempty"`
Type string `json:"type,omitempty"`
Actual_Md5 string `json:"actual_md5,omitempty"`
Actual_Sha1 string `json:"actual_sha1,omitempty"`
Sha256 string `json:"sha256,omitempty"`
Depth int `json:"depth,omitempty"`
Size int64 `json:"size,omitempty"`
OriginalMd5 string `json:"original_md5,omitempty"`
Properties []Property `json:"properties,omitempty"`
Stats []Stat `json:"stats,omitempty"`
}
type Stat struct {
Downloaded string `json:"downloaded,omitempty"`
Downloads json.Number `json:"downloads,omitempty"`
DownloadedBy string `json:"downloaded_by,omitempty"`
RemoteDownloads json.Number `json:"remote_downloads,omitempty"`
}
func (item ResultItem) GetSortKey() string {
if item.Type == "folder" {
return appendFolderSuffix(item.GetItemRelativePath())
}
return item.GetItemRelativePath()
}
func (item ResultItem) GetName() string {
return item.Name
}
func (item ResultItem) GetType() string {
return item.Type
}
func (item ResultItem) GetItemRelativePath() string {
if item.Path == "." {
return path.Join(item.Repo, item.Name)
}
url := item.Repo
url = path.Join(url, item.Path, item.Name)
if item.Type == "folder" {
url = appendFolderSuffix(url)
}
return url
}
// Returns "item.Repo/item.Path/".
func (item ResultItem) GetItemRelativeLocation() string {
return path.Join(item.Repo, item.Path) + "/"
}
func (item *ResultItem) ToArtifact() buildinfo.Artifact {
return buildinfo.Artifact{
Name: item.Name,
Checksum: buildinfo.Checksum{
Sha1: item.Actual_Sha1,
Md5: item.Actual_Md5,
Sha256: item.Sha256,
},
Path: path.Join(item.Path, item.Name),
}
}
func (item *ResultItem) ToDependency() buildinfo.Dependency {
return buildinfo.Dependency{
Id: item.Name,
Checksum: buildinfo.Checksum{
Sha1: item.Actual_Sha1,
Md5: item.Actual_Md5,
Sha256: item.Sha256,
},
}
}
type AqlSearchResultItemFilter func(SearchBasedContentItem, *content.ContentReader) (*content.ContentReader, error)
func (item *ResultItem) GetProperty(key string) string {
for _, prop := range item.Properties {
if prop.Key == key {
return prop.Value
}
}
return ""
}
func FilterBottomChainResults(readerRecord SearchBasedContentItem, reader *content.ContentReader) (resultReader *content.ContentReader, err error) {
writer, err := content.NewContentWriter(content.DefaultKey, true, false)
if err != nil {
return nil, err
}
defer func(writer *content.ContentWriter) {
err = errors.Join(err, errorutils.CheckError(writer.Close()))
}(writer)
// Get the expected record type from the reader.
recordType := reflect.ValueOf(readerRecord).Type()
var temp string
for newRecord := (reflect.New(recordType)).Interface(); reader.NextRecord(newRecord) == nil; newRecord = (reflect.New(recordType)).Interface() {
resultItem, ok := newRecord.(SearchBasedContentItem)
if !ok {
return nil, errorutils.CheckErrorf("Reader record is not search-based.")
}
if resultItem.GetName() == "." {
continue
}
rPath := resultItem.GetItemRelativePath()
if !strings.HasSuffix(rPath, "/") {
rPath += "/"
}
if temp == "" || !strings.HasPrefix(temp, rPath) {
writer.Write(resultItem)
temp = rPath
}
}
if err = reader.GetError(); err != nil {
return nil, err
}
reader.Reset()
resultReader = content.NewContentReader(writer.GetFilePath(), writer.GetArrayKey())
return
}
// Reduce the amount of items by saving only the shortest item path for each unique path e.g.:
// a | a/b | c | e/f -> a | c | e/f
func FilterTopChainResults(readerRecord SearchBasedContentItem, reader *content.ContentReader) (resultReader *content.ContentReader, err error) {
writer, err := content.NewContentWriter(content.DefaultKey, true, false)
if err != nil {
return nil, err
}
defer func(writer *content.ContentWriter) {
err = errors.Join(err, errorutils.CheckError(writer.Close()))
}(writer)
// Get the expected record type from the reader.
recordType := reflect.ValueOf(readerRecord).Type()
var prevFolder string
for newRecord := (reflect.New(recordType)).Interface(); reader.NextRecord(newRecord) == nil; newRecord = (reflect.New(recordType)).Interface() {
resultItem, ok := newRecord.(SearchBasedContentItem)
if !ok {
return nil, errorutils.CheckErrorf("Reader record is not search-based.")
}
if resultItem.GetName() == "." {
continue
}
rPath := resultItem.GetItemRelativePath()
if resultItem.GetType() == "folder" && !strings.HasSuffix(rPath, "/") {
rPath += "/"
}
if prevFolder == "" || !strings.HasPrefix(rPath, prevFolder) {
writer.Write(resultItem)
if resultItem.GetType() == "folder" {
prevFolder = rPath
}
}
}
if err = reader.GetError(); err != nil {
return nil, err
}
reader.Reset()
resultReader = content.NewContentReader(writer.GetFilePath(), writer.GetArrayKey())
return
}
func ReduceTopChainDirResult(readerRecord SearchBasedContentItem, searchResults *content.ContentReader) (*content.ContentReader, error) {
return ReduceDirResult(readerRecord, searchResults, true, FilterTopChainResults)
}
func ReduceBottomChainDirResult(readerRecord SearchBasedContentItem, searchResults *content.ContentReader) (*content.ContentReader, error) {
return ReduceDirResult(readerRecord, searchResults, false, FilterBottomChainResults)
}
// Reduce Dir results by using the resultsFilter.
func ReduceDirResult(readerRecord SearchBasedContentItem, searchResults *content.ContentReader, ascendingOrder bool, resultsFilter AqlSearchResultItemFilter) (reader *content.ContentReader, err error) {
sortedFile, err := content.SortContentReader(readerRecord, searchResults, ascendingOrder)
if err != nil {
return nil, err
}
defer func() {
err = errors.Join(err, errorutils.CheckError(sortedFile.Close()))
}()
reader, err = resultsFilter(readerRecord, sortedFile)
return
}
func DisableTransitiveSearchIfNotAllowed(params *CommonParams, artifactoryVersion *version.Version) {
transitiveSearchMinVersion := "7.17.0"
if params.Transitive && !artifactoryVersion.AtLeast(transitiveSearchMinVersion) {
log.Info(fmt.Sprintf("Transitive search is available on Artifactory version %s or higher. Installed Artifactory version: %s. Transitive option is ignored.",
transitiveSearchMinVersion, artifactoryVersion.GetVersion()))
params.Transitive = false
}
}
func appendFolderSuffix(folderPath string) string {
if !strings.HasSuffix(folderPath, "/") {
folderPath += "/"
}
return folderPath
}