Skip to content

feat: support runner job resource overrides #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
archf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support runner job resource overrides #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions job.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,29 @@ type RunnerJobFile struct {
Contents string `json:"contents"`
}

// RunnerJobResourceSpecs holds Kubernetes resource specs
// (for example "500m", "1Gi", "64Mi"). All fields are optional; missing values
// mean the runner should keep its configured default for that dimension.
type RunnerJobResourceSpecs struct {
CPU string `json:"cpu"`
Memory string `json:"memory"`
EphemeralStorage string `json:"ephemeralStorage"`
}

// RunnerJobResources allows a job to override the pod's main container
// resource requests and limits. Nil values (or nil pointers on the enclosing
// struct) mean the runner uses its configured defaults for that side.
type RunnerJobResources struct {
Requests *RunnerJobResourceSpecs `json:"requests"`
Limits *RunnerJobResourceSpecs `json:"limits"`
}

type RunnerJob struct {
Commands []string `json:"commands"`
Id ID `json:"id"`
Image string `json:"image"`
Outcome RunnerJobOutcomeEnum `json:"outcome"`
Resources *RunnerJobResources `json:"resources"`
Status RunnerJobStatusEnum `json:"status"`
Variables []RunnerJobVariable `json:"variables"`
Files []RunnerJobFile `json:"files"`
Expand Down
63 changes: 58 additions & 5 deletions job_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,15 @@ func TestRunnerGetScale(t *testing.T) {
func TestRunnerGetPendingJobs(t *testing.T) {
// Arrange
testRequest := autopilot.NewTestRequest(
`mutation RunnerGetPendingJob($id:ID!$token:ID){runnerGetPendingJob(runnerId: $id lastUpdateToken: $token){runnerJob{commands,id,image,outcome,status,variables{key,sensitive,value,scope},files{name,contents},initCommands,initImage},lastUpdateToken,errors{message,path}}}`,
`mutation RunnerGetPendingJob($id:ID!$token:ID){runnerGetPendingJob(runnerId: $id lastUpdateToken: $token){runnerJob{commands,id,image,outcome,resources{requests{cpu,memory,ephemeralStorage},limits{cpu,memory,ephemeralStorage}},status,variables{key,sensitive,value,scope},files{name,contents},initCommands,initImage},lastUpdateToken,errors{message,path}}}`,
`{"id":"1234567890", "token": "1234"}`,
`{"data": {
"runnerGetPendingJob": {
"runnerJob": {
{{ template "id1" }},
"image": "public.ecr.aws/opslevel/cli:v2022.02.25",
"image": "public.ecr.aws/opslevel/cli:v2026.7.8",
"outcome": "unstarted",
"resources": null,
"status": "running",
"commands": [
"pwd",
Expand All @@ -88,7 +89,7 @@ func TestRunnerGetPendingJobs(t *testing.T) {
"initCommands": [
"/opslevel/clone-repo ."
],
"initImage": "public.ecr.aws/opslevel/cli:v2022.02.25"
"initImage": "public.ecr.aws/opslevel/cli:v2026.7.8"
},
"lastUpdateToken": "12344321",
"errors": []
Expand All @@ -100,13 +101,65 @@ func TestRunnerGetPendingJobs(t *testing.T) {
result, token, err := client.RunnerGetPendingJob("1234567890", "1234")
// Assert
autopilot.Ok(t, err)
autopilot.Equals(t, "public.ecr.aws/opslevel/cli:v2022.02.25", result.Image)
autopilot.Equals(t, "public.ecr.aws/opslevel/cli:v2026.7.8", result.Image)
autopilot.Equals(t, "ls -al", result.Commands[1])
autopilot.Equals(t, ol.ID("12344321"), token)
autopilot.Equals(t, []string{"/opslevel/clone-repo ."}, result.InitCommands)
autopilot.Equals(t, "public.ecr.aws/opslevel/cli:v2022.02.25", result.InitImage)
autopilot.Equals(t, "public.ecr.aws/opslevel/cli:v2026.7.8", result.InitImage)
autopilot.Equals(t, ol.RunnerJobVariableScopeMain, result.Variables[0].Scope)
autopilot.Equals(t, ol.RunnerJobVariableScopeInit, result.Variables[1].Scope)
autopilot.Assert(t, result.Resources == nil, "expected Resources to be nil when server omits it")

@derek-etherton-opslevel derek-etherton-opslevel Jul 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

}

func TestRunnerGetPendingJobsWithResourcesSpecs(t *testing.T) {
// Arrange
testRequest := autopilot.NewTestRequest(
`mutation RunnerGetPendingJob($id:ID!$token:ID){runnerGetPendingJob(runnerId: $id lastUpdateToken: $token){runnerJob{commands,id,image,outcome,resources{requests{cpu,memory,ephemeralStorage},limits{cpu,memory,ephemeralStorage}},status,variables{key,sensitive,value,scope},files{name,contents},initCommands,initImage},lastUpdateToken,errors{message,path}}}`,
`{"id":"1234567890", "token": "1234"}`,
`{"data": {
"runnerGetPendingJob": {
"runnerJob": {
{{ template "id1" }},
"image": "public.ecr.aws/opslevel/cli:v2026.7.8",
"outcome": "unstarted",
"resources": {
"requests": {
"cpu": "500m",
"memory": "1Gi",
"ephemeralStorage": "64Mi"
},
"limits": {
"cpu": "4000m",
"memory": "4Gi",
"ephemeralStorage": "26Gi"
}
},
"status": "running",
"commands": ["pwd"],
"variables": [],
"files": [],
"initCommands": [],
"initImage": ""
},
"lastUpdateToken": "12344321",
"errors": []
}}}`,
)

client := BestTestClient(t, "job/get_pending_with_resources", testRequest)
// Act
result, _, err := client.RunnerGetPendingJob("1234567890", "1234")
// Assert
autopilot.Ok(t, err)
autopilot.Assert(t, result.Resources != nil, "expected Resources to be non-nil")
autopilot.Assert(t, result.Resources.Requests != nil, "expected Resources.Requests to be non-nil")
autopilot.Equals(t, "500m", result.Resources.Requests.CPU)
autopilot.Equals(t, "1Gi", result.Resources.Requests.Memory)
autopilot.Equals(t, "64Mi", result.Resources.Requests.EphemeralStorage)
autopilot.Assert(t, result.Resources.Limits != nil, "expected Resources.Limits to be non-nil")
autopilot.Equals(t, "4000m", result.Resources.Limits.CPU)
autopilot.Equals(t, "4Gi", result.Resources.Limits.Memory)
autopilot.Equals(t, "26Gi", result.Resources.Limits.EphemeralStorage)
}

func TestRunnerAppendJobLog(t *testing.T) {
Expand Down
Loading