README.md

TeammatesTesting

Used for building and testing branches forked from Teammates project

To Request a Test-run on our remote testing station:

1. Clone this repository to your local system.
2. Switch to the master branch (git checkout master)
3. Tag the latest commit with in the following format:
   1. Tag Name: {remote}---{branch}. Eg: origin---master
   2. Tag Message: Anything for now. (Watch this space for more flexibility running tests)
   3. Push just the tag to the remote ( git push origin {tag_name})
   
   Or simply:
   git tag -a {remote}---{branch} -m "{tag-message}"
git push origin {remote}---{branch}


4. If you would like run a branch again, simply push the tag to the remote again:
   git push origin {remote}---{branch}

To get the results and make sense of it:

1. Once the remote stating is done testing the requested branch, it will upload the test results to a new branch in this repository (TeammatesTesting) with a branchname {remote}-{branch} based on the parameters specified in the tag that was used for the request.
2. The following files will be uploaded as part of the test output:
   1. A folder named test-output containing the final testng results based on the 5th run of the failed tests
   2. A text file named git-output.txt will contain the output from the git commands used to access the branch that was requested
   3. A text file named build-output.txt will contain the output of the ANT builder that is used to compile and enhance the app
   4. A text file named server-output.txt will contain the entire output from the server that was started (inc. logging from the main app)
   5. A text file named testng-output.txt will contain the entire output from the testng process (inc. logging from the tests)


3. If there were any errors while trying to test the branch, one of the following happens:
   1. Invalid format: If the request does not comply to the {remote}---{branch} format, it is simply ignored
   2. Branch does not exist: If the requested branch does not exist in the specified remote, the git-output.txt will contain the error information and no other files will be uploaded to the new branch created in this repo
   3. Build error: if the version of the app on the branch does not compile/enhance, the build-output.txt file will contain all the required information to debug the build issue. The testng-output.txt will contain one line indicating that test did not run because building failed
   4. Testng Test Failures: All the failed test cases with all related information (testname, reason, any exceptions in the server, any exceptions in the testng process) will be packaged in the various text files that are uploaded with a summary view available at: test-output/index.html
<

Please use the issue tracker to let us know of any bugs/problems that you may face.

Enjoy the TeammatesTesting system!