com.greenpepper.Call Maven / Gradle / Ivy

/*
 * Copyright (c) 2006 Pyxis Technologies inc.
 *
 * This 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 2 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 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 St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 */
package com.greenpepper;

import com.greenpepper.call.Result;
import com.greenpepper.call.ResultHandler;
import com.greenpepper.call.Stub;
import com.greenpepper.call.StubSyntax;
import com.greenpepper.expectation.Collator;
import com.greenpepper.expectation.Expectation;
import com.greenpepper.expectation.ShouldBe;
import com.greenpepper.reflect.Message;
import com.greenpepper.reflect.SystemUnderDevelopmentException;
import com.greenpepper.util.log.GreenPepperLogger;
import com.greenpepper.shaded.org.slf4j.Logger;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;

/**
 * A test to be executed against the SUT.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public class Call
{

    private static final Logger logger = GreenPepperLogger.getLogger(Call.class);

    private final Message message;
    private final Collection inputs = new ArrayList();

    private Expectation expectation;
    private Result result;
    private List handlers = new ArrayList();

    /**
     * Constructor for Call.
     *
     * @param message a {@link com.greenpepper.reflect.Message} object.
     */
    public Call( Message message )
    {
        this.message = message;
    }

    /**
     * addInput.
     *
     * @param values a {@link java.lang.String} object.
     */
    public void addInput( String... values )
    {
        inputs.addAll( Arrays.asList( values ) );
    }

    /**
     * execute.
     *
     * @param args a {@link java.lang.String} object.
     * @return a {@link java.lang.Object} object.
     * @throws java.lang.Exception if any.
     */
    public Object execute( String... args ) throws Exception
    {
        result = new Result( expectation );
        try
        {
            result.setActual( message.send( mergeInputsWith( args ) ) );
        }
        catch (SystemUnderDevelopmentException e)
        {
            if(logger.isDebugEnabled()){
                logger.debug("Error while executing specifications", e.getCause());
            }
            result.exceptionOccured( e.getCause() );
        }

        dispatchForHandling( result );

        return result.getActual();
    }

    private void dispatchForHandling( Result result )
    {
        for (ResultHandler handler : handlers)
        {
            handler.handle( result );
        }
    }

    /**
     * expect.
     *
     * @param collator a {@link com.greenpepper.expectation.Collator} object.
     */
    public void expect( Collator collator )
    {
        expect( collator.toExpectation() );
    }

    /**
     * expect.
     *
     * @param expected a {@link com.greenpepper.expectation.Expectation} object.
     */
    public void expect( Expectation expected )
    {
        this.expectation = expected;
    }

    /**
     * expect.
     *
     * @param value a {@link java.lang.String} object.
     */
    public void expect( String value )
    {
        expect( ShouldBe.literal( value ) );
    }

    private String[] mergeInputsWith( String... args )
    {
        inputs.addAll( Arrays.asList( args ) );
        return inputs.toArray( new String[inputs.size()] );
    }

    /**
     * Getter for the field result.
     *
     * @return a {@link com.greenpepper.call.Result} object.
     */
    public Result getResult()
    {
        return result;
    }

    /**
     * wasRight.
     *
     * @return a boolean.
     */
    public boolean wasRight()
    {
        return result.isRight();
    }

    /**
     * wasWrong.
     *
     * @return a boolean.
     */
    public boolean wasWrong()
    {
        return result.isWrong();
    }

    /**
     * wasIgnored.
     *
     * @return a boolean.
     */
    public boolean wasIgnored()
    {
        return result.isIgnored();
    }

    /**
     * hasFailed.
     *
     * @return a boolean.
     */
    public boolean hasFailed()
    {
        return result.isException();
    }

    /**
     * getFailure.
     *
     * @return a {@link java.lang.Throwable} object.
     */
    public Throwable getFailure()
    {
        return result.getException();
    }

    /**
     * will.
     *
     * @param stub a {@link com.greenpepper.call.Stub} object.
     * @return a {@link com.greenpepper.call.StubSyntax} object.
     */
    public StubSyntax will( Stub stub )
    {
        ResultHandler handler = new ResultHandler( stub );
        handlers.add( handler );
        return handler;
    }
}