BuildReport

data class BuildReport: Any

Represents the output that is generated by Maven for a certain Submission's code.

Fields

Name Description
val LOG: LoggerFactory.getLogger(this.javaClass.name)
val mavenOutputLines: List<String>

is a List of String, where each String is a line of the Maven's build process's output

val mavenizedProjectFolder: String

is a String

val assignment: Assignment

identifies the Assignment that Submission targetted.

val junitResults: List<JUnitResults>

is a List of JunitResults with the result of evaluating the Submission using JUnit tests

val jacocoResults: List<JacocoResults>

is a List of JacocoResults with the result of evaluating the Submission's code coverage

val assignmentTestMethods: List<AssignmentTestMethod>

is a List of AssignmentTestMethod. Each object describes on of the executed Unit Tests

Constructors

<init>

constructor(mavenOutputLines: List<String>, mavenizedProjectFolder: String, assignment: Assignment, junitResults: List<JUnitResults>, jacocoResults: List<JacocoResults>, assignmentTestMethods: List<AssignmentTestMethod>)

Represents the output that is generated by Maven for a certain Submission's code.

Parameters

Name Description
mavenOutputLines: List<String>
mavenizedProjectFolder: String
assignment: Assignment
junitResults: List<JUnitResults>
jacocoResults: List<JacocoResults>
assignmentTestMethods: List<AssignmentTestMethod>

Methods

mavenOutput

fun mavenOutput(): String

ReturnValue

Name Description
String

mavenExecutionFailed

fun mavenExecutionFailed(): Boolean

ReturnValue

Name Description
Boolean

compilationErrors

fun compilationErrors(): List<String>

Collects from a Maven Output the errors related with the Compilation process.

ReturnValue

Name Description
List<String>

a List of String where each String is a Compilation problem / warning.

checkstyleErrors

fun checkstyleErrors(): List<String>

Collects from a Maven Output the errors related with the CheckStyle plugin / rules.

ReturnValue

Name Description
List<String>

a List of String where each String is a CheckStyle problem / warning.

checkstyleValidationActive

fun checkstyleValidationActive(): Boolean

ReturnValue

Name Description
Boolean

PMDerrors

fun PMDerrors(): List<String>

ReturnValue

Name Description
List<String>

junitSummary

fun junitSummary(testType: TestType): String?

Parameters

Name Description
testType: TestType

ReturnValue

Name Description
String?

junitSummaryAsObject

fun junitSummaryAsObject(testType: TestType): JUnitSummary?

Creates a summary of the testing results, considering a certain TestType.

Parameters

Name Description
testType: TestType

is a TestType, indicating which tests should be considered (e.g TEACHER tests)

ReturnValue

Name Description
JUnitSummary?

a JUnitSummary

elapsedTimeJUnit

fun elapsedTimeJUnit(): BigDecimal?

Calculates the total elapsed time during the execution of the Unit Tests. Considers both the public and the private (hidden) tests.

ReturnValue

Name Description
BigDecimal?

a BigDecimal representing the elapsed time

hasJUnitErrors

fun hasJUnitErrors(testType: TestType): Boolean?

Determines if the evaluation resulted in any JUnit errors or failures.

Parameters

Name Description
testType: TestType

ReturnValue

Name Description
Boolean?

jUnitErrors

fun jUnitErrors(testType: TestType): String?

Determines if the evaluation resulted in any JUnit errors or failures.

Parameters

Name Description
testType: TestType

ReturnValue

Name Description
String?

notEnoughStudentTestsMessage

fun notEnoughStudentTestsMessage(): String?

Determines if the student's (own) Test class contains at least the minimum number of JUnit tests that are expected by the Assignment.

ReturnValue

Name Description
String?

a String with an informative error message or null.

testResults

fun testResults(): List<JUnitMethodResult>?

ReturnValue

Name Description
List<JUnitMethodResult>?