test/automation/README.md

<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# Automated Cluster Testing

Testing a snapshot version of Accumulo on a cluster using this respository requires many repetive steps.  Luckily, there is script that automates this using [Muchos].  This script is found in [test/automation/automateEC2.sh](automateEC2.sh).  

Before running the script, edit [cluster_props.sh](cluster_props.sh). All repositories are set to the main branch of the corresponding Apache project by default. You can change these values to your specific forks and branches as desired.

A path to `muchos.props` is required in order to run the script. You can find the required configurations and an example of `muchos.props` [in the official Fluo-Muchos readme][Muchos].

### Execution takes no arguments as followed: 
    ./automateEC2.sh

### Things to consider:
* The script will read from the `MUCHOS_PROPS` environment variable if defined. 
* Accumulo versions between `muchos.props` and `pom.xml` file of a given Accumulo branch should be consistent.
* Accumulo and Fluo-Muchos will be installed locally in a temporary directory under `/tmp`, which is typically cleared by the operating system periodically (system-specific, possibly on reboots, daily, weekly, etc.).

[Muchos]: https://github.com/apache/fluo-muchos