/*
* The Kuali Financial System, a comprehensive financial management system for higher education.
*
* Copyright 2005-2014 The Kuali Foundation
*
* This program 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, see <http://www.gnu.org/licenses/>.
*/
package org.kuali.kfs.module.purap.document;
import static org.kuali.kfs.sys.fixture.UserNameFixture.jgerhart;
import static org.kuali.kfs.sys.fixture.UserNameFixture.khuntley;
import static org.kuali.kfs.sys.fixture.UserNameFixture.parke;
import static org.kuali.kfs.sys.fixture.UserNameFixture.sterner;
import java.util.List;
import org.kuali.kfs.module.purap.PurapConstants;
import org.kuali.kfs.module.purap.businessobject.ContractManagerAssignmentDetail;
import org.kuali.kfs.module.purap.fixture.ContractManagerAssignmentDocumentFixture;
import org.kuali.kfs.sys.ConfigureContext;
import org.kuali.kfs.sys.context.KualiTestBase;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.document.AccountingDocumentTestUtils;
import org.kuali.kfs.sys.document.workflow.WorkflowTestUtils;
import org.kuali.rice.kew.api.document.DocumentStatus;
import org.kuali.rice.kew.api.exception.WorkflowException;
import org.kuali.rice.krad.document.Document;
import org.kuali.rice.krad.exception.ValidationException;
import org.kuali.rice.krad.service.DocumentService;
import org.kuali.rice.krad.util.GlobalVariables;
/**
* This class is used to test create and route populated Assign Contract Manager Documents.
*/
@ConfigureContext(session = parke)
public class ContractManagerAssignmentDocumentTest extends KualiTestBase {
public static final Class<ContractManagerAssignmentDocument> DOCUMENT_CLASS = ContractManagerAssignmentDocument.class;
private static final String ACCOUNT_REVIEW = "Account";
private ContractManagerAssignmentDocument acmDocument = null;
@Override
protected void setUp() throws Exception {
super.setUp();
}
@Override
protected void tearDown() throws Exception {
acmDocument = null;
super.tearDown();
}
private int getExpectedPrePeCount() {
return 0;
}
/**
* Tests the routing of ContractManagerAssignmentDocument to final.
*
* @throws Exception
*/
@ConfigureContext(session = parke, shouldCommitTransactions = true)
public final void testRouteDocument() throws Exception {
acmDocument = buildSimpleDocument();
acmDocument.prepareForSave();
DocumentService documentService = SpringContext.getBean(DocumentService.class);
assertFalse(DocumentStatus.ENROUTE.equals(acmDocument.getDocumentHeader().getWorkflowDocument().getStatus()));
routeDocument(acmDocument, "saving copy source document", documentService);
WorkflowTestUtils.waitForDocumentApproval(acmDocument.getDocumentNumber());
Document document = documentService.getByDocumentHeaderId(acmDocument.getDocumentNumber());
assertTrue("Document should now be final.", document.getDocumentHeader().getWorkflowDocument().isFinal());
}
/**
* Tests the routing of ContractManagerAssignmentDocument to final.
*
* @throws Exception
*/
@ConfigureContext(session = parke, shouldCommitTransactions = true)
public final String testRouteDocument2() throws Exception {
acmDocument = buildSimpleDocument2();
acmDocument.prepareForSave();
DocumentService documentService = SpringContext.getBean(DocumentService.class);
assertFalse(DocumentStatus.ENROUTE.equals(acmDocument.getDocumentHeader().getWorkflowDocument().getStatus()));
routeDocument(acmDocument, "saving copy source document", documentService);
WorkflowTestUtils.waitForDocumentApproval(acmDocument.getDocumentNumber());
ContractManagerAssignmentDocument document = (ContractManagerAssignmentDocument) documentService.getByDocumentHeaderId(acmDocument.getDocumentNumber());
assertTrue("Document should now be final.", document.getDocumentHeader().getWorkflowDocument().isFinal());
return acmDocument.getContractManagerAssignmentDetail(0).getRequisition().getDocumentNumber();
}
/**
* Helper method to route the document.
*
* @param document The assign contract manager document to be routed.
* @param annotation The annotation String.
* @param documentService The service to use to route the document.
* @throws WorkflowException
*/
private void routeDocument(Document document, String annotation, DocumentService documentService) throws WorkflowException {
try {
documentService.routeDocument(document, annotation, null);
}
catch (ValidationException e) {
// If the business rule evaluation fails then give us more info for debugging this test.
fail(e.getMessage() + ", " + GlobalVariables.getMessageMap());
}
}
/**
* Helper method to create a new valid ContractManagerAssignmentDocument.
*
* @return The ContractManagerAssignmentDocument created by this method.
* @throws Exception
*/
private ContractManagerAssignmentDocument buildSimpleDocument() throws Exception {
List<ContractManagerAssignmentDetail> details = ContractManagerAssignmentDocumentFixture.ACM_DOCUMENT_VALID.getContractManagerAssignmentDetails();
for (ContractManagerAssignmentDetail detail : details) {
detail.getRequisition().setAccountDistributionMethod("S");
RequisitionDocument routedReq = routeRequisitionUntilAwaitingContractManager(detail.getRequisition());
detail.setRequisitionIdentifier(routedReq.getPurapDocumentIdentifier());
detail.refreshNonUpdateableReferences();
}
acmDocument = ContractManagerAssignmentDocumentFixture.ACM_DOCUMENT_VALID.createContractManagerAssignmentDocument();
for (ContractManagerAssignmentDetail detail : details) {
detail.getRequisition().setAccountDistributionMethod("S");
detail.setContractManagerAssignmentDocument(acmDocument);
}
acmDocument.setContractManagerAssignmentDetailss(details);
return acmDocument;
}
/**
* Helper method to create a new valid ContractManagerAssignmentDocument.
*
* @return The ContractManagerAssignmentDocument created by this method.
* @throws Exception
*/
private ContractManagerAssignmentDocument buildSimpleDocument2() throws Exception {
List<ContractManagerAssignmentDetail> details = ContractManagerAssignmentDocumentFixture.ACM_DOCUMENT_VALID_2.getContractManagerAssignmentDetails();
for (ContractManagerAssignmentDetail detail : details) {
RequisitionDocument routedReq = routeRequisitionUntilAwaitingContractManager2(detail.getRequisition());
detail.setRequisitionIdentifier(routedReq.getPurapDocumentIdentifier());
detail.refreshNonUpdateableReferences();
}
acmDocument = ContractManagerAssignmentDocumentFixture.ACM_DOCUMENT_VALID_2.createContractManagerAssignmentDocument();
for (ContractManagerAssignmentDetail detail : details) {
detail.setContractManagerAssignmentDocument(acmDocument);
}
acmDocument.setContractManagerAssignmentDetailss(details);
return acmDocument;
}
/**
* Helper method to route a requisition document until AwaitingContractManager status.
* The requisition document will be used to create the ContractManagerAssignmentDocument.
*
* @param requisitionDocument The RequisitionDocument to be routed until AwaitingContractManager status.
* @return The RequisitionDocument that was routed until AwaitingContractManager status.
* @throws Exception
*/
private RequisitionDocument routeRequisitionUntilAwaitingContractManager(RequisitionDocument requisitionDocument) throws Exception {
final String docId = requisitionDocument.getDocumentNumber();
AccountingDocumentTestUtils.routeDocument(requisitionDocument, SpringContext.getBean(DocumentService.class));
WorkflowTestUtils.waitForNodeChange(requisitionDocument.getDocumentHeader().getWorkflowDocument(), ACCOUNT_REVIEW);
// the document should now be routed to vputman as Fiscal Officer
changeCurrentUser(sterner);
requisitionDocument = (RequisitionDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(docId);
assertTrue("At incorrect node.", WorkflowTestUtils.isAtNode(requisitionDocument, ACCOUNT_REVIEW));
assertTrue("Document should be enroute.", requisitionDocument.getDocumentHeader().getWorkflowDocument().isEnroute());
assertTrue("rorenfro should have an approve request.", requisitionDocument.getDocumentHeader().getWorkflowDocument().isApprovalRequested());
SpringContext.getBean(DocumentService.class).approveDocument(requisitionDocument, "Test approving as rorenfro", null);
changeCurrentUser(jgerhart);
requisitionDocument = (RequisitionDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(docId);
SpringContext.getBean(DocumentService.class).acknowledgeDocument(requisitionDocument, "Acknowledging as jgerhart", null);
WorkflowTestUtils.waitForDocumentApproval(requisitionDocument.getDocumentNumber());
changeCurrentUser(khuntley);
requisitionDocument = (RequisitionDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(docId);
assertTrue("Document should now be final.", requisitionDocument.getDocumentHeader().getWorkflowDocument().isFinal());
changeCurrentUser(parke);
return requisitionDocument;
}
/**
* Helper method to route a requisition document until AwaitingContractManager status.
* The requisition document will be used to create the ContractManagerAssignmentDocument.
*
* @param requisitionDocument The RequisitionDocument to be routed until AwaitingContractManager status.
* @return The RequisitionDocument that was routed until AwaitingContractManager status.
* @throws Exception
*/
private RequisitionDocument routeRequisitionUntilAwaitingContractManager2(RequisitionDocument requisitionDocument) throws Exception {
final String docId = requisitionDocument.getDocumentNumber();
SpringContext.getBean(DocumentService.class).routeDocument(requisitionDocument, "saving copy source document", null);
WorkflowTestUtils.waitForNodeChange(requisitionDocument.getDocumentHeader().getWorkflowDocument(), ACCOUNT_REVIEW);
// the document should now be routed to sterner as Fiscal Officer
changeCurrentUser(sterner);
requisitionDocument = (RequisitionDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(docId);
assertTrue("At incorrect node.", WorkflowTestUtils.isAtNode(requisitionDocument, ACCOUNT_REVIEW));
assertTrue("Document should be enroute.", requisitionDocument.getDocumentHeader().getWorkflowDocument().isEnroute());
assertTrue("sterner should have an approve request.", requisitionDocument.getDocumentHeader().getWorkflowDocument().isApprovalRequested());
SpringContext.getBean(DocumentService.class).approveDocument(requisitionDocument, "Test approving as sterner", null);
WorkflowTestUtils.waitForDocumentApproval(requisitionDocument.getDocumentNumber());
changeCurrentUser(khuntley);
requisitionDocument = (RequisitionDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(docId);
assertTrue("Document should now be Awaiting Contract Manager Assignment.", requisitionDocument.getApplicationDocumentStatus().equals(PurapConstants.RequisitionStatuses.APPDOC_AWAIT_CONTRACT_MANAGER_ASSGN));
changeCurrentUser(parke);
return requisitionDocument;
}
}