Fixes 4825: add template attribute for when env is created (#846)

Fixes 4825: provide template attribute for when env is created

Author: jlsherrill

api/docs.go

@@ -4741,6 +4741,11 @@ const docTemplate = `{
                         "type": "string"
                     }
                 },
+                "rhsm_environment_created": {
+                    "description": "Whether the candlepin environment is created and systems can be added",
+                    "type": "boolean",
+                    "readOnly": true
+                },
                 "rhsm_environment_id": {
                     "description": "Environment ID used by subscription-manager and candlepin",
                     "type": "string"

api/openapi.json

@@ -1434,6 +1434,11 @@
                         },
                         "type": "array"
                     },
+                    "rhsm_environment_created": {
+                        "description": "Whether the candlepin environment is created and systems can be added",
+                        "readOnly": true,
+                        "type": "boolean"
+                    },
                     "rhsm_environment_id": {
                         "description": "Environment ID used by subscription-manager and candlepin",
                         "type": "string"

db/migrations.latest

@@ -1 +1 @@
-20240919154238
+20241011084507

db/migrations/20241011084507_AddEnvironmentCreated.down.sql

@@ -0,0 +1,5 @@
+BEGIN;
+
+alter table templates drop column rhsm_environment_created;
+
+COMMIT;

db/migrations/20241011084507_AddEnvironmentCreated.up.sql

@@ -0,0 +1,7 @@
+BEGIN;
+
+alter table templates add column rhsm_environment_created boolean NOT NULL DEFAULT false;
+update templates set rhsm_environment_created = true
+                 where templates.uuid in (select object_uuid from tasks where type = 'update-template-content' and status = 'completed');
+
+COMMIT;

pkg/api/templates.go

@@ -23,23 +23,24 @@ type TemplateRequest struct {
 
 type TemplateResponse struct {
 	UUID                    string            `json:"uuid" readonly:"true"`
-	Name                    string            `json:"name"`                            // Name of the template
-	OrgID                   string            `json:"org_id"`                          // Organization ID of the owner
-	Description             string            `json:"description"`                     // Description of 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
-	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
-	DeletedAt               gorm.DeletedAt    `json:"-" swaggerignore:"true"`          // Datetime template was deleted
-	UseLatest               bool              `json:"use_latest"`                      // Use latest snapshot for all repositories in the template
-	LastUpdateSnapshotError string            `json:"last_update_snapshot_error"`      // Error of last update_latest_snapshot task that updated the template
-	LastUpdateTaskUUID      string            `json:"last_update_task_uuid,omitempty"` // UUID of the last update_template_content task that updated the template
-	LastUpdateTask          *TaskInfoResponse `json:"last_update_task,omitempty"`      // Response of last update_template_content task that updated the template
+	Name                    string            `json:"name"`                                     // Name of the template
+	OrgID                   string            `json:"org_id"`                                   // Organization ID of the owner
+	Description             string            `json:"description"`                              // Description of 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
+	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
+	DeletedAt               gorm.DeletedAt    `json:"-" swaggerignore:"true"`                   // Datetime template was deleted
+	UseLatest               bool              `json:"use_latest"`                               // Use latest snapshot for all repositories in the template
+	LastUpdateSnapshotError string            `json:"last_update_snapshot_error"`               // Error of last update_latest_snapshot task that updated the template
+	LastUpdateTaskUUID      string            `json:"last_update_task_uuid,omitempty"`          // UUID of the last update_template_content task that updated the template
+	LastUpdateTask          *TaskInfoResponse `json:"last_update_task,omitempty"`               // Response of last update_template_content task that updated the template
+	RHSMEnvironmentCreated  bool              `json:"rhsm_environment_created" readonly:"true"` // Whether the candlepin environment is created and systems can be added
 }
 
 // We use a separate struct because version and arch cannot be updated