-
Notifications
You must be signed in to change notification settings - Fork 40
/
imagesets.go
842 lines (764 loc) · 31.9 KB
/
imagesets.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
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
// nolint:gocritic,govet,revive
package routes
import (
"context"
"fmt"
"net/http"
"sort"
"strconv"
"strings"
"github.com/redhatinsights/edge-api/pkg/db"
"github.com/redhatinsights/edge-api/pkg/dependencies"
"github.com/redhatinsights/edge-api/pkg/errors"
"github.com/redhatinsights/edge-api/pkg/models"
"github.com/redhatinsights/edge-api/pkg/routes/common"
"github.com/redhatinsights/edge-api/pkg/services"
"github.com/go-chi/chi/v5"
log "github.com/sirupsen/logrus"
"gorm.io/gorm"
)
type imageSetTypeKey int
type imageSetImageTypeKey int
const imageSetKey imageSetTypeKey = iota
const imageSetImageKey imageSetImageTypeKey = iota
var sortImageSetImageOption = []string{"created_at", "name", "version"}
var sortOption = []string{"created_at", "updated_at", "name"}
var statusOption = []string{models.ImageStatusCreated, models.ImageStatusBuilding, models.ImageStatusError, models.ImageStatusSuccess}
// MakeImageSetsRouter adds support for operations on image-sets
func MakeImageSetsRouter(sub chi.Router) {
sub.With(ValidateQueryParams("image-sets")).With(validateFilterParams).With(common.Paginate).Get("/", ListAllImageSets)
sub.With(ValidateQueryParams("image-sets")).With(validateFilterParams).With(common.Paginate).Get("/view", GetImageSetsView)
sub.Route("/{imageSetID}", func(r chi.Router) {
r.Use(ImageSetCtx)
r.With(validateFilterParams).With(common.Paginate).Get("/", GetImageSetsByID)
r.Delete("/", DeleteImageSet)
r.With(common.Paginate).Get("/devices", GetImageSetsDevicesByID)
})
sub.Route("/view/{imageSetID}", func(r chi.Router) {
r.Use(ImageSetViewCtx)
r.Get("/", GetImageSetViewByID)
r.With(ValidateQueryParams("imagesetimageview")).With(validateImageFilterParams).With(common.Paginate).Get("/versions", GetAllImageSetImagesView)
r.Route("/versions/{imageID}", func(rVersion chi.Router) {
rVersion.Use(ImageSetImageViewCtx)
rVersion.With(ValidateQueryParams("imagesetimageview")).With(validateImageFilterParams).Get("/", GetImageSetImageView)
})
})
}
func getStorageInstallerIsoURL(installerID uint) string {
return services.GetStorageInstallerIsoURL(installerID)
}
var imageSetFilters = common.ComposeFilters(
common.ContainFilterHandler(&common.Filter{
QueryParam: "status",
DBField: "images.status",
}),
common.ContainFilterHandler(&common.Filter{
QueryParam: "name",
DBField: "image_sets.name",
}),
common.IntegerNumberFilterHandler(&common.Filter{
QueryParam: "id",
DBField: "image_sets.id",
}),
common.SortFilterHandler("image_sets", "created_at", "DESC"),
)
// imageSetsViewSortFilterHandler filter and sort handler for images-sets view
func imageSetsViewSortFilterHandler(sortTable, defaultSortKey, defaultOrder string) common.FilterFunc {
return common.FilterFunc(func(r *http.Request, tx *gorm.DB) *gorm.DB {
sortBy := defaultSortKey
sortOrder := defaultOrder
if val := r.URL.Query().Get("sort_by"); val != "" {
if strings.HasPrefix(val, "-") {
sortOrder = "DESC"
sortBy = val[1:]
} else {
sortOrder = "ASC"
sortBy = val
}
}
if sortBy == "updated_at" {
sortTable = "images"
return tx.Order(fmt.Sprintf("%s.%s %s", sortTable, sortBy, sortOrder))
}
sortTable = "image_sets"
return tx.Order(fmt.Sprintf("%s.%s %s", sortTable, sortBy, sortOrder))
})
}
// imageSetsViewFilters compose filters for image-sets view
var imageSetsViewFilters = common.ComposeFilters(
common.ContainFilterHandler(&common.Filter{QueryParam: "status", DBField: "images.status"}),
common.ContainFilterHandler(&common.Filter{QueryParam: "name", DBField: "image_sets.name"}),
common.IntegerNumberFilterHandler(&common.Filter{QueryParam: "id", DBField: "image_sets.id"}),
imageSetsViewSortFilterHandler("images", "updated_at", "DESC"),
)
var imageDetailFilters = common.ComposeFilters(
common.ContainFilterHandler(&common.Filter{
QueryParam: "status",
DBField: "images.status",
}),
common.ContainFilterHandler(&common.Filter{
QueryParam: "name",
DBField: "images.name",
}),
common.IntegerNumberFilterHandler(&common.Filter{
QueryParam: "version",
DBField: "images.version",
}),
common.SortFilterHandler("images", "created_at", "DESC"),
)
// ImageSetCtx provides the handler for Image Sets
func ImageSetCtx(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
s := dependencies.ServicesFromContext(r.Context())
var imageSet models.ImageSet
orgID := readOrgID(w, r, s.Log)
if orgID == "" {
return
}
if imageSetID := chi.URLParam(r, "imageSetID"); imageSetID != "" {
s.Log = s.Log.WithField("imageSetID", imageSetID)
_, err := strconv.Atoi(imageSetID)
if err != nil {
errMessage := "imageSetID must be of type integer"
s.Log.WithField("error", err.Error()).Error(errMessage)
respondWithAPIError(w, s.Log, errors.NewBadRequest(errMessage))
return
}
result := db.Org(orgID, "").Where("Image_sets.id = ?", imageSetID).First(&imageSet)
if result.Error != nil {
s.Log.WithFields(log.Fields{"error": result.Error.Error(), "image_set_id": imageSetID}).Error("error getting image-set")
var apiError errors.APIError
switch result.Error {
case gorm.ErrRecordNotFound:
apiError = errors.NewNotFound("record not found")
default:
apiError = errors.NewInternalServerError()
}
respondWithAPIError(w, s.Log, apiError)
return
}
if imageSet.Images != nil {
result := db.DBx(r.Context()).Where("image_set_id = ?", imageSetID).Find(&imageSet.Images)
if result.Error != nil {
s.Log.WithField("error", result.Error.Error()).Error("error when getting image-set images")
respondWithAPIError(w, s.Log, errors.NewInternalServerError())
return
}
if result := db.DBx(r.Context()).Where("id = ?", &imageSet.Images[len(imageSet.Images)-1].InstallerID).Find(&imageSet.Images[len(imageSet.Images)-1].Installer); result.Error != nil {
s.Log.WithField("error", result.Error.Error()).Error("error when getting image installer")
respondWithAPIError(w, s.Log, errors.NewInternalServerError())
return
}
}
ctx := context.WithValue(r.Context(), imageSetKey, &imageSet)
next.ServeHTTP(w, r.WithContext(ctx))
}
})
}
// ImageSetInstallerURL returns Imageset structure with last installer available
type ImageSetInstallerURL struct {
ImageSetData models.ImageSet `json:"image_set"`
ImageBuildISOURL *string `json:"image_build_iso_url"`
}
// ListAllImageSets return the list of image sets and images
// @ID ListAllImageSets
// @Summary Return the list of image sets.
// @Description Return the list of image sets.
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param sort_by query string false "Define sort fields: created_at, updated_at, name. To sort DESC use -"
// @Param name query string false "field: filter by name"
// @Param status query string false "field: filter by status"
// @Param limit query int false "field: return number of image-set view until limit is reached. Default is 100."
// @Param offset query int false "field: return number of image-set view beginning at the offset."
// @Success 200 {object} models.ImageSetsResponseAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "The Image Set was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets [get]
func ListAllImageSets(w http.ResponseWriter, r *http.Request) {
s := dependencies.ServicesFromContext(r.Context())
var imageSet []models.ImageSet
var imageSetInfo []ImageSetInstallerURL
var count int64
var result *gorm.DB
pagination := common.GetPagination(r)
orgID := readOrgID(w, r, s.Log)
if orgID == "" {
// logs and response handled by readOrgID
return
}
latestImagesSubQuery := db.Org(orgID, "").Model(&models.Image{}).Select("image_set_id", "deleted_at", "max(id) as image_id").Group("image_set_id, deleted_at")
countResult := imageSetFilters(r, db.OrgDB(orgID, db.DBx(r.Context()), "image_sets")).Table("(?) as latest_images", latestImagesSubQuery).
Joins("JOIN images on images.id = latest_images.image_id").
Joins("JOIN image_sets on image_sets.id = latest_images.image_set_id").
Where("image_sets.deleted_at IS NULL").
Count(&count)
if countResult.Error != nil {
s.Log.WithField("error", countResult.Error.Error()).Error("Error counting results for image sets list")
respondWithAPIError(w, s.Log, errors.NewInternalServerError())
return
}
result = imageSetFilters(r, db.OrgDB(orgID, db.DBx(r.Context()), "Image_Sets").Model(&models.ImageSet{})).Table("(?) as latest_images", latestImagesSubQuery).
Distinct("image_sets.*").
Limit(pagination.Limit).Offset(pagination.Offset).
Preload("Images").
Preload("Images.Commit").
Preload("Images.Installer").
Preload("Images.Commit.Repo").
Joins("JOIN images on images.id = latest_images.image_id").
Joins("JOIN image_sets on image_sets.id = latest_images.image_set_id").
Where("image_sets.deleted_at IS NULL").
Find(&imageSet)
if result.Error != nil {
s.Log.WithField("error", result.Error.Error()).Error("error while getting Image-sets")
respondWithAPIError(w, s.Log, errors.NewInternalServerError())
return
}
for idx, img := range imageSet {
var imgSet ImageSetInstallerURL
imgSet.ImageSetData = imageSet[idx]
sort.Slice(img.Images, func(i, j int) bool {
return img.Images[i].ID > img.Images[j].ID
})
imgSet.ImageSetData.Version = img.Images[0].Version
imageSetIsoURLSetten := false
for _, i := range img.Images {
// avoid Implicit memory aliasing
i := i
if i.InstallerID != nil {
if i.Installer == nil {
result = db.DBx(r.Context()).First(&i.Installer, &i.InstallerID)
}
if i.Installer.ImageBuildISOURL != "" {
installerIsoURL := getStorageInstallerIsoURL(i.Installer.ID)
if !imageSetIsoURLSetten {
// imageSet iso url should be set from the latest image installer
// e.g. the first one defined in this list
imgSet.ImageBuildISOURL = &installerIsoURL
imageSetIsoURLSetten = true
}
// update the image installer iso url
i.Installer.ImageBuildISOURL = installerIsoURL
}
}
}
imageSetInfo = append(imageSetInfo, imgSet)
}
if result.Error != nil {
s.Log.WithField("error", result.Error.Error()).Error("error occurred while getting Image sets image installer")
var apiError errors.APIError
switch result.Error {
case gorm.ErrRecordNotFound:
apiError = errors.NewNotFound("image-set image installer not found")
default:
apiError = errors.NewInternalServerError()
}
respondWithAPIError(w, s.Log, apiError)
return
}
respondWithJSONBody(w, s.Log, &common.EdgeAPIPaginatedResponse{
Count: count,
Data: imageSetInfo,
})
}
// ImageSetImagePackages return info related to details on images from imageset
type ImageSetImagePackages struct {
ImageSetData models.ImageSet `json:"image_set"`
Images []ImageDetail `json:"images"`
ImageBuildISOURL string `json:"image_build_iso_url"`
}
// GetImageSetsByID returns the list of Image Sets by a given Image Set ID
// @ID GetImageSetsByID
// @Summary Get an image-set
// @Description Get image set by ID
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param imageSetID path int true "Image Set ID"
// @Param sort_by query string false "Define sort fields: created_at, updated_at, name. To sort DESC use -"
// @Param name query string false "field: filter by name"
// @Param status query string false "field: filter by status"
// @Param version query string false "field: filter by version"
// @Param limit query int false "field: return number of image-set view until limit is reached. Default is 100."
// @Param offset query int false "field: return number of image-set view beginning at the offset."
// @Success 200 {object} models.ImageSetDetailsResponseAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "image-set was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/{imageSetID}/ [get]
func GetImageSetsByID(w http.ResponseWriter, r *http.Request) {
var images []models.Image
var details ImageSetImagePackages
s := dependencies.ServicesFromContext(r.Context())
pagination := common.GetPagination(r)
orgID := readOrgID(w, r, s.Log)
if orgID == "" {
// logs and response handled by readOrgID
return
}
ctx := r.Context()
imageSet, ok := ctx.Value(imageSetKey).(*models.ImageSet)
if !ok {
s.Log.Error("image-set not found in the context")
respondWithAPIError(w, s.Log, errors.NewBadRequest("image-set not found in the context"))
return
}
result := imageDetailFilters(r, db.OrgDB(orgID, db.DBx(r.Context()), "Image_Sets").Model(&models.Image{})).Limit(pagination.Limit).Offset(pagination.Offset).
Preload("Commit.Repo").Preload("Commit.InstalledPackages").Preload("Installer").
Joins(`JOIN Image_Sets ON Image_Sets.id = Images.image_set_id`).
Where(`Image_sets.id = ?`, &imageSet.ID).
Find(&images)
if result.Error != nil {
err := errors.NewBadRequest("Error to filter images")
respondWithAPIError(w, s.Log.WithError(err), err)
return
}
Imgs := returnImageDetails(images, s)
details.ImageSetData = *imageSet
details.Images = Imgs
// update image installer iso URL for all images with the internal application storage end-point
for _, imageDetail := range details.Images {
if imageDetail.Image.InstallerID != nil && imageDetail.Image.Installer.ImageBuildISOURL != "" {
imageDetail.Image.Installer.ImageBuildISOURL = getStorageInstallerIsoURL(imageDetail.Image.Installer.ID)
}
}
if Imgs != nil && Imgs[len(Imgs)-1].Image != nil && Imgs[len(Imgs)-1].Image.InstallerID != nil {
img := Imgs[len(Imgs)-1].Image
details.ImageBuildISOURL = img.Installer.ImageBuildISOURL
}
respondWithJSONBody(w, s.Log, &common.EdgeAPIPaginatedResponse{
Data: &details,
Count: int64(len(images)),
})
}
func validateFilterParams(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
errs := []common.ValidationError{}
if statuses, ok := r.URL.Query()["status"]; ok {
for _, status := range statuses {
if !contains(statusOption, strings.ToUpper(status)) {
errs = append(errs, common.ValidationError{Key: "status", Reason: fmt.Sprintf("%s is not a valid status. Status must be %s", status, strings.Join(validStatuses, " or "))})
}
}
}
if val := r.URL.Query().Get("sort_by"); val != "" {
name := val
if string(val[0]) == "-" {
name = val[1:]
}
if !contains(sortOption, name) {
errs = append(errs, common.ValidationError{Key: "sort_by", Reason: fmt.Sprintf("%s is not a valid sort_by. Sort-by must %v", name, strings.Join(sortOption, " or "))})
}
}
if val := r.URL.Query().Get("version"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "version", Reason: fmt.Sprintf("%s is not a valid version type, version must be number", val)})
}
}
if val := r.URL.Query().Get("limit"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "limit", Reason: fmt.Sprintf("%s is not a valid limit type, limit must be an integer", val)})
}
}
if val := r.URL.Query().Get("offset"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "offset", Reason: fmt.Sprintf("%s is not a valid offset type, offset must be an integer", val)})
}
}
if val := r.URL.Query().Get("id"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "id", Reason: fmt.Sprintf("%s is not a valid id type, id must be an integer", val)})
}
}
if len(errs) == 0 {
next.ServeHTTP(w, r)
return
}
w.WriteHeader(http.StatusBadRequest)
respondWithJSONBody(w, ctxServices.Log, &errs)
})
}
func validateImageFilterParams(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
errs := []common.ValidationError{}
if statuses, ok := r.URL.Query()["status"]; ok {
for _, status := range statuses {
if !contains(statusOption, strings.ToUpper(status)) {
errs = append(errs, common.ValidationError{Key: "status", Reason: fmt.Sprintf("%s is not a valid status. Status must be %s", status, strings.Join(validStatuses, " or "))})
}
}
}
if val := r.URL.Query().Get("sort_by"); val != "" {
name := val
if string(val[0]) == "-" {
name = val[1:]
}
if !contains(sortImageSetImageOption, name) {
errs = append(errs, common.ValidationError{Key: "sort_by", Reason: fmt.Sprintf("%s is not a valid sort_by. Sort-by must %v", name, strings.Join(sortImageSetImageOption, " or "))})
}
}
if val := r.URL.Query().Get("version"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "version", Reason: fmt.Sprintf("%s is not a valid version type, version must be number", val)})
}
}
if val := r.URL.Query().Get("limit"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "limit", Reason: fmt.Sprintf("%s is not a valid limit type, limit must be an integer", val)})
}
}
if val := r.URL.Query().Get("offset"); val != "" {
_, err := strconv.Atoi(val)
if err != nil {
errs = append(errs, common.ValidationError{Key: "offset", Reason: fmt.Sprintf("%s is not a valid offset type, offset must be an integer", val)})
}
}
if len(errs) == 0 {
next.ServeHTTP(w, r)
return
}
w.WriteHeader(http.StatusBadRequest)
respondWithJSONBody(w, ctxServices.Log, &errs)
})
}
func contains(s []string, searchterm string) bool {
for _, a := range s {
if a == searchterm {
return true
}
}
return false
}
func returnImageDetails(images []models.Image, s *dependencies.EdgeAPIServices) []ImageDetail {
var Imgs []ImageDetail
for idx, i := range images {
err := db.DB.Model(i).Association("Packages").Find(&images[idx].Packages)
if err != nil {
return nil
}
img, err := s.ImageService.AddPackageInfo(&images[idx])
if err != nil {
s.Log.Error("Image detail not found")
}
Imgs = append(Imgs, ImageDetail(img))
}
return Imgs
}
// GetImageSetsView return a list of image-sets view
// @Summary Return the list of image set view.
// @Description Return the list of image set view.
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param sort_by query string false "Define sort fields: created_at, updated_at, name. To sort DESC use -"
// @Param name query string false "field: filter by name"
// @Param status query string false "field: filter by status"
// @Param id query int false "field: filter by id"
// @Param limit query int false "field: return number of image-set view until limit is reached. Default is 30."
// @Param offset query int false "field: return number of image-set view beginning at the offset."
// @Success 200 {object} models.ImageSetsViewResponseAPI
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/view [get]
func GetImageSetsView(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
orgID := readOrgID(w, r, ctxServices.Log)
if orgID == "" {
// logs and response handled by readOrgID
return
}
pagination := common.GetPagination(r)
imageSetsCount, err := ctxServices.ImageSetService.GetImageSetsViewCount(imageSetsViewFilters(r, db.DBx(r.Context())))
if err != nil {
ctxServices.Log.WithFields(log.Fields{"error": err.Error(), "orgID": orgID}).Error("error getting image-sets view count")
respondWithAPIError(w, ctxServices.Log, errors.NewInternalServerError())
return
}
imageSetsViewList, err := ctxServices.ImageSetService.GetImageSetsView(pagination.Limit, pagination.Offset, imageSetsViewFilters(r, db.DBx(r.Context())))
if err != nil {
ctxServices.Log.WithFields(log.Fields{"error": err.Error(), "orgID": orgID}).Error("error getting image-sets view")
respondWithAPIError(w, ctxServices.Log, errors.NewInternalServerError())
return
}
respondWithJSONBody(w, ctxServices.Log, map[string]interface{}{"data": imageSetsViewList, "count": imageSetsCount})
}
// ImageSetViewCtx provides the handler for ImageSet view details
func ImageSetViewCtx(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
orgID := readOrgID(w, r, ctxServices.Log)
if orgID == "" {
return
}
imageSetIDString := chi.URLParam(r, "imageSetID")
if imageSetIDString == "" {
return
}
ctxServices.Log = ctxServices.Log.WithField("imageSetID", imageSetIDString)
imageSetID, err := strconv.Atoi(imageSetIDString)
if err != nil {
ctxServices.Log.WithField("error", err.Error()).Error("error while converting image-set id from string")
respondWithAPIError(w, ctxServices.Log, errors.NewBadRequest("bad image-set id"))
return
}
var imageSet models.ImageSet
if result := db.Org(orgID, "").First(&imageSet, imageSetID); result.Error != nil {
if result.Error == gorm.ErrRecordNotFound {
respondWithAPIError(w, ctxServices.Log, errors.NewNotFound("image-set not found"))
return
}
apiError := errors.NewInternalServerError()
apiError.SetTitle("internal server error occurred while getting image-set")
respondWithAPIError(w, ctxServices.Log, apiError)
return
}
ctx := context.WithValue(r.Context(), imageSetKey, &imageSet)
next.ServeHTTP(w, r.WithContext(ctx))
})
}
func getContextImageSet(w http.ResponseWriter, r *http.Request) *models.ImageSet {
ctx := r.Context()
imageSet, ok := ctx.Value(imageSetKey).(*models.ImageSet)
if !ok {
ctxServices := dependencies.ServicesFromContext(r.Context())
respondWithAPIError(w, ctxServices.Log, errors.NewBadRequest("failed to get image-set from context"))
return nil
}
return imageSet
}
// GetImageSetViewByID handle the image-set view
// @ID GetImageSetViewByID
// @Summary Return the image-set description view.
// @Description Return the image-set description view.
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param image_set_id path int true "the image-set id"
// @Success 200 {object} models.ImageSetIDViewAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "The Image-Set was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/view/{image_set_id} [get]
func GetImageSetViewByID(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
imageSet := getContextImageSet(w, r)
if imageSet == nil {
// log and response handled by getContextImageSet
return
}
imageSetIDView, err := ctxServices.ImageSetService.GetImageSetViewByID(imageSet.ID)
if err != nil {
var apiError errors.APIError
switch err.(type) {
case *services.ImageSetNotFoundError:
apiError = errors.NewNotFound("image-set not found")
case *services.ImageNotFoundError:
apiError = errors.NewNotFound("image-set has no image")
case *services.OrgIDNotSet:
apiError = errors.NewBadRequest("org-id not set")
default:
apiError = errors.NewInternalServerError()
}
respondWithAPIError(w, ctxServices.Log, apiError)
return
}
respondWithJSONBody(w, ctxServices.Log, imageSetIDView)
}
// GetAllImageSetImagesView handle the image-set images view
// @ID GetAllImageSetImagesView
// @Summary Return the image-set images view list.
// @Description Return the image-set images view list.
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param image_set_id path int true "the image-set id"
// @Param sort_by query string false "Define sort fields: created_at, version, To sort DESC use -"
// @Param status query string false "field: filter by status"
// @Param version query string false "field: filter by version"
// @Param limit query int false "field: return number of images until limit is reached. Default is 100."
// @Param offset query int false "field: return number of images beginning at the offset."
// @Success 200 {object} models.ImagesViewDataAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "The Image-Set was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/view/{image_set_id}/versions [get]
func GetAllImageSetImagesView(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
imageSet := getContextImageSet(w, r)
if imageSet == nil {
// log and response handled by getContextImageSet
return
}
imagesDBFilters := imageDetailFilters(r, db.DBx(r.Context()))
pagination := common.GetPagination(r)
imageSetImagesView, err := ctxServices.ImageSetService.GetImagesViewData(imageSet.ID, pagination.Limit, pagination.Offset, imagesDBFilters)
if err != nil {
var apiError errors.APIError
switch err.(type) {
case *services.OrgIDNotSet:
apiError = errors.NewBadRequest("org-id not set")
default:
apiError = errors.NewInternalServerError()
}
respondWithAPIError(w, ctxServices.Log, apiError)
return
}
respondWithJSONBody(w, ctxServices.Log, imageSetImagesView)
}
// ImageSetImageViewCtx provides the handler for Image view details
func ImageSetImageViewCtx(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
orgID := readOrgID(w, r, ctxServices.Log)
if orgID == "" {
return
}
imageSet := getContextImageSet(w, r)
if imageSet == nil {
return
}
imageIDString := chi.URLParam(r, "imageID")
if imageIDString == "" {
return
}
ctxServices.Log = ctxServices.Log.WithField("imageID", imageIDString)
imageID, err := strconv.Atoi(imageIDString)
if err != nil {
ctxServices.Log.WithField("error", err.Error()).Error("error while converting image id from string")
respondWithAPIError(w, ctxServices.Log, errors.NewBadRequest("bad image id"))
return
}
var image models.Image
if result := db.Org(orgID, "").Where("image_set_id", imageSet.ID).First(&image, imageID); result.Error != nil {
if result.Error == gorm.ErrRecordNotFound {
respondWithAPIError(w, ctxServices.Log, errors.NewNotFound("image for image set view not found"))
return
}
apiError := errors.NewInternalServerError()
apiError.SetTitle("internal server error occurred while getting image set image")
respondWithAPIError(w, ctxServices.Log, apiError)
return
}
ctx := context.WithValue(r.Context(), imageSetImageKey, &image)
next.ServeHTTP(w, r.WithContext(ctx))
})
}
func getContextImageSetImage(w http.ResponseWriter, r *http.Request) *models.Image {
ctx := r.Context()
image, ok := ctx.Value(imageSetImageKey).(*models.Image)
if !ok {
ctxServices := dependencies.ServicesFromContext(r.Context())
respondWithAPIError(w, ctxServices.Log, errors.NewBadRequest("failed to get image from context"))
return nil
}
return image
}
// GetImageSetImageView handle the image-set image view
// @ID GetImageSetImageView
// @Summary Return the image-set images view list.
// @Description Return the image-set images view list.
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param imageSetID path int true "the image set id"
// @Param imageID path int true "the image id"
// @Success 200 {object} models.ImageSetImageIDViewAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "The Image-Set or Image was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/view/{imageSetID}/versions/{imageID} [get]
func GetImageSetImageView(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
imageSet := getContextImageSet(w, r)
if imageSet == nil {
return
}
image := getContextImageSetImage(w, r)
if image == nil {
return
}
imageSetImageView, err := ctxServices.ImageSetService.GetImageSetImageViewByID(imageSet.ID, image.ID)
if err != nil {
var apiError errors.APIError
switch err.(type) {
case *services.ImageSetNotFoundError:
apiError = errors.NewNotFound("image-set not found")
case *services.ImageNotFoundError:
apiError = errors.NewNotFound("image-set has no image")
case *services.OrgIDNotSet:
apiError = errors.NewBadRequest("org-id not set")
default:
apiError = errors.NewInternalServerError()
}
respondWithAPIError(w, ctxServices.Log, apiError)
return
}
respondWithJSONBody(w, ctxServices.Log, imageSetImageView)
}
// DeleteImageSet deletes an imageset
// @ID DeleteImageSet
// @Summary Delete Image Set
// @Description Delete Image Set
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param imageSetID path int true "Identifier of the ImageSet"
// @Success 200 {object} models.ImageSetAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "image-set was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/{imageSetID} [delete]
func DeleteImageSet(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
imageSet := getContextImageSet(w, r)
if imageSet == nil {
return
}
err := ctxServices.ImageSetService.DeleteImageSet(imageSet.ID)
if err != nil {
respondWithAPIError(w, ctxServices.Log, errors.NewBadRequest("failed to delete image set"))
return
}
w.WriteHeader(http.StatusOK)
}
// ImageSetDevices contains the count and data for a list of Imagesets
type ImageSetDevices struct {
Count int `json:"Count"`
Data []string `json:"Data"`
}
// GetImageSetsDevicesByID gets all devices related to an imageset
// @ID GetImageSetsDevicesByID
// @Summary Return device ids for an image set.
// @Description Return device ids for an image set.
// @Tags Image-Sets
// @Accept json
// @Produce json
// @Param ImageSetId path int true "Identifier of the ImageSet"
// @Success 200 {object} models.ImageSetDevicesAPI
// @Failure 400 {object} errors.BadRequest "The request sent couldn't be processed."
// @Failure 404 {object} errors.NotFound "The Image Set ID was not found."
// @Failure 500 {object} errors.InternalServerError "There was an internal server error."
// @Router /image-sets/{imageSetID}/devices [get]
func GetImageSetsDevicesByID(w http.ResponseWriter, r *http.Request) {
ctxServices := dependencies.ServicesFromContext(r.Context())
imageSet := getContextImageSet(w, r)
if imageSet == nil {
return
}
count, devices, err := ctxServices.ImageSetService.GetDeviceIdsByImageSetID(imageSet.ID)
if err != nil {
respondWithAPIError(w, ctxServices.Log, errors.NewInternalServerError())
return
}
returnData := ImageSetDevices{Count: count, Data: devices}
respondWithJSONBody(w, ctxServices.Log, returnData)
}