Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-3658

Unit tests should throw exceptions

    XMLWordPrintable

    Details

    • Message:
      Remove this failure assertion and simply add the exception type to the method signature.
    • Highlighting:
      • Primary: Assert.fail
      • Secondary: try and catch (...)
    • Default Severity:
      Minor
    • Impact:
      Low
    • Likelihood:
      Low
    • Covered Languages:
      Java
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      2min
    • Analysis Scope:
      Test Sources

      Description

      When the code under test in a unit test throws an exception, the test itself fails. Therefore, there is no need to surround the tested code with a try-catch structure to detect failure. Instead, you can simply move the exception type to the method signature.

      This rule raises an issue when there is a fail assertion inside a catch block.

      Noncompliant Code Example

      @Test
public void testMethod() {
  try {
            // Some code
  } catch (MyException e) {
    Assert.fail(e.getMessage());  // Noncompliant
  }
}

      Compliant Solution

      @Test
public void testMethod() throws MyException {
    // Some code
}

        Attachments

          Issue Links

          is implemented by

          New Feature - A new feature of the product, which has yet to be developed. SONARJAVA-1750 Rule S3658: Unit test should throw exception instead of failing in a catch block

          • Major - Major loss of function.
          • Closed
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. SONARJAVA-3397 S3658, S5778, S5779, S5783 support AssertJ "fail"

          • Major - Major loss of function.
          • Closed

          Code Smell Detection - RSPEC-3431 "[ExpectedException]" should not be used

          • Active
          1.
          		 Java RSPEC-5775 Language-Specification Active Unassigned

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              nicolas.peru Nicolas Peru
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated: