The integration of CDEvents with Gerrit is accomplished by translating Gerrit events into CDEvents. This approach utilizes existing Gerrit Webhooks instead of requiring the implementation of a new CDEvent producer for each source code control action.
Gerrit sends real-time events for every change in the source code. These events can be converted into CDEvents-Source Code Control Events by creating a new event translator specifically tailored for the translation from Gerrit to CDEvents.
The Gerrit Webhooks plugin enables the propagation of all Gerrit events to remote HTTP URL endpoints. This plugin can be configured either at the global level or on a per-project basis.
For instance, an example webhook configuration at the All-Projects level will be inherited by all projects by default.
curl --user admin:password -H 'Content-Type: application/json' -X PUT -d '{"url" : "https://gerrit-translator-cdevents/gerrit-events","maxTries" : "3","sslVerify": "true"}' http://gerrit.est.tech/a/config/server/webhooks~projects/All-Projects/remotes/gerrit-events
The webhooks.config file will be created as below under All-Projects/refs/meta/config, once the above request is successful
[remote "gerrit-events"]
url = http://gerrit-translator-cdevents.est.tech/gerrit-events
maxTries = 3
sslVerify = true
If you need only specific events to be sent to a remote HTTP URL endpoint, you can configure it as follows:
[remote "gerrit-events"]
url = http://gerrit-translator-cdevents.est.tech/gerrit-events
maxTries = 3
sslVerify = true
event = patchset-created
event = ref-updated
Additional information regarding Gerrit plugin configuration and APIs can be found at Webhooks-Documentation
A new REST endpoint /gerrit-events will be implemented to receive all the Gerrit events and translate them to CDEvents.
The below list of CDEvents-Source Code Control Events will be mapped with corresponding Gerrit event types to translate.
| CDEvent Type | Gerrit Event Type | Comments / Gerrit Event Format |
|---|---|---|
| dev.cdevents.repository.created | project-created | Event JSON{"projectName":"TestRepo3","headName":"refs/heads/master","type":"project-created","eventCreatedOn":1700131789} |
| dev.cdevents.repository.modified | project-head-updated | Event JSON{"projectName":"TestRepo3","oldHead":"refs/heads/master","newHead":"refs/heads/main","type":"project-head-updated","eventCreatedOn":1700148011} |
| dev.cdevents.repository.deleted | ref-updated | To delete repository in Gerrit Hide the Project State under Repository Options Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"2d351d6d3bd1bec64f6b165a843c9dd18ac4d2cd","newRev":"5a2347177cdc707c6b42444c505b974d6499047d","refName":"refs/meta/config","project":"TestRepo3"},"type":"ref-updated","eventCreatedOn":1700221454} |
| dev.cdevents.branch.created | ref-updated | Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"0000000000000000000000000000000000000000","newRev":"0c8c548ca93b44dd501c000ebb79ecc8f9aa4bd6","refName":"refs/heads/test_branch","project":"TestRepo"},"type":"ref-updated","eventCreatedOn":1700147670} |
| dev.cdevents.branch.deleted | ref-updated | Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"0c8c548ca93b44dd501c000ebb79ecc8f9aa4bd6","newRev":"0000000000000000000000000000000000000000","refName":"refs/heads/test_branch","project":"TestRepo"},"type":"ref-updated","eventCreatedOn":1700222081} |
| dev.cdevents.change.created | patchset-created | Event JSON{"uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"patchSet":{"number":1,"revision":"b59138869113bfd9d3e7fbf9439d74e1ae6c54b8","parents":["b8112960b06810405b3e8ce6c8560ee93694700f"],"ref":"refs/changes/02/2/1","uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"createdOn":1700478731,"author":{"name":"Administrator","email":"[email protected]","username":"admin"},"kind":"REWORK","sizeInsertions":10,"sizeDeletions":0},"change":{"project":"TestRepo1","branch":"patch_create","id":"Ie10fd901201c53e9fe3b9766343060763ac81dc6","number":2,"subject":"test.file added","owner":{"name":"Administrator","email":"[email protected]","username":"admin"},"url":"http://959be7129610/c/TestRepo1/+/2","commitMessage":"test.file added\n\nChange-Id: Ie10fd901201c53e9fe3b9766343060763ac81dc6\n","createdOn":1700478731,"status":"NEW"},"project":{"name":"TestRepo1"},"refName":"refs/heads/patch_create","changeKey":{"key":"Ie10fd901201c53e9fe3b9766343060763ac81dc6"},"type":"patchset-created","eventCreatedOn":1700478732}Followed by ref-updated and eventCreatedOn the same time, that can be ignored Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"0000000000000000000000000000000000000000","newRev":"b59138869113bfd9d3e7fbf9439d74e1ae6c54b8","refName":"refs/changes/02/2/1","project":"TestRepo1"},"type":"ref-updated","eventCreatedOn":1700478732} |
| dev.cdevents.change.reviewed | comment-added | Event JSON{"author":{"name":"Administrator","email":"[email protected]","username":"admin"},"approvals":[{"type":"Code-Review","description":"Code-Review","value":"2","oldValue":"1"}],"comment":"Patch Set 2: Code-Review+2","patchSet":{"number":2,"revision":"ba8c3584916c93b3e17a1ab63072b0ebd0d3ed84","parents":["0c8c548ca93b44dd501c000ebb79ecc8f9aa4bd6"],"ref":"refs/changes/01/1/2","uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"createdOn":1700230164,"author":{"name":"Administrator","email":"[email protected]","username":"admin"},"kind":"NO_CODE_CHANGE","sizeInsertions":9,"sizeDeletions":0},"change":{"project":"TestRepo","branch":"test_branch","id":"I55862204ef71f69bc88c79fe2259f7cb8365699a","number":1,"subject":"updates to the test branch 2 Change-Id: I55862204ef71f69bc88c79fe2259f7cb8365699a","owner":{"name":"Administrator","email":"[email protected]","username":"admin"},"url":"http://959be7129610/c/TestRepo/+/1","commitMessage":"updates to the test branch 2\nChange-Id: I55862204ef71f69bc88c79fe2259f7cb8365699a\n","createdOn":1700229687,"status":"NEW"},"project":{"name":"TestRepo"},"refName":"refs/heads/test_branch","changeKey":{"key":"I55862204ef71f69bc88c79fe2259f7cb8365699a"},"type":"comment-added","eventCreatedOn":1700231622}Followed by ref-updated and eventCreatedOn the same time, that can be ignored Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"552f864688cb7c660bb149cd4746f6e69882efcf","newRev":"ba876fbc1bbe1c3c1670163275bceca061eb98e8","refName":"refs/changes/01/1/meta","project":"TestRepo"},"type":"ref-updated","eventCreatedOn":1700231622} |
| dev.cdevents.change.merged | change-merged | Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"newRev":"4c688da535ea3352536e3b320880aa353bd404b2","patchSet":{"number":2,"revision":"ba8c3584916c93b3e17a1ab63072b0ebd0d3ed84","parents":["0c8c548ca93b44dd501c000ebb79ecc8f9aa4bd6"],"ref":"refs/changes/01/1/2","uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"createdOn":1700230164,"author":{"name":"Administrator","email":"[email protected]","username":"admin"},"kind":"NO_CODE_CHANGE","sizeInsertions":9,"sizeDeletions":0},"change":{"project":"TestRepo","branch":"test_branch","id":"I55862204ef71f69bc88c79fe2259f7cb8365699a","number":1,"subject":"updates to the test branch 2 Change-Id: I55862204ef71f69bc88c79fe2259f7cb8365699a","owner":{"name":"Administrator","email":"[email protected]","username":"admin"},"url":"http://959be7129610/c/TestRepo/+/1","commitMessage":"updates to the test branch 2\nChange-Id: I55862204ef71f69bc88c79fe2259f7cb8365699a\n","createdOn":1700229687,"status":"MERGED"},"project":{"name":"TestRepo"},"refName":"refs/heads/test_branch","changeKey":{"key":"I55862204ef71f69bc88c79fe2259f7cb8365699a"},"type":"change-merged","eventCreatedOn":1700231698}Followed by ref-updated and eventCreatedOn the same time, that can be ignored Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"ba876fbc1bbe1c3c1670163275bceca061eb98e8","newRev":"2ae17bf7464a6a4871d16d3d506df75476ea87e4","refName":"refs/changes/01/1/meta","project":"TestRepo"},"type":"ref-updated","eventCreatedOn":1700231698} |
| dev.cdevents.change.abandoned | change-abandoned | Event JSON{"abandoner":{"name":"Administrator","email":"[email protected]","username":"admin"},"reason":"change not needed","patchSet":{"number":1,"revision":"e88822ed72749d99e3b1d09fe73a1fdffc8e482c","parents":["ba8c3584916c93b3e17a1ab63072b0ebd0d3ed84"],"ref":"refs/changes/21/21/1","uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"createdOn":1700236344,"author":{"name":"Administrator","email":"[email protected]","username":"admin"},"kind":"REWORK","sizeInsertions":13,"sizeDeletions":1},"change":{"project":"TestRepo","branch":"test_branch","id":"Ifc7af9f849cbfb677ef6f1adcf05956292d4f571","number":21,"subject":"Revert "updates to the test branch 2"","owner":{"name":"Administrator","email":"[email protected]","username":"admin"},"url":"http://959be7129610/c/TestRepo/+/21","commitMessage":"Revert "updates to the test branch 2"\n\nThis reverts commit ba8c3584916c93b3e17a1ab63072b0ebd0d3ed84.\n\nReason for revert: Testing abort\n\nChange-Id: Ifc7af9f849cbfb677ef6f1adcf05956292d4f571\n","createdOn":1700236344,"status":"ABANDONED"},"project":{"name":"TestRepo"},"refName":"refs/heads/test_branch","changeKey":{"key":"Ifc7af9f849cbfb677ef6f1adcf05956292d4f571"},"type":"change-abandoned","eventCreatedOn":1700236563}Followed by ref-updated and eventCreatedOn the same time, that can be ignored Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"c69dc799c251a0023e78382225a90f9f1e9cfbf5","newRev":"8e4477b221efd63f6c064aacb75395e7480174a3","refName":"refs/changes/21/21/meta","project":"TestRepo"},"type":"ref-updated","eventCreatedOn":1700236563} |
| dev.cdevents.change.updated | patchset-created | Event JSON{"uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"patchSet":{"number":2,"revision":"66e097f59116e761f5473b66b351f7eba63aed50","parents":["b8112960b06810405b3e8ce6c8560ee93694700f"],"ref":"refs/changes/02/2/2","uploader":{"name":"Administrator","email":"[email protected]","username":"admin"},"createdOn":1700479995,"author":{"name":"Administrator","email":"[email protected]","username":"admin"},"kind":"REWORK","sizeInsertions":11,"sizeDeletions":0},"change":{"project":"TestRepo1","branch":"patch_create","id":"Ie10fd901201c53e9fe3b9766343060763ac81dc6","number":2,"subject":"update commit as per review","owner":{"name":"Administrator","email":"[email protected]","username":"admin"},"url":"http://959be7129610/c/TestRepo1/+/2","commitMessage":"update commit as per review\n\nChange-Id: Ie10fd901201c53e9fe3b9766343060763ac81dc6\n","createdOn":1700478731,"status":"NEW"},"project":{"name":"TestRepo1"},"refName":"refs/heads/patch_create","changeKey":{"key":"Ie10fd901201c53e9fe3b9766343060763ac81dc6"},"type":"patchset-created","eventCreatedOn":1700479996}Followed by ref-updated and eventCreatedOn the same time, that can be ignored Event JSON{"submitter":{"name":"Administrator","email":"[email protected]","username":"admin"},"refUpdate":{"oldRev":"97de9dd4a272dffe8cf881057108713d01e03930","newRev":"06932a8928e6e0beff7f9b65f04d9aa0f59b10d1","refName":"refs/changes/02/2/meta","project":"TestRepo1"},"type":"ref-updated","eventCreatedOn":1700479996} |
Once mapped the CDEvent will be created using CDEvents SDK(Java/Go) and send to the configured Events Broker URL
The Gerrit events that do not have corresponding CDEvents mapping,
| Gerrit Event Type |
|---|
| change-deleted |
| change-restored |
| dropped-output |
| hashtags-changed |
| batch-ref-updated |
| reviewer-added |
| reviewer-deleted |
| topic-changed |
| wip-state-changed |
| private-state-changed |
| vote-deleted |