##gerrit-sync This tool is used to create users, create groups, create projects and sync projects. Users and groups that already exist will not be modified on subsequent invocations.

####Usage Invoke gerrit-sync with an optional argument for configuration file. /etc/gerrit-python-tools/projects.yaml will be used by default when no configuration file argument is provided.

gerrit-sync

##gerrit-python-tools This was written for a scenario involving an upstream gerrit and a downstream gerrit. Downstream gerrit should receive code updates from upstream as changes are merged in on upstream. Code changes that have successfully passed review on downstream should be sent to upstream for review.

This tool will set up an event listener to both upstream and downstream and will respond to gerrit events on either accordingly.

ref-updated events on configured projects on the upstream event stream will cause a sync to downstream to take place.

comment-added events on configured projects on the downstream event stream will cause a push to upstream for review if configured criteria is met.

####Usage Invoke gerrit-python-tools with an optional argument for configuration file. /etc/gerrit-python-tools/projects.yaml will be used by defauled when no configuration file argument is provided.

gerrit-python-tools

##Configuration

###Logging The configuration for logging is located at /etc/gerrit-python-tools/logging.yaml. This may be made configurable in the future. The log will always use a TimedRotatingFileHandler that switches over at midnight.

Example:

file: '/var/log/gerrit-python-tools/gerrit-sync'
level: 'info'
format: '%(asctime)s - %(levelname)s - %(message)s'

Configuration for everything else should be in a single yaml file. By default, this file is located at /etc/gerrit-python-tools/projects.yaml. This file should contain the following sections

This section configures author information. gerrit-python-tools should only be authoring changes when it is configured to manage project.config files for downstream gerrit projects.

git-config:
  email: 'someaddress@somedomain.com'
  name: 'joe somebody'

gerrit-python-tools will run the following commands when authoring a project.config.

git config user.name "<name>"
git config user.email "<email>"

This section configures how to talk to a downstream gerrit.

gerrit:
  host: localhost
  port: 29418
  username: YourUserName
  git-config-email: "someemailaddress@somedomain.com"
  git-config-name: "some name"

####upstream This section configures how to talk to the upstream gerrit.

upstream:
  host: somehost
  port: 29418
  username: SomeUser
  timeout: 10
  keepalive: 60
  trigger: "Verified+2"

####upstream-labels This section configures the labels that must have sufficient approvals before a change can be sent to upstream for review. The section should be a yaml list of labels. The labels defined here will emulate the MaxWithBlock behavior. All projects will use these labels as criteria before sending to upstream unless otherwise configured.

Note: This should be changed in the future to look at submit records from a gerrit query.

upstream-labels:
  - name: Code-Review
    min: -2
    max: 2
  - name: Verified
    min: -2
    max: 2

In the above sample, a code change must have a +2 in Verified and Code-Review, both without a -2 before a change can be sent to upstream.

####daemon This section configures various parts of the gerrit-python-tools daemon.

daemon:
  numthreads: 5
  sleep: 5
  delay: 120
  upstream: True
  sync: True

####Projects This section configures the the projects that gerrit-python-tools will help manage. This section accepts a yaml list of objects describing projects.

projects:
  - name: All-Projects
    config: /etc/gerrit-python-tools/acls/All-Projects.config

  - name: upstream-project-1
    config: /etc/gerrit-python-tools/acls/project-1.config
    create: True
    source: 'https://github.com/YourUserName/project-1.git'
    upstream: True

  - name: downstream-project-2
    config: /etc/gerrit-python-tools/acls/project-2.config
    create: True
    source: 'https://github.com/YourUserName/project-2.git'

    # This is an example of how to specify upstream gating labels
    # per project.
  - name: upstream-project-3-special-labels
    create: True
    source: 'https://github.com/YourUserName/project-3.git'
    upstream-labels:
      - name: Special-Label
        min: -2
        max: 2
  - name: project1
    source: https://somegiturl/project1.git
    create: True

The following table describes the properties available per project:

####Groups This section accepts a yaml list of objects describing gerrit groups. gerrit-python-tools will attempt to create groups. No action will be taken if the group already exists.

groups:
  - name: core-devs
    owner: Administrators
    description: core developers with super powers.
  - name: "Continuous Integration Tools"
    owner: Administrators
    description: CI tools that need users belong here.

The following table describes the properties available to each group

####Users This section accepts a yaml list of objects desribing gerrit users. gerrit-python-tools will attempt to create users. No action will be taken if the user already exists.

users:
 - username: 'a-user-that-runs-tests'
   ssh-key: 'some ssh public key'
   groups:
     - "Continuous Integration Tools"