Add cron running API (#12421)
* Add cron running API Signed-off-by: Andrew Thornton <art27@cantab.net> * Apply suggestions from code review * placate-swagger Signed-off-by: Andrew Thornton <art27@cantab.net> * return not found Signed-off-by: Andrew Thornton <art27@cantab.net> * Apply suggestions from code review Co-authored-by: techknowlogick <techknowlogick@gitea.io>tokarchuk/v1.17
parent
ee047312a1
commit
2ae8c7ab1c
@ -0,0 +1,16 @@ |
|||||||
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a MIT-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package structs |
||||||
|
|
||||||
|
import "time" |
||||||
|
|
||||||
|
// Cron represents a Cron task
|
||||||
|
type Cron struct { |
||||||
|
Name string `json:"name"` |
||||||
|
Schedule string `json:"schedule"` |
||||||
|
Next time.Time `json:"next"` |
||||||
|
Prev time.Time `json:"prev"` |
||||||
|
ExecTimes int64 `json:"exec_times"` |
||||||
|
} |
@ -0,0 +1,86 @@ |
|||||||
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a MIT-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package admin |
||||||
|
|
||||||
|
import ( |
||||||
|
"net/http" |
||||||
|
|
||||||
|
"code.gitea.io/gitea/modules/context" |
||||||
|
"code.gitea.io/gitea/modules/cron" |
||||||
|
"code.gitea.io/gitea/modules/log" |
||||||
|
"code.gitea.io/gitea/modules/structs" |
||||||
|
"code.gitea.io/gitea/routers/api/v1/utils" |
||||||
|
) |
||||||
|
|
||||||
|
// ListCronTasks api for getting cron tasks
|
||||||
|
func ListCronTasks(ctx *context.APIContext) { |
||||||
|
// swagger:operation GET /admin/cron admin adminCronList
|
||||||
|
// ---
|
||||||
|
// summary: List cron tasks
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: page
|
||||||
|
// in: query
|
||||||
|
// description: page number of results to return (1-based)
|
||||||
|
// type: integer
|
||||||
|
// - name: limit
|
||||||
|
// in: query
|
||||||
|
// description: page size of results
|
||||||
|
// type: integer
|
||||||
|
// responses:
|
||||||
|
// "200":
|
||||||
|
// "$ref": "#/responses/CronList"
|
||||||
|
// "403":
|
||||||
|
// "$ref": "#/responses/forbidden"
|
||||||
|
tasks := cron.ListTasks() |
||||||
|
listOpts := utils.GetListOptions(ctx) |
||||||
|
start, end := listOpts.GetStartEnd() |
||||||
|
|
||||||
|
if len(tasks) > listOpts.PageSize { |
||||||
|
tasks = tasks[start:end] |
||||||
|
} |
||||||
|
|
||||||
|
res := make([]structs.Cron, len(tasks)) |
||||||
|
for i, task := range tasks { |
||||||
|
res[i] = structs.Cron{ |
||||||
|
Name: task.Name, |
||||||
|
Schedule: task.Spec, |
||||||
|
Next: task.Next, |
||||||
|
Prev: task.Prev, |
||||||
|
ExecTimes: task.ExecTimes, |
||||||
|
} |
||||||
|
} |
||||||
|
ctx.JSON(http.StatusOK, res) |
||||||
|
} |
||||||
|
|
||||||
|
// PostCronTask api for getting cron tasks
|
||||||
|
func PostCronTask(ctx *context.APIContext) { |
||||||
|
// swagger:operation POST /admin/cron/{task} admin adminCronRun
|
||||||
|
// ---
|
||||||
|
// summary: Run cron task
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: task
|
||||||
|
// in: path
|
||||||
|
// description: task to run
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// responses:
|
||||||
|
// "204":
|
||||||
|
// "$ref": "#/responses/empty"
|
||||||
|
// "404":
|
||||||
|
// "$ref": "#/responses/notFound"
|
||||||
|
task := cron.GetTask(ctx.Params(":task")) |
||||||
|
if task == nil { |
||||||
|
ctx.NotFound() |
||||||
|
return |
||||||
|
} |
||||||
|
task.Run() |
||||||
|
log.Trace("Cron Task %s started by admin(%s)", task.Name, ctx.User.Name) |
||||||
|
|
||||||
|
ctx.Status(http.StatusNoContent) |
||||||
|
} |
@ -0,0 +1,16 @@ |
|||||||
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a MIT-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package swagger |
||||||
|
|
||||||
|
import ( |
||||||
|
api "code.gitea.io/gitea/modules/structs" |
||||||
|
) |
||||||
|
|
||||||
|
// CronList
|
||||||
|
// swagger:response CronList
|
||||||
|
type swaggerResponseCronList struct { |
||||||
|
// in:body
|
||||||
|
Body []api.Cron `json:"body"` |
||||||
|
} |
Loading…
Reference in new issue