SpecialistOff.NET / Вопросы / Статьи / Фрагменты кода / Резюме / Метки / Помощь / Файлы

2.5.3.13. GerritChangeSource

Метки: buildbot

classbuildbot.changes.gerritchangesource.GerritChangeSource

The GerritChangeSource class connects to a Gerrit server by its SSH interface and uses its event source mechanism, gerrit stream-events.

Note that the Gerrit event stream is stateless and any events that occur while buildbot is not connected to Gerrit will be lost. See GerritEventLogPoller for a stateful change source.

The patchset-created and ref-updated events will be deduplicated, that is, if multiple events related to the same revision are received, only the first will be acted upon. This allows GerritChangeSource to be used together with GerritEventLogPoller.

The GerritChangeSource accepts the following arguments:

gerritserver: The dns or ip that host the Gerrit ssh server
gerritport: The port of the Gerrit ssh server
username: The username to use to connect to Gerrit
identity_file: Ssh identity file to for authentication (optional). Pay attention to the ssh passphrase
handled_events: Event to be handled (optional). By default processes patchset-created and ref-updated
get_files: Populate the files attribute of emitted changes (default False). Buildbot will run an extra query command for each handled event to determine the changed files.
debug: Print Gerrit event in the log (default False). This allows to debug event content, but will eventually fill your logs with useless Gerrit event logs.

By default this class adds a change to the Buildbot system for each of the following events:

patchset-created: A change is proposed for review. Automatic checks like checkpatch.pl can be automatically triggered. Beware of what kind of automatic task you trigger. At this point, no trusted human has reviewed the code, and a patch could be specially crafted by an attacker to compromise your workers.
ref-updated: A change has been merged into the repository. Typically, this kind of event can lead to a complete rebuild of the project, and upload binaries to an incremental build results server.

But you can specify how to handle events:

Any event with change and patchSet will be processed by universal collector by default.
In case you’ve specified processing function for the given kind of events, all events of this kind will be processed only by this function, bypassing universal collector.

An example:

from buildbot.plugins import changes

class MyGerritChangeSource(changes.GerritChangeSource):
    """Custom GerritChangeSource
    """
    def eventReceived_patchset_created(self, properties, event):
        """Handler events without properties
        """
        properties = {}
        self.addChangeFromEvent(properties, event)

This class will populate the property list of the triggered build with the info received from Gerrit server in JSON format.

Warning

If you selected GerritChangeSource, you must use Gerrit source step: the branch property of the change will be target_branch/change_id and such a ref cannot be resolved, so the Git source step would fail.

In case of patchset-created event, these properties will be:

event.change.branch: Branch of the Change
event.change.id: Change’s ID in the Gerrit system (the ChangeId: in commit comments)
event.change.number: Change’s number in Gerrit system
event.change.owner.email: Change’s owner email (owner is first uploader)
event.change.owner.name: Change’s owner name
event.change.project: Project of the Change
event.change.subject: Change’s subject
event.change.url: URL of the Change in the Gerrit’s web interface
event.patchSet.number: Patchset’s version number
event.patchSet.ref: Patchset’s Gerrit “virtual branch”
event.patchSet.revision: Patchset’s Git commit ID
event.patchSet.uploader.email: Patchset uploader’s email (owner is first uploader)
event.patchSet.uploader.name: Patchset uploader’s name (owner is first uploader)
event.type: Event type (patchset-created)
event.uploader.email: Patchset uploader’s email
event.uploader.name: Patchset uploader’s name

In case of ref-updated event, these properties will be:

event.refUpdate.newRev: New Git commit ID (after merger)
event.refUpdate.oldRev: Previous Git commit ID (before merger)
event.refUpdate.project: Project that was updated
event.refUpdate.refName: Branch that was updated
event.submitter.email: Submitter’s email (merger responsible)
event.submitter.name: Submitter’s name (merger responsible)
event.type: Event type (ref-updated)
event.submitter.email: Submitter’s email (merger responsible)
event.submitter.name: Submitter’s name (merger responsible)

A configuration for this source might look like:

from buildbot.plugins import changes

c['change_source'] = changes.GerritChangeSource(
    "gerrit.example.com",
    "gerrit_user",
    handled_events=["patchset-created", "change-merged"])

See master/docs/examples/git_gerrit.cfg or master/docs/examples/repo_gerrit.cfg in the Buildbot distribution for a full example setup of Git+Gerrit or Repo+Gerrit of GerritChangeSource.