All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • dk.clanie.test.logging.LoggingEventMatchers Maven / Gradle / Ivy

    The newest version!
    /**
 * Copyright (C) 2008, Claus Nielsen, [email protected]
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
package dk.clanie.test.logging;

import static dk.clanie.test.logging.LogLevelMatchers.ge;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.instanceOf;

import org.hamcrest.Description;
import org.hamcrest.Factory;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.classic.spi.ThrowableProxy;

/**
 * Matchers to check LoggingEvents.
 * 
 * @author Claus Nielsen
 */
public class LoggingEventMatchers {

	/**
	 * Does the LoggingEvent have a matching Level?
	 */
	@Factory
	public static TypeSafeMatcher level(Matcher levelMatcher) {
		return new LevelMatcher(levelMatcher);
	}
	
	/**
	 * Does the LoggingEvent have a particular Level?
	 */
	@Factory
	public static TypeSafeMatcher level(Level level) {
		return new LevelMatcher(equalTo(level));
	}
	
	/**
	 * Does the LoggingEvent have at least a particular Level?
	 */
	@Factory
	public static TypeSafeMatcher levelGE(Level level) {
		return new LevelMatcher(ge(level));
	}
	
	/**
	 * Does the LoggingEvent have a matching message?
	 */
	@Factory
	public static TypeSafeMatcher message(Matcher messageMatcher) {
		return new MessageMatcher(messageMatcher);
	}

	/**
	 * Does the LoggingEvent have a particular message?
	 */
	@Factory
	public static TypeSafeMatcher message(String message) {
		return new MessageMatcher(equalTo(message));
	}

	/**
	 * Does the LoggingEvent contain a matching Throwable?
	 */
	@Factory
	public static TypeSafeMatcher exception(Matcher exceptionMatcher) {
		return new ExceptionMatcher(exceptionMatcher);
	}

	
	/**
	 * Does the LoggingEvent contain a matching Throwable?
	 */
	@Factory
	public static TypeSafeMatcher exception(Class exceptionClass) {
		return exception(instanceOf(exceptionClass));
	}

	
	/**
	 * Matcher to check if an LoggingEvent has a matching Level.
	 *
	 * @author Claus Nielsen
	 */
	private static class LevelMatcher extends TypeSafeMatcher {

		private final Matcher theMatcher;

		/**
		 * Constructor.
		 * 
		 * @param theMatcher
		 *            The predicate evaluates to true for LoggingEvents
		 *            with a Level satisfying this Matcher.
		 */
		private LevelMatcher(Matcher theMatcher) {
			this.theMatcher = theMatcher;
		}

		@Override
		public boolean matchesSafely(ILoggingEvent event) {
			return theMatcher.matches(event.getLevel());
		}

		@Override
		public void describeTo(Description description) {
			description.appendText("an LoggingEvent with Level ").appendDescriptionOf(theMatcher);
		}

	}


	/**
	 * Matcher to check if an LoggingEvent has a matching message.
	 *
	 * @author Claus Nielsen
	 */
	private static class MessageMatcher extends TypeSafeMatcher {

		private final Matcher theMatcher;

		/**
		 * Constructor.
		 * 
		 * @param theMatcher
		 *            The predicate evaluates to true for ILoggingEvents
		 *            with a message satisfying this matcher.
		 */
		private MessageMatcher(Matcher theMatcher) {
			this.theMatcher = theMatcher;
		}

		@Override
		public boolean matchesSafely(ILoggingEvent event) {
			return theMatcher.matches(event.getMessage());
		}

		@Override
		public void describeTo(Description description) {
			description.appendText("an ILoggingEvent with a message ").appendValue(theMatcher);
		}

	}


	/**
	 * Matcher to check if an ILoggingEvent contains an matching type of exception.
	 *
	 * @author Claus Nielsen
	 */
	private static class ExceptionMatcher extends TypeSafeMatcher {

		private final Matcher theMatcher;

		/**
		 * Constructor.
		 * 
		 * @param theMatcher
		 *            The predicate evaluates to true for ILoggingEvents
		 *            containing a Throwable which satisfies this matcher.
		 */
		private ExceptionMatcher(Matcher theMatcher) {
			this.theMatcher = theMatcher;
		}

		@Override
		public boolean matchesSafely(ILoggingEvent event) {
			ThrowableProxy throwableProxy = (ThrowableProxy) event.getThrowableProxy();
			if (throwableProxy == null) return false;
			return theMatcher.matches(throwableProxy.getThrowable());
		}

		@Override
		public void describeTo(Description description) {
			description.appendText("an ILoggingEvent with a Throwable ").appendDescriptionOf(theMatcher);
		}

	}


}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy