✨ Kai support #631

jortel · 2024-04-29T03:58:34Z

closes #630

Added endpoint:
- GET /applications/:id/analyses/issues
- GET /analyses
- GET /analyses/:id/issues
Updated api.Analysis to omit issues, summary. Struct never used this way.
Add field: Analysis.Commit. migration=13.

Added IssueWriter to support new endpoints.

migration/14

diff -bur migration/v13/model/analysis.go migration/v14/model/analysis.go
--- migration/v13/model/analysis.go	2024-06-11 03:29:34.402853992 -0700
+++ migration/v14/model/analysis.go	2024-06-11 04:29:29.898613621 -0700
@@ -6,7 +6,8 @@
 type Analysis struct {
 	Model
 	Effort        int
-	Archived      bool             `json:"archived"`
+	Commit        string
+	Archived      bool
 	Summary       JSON             `gorm:"type:json"`
 	Issues        []Issue          `gorm:"constraint:OnDelete:CASCADE"`
 	Dependencies  []TechDependency `gorm:"constraint:OnDelete:CASCADE"`
diff -bur migration/v13/model/application.go migration/v14/model/application.go
--- migration/v13/model/application.go	2024-06-11 03:29:34.402853992 -0700
+++ migration/v14/model/application.go	2024-06-11 04:29:29.898613621 -0700
@@ -76,7 +76,7 @@
 	return
 }
 
-// Validation Hook to avoid cyclic dependencies.
+// BeforeCreate detects cyclic dependencies.
 func (r *Dependency) BeforeCreate(db *gorm.DB) (err error) {
 	var nextDeps []*Dependency
 	var nextAppsIDs []uint
@@ -96,11 +96,11 @@
 	return
 }
 
-// Custom error type to allow API recognize Cyclic Dependency error and assign proper status code.
+// DependencyCyclicError reports cyclic Dependency error.
 type DependencyCyclicError struct{}
 
