zuul/zuul
Code Issues Proposed changes

Add launcher relative priority tests

Browse Source 
This change extends the test setup a bit so that we can more easily hold

Change-Id: I2116191c1b1e6ecdf9e81e161682ac8631df449c
This commit is contained in:
Simon Westphahl
2025-03-12 11:25:06 +01:00
parent 2dc9ec644d
commit 1f76510835
6 changed files with 344 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
tests/base.py
View File

@ -3089,6 +3089,20 @@ class ZuulTestCase(BaseTestCase):
for app in self.scheds:
app.sched.merger.merger_api.hold_in_queue = hold_in_queue
@property
def hold_nodeset_requests_in_queue(self):
return self.scheds.first.sched.launcher.hold_in_queue
@hold_nodeset_requests_in_queue.setter
def hold_nodeset_requests_in_queue(self, hold_in_queue):
for app in self.scheds:
app.sched.launcher.hold_in_queue = hold_in_queue
def releaseNodesetRequests(self, *requests):
ctx = self.createZKContext(None)
for req in requests:
req.updateAttributes(ctx, state=req.State.REQUESTED)
@property
def merge_job_history(self):
history = defaultdict(list)
@ -3211,6 +3225,8 @@ class ZuulTestCase(BaseTestCase):
for app in self.scheds.filter(matcher):
sched = app.sched
for request in self.launcher.api.getNodesetRequests():
if request.state == request.State.TEST_HOLD:
continue
if request.state not in model.NodesetRequest.FINAL_STATES:
return False
if sched.pipeline_result_events[request.tenant_name][

48
tests/fixtures/config/single-tenant/git/common-config/zuul.yaml vendored
View File

@ -220,3 +220,51 @@
- playbooks/post-run-01.yaml
- playbooks/post-run-02.yaml
cleanup-run: playbooks/cleanup-run.yaml
- image:
name: ubuntu-xenial
type: cloud
- flavor:
name: normal
- label:
name: ubuntu-xenial
image: ubuntu-xenial
flavor: normal
- label:
name: label1
image: ubuntu-xenial
flavor: normal
- label:
name: label2
image: ubuntu-xenial
flavor: normal
- section:
name: aws-us-east-1
region: us-east-1
connection: aws
host-key-checking: false
boot-timeout: 300
launch-timeout: 600
launch-attempts: 2
object-storage:
bucket-name: zuul
key-name: zuul
flavors:
- name: normal
instance-type: t3.medium
images:
- name: ubuntu-xenial
image-id: ami-1e749f67
- provider:
name: aws-us-east-1-main
section: aws-us-east-1
labels:
- name: ubuntu-xenial
- name: label1
- name: label2

24
tests/fixtures/config/single-tenant/main-launcher.yaml vendored Normal file
View File

@ -0,0 +1,24 @@
- tenant:
name: tenant-one
source:
gerrit:
config-projects:
- common-config:
include:
- job
- nodeset
- secret
- pipeline
- project
- project-template
- semaphore
- queue
- image
- flavor
- label
- section
- provider
untrusted-projects:
- org/project
- org/project1
- org/project2

37
tests/fixtures/layouts/two-projects-integrated.yaml vendored
View File

@ -86,3 +86,40 @@
gate:
jobs:
- integration
- image:
name: ubuntu-xenial
type: cloud
- flavor:
name: normal
- label:
name: ubuntu-xenial
image: ubuntu-xenial
flavor: normal
- section:
name: aws-us-east-1
region: us-east-1
connection: aws
host-key-checking: false
boot-timeout: 300
launch-timeout: 600
launch-attempts: 2
object-storage:
bucket-name: zuul
key-name: zuul
flavors:
- name: normal
instance-type: t3.medium
images:
- name: ubuntu-xenial
image-id: ami-1e749f67
- provider:
name: aws-us-east-1-main
section: aws-us-east-1
labels:
- name: ubuntu-xenial

9
tests/fixtures/zuul.conf vendored
View File

@ -35,3 +35,12 @@ dburi=$MYSQL_FIXTURE_DBURI$
[web]
static_cache_expiry=1200
root=https://zuul.example.com/
[connection aws]
driver=aws
access_key_id=fake
secret_access_key=fake
[connection openstack]
driver=openstack
cloud=fakecloud

210
tests/unit/test_launcher.py
View File

@ -1277,3 +1277,213 @@ class TestMinReadyTenantVariant(LauncherBaseTestCase):
}
self.assertGreaterEqual(len(debian_normal_cfg_hashes), 2)
self.assertLessEqual(len(debian_normal_cfg_hashes), 3)
class TestNodesetRequestPriority(LauncherBaseTestCase):
config_file = 'zuul.conf'
tenant_config_file = 'config/single-tenant/main-launcher.yaml'
def test_pipeline_priority(self):
"Test that nodes are requested at the correct pipeline priority"
self.hold_nodeset_requests_in_queue = True
A = self.fake_gerrit.addFakeChange('org/project', 'master', 'A')
A.setMerged()
self.fake_gerrit.addEvent(A.getRefUpdatedEvent())
self.waitUntilSettled()
B = self.fake_gerrit.addFakeChange('org/project1', 'master', 'B')
self.fake_gerrit.addEvent(B.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
C = self.fake_gerrit.addFakeChange('org/project', 'master', 'C')
C.addApproval('Code-Review', 2)
self.fake_gerrit.addEvent(C.addApproval('Approved', 1))
self.waitUntilSettled()
reqs = self.launcher.api.getNodesetRequests()
# The requests come back sorted by priority. Since we have
# three requests for the three changes each with a different
# priority.
# * gate first - high priority - change C
self.assertEqual(reqs[0].priority, 100)
self.assertEqual(reqs[0].labels, ['label1'])
# * check second - normal priority - change B
self.assertEqual(reqs[1].priority, 200)
self.assertEqual(reqs[1].labels, ['label1'])
# * post third - low priority - change A
# additionally, the post job defined uses an ubuntu-xenial node,
# so we include that check just as an extra verification
self.assertEqual(reqs[2].priority, 300)
self.assertEqual(reqs[2].labels, ['ubuntu-xenial'])
self.hold_nodeset_requests_in_queue = False
self.releaseNodesetRequests(*reqs)
self.waitUntilSettled()
self.assertHistory([
dict(name='project-merge', result='SUCCESS', changes='2,1'),
dict(name='project-test1', result='SUCCESS', changes='2,1'),
dict(name='project-test2', result='SUCCESS', changes='2,1'),
dict(name='project-merge', result='SUCCESS', changes='3,1'),
dict(name='project-test1', result='SUCCESS', changes='3,1'),
dict(name='project-test2', result='SUCCESS', changes='3,1'),
dict(name='project1-project2-integration',
result='SUCCESS', changes='2,1'),
dict(name='project-post', result='SUCCESS'),
], ordered=False)
@simple_layout('layouts/two-projects-integrated.yaml',
enable_nodepool=True)
def test_relative_priority_check(self):
"Test that nodes are requested at the relative priority"
self.hold_nodeset_requests_in_queue = True
A = self.fake_gerrit.addFakeChange('org/project', 'master', 'A')
self.fake_gerrit.addEvent(A.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
B = self.fake_gerrit.addFakeChange('org/project', 'master', 'B')
self.fake_gerrit.addEvent(B.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
C = self.fake_gerrit.addFakeChange('org/project1', 'master', 'C')
self.fake_gerrit.addEvent(C.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
D = self.fake_gerrit.addFakeChange('org/project2', 'master', 'D')
self.fake_gerrit.addEvent(D.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
# The requests come back sorted by priority.
reqs = self.launcher.api.getNodesetRequests()
# Change A, first change for project, high relative priority.
self.assertEqual(reqs[0].priority, 200)
self.assertEqual(reqs[0].relative_priority, 0)
# Change C, first change for project1, high relative priority.
self.assertEqual(reqs[1].priority, 200)
self.assertEqual(reqs[1].relative_priority, 0)
# Change B, second change for project, lower relative priority.
self.assertEqual(reqs[2].priority, 200)
self.assertEqual(reqs[2].relative_priority, 1)
# Change D, first change for project2 shared with project1,
# lower relative priority than project1.
self.assertEqual(reqs[3].priority, 200)
self.assertEqual(reqs[3].relative_priority, 1)
# Fulfill only the first request
ctx = self.createZKContext(None)
reqs[0].updateAttributes(ctx, state=reqs[0].State.REQUESTED)
for x in iterate_timeout(30, 'fulfill request'):
reqs = self.launcher.api.getNodesetRequests()
if len(reqs) < 4:
break
self.waitUntilSettled()
reqs = self.launcher.api.getNodesetRequests()
# Change B, now first change for project, equal priority.
self.assertEqual(reqs[0].priority, 200)
self.assertEqual(reqs[0].relative_priority, 0)
# Change C, now first change for project1, equal priority.
self.assertEqual(reqs[1].priority, 200)
self.assertEqual(reqs[1].relative_priority, 0)
# Change D, first change for project2 shared with project1,
# still lower relative priority than project1.
self.assertEqual(reqs[2].priority, 200)
self.assertEqual(reqs[2].relative_priority, 1)
self.hold_nodeset_requests_in_queue = False
self.releaseNodesetRequests(*reqs)
self.waitUntilSettled()
@simple_layout('layouts/two-projects-integrated.yaml',
enable_nodepool=True)
def test_relative_priority_long(self):
"Test that nodes are requested at the relative priority"
self.hold_nodeset_requests_in_queue = True
count = 13
changes = []
for x in range(count):
change = self.fake_gerrit.addFakeChange(
'org/project', 'master', 'A')
self.fake_gerrit.addEvent(change.getPatchsetCreatedEvent(1))
self.waitUntilSettled()
changes.append(change)
reqs = self.launcher.api.getNodesetRequests()
self.assertEqual(len(reqs), 13)
# The requests come back sorted by priority.
for x in range(10):
self.assertEqual(reqs[x].relative_priority, x)
self.assertEqual(reqs[10].relative_priority, 10)
self.assertEqual(reqs[11].relative_priority, 10)
self.assertEqual(reqs[12].relative_priority, 10)
# Fulfill only the first request
self.releaseNodesetRequests(reqs[0])
self.waitUntilSettled()
reqs = self.launcher.api.getNodesetRequests()
self.assertEqual(len(reqs), 12)
for x in range(10):
self.assertEqual(reqs[x].relative_priority, x)
self.assertEqual(reqs[10].relative_priority, 10)
self.assertEqual(reqs[11].relative_priority, 10)
self.hold_nodeset_requests_in_queue = False
self.releaseNodesetRequests(*reqs)
self.waitUntilSettled()
@simple_layout('layouts/two-projects-integrated.yaml',
enable_nodepool=True)
def test_relative_priority_gate(self):
"Test that nodes are requested at the relative priority"
self.hold_nodeset_requests_in_queue = True
A = self.fake_gerrit.addFakeChange('org/project1', 'master', 'A')
A.addApproval('Code-Review', 2)
self.fake_gerrit.addEvent(A.addApproval('Approved', 1))
self.waitUntilSettled()
B = self.fake_gerrit.addFakeChange('org/project2', 'master', 'B')
B.addApproval('Code-Review', 2)
self.fake_gerrit.addEvent(B.addApproval('Approved', 1))
self.waitUntilSettled()
# project does not share a queue with project1 and project2.
C = self.fake_gerrit.addFakeChange('org/project', 'master', 'C')
C.addApproval('Code-Review', 2)
self.fake_gerrit.addEvent(C.addApproval('Approved', 1))
self.waitUntilSettled()
# The requests come back sorted by priority.
reqs = self.launcher.api.getNodesetRequests()
# Change A, first change for shared queue, high relative
# priority.
self.assertEqual(reqs[0].priority, 100)
self.assertEqual(reqs[0].relative_priority, 0)
# Change C, first change for independent project, high
# relative priority.
self.assertEqual(reqs[1].priority, 100)
self.assertEqual(reqs[1].relative_priority, 0)
# Change B, second change for shared queue, lower relative
# priority.
self.assertEqual(reqs[2].priority, 100)
self.assertEqual(reqs[2].relative_priority, 1)
self.hold_nodeset_requests_in_queue = False
self.releaseNodesetRequests(*reqs)
self.waitUntilSettled()