Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Apply Questionnaire seeds #496

Merged
merged 1 commit into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ require (
github.com/golang-jwt/jwt/v4 v4.5.0
github.com/google/uuid v1.3.0
github.com/jortel/go-utils v0.1.1
github.com/konveyor/tackle2-seed v0.0.0-20230731150314-953199a73e93
github.com/konveyor/tackle2-seed v0.0.0-20230928184719-4a383c5aa887
github.com/mattn/go-sqlite3 v1.14.17
github.com/onsi/gomega v1.27.6
github.com/prometheus/client_golang v1.15.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
github.com/klauspost/cpuid/v2 v2.0.9 h1:lgaqFMSdTdQYdZ04uHyN2d/eKdOMyi2YLSvlQIBFYa4=
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
github.com/konveyor/tackle2-seed v0.0.0-20230731150314-953199a73e93 h1:uMJnrcH2+luiLf1l7skj5kBJSEffbhyl41uvXA+JKUQ=
github.com/konveyor/tackle2-seed v0.0.0-20230731150314-953199a73e93/go.mod h1:4yas66RZJudLqkehmiFeQZ6NDgXk+XutksjoKFx8JzY=
github.com/konveyor/tackle2-seed v0.0.0-20230928184719-4a383c5aa887 h1:LF8F78Oz/S7K0LakDWrjMaoeBMs5tYj2ntcf73u+gt0=
github.com/konveyor/tackle2-seed v0.0.0-20230928184719-4a383c5aa887/go.mod h1:wt9Zb1l1PAd+XxW03KTp8z4dth3DkCDsRrcdZSWTyjA=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
Expand Down
2 changes: 1 addition & 1 deletion seed/jobfunction.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func (r *JobFunction) Apply(db *gorm.DB) (err error) {
return
}
}
} else {
} else if !found {
jobFunction, found, fErr = r.find(db, "name = ?", jf.Name)
if fErr != nil {
err = fErr
Expand Down
132 changes: 132 additions & 0 deletions seed/questionnaire.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
package seed

import (
"encoding/json"
"errors"
"fmt"
liberr "github.com/jortel/go-utils/error"
"github.com/konveyor/tackle2-hub/model"
libseed "github.com/konveyor/tackle2-seed/pkg"
"gorm.io/gorm"
)

//
// Questionnaire applies Questionnaire seeds.
type Questionnaire struct {
questionnaires []libseed.Questionnaire
}

//
// With collects all the Questionnaire seeds.
func (r *Questionnaire) With(seed libseed.Seed) (err error) {
items, err := seed.DecodeItems()
if err != nil {
return
}
for _, item := range items {
r.questionnaires = append(r.questionnaires, item.(libseed.Questionnaire))
}
return
}

//
// Apply seeds the database with Questionnaires.
func (r *Questionnaire) Apply(db *gorm.DB) (err error) {
log.Info("Applying Questionnaires", "count", len(r.questionnaires))
for i := range r.questionnaires {
q := r.questionnaires[i]
questionnaire, found, fErr := r.find(db, "uuid = ?", q.UUID)
if fErr != nil {
err = fErr
return
}
// model exists and is being renamed
if found && questionnaire.Name != q.Name {
// ensure that the target name is clear
collision, collides, fErr := r.find(db, "name = ? and id != ?", q.Name, questionnaire.ID)
if fErr != nil {
err = fErr
return
}
if collides {
err = r.rename(db, collision)
if err != nil {
return
}
}
} else if !found {
questionnaire, found, fErr = r.find(db, "name = ?", q.Name)
if fErr != nil {
err = fErr
return
}
if found && questionnaire.CreateUser != "" {
err = r.rename(db, questionnaire)
if err != nil {
return
}
found = false
}
if !found {
// only set the required flag on first seed so that
// we don't e.g. turn it back on when reseeding to
// fix a typo in the questionnaire or etc.
questionnaire = &model.Questionnaire{}
questionnaire.Required = q.Required
}
}

questionnaire.Name = q.Name
questionnaire.UUID = &q.UUID
questionnaire.Description = q.Description
questionnaire.Sections, _ = json.Marshal(q.Sections)
questionnaire.RiskMessages, _ = json.Marshal(q.RiskMessages)
questionnaire.Thresholds, _ = json.Marshal(q.Thresholds)
result := db.Save(&questionnaire)
if result.Error != nil {
err = liberr.Wrap(result.Error)
return
}
}
return
}

//
// Convenience method to find a Questionnaire.
func (r *Questionnaire) find(db *gorm.DB, conditions ...interface{}) (q *model.Questionnaire, found bool, err error) {
q = &model.Questionnaire{}
result := db.First(q, conditions...)
if result.Error != nil {
if errors.Is(result.Error, gorm.ErrRecordNotFound) {
return
}
err = liberr.Wrap(result.Error)
return
}
found = true
return
}

//
// Rename a Questionnaire by adding a suffix.
func (r *Questionnaire) rename(db *gorm.DB, q *model.Questionnaire) (err error) {
suffix := 0
for {
suffix++
newName := fmt.Sprintf("%s (%d)", q.Name, suffix)
_, found, fErr := r.find(db, "name = ?", newName)
if fErr != nil {
err = fErr
return
}
if !found {
q.Name = newName
result := db.Save(q)
if result.Error != nil {
err = liberr.Wrap(result.Error)
return
}
return
}
}
}
2 changes: 1 addition & 1 deletion seed/ruleset.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func (r *RuleSet) Apply(db *gorm.DB) (err error) {
return
}
}
} else {
} else if !found {
ruleSet, found, fErr = r.find(db, "name = ?", rs.Name)
if fErr != nil {
err = fErr
Expand Down
7 changes: 7 additions & 0 deletions seed/seed.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ type Hub struct {
JobFunction
RuleSet
Target
Questionnaire
}

//
Expand All @@ -32,6 +33,8 @@ func (r *Hub) With(seed libseed.Seed) (err error) {
err = r.RuleSet.With(seed)
case libseed.KindTarget:
err = r.Target.With(seed)
case libseed.KindQuestionnaire:
err = r.Questionnaire.With(seed)
default:
err = liberr.New("unknown kind", "kind", seed.Kind, "file", seed.Filename())
}
Expand All @@ -57,6 +60,10 @@ func (r *Hub) Apply(db *gorm.DB) (err error) {
if err != nil {
return
}
err = r.Questionnaire.Apply(db)
if err != nil {
return
}

return
}
Expand Down
2 changes: 1 addition & 1 deletion seed/tag.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func (r *TagCategory) Apply(db *gorm.DB) (err error) {
return
}
}
} else {
} else if !found {
category, found, fErr = r.find(db, "name = ?", tc.Name)
if fErr != nil {
err = fErr
Expand Down
2 changes: 1 addition & 1 deletion seed/target.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func (r *Target) Apply(db *gorm.DB) (err error) {
return
}
}
} else {
} else if !found {
target, found, fErr = r.find(db, "name = ?", t.Name)
if fErr != nil {
err = fErr
Expand Down