-func (err DependencyCyclicError) Error() string {
-	return "cyclic dependencies are not allowed"
+func (e DependencyCyclicError) Error() string {
+	return "Cyclic dependencies are not permitted."
 }
 
 type BusinessService struct {

jortel · 2024-05-08T14:44:48Z

migration/v13/model/analysis.go

+type Analysis struct {
+	Model
+	Effort        int
+	Commit        string           `json:"commit"`


hint: added Commit.

jortel · 2024-05-08T14:45:32Z

settings/hub.go

+	EnvAppName                 = "APP_NAME"
+	EnvDisconnected            = "DISCONNECTED"
+	EnvAnalysisReportPath      = "ANALYSIS_REPORT_PATH"
+	EnvAnalysisArchiverEnabled = "ANALYSIS_ARCHIVER_ENABLED"


hint: added EnvAnalysisArchiverEnabled.

jortel · 2024-05-08T14:48:10Z

api/analysis.go

+	if err != nil {
+		_ = ctx.Error(err)
+		return
+	}


hint: Moved this code blocker here to use r.Model() to properly transfer analysis fields in the posted resource (like: Commit).

jortel · 2024-06-11T10:55:56Z

migration/v14/model/analysis.go

+type Analysis struct {
+	Model
+	Effort        int
+	Commit        string


hint: adds commit.

jortel · 2024-06-11T10:58:07Z

api/analysis.go

+// @tags analyses
+// @produce json
+// @success 200 {object} []api.Analysis
+// @router /analyses [get]


hint: added for completeness.

jortel · 2024-06-11T10:58:39Z

api/analysis.go

+// @produce octet-stream
+// @success 204 {object}
+// @router /analyses/{id}/archive [post]
+// @param id path int true "Analysis ID"


hint: added to support manual archiving (by kai service) when automatic archiver disabled.

jortel · 2024-06-11T11:01:48Z

api/analysis.go

@@ -185,6 +279,8 @@ func (h AnalysisHandler) AppList(ctx *gin.Context) {
 	db := h.DB(ctx)
 	db = db.Model(&model.Analysis{})
 	db = db.Where("ApplicationID = ?", id)
+	db = db.Preload("Application")


hint: preload application so name is set in ref.

jortel · 2024-06-11T11:03:04Z

api/analysis.go

@@ -388,7 +482,7 @@ func (h AnalysisHandler) AppCreate(ctx *gin.Context) {
 	}

 	db = h.DB(ctx)
-	db = db.Preload(clause.Associations)
+	db = db.Preload("Application")


hint: only preload app. Don't need/want issues.

jortel · 2024-06-11T11:03:47Z

api/analysis.go

+// @produce json
+// @success 200 {object} []api.Issue
+// @router /analyses/{id}/issues [get]
+// @param id path int true "Analysis ID"


hint: needed by kai to fetch issues.

Signed-off-by: Jeff Ortel <jortel@redhat.com>

mansam

LGTM, just little nits

mansam · 2024-06-11T11:46:31Z

api/analysis.go

+// @summary Archive an analysis (report) by ID.
+// @description Archive an analysis (report) by ID.
+// @tags analyses
+// @produce octet-stream


@produce line can be removed

mansam · 2024-06-11T11:47:05Z

api/analysis.go

+// @description Archive an analysis (report) by ID.
+// @tags analyses
+// @produce octet-stream
+// @success 204 {object}


can be @success 204 as there's no returned object

mansam · 2024-06-11T11:50:15Z

api/analysis.go

@@ -202,15 +298,11 @@ func (h AnalysisHandler) AppList(ctx *gin.Context) {
 		}
 		list = append(list, m)
 	}
-	err = h.WithCount(ctx, cursor.Count())


Is WithCount not necessary here to set the pagination header?

mansam · 2024-06-11T12:44:56Z

api/analysis.go

@@ -1683,6 +1936,16 @@ func (h *AnalysisHandler) appIDs(ctx *gin.Context, f qf.Filter) (q *gorm.DB) {
 }

 // analysisIDs provides analysis IDs.


might be good to fix up the method name in the commend here

mansam · 2024-06-11T12:58:17Z

api/analysis.go

@@ -1900,6 +2158,7 @@ type Issue struct {
 // With updates the resource with the model.
 func (r *Issue) With(m *model.Issue) {
 	r.Resource.With(&m.Model)
+	r.Analysis = m.AnalysisID


Wondering if these should be refs rather than bare IDs, unless these IDs aren't intended to be used to reference API resources?

mansam · 2024-06-11T13:09:00Z

migration/v14/migrate.go

+	"gorm.io/gorm"
+)
+
+var log = logr.WithName("migration|v13")


log message needs to be updated to v14

This is necessary for Kai to harvest historical data from the hub Related to konveyor/tackle2-hub/pull/631 Signed-off-by: Fabian von Feilitzsch <fabian@fabianism.us>

jortel force-pushed the kai-support branch from 90a7edd to aa60734 Compare April 29, 2024 18:35

jortel commented May 8, 2024

View reviewed changes

jortel marked this pull request as ready for review May 29, 2024 20:01

jortel added this to the v0.5.0 milestone Jun 5, 2024

jortel force-pushed the kai-support branch from 098e2e2 to 3d85dcc Compare June 11, 2024 10:53

jortel commented Jun 11, 2024

View reviewed changes

jortel added 5 commits June 11, 2024 04:29

api changes.

ee5ae6d

Signed-off-by: Jeff Ortel <jortel@redhat.com>

add commit to model.

65e9fa0

Signed-off-by: Jeff Ortel <jortel@redhat.com>

add commit to model.

5730824

Signed-off-by: Jeff Ortel <jortel@redhat.com>

thin analysis struct.

3f22efd

Signed-off-by: Jeff Ortel <jortel@redhat.com>

add filter incident by issueid.

057901d

Signed-off-by: Jeff Ortel <jortel@redhat.com>

jortel force-pushed the kai-support branch from 3d85dcc to 057901d Compare June 11, 2024 11:34

Add commit to hack.

263d578

Signed-off-by: Jeff Ortel <jortel@redhat.com>

mansam approved these changes Jun 11, 2024

View reviewed changes

jortel merged commit 5359ea3 into konveyor:main Jun 11, 2024
11 checks passed

fabianvf mentioned this pull request Jun 18, 2024

✨ Add setting to disable analysis archiver konveyor/operator#339

Merged

This was referenced Jun 22, 2024

operator konveyor-operator (0.5.0-alpha.1) k8s-operatorhub/community-operators#4534

Merged

operator konveyor-operator (0.5.0-alpha.1) redhat-openshift-ecosystem/community-operators-prod#4700

Merged

This was referenced Jul 30, 2024

operator konveyor-operator (0.5.0) k8s-operatorhub/community-operators#4759

Merged

operator konveyor-operator (0.5.0) redhat-openshift-ecosystem/community-operators-prod#4884

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Kai support #631

✨ Kai support #631

jortel commented Apr 29, 2024 •

edited

Loading

jortel May 8, 2024 •

edited

Loading

jortel May 8, 2024

jortel May 8, 2024

jortel Jun 11, 2024

jortel Jun 11, 2024

jortel Jun 11, 2024 •

edited

Loading

jortel Jun 11, 2024

jortel Jun 11, 2024

jortel Jun 11, 2024

mansam left a comment

mansam Jun 11, 2024

mansam Jun 11, 2024

mansam Jun 11, 2024

mansam Jun 11, 2024

mansam Jun 11, 2024

mansam Jun 11, 2024

		@@ -1683,6 +1936,16 @@ func (h AnalysisHandler) appIDs(ctx gin.Context, f qf.Filter) (q *gorm.DB) {
		}

		// analysisIDs provides analysis IDs.

✨ Kai support #631

✨ Kai support #631

Conversation

jortel commented Apr 29, 2024 • edited Loading

jortel May 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jortel Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mansam left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jortel commented Apr 29, 2024 •

edited

Loading

jortel May 8, 2024 •

edited

Loading

jortel Jun 11, 2024 •

edited

Loading