-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/oidc-provider
- Loading branch information
Showing
144 changed files
with
6,456 additions
and
740 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,293 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package admin | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/sirupsen/logrus" | ||
|
|
||
| "github.com/go-vela/server/api/types/settings" | ||
| "github.com/go-vela/server/compiler/native" | ||
| "github.com/go-vela/server/database" | ||
| "github.com/go-vela/server/internal/image" | ||
| "github.com/go-vela/server/queue" | ||
| cliMiddleware "github.com/go-vela/server/router/middleware/cli" | ||
| sMiddleware "github.com/go-vela/server/router/middleware/settings" | ||
| uMiddleware "github.com/go-vela/server/router/middleware/user" | ||
| "github.com/go-vela/server/util" | ||
| ) | ||
|
|
||
| // 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 | ||
| // type: json | ||
| // schema: | ||
| // "$ref": "#/definitions/Platform" | ||
| // '401': | ||
| // description: Unauthorized | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
| // '404': | ||
| // description: Unable to retrieve settings | ||
| // 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") | ||
|
|
||
| // check captured value because we aren't retrieving settings from the database | ||
| // instead we are retrieving the auto-refreshed middleware value | ||
| if s == nil { | ||
| retErr := fmt.Errorf("settings not found") | ||
|
|
||
| util.HandleError(c, http.StatusNotFound, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, s) | ||
| } | ||
|
|
||
| // swagger:operation PUT /api/v1/admin/settings admin UpdateSettings | ||
| // | ||
| // Update the platform settings singleton in the database. | ||
| // | ||
| // --- | ||
| // produces: | ||
| // - application/json | ||
| // parameters: | ||
| // - in: body | ||
| // name: body | ||
| // description: Payload containing settings to update | ||
| // required: true | ||
| // schema: | ||
| // "$ref": "#/definitions/Platform" | ||
| // security: | ||
| // - ApiKeyAuth: [] | ||
| // responses: | ||
| // '200': | ||
| // description: Successfully updated platform settings in the database | ||
| // type: json | ||
| // schema: | ||
| // "$ref": "#/definitions/Platform" | ||
| // '400': | ||
| // description: Unable to update settings — bad request | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
| // '401': | ||
| // description: Unauthorized | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
| // '404': | ||
| // description: Unable to retrieve platform settings to update | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
| // '500': | ||
| // description: Unable to update platform 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) | ||
| u := uMiddleware.FromContext(c) | ||
| ctx := c.Request.Context() | ||
|
|
||
| logrus.Info("Admin: updating settings") | ||
|
|
||
| // check captured value because we aren't retrieving settings from the database | ||
| // instead we are retrieving the auto-refreshed middleware value | ||
| if s == nil { | ||
| retErr := fmt.Errorf("settings not found") | ||
|
|
||
| util.HandleError(c, http.StatusNotFound, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| // duplicate settings to not alter the shared pointer | ||
| _s := new(settings.Platform) | ||
| _s.FromSettings(s) | ||
|
|
||
| // ensure we update the singleton record | ||
| _s.SetID(1) | ||
|
|
||
| // 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.Compiler != nil { | ||
| if input.CloneImage != nil { | ||
| // validate clone image | ||
| cloneImage := *input.CloneImage | ||
|
|
||
| _, err = image.ParseWithError(cloneImage) | ||
| if err != nil { | ||
| retErr := fmt.Errorf("invalid clone image %s: %w", cloneImage, err) | ||
|
|
||
| util.HandleError(c, http.StatusBadRequest, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| _s.SetCloneImage(cloneImage) | ||
| } | ||
|
|
||
| if input.TemplateDepth != nil { | ||
| _s.SetTemplateDepth(*input.TemplateDepth) | ||
| } | ||
|
|
||
| if input.StarlarkExecLimit != nil { | ||
| _s.SetStarlarkExecLimit(*input.StarlarkExecLimit) | ||
| } | ||
| } | ||
|
|
||
| if input.Queue != nil { | ||
| if input.Queue.Routes != nil { | ||
| _s.SetRoutes(input.GetRoutes()) | ||
| } | ||
| } | ||
|
|
||
| if input.RepoAllowlist != nil { | ||
| _s.SetRepoAllowlist(input.GetRepoAllowlist()) | ||
| } | ||
|
|
||
| if input.ScheduleAllowlist != nil { | ||
| _s.SetScheduleAllowlist(input.GetScheduleAllowlist()) | ||
| } | ||
|
|
||
| _s.SetUpdatedBy(u.GetName()) | ||
|
|
||
| // send API call to update the settings | ||
| _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) | ||
| } | ||
|
|
||
| // swagger:operation DELETE /api/v1/admin/settings admin RestoreSettings | ||
| // | ||
| // Restore the currently configured settings to the environment defaults. | ||
| // | ||
| // --- | ||
| // produces: | ||
| // - application/json | ||
| // security: | ||
| // - ApiKeyAuth: [] | ||
| // responses: | ||
| // '200': | ||
| // description: Successfully restored default settings in the database | ||
| // type: json | ||
| // schema: | ||
| // "$ref": "#/definitions/Platform" | ||
| // '401': | ||
| // description: Unauthorized | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
| // '404': | ||
| // description: Unable to retrieve settings to restore | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
| // '500': | ||
| // description: Unable to restore settings in the database | ||
| // schema: | ||
| // "$ref": "#/definitions/Error" | ||
|
|
||
| // RestoreSettings represents the API handler to | ||
| // restore settings stored in the database to the environment defaults. | ||
| func RestoreSettings(c *gin.Context) { | ||
| // capture middleware values | ||
| s := sMiddleware.FromContext(c) | ||
| u := uMiddleware.FromContext(c) | ||
| cliCtx := cliMiddleware.FromContext(c) | ||
| ctx := c.Request.Context() | ||
|
|
||
| logrus.Info("Admin: restoring settings") | ||
|
|
||
| // check captured value because we aren't retrieving settings from the database | ||
| // instead we are retrieving the auto-refreshed middleware value | ||
| if s == nil { | ||
| retErr := fmt.Errorf("settings not found") | ||
|
|
||
| util.HandleError(c, http.StatusNotFound, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| compiler, err := native.FromCLIContext(cliCtx) | ||
| if err != nil { | ||
| retErr := fmt.Errorf("unable to restore settings: %w", err) | ||
|
|
||
| util.HandleError(c, http.StatusInternalServerError, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| queue, err := queue.FromCLIContext(cliCtx) | ||
| if err != nil { | ||
| retErr := fmt.Errorf("unable to restore settings: %w", err) | ||
|
|
||
| util.HandleError(c, http.StatusInternalServerError, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| // initialize a new settings record | ||
| _s := settings.FromCLIContext(cliCtx) | ||
|
|
||
| _s.SetUpdatedAt(time.Now().UTC().Unix()) | ||
| _s.SetUpdatedBy(u.GetName()) | ||
|
|
||
| // read in defaults supplied from the cli runtime | ||
| compilerSettings := compiler.GetSettings() | ||
| _s.SetCompiler(compilerSettings) | ||
|
|
||
| queueSettings := queue.GetSettings() | ||
| _s.SetQueue(queueSettings) | ||
|
|
||
| // send API call to update the settings | ||
| s, err = database.FromContext(c).UpdateSettings(ctx, _s) | ||
| if err != nil { | ||
| retErr := fmt.Errorf("unable to update (restore) settings: %w", err) | ||
|
|
||
| util.HandleError(c, http.StatusInternalServerError, retErr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, s) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.