Merge "Add Gerrit pipeline trigger requirements"

3 files changed, 383 insertions, 1 deletions

diff --git a/tests/base.py b/tests/base.py
index c031497a2..af10ebe96 100644
--- a/tests/base.py
+++ b/tests/base.py
@@ -950,6 +950,7 @@ class FakeGerritChange(object):
         if self.fail_merge:
             return
         self.data['status'] = 'MERGED'
+        self.data['open'] = False
         self.open = False
 
         path = os.path.join(self.upstream_root, self.project)
diff --git a/tests/fixtures/layouts/gerrit-trigger-requirements.yaml b/tests/fixtures/layouts/gerrit-trigger-requirements.yaml
new file mode 100644
index 000000000..72ad6b41e
--- /dev/null
+++ b/tests/fixtures/layouts/gerrit-trigger-requirements.yaml
@@ -0,0 +1,162 @@
+- pipeline:
+    name: require-open
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test require-open
+          require:
+            open: true
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: reject-open
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test reject-open
+          reject:
+            open: true
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: require-wip
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test require-wip
+          require:
+            wip: true
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: reject-wip
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test reject-wip
+          reject:
+            wip: true
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: require-current-patchset
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test require-current-patchset
+          require:
+            current-patchset: true
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: reject-current-patchset
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test reject-current-patchset
+          reject:
+            current-patchset: true
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: require-status
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test require-status
+          require:
+            status: MERGED
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: reject-status
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test reject-status
+          reject:
+            status: MERGED
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: require-approval
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test require-approval
+          require:
+            approval:
+              username: zuul
+              Verified: 1
+    success:
+      gerrit:
+        Verified: 1
+
+- pipeline:
+    name: reject-approval
+    manager: independent
+    trigger:
+      gerrit:
+        - event: comment-added
+          comment: test reject-approval
+          reject:
+            approval:
+              username: zuul
+              Verified: 1
+    success:
+      gerrit:
+        Verified: 1
+
+- job:
+    name: base
+    parent: null
+    run: playbooks/base.yaml
+
+- job: {name: require-open}
+- job: {name: reject-open}
+- job: {name: require-wip}
+- job: {name: reject-wip}
+- job: {name: require-current-patchset}
+- job: {name: reject-current-patchset}
+- job: {name: require-status}
+- job: {name: reject-status}
+- job: {name: require-approval}
+- job: {name: reject-approval}
+
+- project:
+    name: org/project
+    require-open: {jobs: [require-open]}
+    reject-open: {jobs: [reject-open]}
+    require-wip: {jobs: [require-wip]}
+    reject-wip: {jobs: [reject-wip]}
+    require-current-patchset: {jobs: [require-current-patchset]}
+    reject-current-patchset: {jobs: [reject-current-patchset]}
+    require-status: {jobs: [require-status]}
+    reject-status: {jobs: [reject-status]}
+    require-approval: {jobs: [require-approval]}
+    reject-approval: {jobs: [reject-approval]}
diff --git a/tests/unit/test_requirements.py b/tests/unit/test_requirements.py
index 9f3b87187..c5dca56cd 100644
--- a/tests/unit/test_requirements.py
+++ b/tests/unit/test_requirements.py
@@ -14,7 +14,7 @@
 
 import time
 
-from tests.base import ZuulTestCase
+from tests.base import ZuulTestCase, simple_layout
 
 
 class TestRequirementsApprovalNewerThan(ZuulTestCase):
@@ -490,3 +490,222 @@ class TestRequirementsTrustedCheck(ZuulTestCase):
         self.fake_gerrit.addEvent(B.getPatchsetCreatedEvent(1))
         self.waitUntilSettled()
         self.assertHistory([])
+
+
+class TestGerritTriggerRequirements(ZuulTestCase):
+    scheduler_count = 1
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_require_open(self):
+        # Test trigger require-open
+        jobname = 'require-open'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's open, so it should be enqueued
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+        # Not open, so should be ignored
+        A.setMerged()
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_reject_open(self):
+        # Test trigger reject-open
+        jobname = 'reject-open'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's open, so it should not be enqueued
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 0)
+
+        # Not open, so should be enqueued
+        A.setMerged()
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_require_wip(self):
+        # Test trigger require-wip
+        jobname = 'require-wip'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's not WIP, so it should be ignored
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 0)
+
+        # WIP, so should be enqueued
+        A.setWorkInProgress(True)
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_reject_wip(self):
+        # Test trigger reject-wip
+        jobname = 'reject-wip'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's not WIP, so it should be enqueued
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+        # WIP, so should be ignored
+        A.setWorkInProgress(True)
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_require_current_patchset(self):
+        # Test trigger require-current_patchset
+        jobname = 'require-current-patchset'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's current, so it should be enqueued
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+        # Not current, so should be ignored
+        A.addPatchset()
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_reject_current_patchset(self):
+        # Test trigger reject-current_patchset
+        jobname = 'reject-current-patchset'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's current, so it should be ignored
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 0)
+
+        # Not current, so should be enqueued
+        A.addPatchset()
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_require_status(self):
+        # Test trigger require-status
+        jobname = 'require-status'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's not merged, so it should be ignored
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 0)
+
+        # Merged, so should be enqueued
+        A.setMerged()
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_reject_status(self):
+        # Test trigger reject-status
+        jobname = 'reject-status'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # It's not merged, so it should be enqueued
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+        # Merged, so should be ignored
+        A.setMerged()
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_require_approval(self):
+        # Test trigger require-approval
+        jobname = 'require-approval'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # Missing approval, so it should be ignored
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 0)
+
+        # Has approval, so it should be enqueued
+        A.addApproval('Verified', 1, username='zuul')
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+    @simple_layout('layouts/gerrit-trigger-requirements.yaml')
+    def test_reject_approval(self):
+        # Test trigger reject-approval
+        jobname = 'reject-approval'
+        project = 'org/project'
+        A = self.fake_gerrit.addFakeChange(project, 'master', 'A')
+        # A comment event that we will keep submitting to trigger
+        comment = A.getChangeCommentEvent(1, f'test {jobname}')
+
+        # Missing approval, so it should be enqueued
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)
+
+        # Has approval, so it should be ignored
+        A.addApproval('Verified', 1, username='zuul')
+        self.fake_gerrit.addEvent(comment)
+        self.waitUntilSettled()
+        self.assertEqual(len(self.history), 1)
+        self.assertEqual(self.history[0].name, jobname)