TestEngine

Object
- TestEngine

```
public class TestEngine
extends Object
```
Used to generated expected results by running against the solution and also used to grade student assignments once expected results have been generated. How to use to generate expected results:
1. Copy TestEngine and TestSuite to package where solution resides. Add package statement to each as necessary.
2. Write test methods in TestSuite.
3. Set path variable so that expectedResults.txt will be located in the package. If using Eclipse, path="src\\soln_package\\" is probably what you want.
4. Set shouldGenerateExpectedResults=true
5. Run. This generates expectedResults.txt and also displays it to the console.
6. Set shouldGenerateExpectedResults=false
7. Run. You are grading the solution, thus, examine the console which shows the studentReport and make sure everything looks correct. If not, repeat these steps.
How to use to grade a student assignment:
1. Copy TestEngine, TestSuite, and expectedResults.txt to package where student solution resides. Add package statement to each as necessary.
2. Set path variable so that expectedResults.txt will be located in the package. If using Eclipse, path="src\\student_package\\" is probably what you want.
3. Set shouldGenerateExpectedResults=false
4. Run. This generates studentReport.txt and also displays it to the console

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) File`	`expectedResultsFile`
`(package private) GradeReport`	`gradeReport`
`(package private) String`	`path` Path to location where student assessment summary should be saved if `shouldSaveStudentReport=true`.
`(package private) boolean`	`shouldGenerateExpectedResults` Set to `true` when generating expected results by running against the solution.
`(package private) boolean`	`shouldSaveStudentReport` Set to `true` to save assessment summary from running against student solution.
`(package private) File`	`studentReportFile`

Constructor Summary

Constructors
Constructor and Description

TestEngine()

Constructors
Constructor and Description
`TestEngine()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addActualResults(ArrayList<ArrayList<String>> resultsLists)` Adds the list of results from running against the student solution (actual results) to the `GradeReport`
`private GradeReport`	`buildExpectedGradeReport(ArrayList<ArrayList<String>> resultsLists)` Builds the `GradeReport` holding the expected results when running against the solution.
`private void`	`generateActualResults()` Runs against student solution, assesses against expected results and displays a summary.
`private void`	`generateExpectedResults()` Builds and saves the expected results by running program against the solution.
`private ArrayList<ArrayList<String>>`	`generateTestResults()` Run the test case methods.
`static void`	`main(String[] args)` Program either (a) generates and saves the expected results or (b) generates, assesses and saves the actual results from running against the student solution.
`private ArrayList<ArrayList<String>>`	`readExpectedResults(File file)` Read the expected results that are saved in `file`
`private void`	`saveResults(String results, File file)` Saves a text file.
`private ArrayList<String>`	`testMethodNames()` Gets the names of the test case methods in `TestSuite`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - gradeReport
```
GradeReport gradeReport
```
  - shouldGenerateExpectedResults
```
boolean shouldGenerateExpectedResults
```
    Set to true when generating expected results by running against the solution. Set to false when running against a student solution. Must have expected results file.
  - shouldSaveStudentReport
```
boolean shouldSaveStudentReport
```
    Set to true to save assessment summary from running against student solution. This is optional because it always displays to console.
  - path
```
String path
```
    Path to location where student assessment summary should be saved if shouldSaveStudentReport=true. Can ignore if set to false
  - studentReportFile
```
File studentReportFile
```
  - expectedResultsFile
```
File expectedResultsFile
```
- Constructor Detail
  - TestEngine
```
public TestEngine()
```
- Method Detail
  - generateExpectedResults
```
private void generateExpectedResults()
```
    Builds and saves the expected results by running program against the solution.
  - generateActualResults
```
private void generateActualResults()
```
    Runs against student solution, assesses against expected results and displays a summary.
  - testMethodNames
```
private ArrayList<String> testMethodNames()
```
    Gets the names of the test case methods in TestSuite
    
    Returns:
    
    the sorted list of method names.
  - generateTestResults
```
private ArrayList<ArrayList<String>> generateTestResults()
```
    Run the test case methods.
    
    Returns:
    
    a list of results from teach test case method. Each method produces an ArrayList<String> of results. This return is the collection of all these lists.
  - buildExpectedGradeReport
```
private GradeReport buildExpectedGradeReport(ArrayList<ArrayList<String>> resultsLists)
```
    Builds the GradeReport holding the expected results when running against the solution.
    
    Parameters:
    
    resultsLists - the list of expected results from each test case method when running against the solution.
    
    Returns:
  - addActualResults
```
private void addActualResults(ArrayList<ArrayList<String>> resultsLists)
```
    Adds the list of results from running against the student solution (actual results) to the GradeReport
    
    Parameters:
    
    resultsLists - the list of actual results from each test case method when running against the student solution.
  - readExpectedResults
```
private ArrayList<ArrayList<String>> readExpectedResults(File file)
```
    Read the expected results that are saved in file
    
    Parameters:
    
    file - contains the expected results
    
    Returns:
    
    a list of results containing the expected results.
  - saveResults
```
private void saveResults(String results,
                         File file)
```
    Saves a text file.
    
    Parameters:
    
    results - either the expected results or the GradeReport summary from running against the student solution.
    
    file -
  - main
```
public static void main(String[] args)
```
    Program either (a) generates and saves the expected results or (b) generates, assesses and saves the actual results from running against the student solution.
    
    Parameters:
    
    args -

Class TestEngine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

gradeReport

shouldGenerateExpectedResults

shouldSaveStudentReport

path

studentReportFile

expectedResultsFile

Constructor Detail

TestEngine

Method Detail

generateExpectedResults

generateActualResults

testMethodNames

generateTestResults

buildExpectedGradeReport

addActualResults

readExpectedResults

saveResults

main