plan approval (#1327)

Author: motatoes

backend/controllers/runs.go

@@ -10,6 +10,7 @@ import (
 	"log"
 	"net/http"
 	"strconv"
+	"time"
 )
 
 func RunsForProject(c *gin.Context) {
@@ -127,3 +128,72 @@ func RunDetails(c *gin.Context) {
 	}
 	c.JSON(http.StatusOK, response)
 }
+
+func ApproveRun(c *gin.Context) {
+
+	currentOrg, exists := c.Get(middleware.ORGANISATION_ID_KEY)
+	runIdStr := c.Param("run_id")
+
+	if runIdStr == "" {
+		c.String(http.StatusBadRequest, "RunID not specified")
+		return
+	}
+
+	runId, err := strconv.Atoi(runIdStr)
+	if err != nil {
+		c.String(http.StatusBadRequest, "Invalid RunId")
+		return
+	}
+
+	if !exists {
+		c.String(http.StatusForbidden, "Not allowed to access this resource")
+		return
+	}
+
+	var org models.Organisation
+	err = models.DB.GormDB.Where("id = ?", currentOrg).First(&org).Error
+	if err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			c.String(http.StatusNotFound, fmt.Sprintf("Could not find organisation: %v", currentOrg))
+		} else {
+			c.String(http.StatusInternalServerError, "Unknown error occurred while fetching database")
+		}
+		return
+	}
+
+	run, err := models.DB.GetDiggerRun(uint(runId))
+	if err != nil {
+		log.Printf("Could not fetch run: %v", err)
+		c.String(http.StatusBadRequest, "Could not fetch run, please check that it exists")
+	}
+	if run.Repo.OrganisationID != org.ID {
+		c.String(http.StatusForbidden, "Not allowed to access this resource")
+		return
+	}
+
+	if run.Status != models.RunPendingApproval {
+		log.Printf("Run status not ready for approval: %v", run.ID)
+		c.String(http.StatusBadRequest, "Approval not possible for run (%v) because status is %v", run.ID, run.Status)
+		return
+	}
+
+	if run.IsApproved == false {
+		run.ApprovalAuthor = "a_user"
+		run.IsApproved = true
+		run.ApprovalDate = time.Now()
+		err := models.DB.UpdateDiggerRun(run)
+		if err != nil {
+			log.Printf("Could update run: %v", err)
+			c.String(http.StatusInternalServerError, "Could not update approval")
+		}
+	} else {
+		log.Printf("Run has already been approved")
+	}
+
+	response, err := run.MapToJsonStruct()
+	if err != nil {
+		c.String(http.StatusInternalServerError, "Could not unmarshall data")
+		return
+	}
+	c.JSON(http.StatusOK, response)
+}

backend/main.go

@@ -170,6 +170,7 @@ func main() {
 	runsApiGroup := apiGroup.Group("/runs")
 	runsApiGroup.Use(middleware.GetWebMiddleware())
 	runsApiGroup.GET("/:run_id", controllers.RunDetails)
+	runsApiGroup.POST("/:run_id/approve", controllers.ApproveRun)
 
 	fronteggWebhookProcessor.POST("/create-org-from-frontegg", controllers.CreateFronteggOrgFromWebhook)
 

backend/migrations/20240405150942.sql

@@ -0,0 +1,2 @@
+-- Modify "digger_runs" table
+ALTER TABLE "public"."digger_runs" ADD COLUMN "is_approved" boolean NULL, ADD COLUMN "approval_author" text NULL, ADD COLUMN "approval_date" timestamptz NULL;

backend/migrations/atlas.sum

@@ -1,4 +1,4 @@
-h1:xkkYzycO+Sb/rIvE5VwTvzTb6dA6kyuQQ1/ZT/Oy9no=
+h1:ksWZreAh93d05Lo6QT68Dm9v5UNw2aFgtP0wiLz+J34=
 20231227132525.sql h1:43xn7XC0GoJsCnXIMczGXWis9d504FAWi4F1gViTIcw=
 20240115170600.sql h1:IW8fF/8vc40+eWqP/xDK+R4K9jHJ9QBSGO6rN9LtfSA=
 20240116123649.sql h1:R1JlUIgxxF6Cyob9HdtMqiKmx/BfnsctTl5rvOqssQw=
@@ -15,3 +15,4 @@ h1:xkkYzycO+Sb/rIvE5VwTvzTb6dA6kyuQQ1/ZT/Oy9no=
 20240404161121.sql h1:ZbMLfHRom6Tws+2M3BcnMu1lcjz/YFwAI8kGmC+I+H4=
 20240404161723.sql h1:z3bJcKs0ZJSyTJewqgE0GSHpn33sX7zgc2rmCMF99Qo=
 20240404165910.sql h1:ofwrBzkvnxFz7sOrtaF3vb2xHsenPmUTSSBHvO1NEdI=
+20240405150942.sql h1:0JIQlXqQmfgfBcill47gAef3LnnfdwK6ry98eHraUbo=

backend/models/runs.go

@@ -51,6 +51,9 @@ type DiggerRun struct {
 	PlanStageId          *uint
 	ApplyStage           DiggerRunStage
 	ApplyStageId         *uint
+	IsApproved           bool
+	ApprovalAuthor       string
+	ApprovalDate         time.Time
 }
 
 type DiggerRunStage struct {
@@ -89,18 +92,21 @@ func (r *DiggerRun) MapToJsonStruct() (interface{}, error) {
 		Status                string             `json:"status"`
 		Type                  string             `json:"type"`
 		ApprovalAuthor        string             `json:"approval_author"`
-		ApprovalStatus        string             `json:"approval_status"`
 		ApprovalDate          string             `json:"approval_date"`
 		LastActivityTimeStamp string             `json:"last_activity_time_stamp"`
 		PlanStage             SerializedRunStage `json:"plan_stage"`
 		ApplyStage            SerializedRunStage `json:"apply_stage"`
+		IsApproved            bool               `json:"is_approved"`
 	}{
 		Id:                    r.ID,
 		Status:                string(r.Status),
 		Type:                  string(r.RunType),
 		LastActivityTimeStamp: r.UpdatedAt.String(),
 		PlanStage:             *planStage,
 		ApplyStage:            *applyStage,
+		IsApproved:            r.IsApproved,
+		ApprovalAuthor:        r.ApprovalAuthor,
+		ApprovalDate:          r.ApprovalDate.String(),
 	}
 
 	return x, nil

backend/models/storage.go

@@ -699,6 +699,7 @@ func (db *Database) CreateDiggerRun(Triggertype string, PrNumber int, Status Dig
 		RunType:              RunType,
 		PlanStageId:          planStageId,
 		ApplyStageId:         applyStageId,
+		IsApproved:           false,
 	}
 	result := db.GormDB.Save(dr)
 	if result.Error != nil {