gerrit_to_platform package

Submodules

gerrit_to_platform.change_merged module

Handler for patchset-created events.

gerrit_to_platform.change_merged.change_merged(change: str, change_url: str, change_owner: str, change_owner_username: str, project: str, branch: str, topic: str, submitter: str, submitter_username: str, commit: str, newrev: str)

Handle change-merged hook.

Parameters:

• change (str) – change ID

• change_url (str) – change URL

• change_owner (str) – change owner eg: ‘Foo <foo@example.com>’

• change_owner_username (str) – change owner username eg: ‘foo’

• project (str) – Gerrit project name

• branch (str) – branch change is against

• topic (str) – topic change is part of

• submitter (str) – submitter of change eg: ‘Foo <foo@example.com>’

• submitter_username (str) – submitter of change username eg: ‘foo’

• commit (str) – SHA1 of commit

• newrev (str) – SHA1 of commit

gerrit_to_platform.comment_added module

Handler for patchset-created events.

gerrit_to_platform.comment_added.comment_added(context: Context, change: str, change_url: str, change_owner: str, change_owner_username: str, project: str, branch: str, topic: str, author: str, author_username: str, commit: str, comment: str)

Handle comment-added hook.

Approval scores should be added as –<approval category id> <score>

When a score is removed it should be –<approval category id>-oldValue <score>

Multiple scores and old scores may be passed

ex: –Code-Review +1 –Code-Review-oldValue 0

Parameters:

• context (typer.Context) – handler for the typer context to allow for extra non-defined parameters (code scores, see above)

• change (str) – change ID

• change_url (str) – change URL

• change_owner (str) – change owner eg: ‘Foo <foo@example.com>’

• change_owner_username (str) – change owner username eg: ‘foo’

• project (str) – Gerrit project name

• branch (str) – branch change is against

• topic (str) – topic change is part of

• submitter (str) – submitter of change eg: ‘Foo <foo@example.com>’

• submitter_username (str) – submitter of change username eg: ‘foo’

• commit (str) – SHA1 of commit

• comment (str) – the comment added to the change

gerrit_to_platform.config module

Configuration subsystem.

