README

The civicrm-upgrade-test suite provides a set of sample databases which can be used for testing upgrade-logic.

Scope

To facilitate testing of many databases, the current script uses the command-line-based upgrader (cv upgrade:db) and never uses the web-based UI (civicrm/upgrade). Therefore, it is appropriate for testing the database manipulations. It does not currently test for:

• Issues in the web UI (such as browser compatibility or CMS page-loading)
• Issues in the civicrm.settings.php
• Issues with setup or compatibility of PHP, MySQL, etc

Pre-Requisites

• Have a Unix-like environment (bash)
• Install CiviCRM and cv
• Configure the username/password for a MySQL administrator in ~/.my.cnf

Setup

## Checkout the repo
cd $HOME
git clone git://github.com/civicrm/civicrm-upgrade-test.git
cd civicrm-upgrade-test
composer install

Finding Test Cases

## Find snapshots from 5.0.0 through 5.30.0
./bin/civicrm-upgrade-examples @5.0.0..5.30.0

Running Test Cases

## Create and edit a settings file
cp examples/civicrm-upgrade-test.settings.txt civicrm-upgrade-test.settings
vi civicrm-upgrade-test.settings
## Note: The file will include comments on the configuration options

## Run the script with a single database
./bin/civicrm-upgrade-test databases/4.2.0-setupsh.sql.bz2

## Run the script with all databases
./bin/civicrm-upgrade-test databases/*.sql.bz2

## Run the script with any databases based on CiviCRM 4.0.x or 4.1.x
./bin/civicrm-upgrade-test databases/{4.0,4.1}*.sql.bz2

After executing any of the above commands, output will be written to the civicrm-upgrade-test/output directory. Examine these files to identify errors.

Creating Test Cases

To create a new test-case, one can take any CiviCRM database and dump it to a file -- as long as the CiviCRM database is separate from the Drupal database. By convention, any sharable databases should be stored in the "databases" directory and should be prefixed with a CiviCRM version number. For example:

mysqldump my_civi_db | bzip2 > databases/4.2.3-my_civi_db.sql.bz2
./scripts/update-json.php

This is not strictly required. If you want to create private test-cases, you can store them anywhere and follow your own naming convention.

Standalone Test Cases

The standard test snapshots do not work on Standalone, as they do not contain the required DB state for a Standalone system.

As such, a separate library of Standalone specific snapshots has been created in "databases_standalone" directory. This will be used automatically by civicrm-upgrade-test when running against a Standalone build.