This tool allows you to easily start Thunderbird with a preconfigured Lightning and OBM connector. It relieves you of all the initial steps, including extension installation, setting up accounts, passwords and certificate overrides.
Dependencies are managed by setuptools, so all you need to do is:
python setup.py install
Now you will need to copy the obmtoolrc file to ~/.obmtoolrc and make any modifications you need. You also need to create the profileCache directory.
This section holds defaults for command line options:
# The default OBM user to set up
user=kewisch
# The password for the OBM user. Make sure config file permissions are
# strict (0600) when using this option.
password=xxx
# The URL of the OBM server to use
server=https://myobm.obm.org/obm-sync/services
# The default Thunderbird version to start
tbversion=24
# The obm version to start, an alias from the [paths] section.
obmversion=next-tb24
# If true, verbose output will be used
verbose=True
# If true, the profile will be reset on each startup
reset=True
# Sets the behavior after Thunderbird quits.
# prompt - In the console, prompt the user if a restart should be done
# auto - Automatically restart Thunderbird
# False - (default) Exit after Thunderbird has been quitted
restart=prompt
This section contains a few aliases that can be used either in the [defaults] section or on the commandline. The first part (lightning, obm, thunderbird) is used as a prefix, the second part (i.e next-tb24) is the alias that can be used on the commandline.
# Location of various Lightning installations. Can be an .xpi file
# or a path to an unpacked extension.
lightning-tb24=~/releases/ltn26/lightning-mac.xpi
lightning-tb17=~/releases/obm/lightning-1.9.24obm-tb-mac.xpi
lightning-tb10=~/releases/obm/lightning-1.2.3.24obm-tb-mac.xpi
lightning-tb3=~/releases/obm/lightning-1.0b2.25obm-tb-mac.xpi
# Location of various OBM Lightning Connector packages. Can be an
# .xpi file or a path to an unpacked extension.
obm-next-tb24=~/obm/tb24/lightning-connector-pkewisch/build/stage
obm-next-tb17=~/obm/tb17/lightning-connector-pkewisch/build/stage
# Location of various Thunderbird packages. On mac this is the
# path to the application bundle, on other platforms the path to the
# Thunderbird executable
thunderbird-24=~/mozilla/tbesr24/thunderbird/thunderbird-bin # Linux example
thunderbird-17=~/mozilla/tbesr17/Thunderbird.app # Mac example
thunderbird-10=d:/thunderbird10/thunderbird.exe # Windows example
# Cache directory for profiles. You need to create this directory.
profileCache=~/.obmtool/cache
# Comma separated list of extra hosts to create SSL certificate
# exceptions for. The OBM sync server will be added automatically.
certificates=vm.obm.org:443,vm.obm.org:143
# Extra password database entries, using signons.txt format.
signons=obm-obm-obm|obm-obm-obm|userb|userb
# Extra extensions to install, whitespace separated. Multiple
# lines can be used as long as the continuation line starts
# with a whitespace.
extensions=
~/mozilla/dist-extensions/ics-inspector-0.8.xpi
~/mozilla/dist-extensions/obmdeveloper-0.1.xpi
This section contains any extra preferences to set. Many debugging preferences are already set by the application, but you might want to set some extra preferences
Most usage is explained using obmtool --help. Note you can use aliases from the [paths] section for the options -t, -l and -o.
usage: obmtool [-h] [-t THUNDERBIRD] [-l LIGHTNING] [-o OBM] [-u USER]
[-s SERVER] [-e EXTENSION [EXTENSION ...]]
[-p key=value [key=value ...]] [-m MOZMILL [MOZMILL ...]]
[--format [pprint|pprint-color|json|xunit]] [--logfile LOGFILE]
[-v]
Start Thunderbird with a preconfigured OBM setup
optional arguments:
-h, --help show this help message and exit
-t THUNDERBIRD, --tbversion THUNDERBIRD
The Thunderbird version (17,24,...), or a path to the
binary.
-l LIGHTNING, --lightning LIGHTNING
The path to the Lightning XPI
-o OBM, --obm OBM The path to the OBM XPI
-u USER, --user USER The OBM user to set up
-s SERVER, --server SERVER
The sync services URI
-e EXTENSION [EXTENSION ...], --extension EXTENSION [EXTENSION ...]
An additional extension to install, can be specified
multiple times
-p key=value [key=value ...], --pref key=value [key=value ...]
Additional preferences to set, can be specified
multiple times. Value can be a string, integer or
true|false.
-m MOZMILL [MOZMILL ...], --mozmill MOZMILL [MOZMILL ...]
Run a specific mozmill test
--format [pprint|pprint-color|json|xunit]
Mozmill output format (default: pprint-color)
--logfile LOGFILE Log mozmill events to a file in addition to the
console
-v, --verbose Show more information about whats going on
With obmtool you can run MozMill tests. Initial setup will occur using the configuration and arguments provided. To use obmtool in mozmill mode, pass a manifest, test file or directory to the -m option. When passing a directory, all files beginning with "test_" will be processed. See the next section for examples.
When executing mozmill tests, you can use the --format and --logfile options to output events and results to a logfile.
As noted above, you can pass a test manifest to obmtool. This allows you to
easily put conditions on tests or disable them for other reasons. The basic
format is described
here.
In addition to what mozinfo defines (most importantly os), a few other variables
are predefined from the options passed to obmtool (values are examples):
tb_version = 24.0.2
ltn_version = 2.6.4
obm_version = 4.0.2
Each of the version variables is additionally split up into major, minor and maintenance values for convenience. Example:
ltn_version = 2.6.4
ltn_major = 2
ltn_minor = 6
ltn_maintenance = 4
You can use these variables in the passed manifest.ini. Note that currently the manifest parser only supports a very limited set of operators, please check the documentation.
[test_sso_buttons.js]
run-if = tb_major == 24
Start with Thunderbird 24, the corresponding Lightning version, the connector from the next-tb24 alias, with usera:
obmtool -t 24 -o next-tb24 -u usera
Example of how to use a custom Lightning and Thunderbird package:
obmtool -t ~/releases/tb24/Thunderbird.app -l ~/releases/lightning-2.6.1-custom.xpi # on mac
obmtool -t ~/releases/tb24/thunderbird-bin -l ~/releases/lightning-2.6.1-custom.xpi # on linux
Run a specific mozmill test by its filename on Thunderbird 24 with userb.
obmtool -t 24 -u userb -m ~/tests/test_create_event.js
Run all mozmill tests in the ~/tests directory, using the same options.
obmtool -t 24 -u userb -m ~/tests
- Allow passing http urls to -l or -o, possibly with a configurable prefix (i.e for getting a package from jenkins)
- Some more commandline options, i.e devtools debugger port, common obm settings like proactive sync.