class gerrit_to_platform.config.Platform(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enumeration of all platforms recognized by the app.

GITHUB = 'github'

GITLAB = 'gitlab'

class gerrit_to_platform.config.Remote

Bases: TypedDict

Remote Dictionary definition.

owner: str

remotenamestyle: str

repo: str

class gerrit_to_platform.config.ReplicationRemotes

Bases: TypedDict

Platform Dictionary definition.

github: Dict[str, Remote]

gitlab: Dict[str, Remote]

gerrit_to_platform.config.get_config(config_type: str = 'config') → ConfigParser

Get the config object.

Parameters:

config_type (str) – Type of configuration file that the parser should use

Returns:

A loaded ConfigParser object with the requested

configuration file

Return type:

ConfigParser

gerrit_to_platform.config.get_mapping(mapping_section: str) → Dict[str, str] | None

Return all of the keyword to job mappings

Parameters:

mapping_section (str) – the section of the config file to load

Returns:

The key / value mapping object or None if it

does not exist

Return type:

Optional(Dict[str,str])

gerrit_to_platform.config.get_replication_remotes() → ReplicationRemotes

Get the replication remotes available.

Returns:

All the replication remotes defined the Gerrit

configuration file

Return type:

ReplicationRemotes

gerrit_to_platform.config.get_setting(section: str, option: str | None = None) → list | str

Get all configuration options from a section, or specific option from a section.

Parameters:

• section (str) – config section to use

• option (Optional[str]) – a suboption to get from the section

Returns:

all of the configuration for a section str: the single sub-option of a section

Return type:

list

gerrit_to_platform.config.has_section(section: str) → bool

Indicate if section exists in config file.

Parameters:

section (str) – config section to lookup

Returns:

True if the section exists in configuration, False otherwise

Return type:

bool

gerrit_to_platform.github module

Github connection module.

gerrit_to_platform.github.dispatch_workflow(owner: str, repository: str, workflow_id: str, ref: str, inputs: Dict[str, str]) → Any

Trigger target workflow on GitHub.

Parameters:

• owner (str) – GitHub owner (user or organization)

• repository (str) – target repository

• workflow_id (str) – ID of the workflow to trigger

• ref (str) – the commit ref to trigger with

• inputs (Dict[str, str]) – dictionary of key / value pairs to pass as inputs to the workflow

gerrit_to_platform.github.filter_path(search_filter: str, workflow: Dict[str, str]) → bool

Case insensitive path filter for use in lambda filters.

Parameters:

• search_filter (str) – string to search workflow file names for

• workflow (Dict[str, str]) – dictionary containing all data related to the workflow being evaluated

Returns:

True if search_filter matches in workflow[“path”], False otherwise

Return type:

bool

gerrit_to_platform.github.filter_workflows(owner: str, repository: str, search_filter: str, search_required: bool = False) → List[Dict[str, str]]

Return a case insensitive filtered list of workflows.

All workflows must meet the basic filtering of containing the search_filter in the name as well as “gerrit” in the name.

If search_required is true, then the list will contiain all workflows that contain “required” in the name

If search_required is false (the default), then the list will _exclude_ all workflows that contain “required” in the name.

Parameters:

• owner (str) – GitHub owner (entity or organization)

• repository (str) – target repository

• search_filter (str) – the substring to search for in workflow filenames

• search_required (bool) – if workflows with “required” in the filename are to be returned. If false, then required workflows will be filtered out, if true only required workflows will be returned.

Returns:

list of dictionaries containing all workflows

that meet the search criteria of having “gerrit” in the name, the search_filter substring, and either required or not required according to the search_required argument.

Return type:

List[Dict[str, str]]

gerrit_to_platform.github.get_workflows(owner: str, repository: str) → List[Dict[str, str]]

Get all active workflows for specific repository.

Parameters:

• owner (str) – GitHub owner (entity or organization)

• repository (str) – target repository

Returns:

list of dictionaries containing data related to

active workflows in the target repository.

Return type:

List[Dict[str, str]]

gerrit_to_platform.helpers module

Common helper functions.

gerrit_to_platform.helpers.choose_dispatch(platform: Platform) → Callable | None

Choose platform job dispatcher.

Parameters:

platform (Platform) – the platform that the dispatch is being looked up for

Returns:

The appropriate callable matching the dispatch_worfklow call

signature for the platform

None: If no dispatch_workflow is defined for the platform passed in a

None is returned

Return type:

Callable

gerrit_to_platform.helpers.choose_filter_workflows(platform: Platform) → Callable | None

Choose platform workflow filter.

Parameters:

platform (Platform) – the platform that the filter_workflows is being looked up for

Returns:

The appropriate callable matching the filter_workflows call

signature for the platform

None: If no filter_workflows is defined for the platform passed in a

None is returned

Return type:

Callable

gerrit_to_platform.helpers.convert_repo_name(remotes: ReplicationRemotes, platform: Platform, remote: str, repository: str) → str

Convert the repository name based on the remotenamestyle of the target platform/owner.

Parameters:

• remotes (ReplicationRemotes) – object containing the defined remotes styles

• platform (Platform) – what platform is the conversion happening against

• remote (str) – The specific remote that is being worked on

• repository (str) – The repository name that needs conversion

Returns:

The repository name converted to the appropriate flattening for

the target remote

Return type:

str

gerrit_to_platform.helpers.find_and_dispatch(project: str, workflow_filter: str, inputs: Dict[str, str])

Find relevant workflows and dispatch them.

Parameters:

• project (str) – the project repository name

• workflow_filter (str) – the filter for the workflow names

• inputs (Dict[str, str]) – key / value pair dictionary for inputs to be passed to the target workflow dispatch

gerrit_to_platform.helpers.get_change_id(change: str) → str

Get the Gerrit change_id from an hook event.

Parameters:

change (str) – the change string passed to event handlers

Returns:

The extracted Gerrit change_id from the event hook

Return type:

str

gerrit_to_platform.helpers.get_change_number(change_url: str) → str

Get the Gerrit change_number

Parameters:

change_url (str) – the url to the specific change passed by the Gerrit event

Returns:

The change number as string extracted from the url

Return type:

str

gerrit_to_platform.helpers.get_change_refspec(change_number: str, patchset: str) → str

Return the change refspec from the change number (str) and patch number

Parameters:

• change_number (str) – The change number to work with

• patchset (str) – The patchset number to work with

Returns:

The git refspec pointing to the hidden ref for the specific change

and patchset

Return type:

str

gerrit_to_platform.helpers.get_magic_repo(platform: Platform) → str | None

Get the “magic” repo for a given Platform used to store organization wide required workflows

Parameters:

platform (Platform) – Platform to lookup magic repo for

Returns:

The magic repo name or None if not defined for the

platform

Return type:

Optional[str]

gerrit_to_platform.patchset_created module

Handler for patchset-created events.

gerrit_to_platform.patchset_created.patchset_created(change: str, kind: str, change_url: str, change_owner: str, change_owner_username: str, project: str, branch: str, topic: str, uploader: str, uploader_username: str, commit: str, patchset: str)

Handle patcheset-created hook.

Parameters:

• change (str) – change ID

• kind (str) – type of change

• change_url (str) – change URL

• change_owner (str) – change owner eg: ‘Foo <foo@example.com>’

• change_owner_username (str) – change owner username eg: ‘foo’

• project (str) – Gerrit project name

• branch (str) – branch change is against

• topic (str) – topic change is part of

• uploader (str) – uploader of change eg: ‘Foo <foo@example.com>’

• uploader_username (str) – uploader of change username eg: ‘foo’

• commit (str) – SHA1 of commit

• patchset (str) – patchset number

Module contents