mockit.integration.logging.Log4jMocks Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation

JMockit is a Java toolkit for developer (unit/integration) testing. It contains mocking APIs and other tools, supporting both JUnit and TestNG. The mocking APIs allow all kinds of Java code, without testability restrictions, to be tested in isolation from selected dependencies.

There is a newer version: 1.7

Show newest version

/*
 * Copyright (c) 2006-2011 Rogério Liesenfeld
 * This file is subject to the terms of the MIT license (see LICENSE.txt).
 */
package mockit.integration.logging;

import org.apache.log4j.*;
import org.apache.log4j.spi.*;

import mockit.*;
import static mockit.Instantiation.*;

/**
 * A mock class containing mocks and stubs for the Log4j API.
 * 
 * When a test class is annotated as {@code @UsingMocksAndStubs(Log4jMocks.class)}, all
 * production code touched by the tests in that class will receive mock {@code Logger} instances
 * instead of real ones, when one of the factory methods in class {@code org.apache.log4j.Logger}
 * is called.
 * 
 * Tutorial
 */
@SuppressWarnings({"UnusedDeclaration"})
@MockClass(
   realClass = Logger.class, instantiation = PerMockSetup, stubs = {"trace", "isTraceEnabled"})
public final class Log4jMocks
{
   private static final Logger MOCK_LOGGER = new RootLogger(Level.OFF);

   public Log4jMocks()
   {
      Mockit.stubOut(Category.class);
   }

   /**
    * Returns a singleton mock {@code Logger} instance, whose methods do nothing.
    */
   @Mock public static Logger getLogger(String name) { return MOCK_LOGGER; }

   /**
    * Returns a singleton mock {@code Logger} instance, whose methods do nothing.
    */
   @Mock public static Logger getLogger(Class clazz) { return MOCK_LOGGER; }

   /**
    * Returns a singleton mock {@code Logger} instance, whose methods do nothing.
    */
   @Mock public static Logger getRootLogger() { return MOCK_LOGGER; }

   /**
    * Returns a singleton mock {@code Logger} instance, whose methods do nothing.
    */
   @Mock public static Logger getLogger(String name, LoggerFactory lf) { return MOCK_LOGGER; }
}