feat!: db driven platform settings

api/admin/settings.go

@@ -0,0 +1,148 @@
+// SPDX-License-Identifier: Apache-2.0
+
+//nolint:dupl // ignore similar code
+package admin
+
+import (
+	"fmt"
+	"net/http"
+	"strings"
+
+	"github.com/gin-gonic/gin"
+	settings "github.com/go-vela/server/api/types/settings"
+	"github.com/go-vela/server/database"
+	sMiddleware "github.com/go-vela/server/router/middleware/settings"
+	"github.com/go-vela/server/util"
+	"github.com/sirupsen/logrus"
+)
+
+// swagger:operation GET /api/v1/admin/settings admin GetSettings
+//
+// Get the currently configured settings.
+//
+// ---
+// produces:
+// - application/json
+// security:
+//   - ApiKeyAuth: []
+// responses:
+//   '200':
+//     description: Successfully retrieved settings from the database
+//     schema:
+//       type: array
+//       items:
+//         "$ref": "#/definitions/Settings"
+//   '500':
+//     description: Unable to retrieve settings from the database
+//     schema:
+//       "$ref": "#/definitions/Error"
+
+// GetSettings represents the API handler to
+// captures settings stored in the database.
+func GetSettings(c *gin.Context) {
+	// capture middleware values
+	s := sMiddleware.FromContext(c)
+
+	logrus.Info("Admin: reading settings")
+
+	output := strings.ToLower(c.Query("output"))
+
+	switch output {
+	case "env":
+		exported := s.ToEnv()
+		c.String(http.StatusOK, exported)
+	case "yaml":
+		exported := s.ToYAML()
+		c.String(http.StatusOK, exported)
+	case "json":
+		fallthrough
+	default:
+		c.JSON(http.StatusOK, s)
+	}
+}
+
+// swagger:operation PUT /api/v1/admin/settings admin AdminUpdateSettings
+//
+// Update the settings singleton in the database
+//
+// ---
+// produces:
+// - application/json
+// parameters:
+// - in: body
+//   name: body
+//   description: Payload containing settings to update
+//   required: true
+//   schema:
+//     "$ref": "#/definitions/Settings"
+// security:
+//   - ApiKeyAuth: []
+// responses:
+//   '200':
+//     description: Successfully updated the settings in the database
+//     schema:
+//       "$ref": "#/definitions/Settings"
+//   '404':
+//     description: Unable to update the settings in the database
+//     schema:
+//       "$ref": "#/definitions/Error"
+//   '501':
+//     description: Unable to update the settings in the database
+//     schema:
+//       "$ref": "#/definitions/Error"
+
+// UpdateSettings represents the API handler to
+// update the settings singleton stored in the database.
+func UpdateSettings(c *gin.Context) {
+	// capture middleware values
+	s := sMiddleware.FromContext(c)
+	ctx := c.Request.Context()
+
+	logrus.Info("Admin: updating settings")
+
+	// capture body from API request
+	input := new(settings.Platform)
+
+	err := c.Bind(input)
+	if err != nil {
+		retErr := fmt.Errorf("unable to decode JSON for settings: %w", err)
+
+		util.HandleError(c, http.StatusBadRequest, retErr)
+
+		return
+	}
+
+	if input.CloneImage != nil {
+		s.CloneImage = input.CloneImage
+	}
+
+	if input.TemplateDepth != nil {
+		s.TemplateDepth = input.TemplateDepth
+	}
+
+	if input.StarlarkExecLimit != nil {
+		s.StarlarkExecLimit = input.StarlarkExecLimit
+	}
+
+	if input.Routes != nil {
+		// update routes if set
+		s.SetRoutes(input.GetRoutes())
+	}
+
+	if input.RepoAllowlist != nil {
+		// update allowlist if set
+		s.SetRepoAllowlist(input.GetRepoAllowlist())
+	}
+
+	// send API call to update the repo
+	s, err = database.FromContext(c).UpdateSettings(ctx, s)
+	if err != nil {
+		retErr := fmt.Errorf("unable to update settings: %w", err)
+
+		util.HandleError(c, http.StatusInternalServerError, retErr)
+
+		return
+	}
+
+	c.JSON(http.StatusOK, s)
+}

