<commit_before>#About fits-blackbox-testing

This project provides test scripts and tools for software developers contributing to the Harvard File Information Toolkit ([FITS](https://github.com/harvard-lts/fits)) project.

#Installation and Use

## Pre-Requisites

Before installation you'll require:

- an environment capable of running bash scripts.
- Java (versions yet to be tested) to execute the testing tool and FITS.
- Maven to build the Java test tools.
- a working git installation.

The scripts have been developed and tested on a Debian 7 linux box.
The test scripts should run fine on OSX systems that meet the other pre-requisites.
Windows users may be able to run the scripts using [Cygwin](http://www.cygwin.com), but this hasn't been tested.

##Installation

Clone this repository:
```
git clone <EMAIL>:openplanets/fits-blackbox-testing.git
```
*TODO:* Add working install instructions once project structure updated.

## Use

The tools are meant to help automate two tasks:

- Developers wanting to test the current HEAD of their development branch again the base of the branch.
- Maintainers given a set of commits that now fail testing, wishing to identify the earliest failed commit.
 
These two workflows are described below.

###Testing Candidate HEAD Against the Branch Base

To use the tool you must be developing in a FITS git repository, working on any branch other than master, with no uncommitted changes.
You can test this by issuing the command:
```
git status
```
You should see:
```
# On branch <my branch name>
nothing to commit (working directory clean)
```
and typing:
```
git status -s
```
should return no output.

*TODO:* Document this workflow with worked examples using FITS branch.

###Identifying the First Commit in Branch History to Fail Testing

This functionality to be implemented.

*TODO:* Implement git bisect run testing to find broken commit <commit_msg>Small README.md edit<commit_after>#About fits-blackbox-testing

This project provides test scripts and tools for software developers contributing to the Harvard File Information Toolkit ([FITS](https://github.com/harvard-lts/fits)) project.

#Installation and Use

## Pre-Requisites

Before installation you'll require:

- an environment capable of running bash scripts.
- Java (versions yet to be tested) to execute the testing tool and FITS.
- Maven to build the Java test tools.
- a working git installation.

The scripts have been developed and tested on a Debian 7 linux box.
The test scripts should run fine on OSX systems that meet the other pre-requisites.
Windows users may be able to run the scripts using [Cygwin](http://www.cygwin.com), but this hasn't been tested.

##Installation

Clone this repository:
```
git clone <EMAIL>:openplanets/fits-blackbox-testing.git
```
*TODO:* Add working install instructions once project structure updated.

## Use

The tools are meant to help automate two tasks:

- Developers wanting to test the current HEAD of their development branch again the base of the branch.
- Maintainers given a set of commits that now fail testing, wishing to identify the earliest failed commit.
 
These two workflows are described below.

###Testing Candidate HEAD Against the Branch Base

To use the tool you must be developing in a FITS git repository, working on any branch other than master, with no uncommitted changes.
You can test this by issuing the command:
```
git status
```
You should see:
```
# On branch <my branch name>
nothing to commit (working directory clean)
```
and typing ```git status -s``` returns no output.

*TODO:* Document this workflow with worked examples using FITS branch.

###Identifying the First Commit in Branch History to Fail Testing

This functionality to be implemented.

*TODO:* Implement git bisect run testing to find broken commit 
{'fraction_non_alphanumeric': 0.06558237145855195, 'fraction_numerical': 0.0005246589716684155, 'mean_word_length': 4.518089725036179, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2156463', 'n_tokens_mistral': 1008, 'n_tokens_neox': 961, 'n_words': 537}