org.codenarc.test.AbstractTestCase.groovy Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 the original author or authors.
 * 
 * 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 or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.codenarc.test

import org.apache.log4j.Logger
import org.junit.Before
import org.junit.Rule
import org.junit.rules.TestName

/**
 * Abstract superclass for tests 
 *
 * @author Chris Mair
 * @author Hamlet D'Arcy
  */

@SuppressWarnings(['AbstractClassWithoutAbstractMethod', 'ConfusingMethodName'])
abstract class AbstractTestCase {

    protected static final CODENARC_PROPERTIES_FILE_PROP = 'codenarc.properties.file'

    @SuppressWarnings('FieldName')
    protected final LOG = Logger.getLogger(getClass())

    @SuppressWarnings('PublicInstanceField')
    @Rule public TestName testName = new TestName()

    /**
     * Write out the specified log message, prefixing with the current class name.
     * @param message - the message to log; toString() is applied first
     */
    protected void log(message) {
        LOG.info message
    }

    protected String getName() {
        return testName.getMethodName()
    }

    private String classNameNoPackage() {
        def className = getClass().name
        def index = className.lastIndexOf('.')
        (index > -1) ? className[index + 1 .. -1] : className
    }

    //------------------------------------------------------------------------------------
    // Test Setup and Tear Down
    //------------------------------------------------------------------------------------

    @Before
    void setUpAbstractTestCase() {
        log "----------[ ${classNameNoPackage()}.${getName()} ]----------"
    }

}