com.qualinsight.libs.sonarqube.test.check

Class JavaCheckAssertions

java.lang.Object

com.qualinsight.libs.sonarqube.test.check.JavaCheckAssertions

public final class JavaCheckAssertions
extends Object

Provides assertions to help in JavaCheck behavior testing.

Author:

Michel Pawlak

Method Summary

Modifier and Type	Method and Description
static void	assertHasIssues(String testFileName, org.sonar.plugins.java.api.JavaFileScanner check) Asserts that a JavaCheck will raise all expected issues declared as non-compliances in a test file, and not more.
static void	assertHasIssues(String testFileName, org.sonar.plugins.java.api.JavaFileScanner check, com.google.common.collect.TreeMultimap<Integer,String> expectedIssues) Asserts that a JavaCheck will raise all expected issues provided as a parameter, and not more.
static void	assertHasNoIssue(String testFileName, org.sonar.plugins.java.api.JavaFileScanner check) Asserts that a JavaCheck will raise no issue when run against a specific test file.
static void	assertHasSingleIssue(String testFileName, org.sonar.plugins.java.api.JavaFileScanner check, Integer expectedLine, String expectedMessage) Asserts that a JavaCheck will raise the expected issue provided as method parameter, and not more.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

assertHasNoIssue

public static void assertHasNoIssue(String testFileName,
                                    org.sonar.plugins.java.api.JavaFileScanner check)

Asserts that a JavaCheck will raise no issue when run against a specific test file.

Parameters:

testFileName - the name of the test file that has to be checked for issues

check - the JavaCheck that is to be run against the test file

Throws:

IllegalArgumentException - if non compliances are declared in the test file

assertHasIssues

public static void assertHasIssues(String testFileName,
                                   org.sonar.plugins.java.api.JavaFileScanner check)

Asserts that a JavaCheck will raise all expected issues declared as non-compliances in a test file, and not more. Expected issues are read from the test file's comments.

Parameters:

testFileName - the name of the test file that has to be checked for issues

check - the JavaCheck that is to be run against the test file

Throws:

IllegalArgumentException - if no expected issue is found

See Also:

ExpectedIssuesCollector

assertHasIssues

public static void assertHasIssues(String testFileName,
                                   org.sonar.plugins.java.api.JavaFileScanner check,
                                   com.google.common.collect.TreeMultimap<Integer,String> expectedIssues)

Asserts that a JavaCheck will raise all expected issues provided as a parameter, and not more.

Parameters:

testFileName - the name of the test file that has to be checked for issues

check - the JavaCheck that is to be run against the test file

expectedIssues - TreeMultimap containing all expected issues. File issues can be declared by putting an issue message in the TreeMultimap with a null key.

Throws:

IllegalArgumentException - if no expected issue is found

See Also:

ExpectedIssuesCollector

assertHasSingleIssue

public static void assertHasSingleIssue(String testFileName,
                                        org.sonar.plugins.java.api.JavaFileScanner check,
                                        @Nonnull @Nonnegative
                                        Integer expectedLine,
                                        String expectedMessage)

Asserts that a JavaCheck will raise the expected issue provided as method parameter, and not more. Expected issues are provided as a parameter.

Parameters:

testFileName - the name of the test file that has to be checked for issues

check - the JavaCheck that is to be run against the test file

expectedLine - the line number on which the issue message is expected (or 0 if it is a file wide issue)

expectedMessage - the expected message

See Also:

ExpectedIssuesCollector