AbstractMockingTestCase.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 software 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.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.test.jmock;

import java.lang.reflect.Type;

import org.jmock.Mockery;
import org.junit.Rule;

/**
 * Offers ability to mock Components easily.
 *
 * @version $Id: 70f6712e850ae8fb6d9562a30c6f046ce19c6c06 $
 * @since 2.4RC1
 * @deprecated starting with 4.3.1 use {@link org.xwiki.test.ComponentManagerRule} instead
 */
@Deprecated
public abstract class AbstractMockingTestCase
{
    /**
     * Automatically verify JMock expectations.
     */
    @Rule
    public final JMockRule mockery = new JMockRule();

    /**
     * @return the JMock Mockery objects to mock interfaces/classes and set expectations on
     */
    public Mockery getMockery()
    {
        return this.mockery;
    }

    /**
     * @return a configured Component Manager (which uses the plexus.xml file in the test resources directory) which can
     *         then be put in the XWiki Context for testing.
     * @throws Exception in case of errors
     */
    public abstract MockingComponentManager getComponentManager() throws Exception;

    /**
     * @throws Exception in case of errors
     * @since 3.0M3
     */
    public <T> T registerMockComponent(Class<T> role, String hint, String mockId) throws Exception
    {
        return getComponentManager().registerMockComponent(getMockery(), role, hint, mockId);
    }

    /**
     * @throws Exception in case of errors
     * @since 4.0M1
     */
    public <T> T registerMockComponent(Type role, String hint, String mockId) throws Exception
    {
        return getComponentManager().registerMockComponent(getMockery(), role, hint, mockId);
    }

    /**
     * @throws Exception in case of errors
     * @since 2.4RC1
     */
    public <T> T registerMockComponent(Class<T> role, String hint) throws Exception
    {
        return getComponentManager().registerMockComponent(getMockery(), role, hint);
    }

    /**
     * @throws Exception in case of errors
     * @since 4.0M1
     */
    public <T> T registerMockComponent(Type role, String hint) throws Exception
    {
        return getComponentManager().registerMockComponent(getMockery(), role, hint);
    }

    /**
     * @throws Exception in case of errors
     * @since 2.4RC1
     */
    public <T> T registerMockComponent(Class<T> role) throws Exception
    {
        return getComponentManager().registerMockComponent(getMockery(), role);
    }

    /**
     * @throws Exception in case of errors
     * @since 4.0M1
     */
    public <T> T registerMockComponent(Type role) throws Exception
    {
        return getComponentManager().registerMockComponent(getMockery(), role);
    }
}