feat!(backend): unify script run and ad-hoc job run

This commit is contained in:
2026-04-05 04:10:59 +03:00
parent add1242b97
commit fd01eecfcc
7 changed files with 76 additions and 150 deletions
+2 -1
View File
@@ -96,7 +96,8 @@ func main() {
log.Printf("Warning: failed to initialize script interpreters table: %v", err) log.Printf("Warning: failed to initialize script interpreters table: %v", err)
} }
scriptSvc := service.NewScriptServiceWithInterpreters(h.Repo, scriptRepo) scriptSvc := service.NewScriptServiceWithInterpreters(h.Repo, scriptRepo)
scriptHandlers := handlers.NewScriptHandlers(scriptSvc, cmdTracker) scriptHandlers := handlers.NewScriptHandlers(scriptSvc, cmdTracker,
os.Getenv("WHEREAMI"))
jobsHandlers := handlers.NewJobsHandlers(cmdTracker, scriptSvc, jobsHandlers := handlers.NewJobsHandlers(cmdTracker, scriptSvc,
os.Getenv("WHEREAMI"), /* our address for redirects */ os.Getenv("WHEREAMI"), /* our address for redirects */
jobRepo, jobRepo,
+2 -28
View File
@@ -1684,7 +1684,7 @@ const docTemplate = `{
"201": { "201": {
"description": "Created", "description": "Created",
"schema": { "schema": {
"$ref": "#/definitions/internal_handlers.RunScriptOut" "$ref": "#/definitions/internal_handlers.JobResult"
} }
}, },
"400": { "400": {
@@ -2118,7 +2118,7 @@ const docTemplate = `{
"201": { "201": {
"description": "Created", "description": "Created",
"schema": { "schema": {
"$ref": "#/definitions/internal_handlers.RunScriptOut" "$ref": "#/definitions/internal_handlers.AddJobOut"
} }
} }
} }
@@ -2904,32 +2904,6 @@ const docTemplate = `{
} }
} }
}, },
"internal_handlers.RunScriptOut": {
"type": "object",
"properties": {
"command": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "integer"
},
"status": {
"type": "integer"
},
"stderr": {
"type": "string"
},
"stdin": {
"type": "string"
},
"stdout": {
"type": "string"
}
}
},
"internal_handlers.RunStoredScriptIn": { "internal_handlers.RunStoredScriptIn": {
"type": "object", "type": "object",
"required": [ "required": [
+2 -28
View File
@@ -1673,7 +1673,7 @@
"201": { "201": {
"description": "Created", "description": "Created",
"schema": { "schema": {
"$ref": "#/definitions/internal_handlers.RunScriptOut" "$ref": "#/definitions/internal_handlers.JobResult"
} }
}, },
"400": { "400": {
@@ -2107,7 +2107,7 @@
"201": { "201": {
"description": "Created", "description": "Created",
"schema": { "schema": {
"$ref": "#/definitions/internal_handlers.RunScriptOut" "$ref": "#/definitions/internal_handlers.AddJobOut"
} }
} }
} }
@@ -2893,32 +2893,6 @@
} }
} }
}, },
"internal_handlers.RunScriptOut": {
"type": "object",
"properties": {
"command": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "integer"
},
"status": {
"type": "integer"
},
"stderr": {
"type": "string"
},
"stdin": {
"type": "string"
},
"stdout": {
"type": "string"
}
}
},
"internal_handlers.RunStoredScriptIn": { "internal_handlers.RunStoredScriptIn": {
"type": "object", "type": "object",
"required": [ "required": [
+2 -19
View File
@@ -504,23 +504,6 @@ definitions:
- interpreter_id - interpreter_id
- script_text - script_text
type: object type: object
internal_handlers.RunScriptOut:
properties:
command:
items:
type: string
type: array
id:
type: integer
status:
type: integer
stderr:
type: string
stdin:
type: string
stdout:
type: string
type: object
internal_handlers.RunStoredScriptIn: internal_handlers.RunStoredScriptIn:
properties: properties:
stdin: stdin:
@@ -1608,7 +1591,7 @@ paths:
"201": "201":
description: Created description: Created
schema: schema:
$ref: '#/definitions/internal_handlers.RunScriptOut' $ref: '#/definitions/internal_handlers.JobResult'
"400": "400":
description: Bad Request description: Bad Request
schema: schema:
@@ -1882,7 +1865,7 @@ paths:
"201": "201":
description: Created description: Created
schema: schema:
$ref: '#/definitions/internal_handlers.RunScriptOut' $ref: '#/definitions/internal_handlers.AddJobOut'
security: security:
- Bearer: [] - Bearer: []
summary: Run a script on an agent summary: Run a script on an agent
+29 -15
View File
@@ -72,35 +72,49 @@ func (h *JobsHandlers) AddJob(c *gin.Context) {
return return
} }
agent, ok := h.tracker.GetAgent(in.AgentID) result, err := h.runCommand(c, in.AgentID, in.InterpreterID, in.Command, in.Stdin)
if !ok {
c.Status(http.StatusNotFound)
c.Error(fmt.Errorf("agent not found"))
return
}
command, err := resolveCommand(c, h.svc, in.InterpreterID, in.Command)
if err != nil { if err != nil {
c.Error(err) c.Error(err)
return return
} }
c.JSON(http.StatusCreated, result)
}
// runCommand resolves command, submits a job to the agent, and returns AddJobOut.
// Shared between jobs and scripts handlers.
func (h *JobsHandlers) runCommand(
c *gin.Context,
agentID string,
interpID int64,
command string,
stdin *string,
) (*AddJobOut, error) {
agent, ok := h.tracker.GetAgent(agentID)
if !ok {
return nil, fmt.Errorf("agent not found")
}
cmd, err := resolveCommand(c, h.svc, interpID, command)
if err != nil {
return nil, err
}
jid, err := agent.AddJob(models.JobForInsert{ jid, err := agent.AddJob(models.JobForInsert{
Command: command, Command: cmd,
Stdin: in.Stdin, Stdin: stdin,
}) })
if err != nil { if err != nil {
c.Error(err) return nil, err
return
} }
waitURL := fmt.Sprintf("%s/api/v1/jobs/%d/wait", h.whereami, jid) waitURL := fmt.Sprintf("%s/api/v1/jobs/%d/wait", h.whereami, jid)
c.JSON(http.StatusCreated, AddJobOut{ return &AddJobOut{
ID: jid, ID: jid,
Command: command, Command: cmd,
WaitURL: waitURL, WaitURL: waitURL,
}) }, nil
} }
// WaitJob waits for a submitted job to complete (long-poll). // WaitJob waits for a submitted job to complete (long-poll).
+24 -44
View File
@@ -15,10 +15,11 @@ import (
type ScriptHandlers struct { type ScriptHandlers struct {
svc *service.ScriptService svc *service.ScriptService
tracker *commander.ConnTracker tracker *commander.ConnTracker
whereami string
} }
func NewScriptHandlers(svc *service.ScriptService, tracker *commander.ConnTracker) ScriptHandlers { func NewScriptHandlers(svc *service.ScriptService, tracker *commander.ConnTracker, whereami string) ScriptHandlers {
return ScriptHandlers{svc: svc, tracker: tracker} return ScriptHandlers{svc: svc, tracker: tracker, whereami: whereami}
} }
type RunScriptIn struct { type RunScriptIn struct {
@@ -28,73 +29,52 @@ type RunScriptIn struct {
Stdin *string `json:"stdin"` Stdin *string `json:"stdin"`
} }
type RunScriptOut struct { // RunScript submits a script as a job and returns a wait_url for the result.
ID int64 `json:"id"`
Command []string `json:"command"`
Stdin *string `json:"stdin"`
Stdout string `json:"stdout"`
Stderr string `json:"stderr"`
Status int32 `json:"status"`
}
// RunScript executes a script on a target agent.
// @Summary Run a script on an agent // @Summary Run a script on an agent
// @Description Resolves interpreter argv[] and sends the full command to the agent // @Description Resolves interpreter argv[] and sends the full command to the agent
// @Tags scripts // @Tags scripts
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body RunScriptIn true "Script request" // @Param body body RunScriptIn true "Script request"
// @Success 201 {object} RunScriptOut // @Success 201 {object} AddJobOut
// @Security Bearer // @Security Bearer
// @Router /scripts/run [post] // @Router /scripts/run [post]
func (h *ScriptHandlers) RunScript(c *gin.Context) { func (h *ScriptHandlers) RunScript(c *gin.Context) {
err := func() error {
var in RunScriptIn var in RunScriptIn
if err := c.Bind(&in); err != nil { if err := c.Bind(&in); err != nil {
return err c.Error(err)
} return
command, err := h.svc.ResolveCommand(
c.Request.Context(),
in.InterpreterID,
in.ScriptText,
)
if err != nil {
return err
} }
agent, ok := h.tracker.GetAgent(in.AgentID) agent, ok := h.tracker.GetAgent(in.AgentID)
if !ok { if !ok {
c.Status(http.StatusNotFound) c.Status(http.StatusNotFound)
return fmt.Errorf("agent not found") c.Error(fmt.Errorf("agent not found"))
return
}
command, err := h.svc.ResolveCommand(c.Request.Context(), in.InterpreterID, in.ScriptText)
if err != nil {
c.Error(err)
return
} }
jid, err := agent.AddJob(models.JobForInsert{ jid, err := agent.AddJob(models.JobForInsert{
Command: command, Command: command,
Stdin: in.Stdin, Stdin: in.Stdin,
}) })
if err != nil {
return err
}
job, err := agent.WaitJob(jid)
if err != nil {
return err
}
c.JSON(http.StatusCreated, RunScriptOut{
ID: job.ID,
Command: job.Command,
Stdin: job.Stdin,
Stdout: job.Stdout,
Stderr: job.Stderr,
Status: job.Status,
})
return nil
}()
if err != nil { if err != nil {
c.Error(err) c.Error(err)
return
} }
waitURL := fmt.Sprintf("%s/api/v1/jobs/%d/wait", h.whereami, jid)
c.JSON(http.StatusCreated, AddJobOut{
ID: jid,
Command: command,
WaitURL: waitURL,
})
} }
// ListInterpreters returns all registered script interpreters. // ListInterpreters returns all registered script interpreters.
+2 -2
View File
@@ -198,7 +198,7 @@ func (sh *ScriptHandlersGroup) DeleteScript(c *gin.Context) {
// @Produce json // @Produce json
// @Param id path int true "Script ID" // @Param id path int true "Script ID"
// @Param body body RunStoredScriptIn true "Agent token and optional stdin" // @Param body body RunStoredScriptIn true "Agent token and optional stdin"
// @Success 201 {object} RunScriptOut // @Success 201 {object} JobResult
// @Failure 400 {object} map[string]string // @Failure 400 {object} map[string]string
// @Failure 404 {object} map[string]string // @Failure 404 {object} map[string]string
// @Failure 500 {object} map[string]string // @Failure 500 {object} map[string]string
@@ -254,7 +254,7 @@ func (sh *ScriptHandlersGroup) RunScriptByID(c *gin.Context) {
return return
} }
c.JSON(http.StatusCreated, RunScriptOut{ c.JSON(http.StatusCreated, JobResult{
ID: job.ID, ID: job.ID,
Command: job.Command, Command: job.Command,
Stdin: job.Stdin, Stdin: job.Stdin,