api/types/settings/compiler.go

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: Apache-2.0
+
+package settings
+
+type Compiler struct {
+	CloneImage        *string `json:"clone_image,omitempty"`
+	TemplateDepth     *int    `json:"template_depth,omitempty"`
+	StarlarkExecLimit *uint64 `json:"starlark_exec_limit,omitempty"`
+}
+
+// GetCloneImage returns the CloneImage field.
+//
+// When the provided CompilerSettings type is nil, or the field within
+// the type is nil, it returns the zero value for the field.
+func (cs *Compiler) GetCloneImage() string {
+	// return zero value if Settings type or CloneImage field is nil
+	if cs == nil || cs.CloneImage == nil {
+		return ""
+	}
+
+	return *cs.CloneImage
+}
+
+// GetTemplateDepth returns the TemplateDepth field.
+//
+// When the provided CompilerSettings type is nil, or the field within
+// the type is nil, it returns the zero value for the field.
+func (cs *Compiler) GetTemplateDepth() int {
+	// return zero value if Settings type or TemplateDepth field is nil
+	if cs == nil || cs.TemplateDepth == nil {
+		return 0
+	}
+
+	return *cs.TemplateDepth
+}
+
+// GetStarlarkExecLimit returns the StarlarkExecLimit field.
+//
+// When the provided CompilerSettings type is nil, or the field within
+// the type is nil, it returns the zero value for the field.
+func (cs *Compiler) GetStarlarkExecLimit() uint64 {
+	// return zero value if Settings type or StarlarkExecLimit field is nil
+	if cs == nil || cs.StarlarkExecLimit == nil {
+		return 0
+	}
+
+	return *cs.StarlarkExecLimit
+}
+
+// SetCloneImage sets the CloneImage field.
+//
+// When the provided CompilerSettings type is nil, it
+// will set nothing and immediately return.
+func (cs *Compiler) SetCloneImage(v string) {
+	// return if Settings type is nil
+	if cs == nil {
+		return
+	}
+
+	cs.CloneImage = &v
+}
+
+// SetTemplateDepth sets the TemplateDepth field.
+//
+// When the provided CompilerSettings type is nil, it
+// will set nothing and immediately return.
+func (cs *Compiler) SetTemplateDepth(v int) {
+	// return if Settings type is nil
+	if cs == nil {
+		return
+	}
+
+	cs.TemplateDepth = &v
+}
+
+// SetStarlarkExecLimit sets the StarlarkExecLimit field.
+//
+// When the provided CompilerSettings type is nil, it
+// will set nothing and immediately return.
+func (cs *Compiler) SetStarlarkExecLimit(v uint64) {
+	// return if Settings type is nil
+	if cs == nil {
+		return
+	}
+
+	cs.StarlarkExecLimit = &v
+}
+
+func CompilerMockEmpty() Compiler {
+	cs := Compiler{}
+	cs.SetCloneImage("")
+	cs.SetTemplateDepth(0)
+	cs.SetStarlarkExecLimit(0)
+	return cs
+}

api/types/settings/platform.go

@@ -0,0 +1,133 @@
+// SPDX-License-Identifier: Apache-2.0
+
+package settings
+
+import (
+	"fmt"
+)
+
+// Platform is the API representation of platform settings.
+//
+// swagger:model Platform
+type Platform struct {
+	ID *int64 `json:"id,omitempty"`
+
+	*Queue    `json:"queue,omitempty"`
+	*Compiler `json:"compiler,omitempty"`
+
+	// misc
+	RepoAllowlist *[]string `json:"repo_allowlist,omitempty"`
+}
+
+// GetID returns the ID field.
+//
+// When the provided Settings type is nil, or the field within
+// the type is nil, it returns the zero value for the field.
+func (s *Platform) GetID() int64 {
+	// return zero value if Settings type or ID field is nil
+	if s == nil || s.ID == nil {
+		return 0
+	}
+
+	return *s.ID
+}
+
+// SetID sets the ID field.
+//
+// When the provided Settings type is nil, it
+// will set nothing and immediately return.
+func (s *Platform) SetID(v int64) {
+	// return if Settings type is nil
+	if s == nil {
+		return
+	}
+
+	s.ID = &v
+}
+
+// SetCompilerSettings sets the CompilerSettings field.
+//
+// When the provided CompilerSettings type is nil, it
+// will set nothing and immediately return.
+func (s *Platform) SetCompilerSettings(cs Compiler) {
+	// return if Settings type is nil
+	if s == nil {
+		return
+	}
+
+	s.Compiler = &cs
+}
+
+// SetQueueSettings sets the QueueSettings field.
+//
+// When the provided QueueSettings type is nil, it
+// will set nothing and immediately return.
+func (s *Platform) SetQueueSettings(qs Queue) {
+	// return if Settings type is nil
+	if s == nil {
+		return
+	}
+
+	s.Queue = &qs
+}
+
+// GetRepoAllowlist returns the RepoAllowlist field.
+//
+// When the provided Settings type is nil, or the field within
+// the type is nil, it returns the zero value for the field.
+func (s *Platform) GetRepoAllowlist() []string {
+	// return zero value if Settings type or RepoAllowlist field is nil
+	if s == nil || s.RepoAllowlist == nil {
+		return []string{}
+	}
+
+	return *s.RepoAllowlist
+}
+
+// SetRepoAllowlist sets the RepoAllowlist field.
+//
+// When the provided Settings type is nil, it
+// will set nothing and immediately return.
+func (s *Platform) SetRepoAllowlist(v []string) {
+	// return if Settings type is nil
+	if s == nil {
+		return
+	}
+
+	s.RepoAllowlist = &v
+}
+
+// String implements the Stringer interface for the Settings type.
+func (s *Platform) String() string {
+	return fmt.Sprintf(`{
+  ID: %d,
+  CloneImage: %s,
+  QueueRoutes: %v,
+  other stuff: %v,
+}`,
+		s.GetID(),
+		s.GetCloneImage(),
+		s.GetRoutes(),
+		s.GetRoutes(),
+	)
+}
+
+// ToEnv converts the Settings type to a string format compatible with standard posix environments.
+func (s *Platform) ToEnv() string {
+	return fmt.Sprintf(`VELA_CLONE_IMAGE='%s'
+VELA_QUEUE_ROUTES='%v'
+`,
+		s.GetCloneImage(),
+		s.GetRoutes(),
+	)
+}
+
+// ToYAML converts the Settings type to a YAML string.
+func (s *Platform) ToYAML() string {
+	return fmt.Sprintf(`VELA_CLONE_IMAGE: '%s'
+VELA_QUEUE_ROUTES: '%s'
+`,
+		s.GetCloneImage(),
+		s.GetRoutes(),
+	)
+}