patterntesting.check.ct.JUnit4Aspect.aj Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-check-ct Show documentation

PatternTesting Check.CT (patterntesting-check-ct) is a quality framework that allows to automatically verify that Architecture/Design recommendations are implemented correctly in the code. It provides different checks of known anti patterns (like using System.out for logging) but provides also a test framework for better testing. The checks are done during compile time (this is the "CT" in Check.CT").

There is a newer version: 2.4.0

Show newest version

/**
 * $Id: JUnit4Aspect.aj,v 1.2 2015/09/07 19:44:49 oboehm Exp $
 *
 * Copyright (c) 2009 by Oliver Boehm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 15.03.2009 by oliver ([email protected])
 */
package patterntesting.check.ct;

import org.junit.*;

import patterntesting.annotation.check.ct.*;

/**
 * This aspect tries to detect some JUnit Anti Patterns like
 * 
 *  Misuse of Assertions
 *      print a warning for the use of "assertTrue"
 *          (using the wrong assert)
 *      
 *  Superficial Test Coverage
 *      no support
 *  Overly Complex Tests
 *      no support
 *  Catching Unexpected Exceptions
 *      You'll get a warning if you catch a warning in a test method.
 * 
 * 

 * For a complete list of JUnit anti patterns see
 * {@link "http://www.exubero.com/junit/antipatterns.html"}.
 * You can suppress the warnings of this aspect by marking a method or class
 * with @SuppressJUnitWarning.
 * 

 * NOTE: Only JUnit 4 is supported by this aspect. For JUnit 3 see
 *       JUnit3Aspect.
 *
 * @see JUnit3Aspect (support for JUnit 3)
 * @see SuppressJUnitWarning
 * @{link "http://www.exubero.com/junit/antipatterns.html"}
 *
 * @author oliver
 * @since 15.03.2009
 * @version $Revision: 1.2 $
 */
public aspect JUnit4Aspect {

    /**
     * A JUnit test method is recognized at the @Test annotation.
     * If you mark a method (or class) with @SuppressJUnitWarning you
     * can suppress the checks of this aspect.
     */
    pointcut withinTestMethod() :
        @withincode(Test)
        && !@withincode(SuppressJUnitWarning)
        && !@within(SuppressJUnitWarning)
        ;

    /**
     * Using the Wrong Assert
     * 

     * There are a large number of different methods beginning with assert
     * defined in the Assert class. Each of these methods has slightly
     * different arguments and semantics about what they are asserting.
     * However, many programmers seem to stick with a single assertion method:
     * assertTrue, and then force the argument of this method into the required
     * boolean expression.
     */
    declare warning :
        withinTestMethod() && call(static void Assert.assertTrue(boolean)) :
            "use other assert method here (e.g. assertEquals)";

    /**
     * Catching Unexpected Exceptions 

     * This anti-pattern seems to catch out a lot of developers who are new to
     * unit testing. When writing production code, developers are generally
     * aware of the problems of uncaught exceptions, and so are relatively
     * diligent about catching exceptions and logging the problem. In the case
     * of unit tests, however, this pattern is completly wrong!
     *
     * @see 
     *      Catching Unexpected Exceptions
     */
    declare warning :
        withinTestMethod() && handler(Throwable+) :
            "normally you don't need to catch exceptions inside JUnit tests, you can use '@Test(expected=Exception.class)' or ignore them";

}