heiglandreas/JUnitDiff

[![Build Status](https://travis-ci.org/heiglandreas/JUnitDiff.svg?branch=master)](https://travis-ci.org/heiglandreas/JUnitDiff)
[![Code Climate](https://codeclimate.com/github/heiglandreas/JUnitDiff/badges/gpa.svg)](https://codeclimate.com/github/heiglandreas/JUnitDiff)
[![Test Coverage](https://codeclimate.com/github/heiglandreas/JUnitDiff/badges/coverage.svg)](https://codeclimate.com/github/heiglandreas/JUnitDiff/coverage)
[![Coverage Status](https://coveralls.io/repos/github/heiglandreas/JUnitDiff/badge.svg?branch=master)](https://coveralls.io/github/heiglandreas/JUnitDiff?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/heiglandreas/JUnitDiff/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/heiglandreas/JUnitDiff/?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1a2e1db4315f42efb79056e3f6c6bcbb)](https://www.codacy.com/app/github_70/JUnitDiff?utm_source=github.com&utm_medium=referral&utm_content=heiglandreas/JUnitDiff&utm_campaign=Badge_Grade)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/46c6fa0c-fcfd-468f-82e1-2c23256e1cd6/mini.png)](https://insight.sensiolabs.com/projects/46c6fa0c-fcfd-468f-82e1-2c23256e1cd6)

[![Latest Stable Version](https://poser.pugx.org/org_heigl/junitdiff/v/stable)](https://packagist.org/packages/org_heigl/junitdiff)
[![Total Downloads](https://poser.pugx.org/org_heigl/junitdiff/downloads)](https://packagist.org/packages/org_heigl/junitdiff)
[![License](https://poser.pugx.org/org_heigl/junitdiff/license)](https://packagist.org/packages/org_heigl/junitdiff)
[![Dependency Status](https://www.versioneye.com/user/projects/5766582207354000415185ba/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5766582207354000415185ba)
[![composer.lock](https://poser.pugx.org/org_heigl/junitdiff/composerlock)](https://packagist.org/packages/org_heigl/junitdiff)

# JUnitDiff

A small CLI to check which tests have changed between test runs.

This software is in an early alpha-stage. PRs and improvement-ideas are more than welcome.

## Installation

JUnitDiff can be installed in one of the two following ways:

### composer.

Run this in your projects root-folder to include JUnitDiff as development-dependency
```bash
$ composer global require --dev org_heigl/junitdiff
```

### Phar

Download the latest release as PHAR-file from the [release-page](https://github.com/heiglandreas/JUnitDiff/releases/).

The releases are signed using the JUNitDiff GPG-Key with ID AE11B9CEBADB342A and
Fingerprint ```A84C BFAC 7147 9C6C E37E FF47 AE11 B9CE BADB 342A```.
 
You can verify the phar-file using these commands:

```bash
gpg --keyserver pgp.mit.edu --recv-key 0xAE11B9CEBADB342A
gpg --fingerprint AE11B9CEBADB342A
gpg --verify junitdiff.phar.asc junitdiff.phar
```

Feel free to rename the file ```junitdiff.phar``` to ```junitdiff``` for easier
execution.

## Usage

JUnitDiff compares two JUnit log files which can be generated with e.g. `phpunit`.

```bash
$ phpunit --log-junit logfile.xml
```

When you have two JUnit log files from two different test runs available you can check which tests have changed between those with `junitdiff`.

```bash
$ php junitdiff.diff compare </path/to/first/logfile> </path/to/last/logfile>
```

An example output might be:

```bash
[o] Test MyTest::testStoringIdWorks changed from success to error
[+] New Test MyTest::testStoringIdWorksBetter with data set #7
[-] Removed Test MyTest::testStoringIdWorksBest
```

## Caveat

PHPUnit adds information about skipped or ignored tests into the JUnit-lof file starting with 
PHPUnit 6.0! So files created with a previous version do not provide information
about skipped or ignored tests. ([Thanks to Sebastian Bergmann for that info!](https://github.com/heiglandreas/JUnitDiff/issues/3))
Until [Issue 3](https://github.com/heiglandreas/JUnitDiff/issues/3)
is resolved  they will **not** be shown in the output! But as they are
ignored or skipped and therefore not executed they are just like not existing tests at
all, so it shouldn't be an issue.