Part A:  Steps to Use This Framework to Run Tests Scripts:

Note:  These steps are for people who do not want to use the TagsTests.pl script included in the TestsScripts folder.  Please read Part B if that script is included in the run.

1.  Make sure the tests scripts are running fine without this framewrok.  For example:  "perl MyTestsScript.pl" works.

2.  Make sure the tests scripts output log files in the following format:
--TESTCASE--  Description of the test case.
--PASS--  Description of result.
or 
--FAIL--  List expected value and actual value.
or
--INFO--  Expected value is the same as actual value.  However, the issue is a too fuzzy to be called a pass.
or 
--WARNING--  Expected value is different from actual value.  However, the issue is a too fuzzy to be called a failure.
or
--ERROR--  Something happened during test.  The test was not finished or something.

(Please see the sample result files inside SampleResults folder.)

3:  It is best that every test script sets it own max running time by having the following line on top:
#<MaxTime>20</MaxTime>

The number represents the number of seconds.
If this line is missing, the default MaxTime is set to 60 seconds.

4.  Make sure Proc::Background perl module is installed on the test PC.

5.  Checkout this Tests Framework from SVN.

6.  Open the Tests.q file inside the "AutoTestsFramework/TestsScript" folder and edit it.

7.  Put the paths and perl tests scripts names on this file, one test script per line.  Please do not put the word "perl " in front of each script.

8.  On the last line of the Tests.q file, please change the path to ParseResults.pl to that of your PC.

9.  ParseResults.pl takes one param -- the folder containing the tests logs.  Please change "E:\AutoTestsFramework\SampleResults" to your own path.

10.  Go to the AutoTestsFramework\TestsFramework folder and type "perl TestsHarness.pl [Folder_Where_Tests.q_Is]".  The tests harness will start running scripts listed in Tests.q.
After that, log files will be parsed.  Results will be summarized and presented in an HTML file.


Part B:  Steps to get the TagsTests.pl sample tests script running:

1.  Install the DBI perl module on the test PC.

2.  Edit TagsTests.pl:
	a.  Change the paths of FreqUsed.pl and FreqUsedSlimDevices.pl to that of the test PC.
	b.  Change $gsLogDir to the path of where the tests logs will be.
	c.  A few tracks ae included in this Framework.  Change $gsTracksDir to where these tracks are.
	d.  Change $gsTracksInfoFile to where the file "ExpectedTagsValuesOfSongs.txt" is.
	e.  Change the $gsPlayer to the name of SqueezeBox or Duet Receiver attached to the test PC.

3.  Edit FreqUsedSlimDevices.pl:
	a:  Add the name of SqueezeBox or Duet Receiver and its MAC address to the %hashPlayersMACs inside sub GetPlayerMAC($).

4.  If more perl modules are needed during the test run, install them.