StateChangeTest.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo MES
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero 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
 * ***************************************************************************
 */
package com.qcadoo.mes.states;

import static com.qcadoo.mes.states.messages.util.MessagesUtil.joinArgs;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;

import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;

import com.google.common.collect.ImmutableList;
import com.qcadoo.mes.states.constants.StateChangeStatus;
import com.qcadoo.mes.states.messages.constants.MessageFields;
import com.qcadoo.mes.states.messages.constants.StateMessageType;
import com.qcadoo.model.api.DataDefinition;
import com.qcadoo.model.api.Entity;
import com.qcadoo.model.api.EntityList;

public abstract class StateChangeTest {

    @Mock
    protected Entity stateChangeEntity;

    @Mock
    protected StateChangeContext stateChangeContext;

    @Mock
    protected DataDefinition stateChangeDD;

    @Mock
    protected DataDefinition ownerDD;

    @Mock
    protected Entity owner;

    protected static final StateChangeEntityDescriber DESCRIBER = new MockStateChangeDescriber();

    protected void stubStateChangeEntity(final StateChangeEntityDescriber describer) {
        given(stateChangeEntity.getDataDefinition()).willReturn(stateChangeDD);
        final EntityList emptyEntityList = mockEntityList(Collections.<Entity> emptyList());
        given(stateChangeEntity.getHasManyField(describer.getMessagesFieldName())).willReturn(emptyEntityList);
        stubEntityField(stateChangeEntity, describer.getStatusFieldName(), StateChangeStatus.IN_PROGRESS.getStringValue());
        given(stateChangeEntity.isValid()).willReturn(true);
        given(stateChangeDD.save(Mockito.any(Entity.class))).willAnswer(new Answer<Entity>() {

            @Override
            public Entity answer(final InvocationOnMock invocation) throws Throwable {
                return (Entity) invocation.getArguments()[0];
            }
        });
    }

    protected EntityList mockEntityList(final List<Entity> entities) {
        final EntityList entityList = mock(EntityList.class);
        given(entityList.iterator()).willAnswer(new Answer<Iterator<Entity>>() {

            @Override
            public Iterator<Entity> answer(final InvocationOnMock invocation) throws Throwable {
                return ImmutableList.copyOf(entities).iterator();
            }
        });
        given(entityList.isEmpty()).willReturn(entities.isEmpty());
        return entityList;
    }

    protected Entity mockMessage(final StateMessageType type, final String translationKey, final String... translationArgs) {
        final Entity message = mock(Entity.class);
        stubEntityField(message, MessageFields.TYPE, type);
        stubEntityField(message, MessageFields.TRANSLATION_KEY, translationKey);
        stubEntityField(message, MessageFields.TRANSLATION_ARGS, joinArgs(translationArgs));
        return message;
    }

    protected static void mockStateChangeStatus(final Entity entity, final StateChangeStatus status) {
        stubEntityField(entity, DESCRIBER.getStatusFieldName(), status.getStringValue());
    }

    protected void stubOwner() {
        given(owner.getDataDefinition()).willReturn(ownerDD);
        given(owner.isValid()).willReturn(true);
        given(ownerDD.save(Mockito.any(Entity.class))).willAnswer(new Answer<Entity>() {

            @Override
            public Entity answer(final InvocationOnMock invocation) throws Throwable {
                return (Entity) invocation.getArguments()[0];
            }
        });
        given(owner.copy()).willReturn(owner);
    }

    protected void stubStateChangeContext() {
        given(stateChangeContext.getOwner()).willReturn(owner);
        given(stateChangeContext.getStateChangeEntity()).willReturn(stateChangeEntity);
        given(stateChangeContext.getDescriber()).willReturn(DESCRIBER);
        given(stateChangeContext.isOwnerValid()).willReturn(true);
        StateEnum stateEnumMock = Mockito.mock(StateEnum.class);
        given(stateEnumMock.canChangeTo(Mockito.any(StateEnum.class))).willReturn(true);
        given(stateEnumMock.getStringValue()).willReturn("stateEnumMock");
        given(stateChangeContext.getStateEnumValue(Mockito.anyString())).willReturn(stateEnumMock);

        Mockito.doAnswer(new Answer<Void>() {

            @Override
            public Void answer(final InvocationOnMock invocation) throws Throwable {
                stateChangeEntity.setField(DESCRIBER.getStatusFieldName(), invocation.getArguments()[0]);
                return null;
            }
        }).when(stateChangeContext).setStatus(Mockito.any(StateChangeStatus.class));

        given(stateChangeContext.getStatus()).willAnswer(new Answer<StateChangeStatus>() {

            @Override
            public StateChangeStatus answer(final InvocationOnMock invocation) throws Throwable {
                return StateChangeStatus.parseString(stateChangeEntity.getStringField(DESCRIBER.getStatusFieldName()));
            }
        });

        given(stateChangeContext.getAllMessages()).willAnswer(new Answer<List<Entity>>() {

            @Override
            public List<Entity> answer(final InvocationOnMock invocation) throws Throwable {
                return stateChangeEntity.getHasManyField(DESCRIBER.getMessagesFieldName());
            }
        });

        Mockito.doAnswer(new Answer<Void>() {

            @Override
            public Void answer(final InvocationOnMock invocation) throws Throwable {
                stateChangeEntity.setField(DESCRIBER.getPhaseFieldName(), invocation.getArguments()[0]);
                return null;
            }
        }).when(stateChangeContext).setPhase(Mockito.anyInt());

        given(stateChangeContext.getPhase()).willAnswer(new Answer<Integer>() {

            @Override
            public Integer answer(final InvocationOnMock invocation) throws Throwable {
                return (Integer) stateChangeEntity.getField(DESCRIBER.getPhaseFieldName());
            }
        });
    }

    protected static void stubEntityField(final Entity entity, final String fieldName, final Object fieldValue) {
        given(entity.getField(fieldName)).willReturn(fieldValue);
        given(entity.getStringField(fieldName)).willReturn(fieldValue == null ? null : fieldValue.toString());
    }

    protected void stubStringField(final Entity entity, final String fieldName, final String fieldValue) {
        given(entity.getField(fieldName)).willReturn(fieldValue);
        given(entity.getStringField(fieldName)).willReturn(fieldValue);
    }

    protected void stubBelongsToField(final Entity entity, final String fieldName, final Entity fieldValue) {
        given(entity.getField(fieldName)).willReturn(fieldValue);
        given(entity.getBelongsToField(fieldName)).willReturn(fieldValue);
    }

}