Fixes 4267,4269: add user to template (#699)

rverdile · web-flow · commit c0d2f6bc004c · 2024-06-12T14:23:16.000+01:00
* Fixes 4267: add user to template

* Fixes 4269: add created_at/updated_at to template response
diff --git a/api/docs.go b/api/docs.go
@@ -3948,6 +3948,14 @@ const docTemplate = `{
                     "description": "Architecture of the template",
                     "type": "string"
                 },
+                "created_at": {
+                    "description": "Datetime template was created",
+                    "type": "string"
+                },
+                "created_by": {
+                    "description": "User that created the template",
+                    "type": "string"
+                },
                 "date": {
                     "description": "Latest date to include snapshots for",
                     "type": "string"
@@ -3956,6 +3964,10 @@ const docTemplate = `{
                     "description": "Description of the template",
                     "type": "string"
                 },
+                "last_updated_by": {
+                    "description": "User that most recently updated the template",
+                    "type": "string"
+                },
                 "name": {
                     "description": "Name of the template",
                     "type": "string"
@@ -3975,6 +3987,10 @@ const docTemplate = `{
                     "description": "Environment ID used by subscription-manager and candlepin",
                     "type": "string"
                 },
+                "updated_at": {
+                    "description": "Datetime template was last updated",
+                    "type": "string"
+                },
                 "uuid": {
                     "type": "string",
                     "readOnly": true
diff --git a/api/openapi.json b/api/openapi.json
@@ -1072,6 +1072,14 @@
                         "description": "Architecture of the template",
                         "type": "string"
                     },
+                    "created_at": {
+                        "description": "Datetime template was created",
+                        "type": "string"
+                    },
+                    "created_by": {
+                        "description": "User that created the template",
+                        "type": "string"
+                    },
                     "date": {
                         "description": "Latest date to include snapshots for",
                         "type": "string"
@@ -1080,6 +1088,10 @@
                         "description": "Description of the template",
                         "type": "string"
                     },
+                    "last_updated_by": {
+                        "description": "User that most recently updated the template",
+                        "type": "string"
+                    },
                     "name": {
                         "description": "Name of the template",
                         "type": "string"
@@ -1099,6 +1111,10 @@
                         "description": "Environment ID used by subscription-manager and candlepin",
                         "type": "string"
                     },
+                    "updated_at": {
+                        "description": "Datetime template was last updated",
+                        "type": "string"
+                    },
                     "uuid": {
                         "readOnly": true,
                         "type": "string"
diff --git a/db/migrations.latest b/db/migrations.latest
@@ -1 +1 @@
-20240604140054
+20240610112037
diff --git a/db/migrations/20240610112037_add_user_to_template.down.sql b/db/migrations/20240610112037_add_user_to_template.down.sql
@@ -0,0 +1,7 @@
+BEGIN;
+
+ALTER TABLE templates
+    DROP COLUMN IF EXISTS created_by,
+    DROP COLUMN IF EXISTS last_updated_by;
+
+COMMIT;
diff --git a/db/migrations/20240610112037_add_user_to_template.up.sql b/db/migrations/20240610112037_add_user_to_template.up.sql
@@ -0,0 +1,7 @@
+BEGIN;
+
+ALTER TABLE templates
+    ADD COLUMN IF NOT EXISTS created_by VARCHAR,
+    ADD COLUMN IF NOT EXISTS last_updated_by VARCHAR;
+
+COMMIT;
diff --git a/pkg/api/templates.go b/pkg/api/templates.go
@@ -8,13 +8,14 @@ import (
 
 type TemplateRequest struct {
 	UUID            *string    `json:"uuid" readonly:"true" swaggerignore:"true"`
-	Name            *string    `json:"name"`                                        // Name of the template
-	Description     *string    `json:"description"`                                 // Description of the template
-	RepositoryUUIDS []string   `json:"repository_uuids"`                            // Repositories to add to the template
-	Arch            *string    `json:"arch"`                                        // Architecture of the template
-	Version         *string    `json:"version"`                                     // Version of the template
-	Date            *time.Time `json:"date"`                                        // Latest date to include snapshots for
-	OrgID           *string    `json:"org_id" readonly:"true" swaggerignore:"true"` // Organization ID of the owner
+	Name            *string    `json:"name"`                                            // Name of the template
+	Description     *string    `json:"description"`                                     // Description of the template
+	RepositoryUUIDS []string   `json:"repository_uuids"`                                // Repositories to add to the template
+	Arch            *string    `json:"arch"`                                            // Architecture of the template
+	Version         *string    `json:"version"`                                         // Version of the template
+	Date            *time.Time `json:"date"`                                            // Latest date to include snapshots for
+	OrgID           *string    `json:"org_id" readonly:"true" swaggerignore:"true"`     // Organization ID of the owner
+	User            *string    `json:"created_by" readonly:"true" swaggerignore:"true"` // User creating the template
 }
 
 type TemplateResponse struct {
@@ -27,15 +28,20 @@ type TemplateResponse struct {
 	Date              time.Time `json:"date"`                // Latest date to include snapshots for
 	RepositoryUUIDS   []string  `json:"repository_uuids"`    // Repositories added to the template
 	RHSMEnvironmentID string    `json:"rhsm_environment_id"` // Environment ID used by subscription-manager and candlepin
+	CreatedBy         string    `json:"created_by"`          // User that created the template
+	LastUpdatedBy     string    `json:"last_updated_by"`     // User that most recently updated the template
+	CreatedAt         time.Time `json:"created_at"`          // Datetime template was created
+	UpdatedAt         time.Time `json:"updated_at"`          // Datetime template was last updated
 }
 
 // We use a separate struct because name, version, arch cannot be updated
 type TemplateUpdateRequest struct {
 	UUID            *string    `json:"uuid" readonly:"true" swaggerignore:"true"`
-	Description     *string    `json:"description"`                                 // Description of the template
-	RepositoryUUIDS []string   `json:"repository_uuids"`                            // Repositories to add to the template
-	Date            *time.Time `json:"date"`                                        // Latest date to include snapshots for
-	OrgID           *string    `json:"org_id" readonly:"true" swaggerignore:"true"` // Organization ID of the owner
+	Description     *string    `json:"description"`                                          // Description of the template
+	RepositoryUUIDS []string   `json:"repository_uuids"`                                     // Repositories to add to the template
+	Date            *time.Time `json:"date"`                                                 // Latest date to include snapshots for
+	OrgID           *string    `json:"org_id" readonly:"true" swaggerignore:"true"`          // Organization ID of the owner
+	User            *string    `json:"last_updated_by" readonly:"true" swaggerignore:"true"` // User creating the template
 }
 
 type TemplateCollectionResponse struct {
diff --git a/pkg/dao/templates.go b/pkg/dao/templates.go
@@ -70,7 +70,7 @@ func (t templateDaoImpl) create(ctx context.Context, tx *gorm.DB, reqTemplate ap
 	}
 
 	// Create a template
-	templatesApiToModel(reqTemplate, &modelTemplate)
+	templatesCreateApiToModel(reqTemplate, &modelTemplate)
 	err := tx.Create(&modelTemplate).Error
 	if err != nil {
 		return api.TemplateResponse{}, t.DBToApiError(err)
@@ -411,7 +411,7 @@ func (t templateDaoImpl) UpdateDistributionHrefs(ctx context.Context, templateUU
 	return nil
 }
 
-func templatesApiToModel(api api.TemplateRequest, model *models.Template) {
+func templatesCreateApiToModel(api api.TemplateRequest, model *models.Template) {
 	if api.Name != nil {
 		model.Name = *api.Name
 	}
@@ -430,6 +430,10 @@ func templatesApiToModel(api api.TemplateRequest, model *models.Template) {
 	if api.OrgID != nil {
 		model.OrgID = *api.OrgID
 	}
+	if api.User != nil {
+		model.CreatedBy = *api.User
+		model.LastUpdatedBy = *api.User
+	}
 }
 
 func templatesUpdateApiToModel(api api.TemplateUpdateRequest, model *models.Template) {
@@ -442,6 +446,9 @@ func templatesUpdateApiToModel(api api.TemplateUpdateRequest, model *models.Temp
 	if api.OrgID != nil {
 		model.OrgID = *api.OrgID
 	}
+	if api.User != nil {
+		model.LastUpdatedBy = *api.User
+	}
 }
 
 func templatesModelToApi(model models.Template, api *api.TemplateResponse) {
@@ -457,6 +464,10 @@ func templatesModelToApi(model models.Template, api *api.TemplateResponse) {
 	for _, repoConfig := range model.RepositoryConfigurations {
 		api.RepositoryUUIDS = append(api.RepositoryUUIDS, repoConfig.UUID)
 	}
+	api.CreatedBy = model.CreatedBy
+	api.LastUpdatedBy = model.LastUpdatedBy
+	api.CreatedAt = model.CreatedAt
+	api.UpdatedAt = model.UpdatedAt
 }
 
 func templatesConvertToResponses(templates []models.Template) []api.TemplateResponse {
diff --git a/pkg/dao/templates_test.go b/pkg/dao/templates_test.go
@@ -81,6 +81,7 @@ func (s *TemplateSuite) TestCreateDeleteCreateSameName() {
 		Version:         pointy.String(config.El8),
 		Date:            &timeNow,
 		OrgID:           &orgID,
+		User:            pointy.String("user"),
 	}
 
 	respTemplate, err := templateDao.Create(context.Background(), reqTemplate)
@@ -105,6 +106,8 @@ func (s *TemplateSuite) TestCreateDeleteCreateSameName() {
 	assert.Equal(s.T(), *reqTemplate.Arch, respTemplate.Arch)
 	assert.Equal(s.T(), *reqTemplate.Version, respTemplate.Version)
 	assert.Len(s.T(), reqTemplate.RepositoryUUIDS, 2)
+	assert.Equal(s.T(), *reqTemplate.User, respTemplate.CreatedBy)
+	assert.Equal(s.T(), *reqTemplate.User, respTemplate.LastUpdatedBy)
 }
 
 func (s *TemplateSuite) TestFetch() {
@@ -122,6 +125,10 @@ func (s *TemplateSuite) TestFetch() {
 	assert.Equal(s.T(), found.Name, resp.Name)
 	assert.Equal(s.T(), found.OrgID, resp.OrgID)
 	assert.Equal(s.T(), candlepin_client.GetEnvironmentID(resp.UUID), resp.RHSMEnvironmentID)
+	assert.Equal(s.T(), found.LastUpdatedBy, resp.LastUpdatedBy)
+	assert.Equal(s.T(), found.CreatedBy, resp.CreatedBy)
+	assert.Equal(s.T(), found.CreatedAt, resp.CreatedAt)
+	assert.Equal(s.T(), found.UpdatedAt, resp.UpdatedAt)
 }
 
 func (s *TemplateSuite) TestFetchNotFound() {
@@ -151,18 +158,22 @@ func (s *TemplateSuite) TestList() {
 	var found []models.Template
 	var total int64
 
-	s.seedWithRepoConfig(orgIDTest)
+	s.seedWithRepoConfig(orgIDTest, 1)
 
 	err = s.tx.Where("org_id = ?", orgIDTest).Find(&found).Count(&total).Error
 	assert.NoError(s.T(), err)
-	assert.Equal(s.T(), int64(2), total)
+	assert.Equal(s.T(), int64(1), total)
 
 	responses, total, err := templateDao.List(context.Background(), orgIDTest, api.PaginationData{Limit: -1}, api.TemplateFilterData{})
 	assert.NoError(s.T(), err)
-	assert.Equal(s.T(), int64(2), total)
-	assert.Len(s.T(), responses.Data, 2)
+	assert.Equal(s.T(), int64(1), total)
+	assert.Len(s.T(), responses.Data, 1)
 	assert.Len(s.T(), responses.Data[0].RepositoryUUIDS, 2)
 	assert.Equal(s.T(), candlepin_client.GetEnvironmentID(responses.Data[0].UUID), responses.Data[0].RHSMEnvironmentID)
+	assert.Equal(s.T(), responses.Data[0].CreatedBy, found[0].CreatedBy)
+	assert.Equal(s.T(), responses.Data[0].LastUpdatedBy, found[0].LastUpdatedBy)
+	assert.Equal(s.T(), responses.Data[0].CreatedAt, found[0].CreatedAt)
+	assert.Equal(s.T(), responses.Data[0].UpdatedAt, found[0].UpdatedAt)
 }
 
 func (s *TemplateSuite) TestListNoTemplates() {
@@ -253,7 +264,7 @@ func (s *TemplateSuite) TestListFilters() {
 	assert.Equal(s.T(), found[0].Arch, responses.Data[0].Arch)
 
 	// Test Filter by RepositoryUUIDs
-	template, rcUUIDs := s.seedWithRepoConfig(orgIDTest)
+	template, rcUUIDs := s.seedWithRepoConfig(orgIDTest, 2)
 	filterData = api.TemplateFilterData{RepositoryUUIDs: []string{rcUUIDs[0]}}
 	responses, total, err = templateDao.List(context.Background(), orgIDTest, api.PaginationData{Limit: -1}, filterData)
 	assert.NoError(s.T(), err)
@@ -390,22 +401,22 @@ func (s *TemplateSuite) fetchTemplate(uuid string) models.Template {
 	return found
 }
 
-func (s *TemplateSuite) seedWithRepoConfig(orgId string) (models.Template, []string) {
+func (s *TemplateSuite) seedWithRepoConfig(orgId string, templateSize int) (models.Template, []string) {
 	err := seeds.SeedRepositoryConfigurations(s.tx, 2, seeds.SeedOptions{OrgID: orgId})
 	require.NoError(s.T(), err)
 
 	var rcUUIDs []string
 	err = s.tx.Model(models.RepositoryConfiguration{}).Where("org_id = ?", orgIDTest).Select("uuid").Find(&rcUUIDs).Error
 	require.NoError(s.T(), err)
 
-	templates, err := seeds.SeedTemplates(s.tx, 2, seeds.TemplateSeedOptions{OrgID: orgId, RepositoryConfigUUIDs: rcUUIDs})
+	templates, err := seeds.SeedTemplates(s.tx, templateSize, seeds.TemplateSeedOptions{OrgID: orgId, RepositoryConfigUUIDs: rcUUIDs})
 	require.NoError(s.T(), err)
 
 	return templates[0], rcUUIDs
 }
 
 func (s *TemplateSuite) TestUpdate() {
-	origTempl, rcUUIDs := s.seedWithRepoConfig(orgIDTest)
+	origTempl, rcUUIDs := s.seedWithRepoConfig(orgIDTest, 2)
 
 	templateDao := templateDaoImpl{db: s.tx}
 	_, err := templateDao.Update(context.Background(), orgIDTest, origTempl.UUID, api.TemplateUpdateRequest{Description: pointy.Pointer("scratch"), RepositoryUUIDS: []string{rcUUIDs[0]}})
@@ -424,6 +435,11 @@ func (s *TemplateSuite) TestUpdate() {
 
 	_, err = templateDao.Update(context.Background(), orgIDTest, found.UUID, api.TemplateUpdateRequest{RepositoryUUIDS: []string{"Notarealrepouuid"}})
 	assert.Error(s.T(), err)
+
+	_, err = templateDao.Update(context.Background(), orgIDTest, found.UUID, api.TemplateUpdateRequest{RepositoryUUIDS: []string{rcUUIDs[1]}, User: pointy.Pointer("new user")})
+	require.NoError(s.T(), err)
+	found = s.fetchTemplate(origTempl.UUID)
+	assert.Equal(s.T(), "new user", found.LastUpdatedBy)
 }
 
 func (s *TemplateSuite) TestGetRepoChanges() {
diff --git a/pkg/handler/templates.go b/pkg/handler/templates.go
@@ -15,6 +15,7 @@ import (
 	"github.com/content-services/content-sources-backend/pkg/tasks/queue"
 	"github.com/google/uuid"
 	"github.com/labstack/echo/v4"
+	"github.com/redhatinsights/platform-go-middlewares/v2/identity"
 	"github.com/rs/zerolog/log"
 )
 
@@ -71,6 +72,9 @@ func (th *TemplateHandler) createTemplate(c echo.Context) error {
 	_, orgID := getAccountIdOrgId(c)
 	newTemplate.OrgID = &orgID
 
+	user := getUser(c)
+	newTemplate.User = &user
+
 	respTemplate, err := th.DaoRegistry.Template.Create(c.Request().Context(), newTemplate)
 	if err != nil {
 		return ce.NewErrorResponse(ce.HttpCodeForDaoError(err), "Error creating template", err.Error())
@@ -187,6 +191,9 @@ func (th *TemplateHandler) update(c echo.Context, fillDefaults bool) error {
 	tempParams := api.TemplateUpdateRequest{}
 	_, orgID := getAccountIdOrgId(c)
 
+	user := getUser(c)
+	tempParams.User = &user
+
 	if err := c.Bind(&tempParams); err != nil {
 		return ce.NewErrorResponse(http.StatusBadRequest, "Error binding parameters", err.Error())
 	}
@@ -303,3 +310,11 @@ func (th *TemplateHandler) enqueueUpdateTemplateContentEvent(c echo.Context, tem
 	}
 	return taskID
 }
+
+func getUser(c echo.Context) string {
+	id := identity.Get(c.Request().Context())
+	if id.Identity.User != nil {
+		return id.Identity.User.Username
+	}
+	return ""
+}
diff --git a/pkg/handler/templates_test.go b/pkg/handler/templates_test.go
@@ -76,6 +76,7 @@ func (suite *TemplatesSuite) TestCreate() {
 		Arch:            pointy.Pointer(config.AARCH64),
 		Version:         pointy.Pointer(config.El8),
 		OrgID:           &orgID,
+		User:            pointy.Pointer("user"),
 	}
 
 	expected := api.TemplateResponse{
diff --git a/pkg/models/template.go b/pkg/models/template.go
@@ -10,13 +10,15 @@ import (
 
 type Template struct {
 	Base
-	Name                     string                    `gorm:"not null;default:null"`
-	OrgID                    string                    `gorm:"default:null"`
-	Description              string                    `gorm:"default:null"`
-	Date                     time.Time                 `gorm:"default:null"`
-	Version                  string                    `gorm:"default:null"`
-	Arch                     string                    `gorm:"default:null"`
-	DeletedAt                gorm.DeletedAt            `json:"deleted_at"`
+	Name                     string         `gorm:"not null;default:null"`
+	OrgID                    string         `gorm:"default:null"`
+	Description              string         `gorm:"default:null"`
+	Date                     time.Time      `gorm:"default:null"`
+	Version                  string         `gorm:"default:null"`
+	Arch                     string         `gorm:"default:null"`
+	DeletedAt                gorm.DeletedAt `json:"deleted_at"`
+	CreatedBy                string
+	LastUpdatedBy            string
 	RepositoryConfigurations []RepositoryConfiguration `gorm:"many2many:templates_repository_configurations"`
 }
 
@@ -61,5 +63,6 @@ func (t *Template) MapForUpdate() map[string]interface{} {
 	// Name, version, arch cannot be updated
 	forUpdate["description"] = t.Description
 	forUpdate["date"] = t.Date
+	forUpdate["last_updated_by"] = t.LastUpdatedBy
 	return forUpdate
 }
diff --git a/pkg/seeds/seeds.go b/pkg/seeds/seeds.go
@@ -224,12 +224,14 @@ func SeedTemplates(db *gorm.DB, size int, options TemplateSeedOptions) ([]models
 			Base: models.Base{
 				UUID: uuid.NewString(),
 			},
-			Name:        RandStringBytes(10),
-			OrgID:       orgID,
-			Description: "description",
-			Date:        time.Now(),
-			Version:     createVersion(options.Version),
-			Arch:        createArch(options.Arch),
+			Name:          RandStringBytes(10),
+			OrgID:         orgID,
+			Description:   "description",
+			Date:          time.Now(),
+			Version:       createVersion(options.Version),
+			Arch:          createArch(options.Arch),
+			CreatedBy:     "user",
+			LastUpdatedBy: "user",
 		}
 		err := db.Create(&t).Error
 		if err != nil {
diff --git a/pkg/test/handler/utils.go b/pkg/test/handler/utils.go
@@ -17,6 +17,7 @@ var MockIdentity = identity.XRHID{
 		Internal: identity.Internal{
 			OrgID: MockOrgId,
 		},
+		User: &identity.User{Username: "user"},
 		Type: "Associate",
 	},
 }

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ func (t templateDaoImpl) create(ctx context.Context, tx *gorm.DB, reqTemplate ap`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`// Create a template`
`73`		`- templatesApiToModel(reqTemplate, &modelTemplate)`
	`73`	`+ templatesCreateApiToModel(reqTemplate, &modelTemplate)`
`74`	`74`	`err := tx.Create(&modelTemplate).Error`
`75`	`75`	`if err != nil {`
`76`	`76`	`return api.TemplateResponse{}, t.DBToApiError(err)`
`@@ -411,7 +411,7 @@ func (t templateDaoImpl) UpdateDistributionHrefs(ctx context.Context, templateUU`
`411`	`411`	`return nil`
`412`	`412`	`}`
`413`	`413`
`414`		`-func templatesApiToModel(api api.TemplateRequest, model *models.Template) {`
	`414`	`+func templatesCreateApiToModel(api api.TemplateRequest, model *models.Template) {`
`415`	`415`	`if api.Name != nil {`
`416`	`416`	`model.Name = *api.Name`
`417`	`417`	`}`
`@@ -430,6 +430,10 @@ func templatesApiToModel(api api.TemplateRequest, model *models.Template) {`
`430`	`430`	`if api.OrgID != nil {`
`431`	`431`	`model.OrgID = *api.OrgID`
`432`	`432`	`}`
	`433`	`+ if api.User != nil {`
	`434`	`+ model.CreatedBy = *api.User`
	`435`	`+ model.LastUpdatedBy = *api.User`
	`436`	`+ }`
`433`	`437`	`}`
`434`	`438`
`435`	`439`	`func templatesUpdateApiToModel(api api.TemplateUpdateRequest, model *models.Template) {`
`@@ -442,6 +446,9 @@ func templatesUpdateApiToModel(api api.TemplateUpdateRequest, model *models.Temp`
`442`	`446`	`if api.OrgID != nil {`
`443`	`447`	`model.OrgID = *api.OrgID`
`444`	`448`	`}`
	`449`	`+ if api.User != nil {`
	`450`	`+ model.LastUpdatedBy = *api.User`
	`451`	`+ }`
`445`	`452`	`}`
`446`	`453`
`447`	`454`	`func templatesModelToApi(model models.Template, api *api.TemplateResponse) {`
`@@ -457,6 +464,10 @@ func templatesModelToApi(model models.Template, api *api.TemplateResponse) {`
`457`	`464`	`for _, repoConfig := range model.RepositoryConfigurations {`
`458`	`465`	`api.RepositoryUUIDS = append(api.RepositoryUUIDS, repoConfig.UUID)`
`459`	`466`	`}`
	`467`	`+ api.CreatedBy = model.CreatedBy`
	`468`	`+ api.LastUpdatedBy = model.LastUpdatedBy`
	`469`	`+ api.CreatedAt = model.CreatedAt`
	`470`	`+ api.UpdatedAt = model.UpdatedAt`
`460`	`471`	`}`
`461`	`472`
`462`	`473`	`func templatesConvertToResponses(templates []models.Template) []api.TemplateResponse {`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ func (suite *TemplatesSuite) TestCreate() {`
`76`	`76`	`Arch: pointy.Pointer(config.AARCH64),`
`77`	`77`	`Version: pointy.Pointer(config.El8),`
`78`	`78`	`OrgID: &orgID,`
	`79`	`+ User: pointy.Pointer("user"),`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`expected := api.TemplateResponse{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ var MockIdentity = identity.XRHID{`
`17`	`17`	`Internal: identity.Internal{`
`18`	`18`	`OrgID: MockOrgId,`
`19`	`19`	`},`
	`20`	`+ User: &identity.User{Username: "user"},`
`20`	`21`	`Type: "Associate",`
`21`	`22`	`},`
`22`	`23`	`}`