hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DS-2058] Failing attempt at an integration test.

Browse Source
This commit is contained in:
Mark H. Wood
2021-04-02 15:08:54 -04:00
parent 3555cf2ef7
commit 9af1c06d11
4 changed files with 377 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
dspace-api/src/main/java/org/dspace/curate/XmlWorkflowCuratorServiceImpl.java
View File

@@ -165,14 +165,13 @@ public class XmlWorkflowCuratorServiceImpl
*/
protected FlowStep getFlowStep(Context c, XmlWorkflowItem wfi)
throws SQLException, IOException {
Collection coll = wfi.getCollection();
String taskSetName = curationTaskConfig.containsKey(coll.getHandle()) ?
coll.getHandle() : "default";
ClaimedTask claimedTask
= claimedTaskService.findByWorkflowIdAndEPerson(c, wfi, c.getCurrentUser());
TaskSet ts = curationTaskConfig.findTaskSet(taskSetName);
if (claimedTask != null) {
Collection coll = wfi.getCollection();
String taskSetName = curationTaskConfig.containsKey(coll.getHandle()) ?
coll.getHandle() : "default";
TaskSet ts = curationTaskConfig.findTaskSet(taskSetName);
for (FlowStep fstep : ts.steps) {
if (fstep.step.equals(claimedTask.getStepID())) {
return fstep;

86
dspace-api/src/main/resources/spring/spring-dspace-addon-workflow-services.xml Normal file
View File

@@ -0,0 +1,86 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
The contents of this file are subject to the license and copyright
detailed in the LICENSE and NOTICE files at the root of the source
tree and available online at
http://www.dspace.org/license/
-->
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:util="http://www.springframework.org/schema/util"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-2.5.xsd
http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util.xsd">
<bean class='org.dspace.xmlworkflow.Role'
id='nullRole'>
<description>
To attach null actions to a Collection for curation testing.
</description>
<property name='name'
value='nullRole'/>
<property name='scope'
value="#{ T(org.dspace.xmlworkflow.Role.Scope).COLLECTION}"/>
<property name='description'
value='Does nothing'/>
</bean>
<bean class='org.dspace.xmlworkflow.state.actions.UserSelectionActionConfig'
id='claimactionNoUi'
scope="prototype">
<description>Claim task for current user without interaction</description>
<constructor-arg type="java.lang.String"
value="claimactionNoUi"/>
<property name="processingAction"
ref="claimactionAPI"/>
<property name="requiresUI"
value="false"/>
</bean>
<bean class='org.dspace.xmlworkflow.state.actions.WorkflowActionConfig'
id='noAction'
scope='prototype'>
<description>Takes no action</description>
<constructor-arg type='java.lang.String'
value='noaction'/>
<property name='processingAction'>
<bean class='org.dspace.xmlworkflow.state.actions.processingaction.NoAction'/>
</property>
<property name='requiresUI'
value='true'/>
</bean>
<bean class='org.dspace.xmlworkflow.state.Step'
id='nullStep'>
<description>Selects current user, does nothing</description>
<property name='role'
ref='nullRole'/>
<property name='userSelectionMethod'
ref='claimactionNoUi'/>
<property name='actions'>
<util:list>
<ref bean='noAction'/>
</util:list>
</property>
</bean>
<bean class='org.dspace.xmlworkflow.state.Workflow'
id='nullWorkflow'>
<description>No-action workflow for curation testing</description>
<property name='firstStep'
ref='nullStep'/>
<property name='steps'>
<util:list>
<ref bean='nullStep'/>
</util:list>
</property>
</bean>
</beans>

242
dspace-api/src/test/java/org/dspace/curate/XmlWorkflowCuratorServiceImplIT.java Normal file
View File

@@ -0,0 +1,242 @@
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.curate;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import java.sql.SQLException;
import java.util.Collections;
import java.util.Map;
import org.dspace.AbstractIntegrationTestWithDatabase;
import org.dspace.builder.CollectionBuilder;
import org.dspace.builder.CommunityBuilder;
import org.dspace.builder.GroupBuilder;
import org.dspace.builder.WorkflowItemBuilder;
import org.dspace.content.Collection;
import org.dspace.content.Community;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CollectionService;
import org.dspace.ctask.general.NoOpCurationTask;
import org.dspace.eperson.Group;
import org.dspace.eperson.factory.EPersonServiceFactory;
import org.dspace.eperson.service.EPersonService;
import org.dspace.eperson.service.GroupService;
import org.dspace.services.ConfigurationService;
import org.dspace.services.factory.DSpaceServicesFactory;
import org.dspace.workflow.CurationTaskConfig;
import org.dspace.xmlworkflow.Role;
import org.dspace.xmlworkflow.WorkflowUtils;
import org.dspace.xmlworkflow.XmlWorkflowFactoryImpl;
import org.dspace.xmlworkflow.factory.XmlWorkflowServiceFactory;
import org.dspace.xmlworkflow.service.XmlWorkflowService;
import org.dspace.xmlworkflow.state.Step;
import org.dspace.xmlworkflow.state.Workflow;
import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.context.ApplicationContext;
/**
*
* @author mwood
*/
public class XmlWorkflowCuratorServiceImplIT
extends AbstractIntegrationTestWithDatabase {
private static final String GROUP_ONE = "one";
private static final String TASK_NOOP = "noop";
private static final String NULL_WORKFLOW = "nullWorkflow";
// Configure the workflow task mapping.
private static final String TASK_CONFIG_TEMPLATE
= ("<?xml version='1.0' encoding='UTF-8'?>"
+ "<workflow-curation>"
+ " <taskset-map>"
+ " <mapping collection-handle='default' taskset='default'/>"
+ " </taskset-map>"
+ " <tasksets>"
+ " <taskset name='default'>"
+ " <flowstep name='%s'>"
+ " <task name='%s'/>"
+ " </flowstep>"
+ " </taskset>"
+ " </tasksets>"
+ "</workflow-curation>");
private static CollectionService collectionService;
private static ConfigurationService dspaceConfiguration;
private static EPersonService epersonService;
private static GroupService groupService;
private static XmlWorkflowServiceFactory wsf;
private static XmlWorkflowService workflowService;
private static AutowireCapableBeanFactory beanFactory;
@BeforeClass
public static void setUpClass()
throws SQLException {
// Get some necessary service instances.
dspaceConfiguration = DSpaceServicesFactory.getInstance().getConfigurationService();
collectionService = ContentServiceFactory.getInstance().getCollectionService();
EPersonServiceFactory esf = EPersonServiceFactory.getInstance();
epersonService = esf.getEPersonService();
groupService = esf.getGroupService();
wsf = XmlWorkflowServiceFactory.getInstance();
workflowService = wsf.getXmlWorkflowService();
beanFactory = kernelImpl.getServiceManager()
.getServiceByName(ApplicationContext.class.getName(), ApplicationContext.class)
.getAutowireCapableBeanFactory();
// Ensure that a known task exists with a known name.
final String CURATION_TASK_MAP_NAME
= "plugin.named.org.dspace.curate.CurationTask";
dspaceConfiguration.setProperty(CURATION_TASK_MAP_NAME, null);
dspaceConfiguration.addPropertyValue(CURATION_TASK_MAP_NAME,
NoOpCurationTask.class.getCanonicalName() + " = " + TASK_NOOP);
}
/**
* Test of doCuration method, of class XmlWorkflowCuratorServiceImpl.
* @throws Exception passed through.
*/
@Ignore
@Test
public void testDoCuration()
throws Exception {
}
/**
* Test of curate method, passing a WorkflowItem's ID.
* @throws Exception passed through.
*/
@Ignore
@Test
public void testCurate_by_id()
throws Exception {
}
/**
* Test of curate method, passing a WorkflowItem instance.
* @throws Exception passed through.
*/
@Test
public void testCurate_by_instance()
throws Exception {
// Find our workflow.
Workflow workflow = beanFactory.getBean(NULL_WORKFLOW, Workflow.class);
// Find the workflow step that we will be testing.
Step firstStep = workflow.getFirstStep();
Role stepRole = firstStep.getRole();
/*
* Build some prerequisite database objects.
*/
// We will be creating some model objects, so become administrator.
context.turnOffAuthorisationSystem();
// We need a Collection to which to attach the workflow.
Community parent = CommunityBuilder.createCommunity(context)
.build();
Collection collection = CollectionBuilder.createCollection(context, parent)
.build();
// Create a group for the necessary role.
Group roleGroup = GroupBuilder.createGroup(context)
.withName(GROUP_ONE)
.addMember(eperson)
.build();
// Define that role on the Collection.
WorkflowUtils.createCollectionWorkflowRole(context, collection, stepRole.getId(), roleGroup);
context.commit(); // XXX try
context.reloadEntity(collection); // XXX try
context.reloadEntity(roleGroup); // XXX try
// Give the workflow factory a known configuration.
Map<String, Workflow> workflowMapping
= Collections.singletonMap(collection.getHandle(), workflow);
XmlWorkflowFactoryImpl workflowFactory
= (XmlWorkflowFactoryImpl) wsf.getWorkflowFactory();
workflowFactory.setWorkflowMapping(workflowMapping);
// Create a dummy WorkflowItem to curate.
XmlWorkflowItem wfi = WorkflowItemBuilder.createWorkflowItem(context, collection)
.withAuthor("JUnit")
.withTitle("Test Item")
.withSubject("Testing")
.withIssueDate("2021-02-23")
.withSubmitter(eperson)
.build();
context.commit();
context.reloadEntity(wfi);
context.reloadEntity(collection);
/*
* Database all set up.
*/
context.restoreAuthSystemState();
// Create a curation task configuration document and parse it.
String taskConfigDocument
= String.format(TASK_CONFIG_TEMPLATE, firstStep.getId(), TASK_NOOP);
CurationTaskConfig curationTaskConfig
= new CurationTaskConfig(
new ByteArrayInputStream(
taskConfigDocument.getBytes(StandardCharsets.UTF_8)));
// Set up a Curator.
Curator curator = new Curator();
StringBuilder reporter = new StringBuilder();
curator.setReporter(reporter);
// Initialize an instance of the Unit Under Test.
XmlWorkflowCuratorServiceImpl instance = new XmlWorkflowCuratorServiceImpl();
instance.claimedTaskService = wsf.getClaimedTaskService();
instance.collectionService = collectionService;
instance.configurationService = dspaceConfiguration;
instance.curationTaskConfig = curationTaskConfig;
instance.ePersonService = epersonService;
instance.groupService = groupService;
instance.workflowFactory = workflowFactory;
instance.workflowItemService = wsf.getXmlWorkflowItemService();
instance.workflowService = workflowService;
// Test!
//XmlWorkflowItem wfi = claimedTask.getWorkflowItem();
boolean curated = instance.curate(curator, context, wfi);
// Check whether curation completed.
assertTrue("Curation did not complete.", curated);
// Check the run status.
int status = curator.getStatus(TASK_NOOP);
assertEquals("Task status was not SUCCESS:", Curator.CURATE_SUCCESS, status);
// Check run's result.
String result = curator.getResult(TASK_NOOP);
// TODO assertSomething("", "expected", result);
// Check report.
String report = reporter.toString();
// TODO assertSomething("", "expected", report);
}
}

45
dspace-api/src/test/java/org/dspace/xmlworkflow/state/actions/processingaction/NoAction.java Normal file
View File

@@ -0,0 +1,45 @@
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.xmlworkflow.state.actions.processingaction;
import java.io.IOException;
import java.sql.SQLException;
import java.util.Collections;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import org.dspace.authorize.AuthorizeException;
import org.dspace.core.Context;
import org.dspace.workflow.WorkflowException;
import org.dspace.xmlworkflow.state.Step;
import org.dspace.xmlworkflow.state.actions.ActionResult;
import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem;
/**
* Null workflow processing action for testing.
* @author mwood
*/
public class NoAction extends ProcessingAction {
@Override
public void activate(Context c, XmlWorkflowItem wf)
throws SQLException, IOException, AuthorizeException, WorkflowException {
}
@Override
public ActionResult execute(Context c, XmlWorkflowItem wfi, Step step,
HttpServletRequest request)
throws SQLException, AuthorizeException, IOException, WorkflowException {
return new ActionResult(ActionResult.TYPE.TYPE_OUTCOME,
ActionResult.OUTCOME_COMPLETE);
}
@Override
public List<String> getOptions() {
return Collections.EMPTY_LIST;
}
}