PHPackages                             civicrm/upgrade-test - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. civicrm/upgrade-test

ActiveLibrary

civicrm/upgrade-test
====================

Collection of scripts and data-files for testing CiviCRM upgrades

v26.03.0(2mo ago)744.0k—4.2%5[1 PRs](https://github.com/civicrm/civicrm-upgrade-test/pulls)AGPL-3.0PHP

Since May 10Pushed 2mo ago8 watchersCompare

[ Source](https://github.com/civicrm/civicrm-upgrade-test)[ Packagist](https://packagist.org/packages/civicrm/upgrade-test)[ Docs](https://github.com/civicrm/civicrm-upgrade-test)[ RSS](/packages/civicrm-upgrade-test/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (13)Used By (0)

CiviCRM Upgrade Test Suite
--------------------------

[](#civicrm-upgrade-test-suite)

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

### Scope

[](#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

[](#pre-requisites)

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

### Setup

[](#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

[](#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

[](#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

[](#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

[](#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.

###  Health Score

56

—

FairBetter than 98% of packages

Maintenance87

Actively maintained with recent releases

Popularity36

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 85.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~393 days

Recently: every ~116 days

Total

12

Last Release

63d ago

Major Versions

0.11 → v26.03.02026-03-16

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1336047?v=4)[Tim Otten](/maintainers/totten)[@totten](https://github.com/totten)

---

Top Contributors

[![totten](https://avatars.githubusercontent.com/u/1336047?v=4)](https://github.com/totten "totten (99 commits)")[![seamuslee001](https://avatars.githubusercontent.com/u/6799125?v=4)](https://github.com/seamuslee001 "seamuslee001 (8 commits)")[![ufundo](https://avatars.githubusercontent.com/u/6513484?v=4)](https://github.com/ufundo "ufundo (5 commits)")[![colemanw](https://avatars.githubusercontent.com/u/2874912?v=4)](https://github.com/colemanw "colemanw (3 commits)")[![kurund](https://avatars.githubusercontent.com/u/151481?v=4)](https://github.com/kurund "kurund (1 commits)")

### Embed Badge

![Health badge](/badges/civicrm-upgrade-test/health.svg)

```
[![Health](https://phpackages.com/badges/civicrm-upgrade-test/health.svg)](https://phpackages.com/packages/civicrm-upgrade-test)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)