org.opencms.test.OpenCmsTestLogAppender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.test;

import org.apache.log4j.ConsoleAppender;
import org.apache.log4j.Priority;
import org.apache.log4j.spi.LoggingEvent;

/**
 * Simple extension of the log4j console appender that throws a
 * RuntimeException if an error (or fatal) event is logged,
 * causing the running test to fail.
 *
 * @since 6.0.0
 */
public class OpenCmsTestLogAppender extends ConsoleAppender {

    // indicates if a logged error / fatal message should cause a test to fail
    private static boolean m_breakOnError;

    private static I_CmsLogHandler m_handler;

    /**
     * Sets the "break on error" status.
     *
     * @param value the "break on error" status to set
     */
    public static void setBreakOnError(boolean value) {

        m_breakOnError = value;
    }

    public static void setHandler(I_CmsLogHandler handler) {

        m_handler = handler;
    }

    /**
     * @see org.apache.log4j.WriterAppender#append(org.apache.log4j.spi.LoggingEvent)
     */
    @Override
    public void append(LoggingEvent logEvent) {

        // first log the event as usual
        super.append(logEvent);
        if (m_handler != null) {
            m_handler.handleLogEvent(logEvent);
        }

        if (m_breakOnError) {
            int logLevel = logEvent.getLevel().toInt();
            switch (logLevel) {
                case Priority.ERROR_INT:
                case Priority.FATAL_INT:
                    if (logEvent.getThrowableInformation() != null) {
                        if (logEvent.getThrowableInformation().getThrowable() != null) {
                            throw new RuntimeException(
                                logEvent.getRenderedMessage(),
                                logEvent.getThrowableInformation().getThrowable());
                        }
                    }
                    throw new RuntimeException(logEvent.getRenderedMessage());
                default:
                    // empty
            }
        }
    }
}