Simple ready scripts

To quickly start using GitZilla:

• Install GitZilla. You may choose the .deb for easy installation on Debian/Ubuntu systems. Otherwise, just unpack the source and install in the usual setuptools way:

  sudo python setup.py install
  

• Switch to the hooks directory (/path/to/repository/.git/hooks) and delete the post-receive and update hooks.

• Link (or copy) the gitzilla provided hooks:

  ln -s $(which gitzilla-post-receive) post-receive
  ln -s $(which gitzilla-update) update
  

• Read and edit the config file at /etc/gitzillarc. A simple (and sufficient for most cases) configuration is something like:

  [/path/to/repository/.git]
  bugzilla_url: https://repo.example.com/bugzilla/
  bugzilla_user: foo@example.com
  bugzilla_password: blahblah
  allowed_bug_states: NEW, ASSIGNED, REOPENED
  

  (and even the last item is optional!)

• Commit away!

Custom GitZilla

If you need the hooks to do other stuff apart from just the Bugzilla integration, you could write your hook as a Python script and leave the Bugzilla stuff to one of the functions from gitzilla.hooks.

In fact with the defaults, the ready scripts are equivalent to the following:

post-receive:

#!/usr/bin/python
from gitzilla.hooks import post_receive
post_receive("https://repo.example.com/bugzilla", "username", "password")

update:

#!/usr/bin/python
from gitzilla.hooks import update
update()

The provided ready scripts do more, but that's just parsing and picking up values from the configuration files.

You could pass a custom bug id extraction regex and your own logging.Logger instance. The update hook function also accepts an array of allowed bug status strings.

Look at the module help for gitzilla.hooks for more information.

Down and dirty

This is an internal-only mode for now. More info when this is stable.

Mandatory parameters

• bugzilla_url

Optional parameters

• bugzilla_user

  the default username for Bugzilla.

• bugzilla_password

  the default password for Bugzilla.

• user_config

  allow/deny user specific bugzilla credentials. The legal values are allow, deny and force. Defaults to allow.

• allowed_bug_states

  a comma separated set of states that a bug must be in, in order for the commit to be allowed by the update hook.

• formatspec

  appended to --format=format: and passed to git whatchanged. See the git whatchanged manpage for more info.

• separator

  a string which would never occur in commit messages. You should not need to set this, as it is already at a safe default.

• bug_regex

  the (Python) regex for capturing bug numbers. MUST capture all the digits (and only the digits) of the bug id in a named group called bug. This regex is compiled internally with the MULTILINE, DOTALL and IGNORECASE options set. The default regex captures from the following forms:

  • bug 123
  • Bug # 123
  • BUG123
  • bug# 123
  • Bug #123

• logfile

  the file to log to. MUST be writable by the uid of the git process. In case of ssh pushes, tha usually means it should be writable by all.

• loglevel

  can be info or debug. Defaults to debug.

Security note

Note that the global config would be readable by all and may contain a bugzilla credentials. If you think this is a problem, you may rely on per-user auth.

If the user_config option is set to allow or force, then auth credentials are picked up from the user specific ~/.gitzillarc file.

If the user_config option is force and the ~/.gitzillarc does not contain bugzilla credentials, then the ~/.bugz_cookie file is used for authentication. To generate a cookie file, a user may use the gitzilla-gencookie script. The cookie validity will of course be dependent on your Bugzilla configuration. If neither credentials nor the cookie file are present (and valid), Bugzilla interactions will fail and the commits will be rejected.

If the user_config option is allow, then user specific credentials are used if available. Only if credentials are unavailable in both the user-specific as well as the systemwide configs, the cookie file is used. This configuration is the default because of the closeness of behaviour from version 1.0.

To summarize:

• To allow (but not force) users to use their own auth/credentials set user_config to allow and set bugzilla_user and bugzilla_password in the system wide config.
• To enforce user credentials, set user_config to force and leave the Bugzilla credentials out of the system wide config.
• To use system wide credentials only, set user_config to deny.
• To enforce Bugzilla integration, use the update hook. The update hook will check the validity of the credentials (system or user, depending on the config), regardless of the allowed_bug_states option. This is a change in behaviour from version 1.0.