Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JBPM-6182 - Add validation for Work Item handlers declarations in Dep… #799

Merged
merged 2 commits into from Jul 25, 2017
Merged

JBPM-6182 - Add validation for Work Item handlers declarations in Dep… #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb8f484
JBPM-6182 - Add validation for Work Item handlers declarations in Dep…
mswiderski Jul 14, 2017
fbc30b8
JBPM-6215 - Improve deployment descriptor validation for Work Item ha…
mswiderski Jul 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...pm-wb-integration-api/src/main/java/org/jbpm/workbench/wi/dd/service/DDEditorService.java
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@

package org.jbpm.workbench.wi.dd.service;

import org.guvnor.common.services.project.builder.service.BuildValidationHelper;
import org.guvnor.common.services.shared.file.SupportsUpdate;
import org.guvnor.common.services.shared.validation.ValidationService;
import org.jboss.errai.bus.server.annotations.Remote;
Expand All @@ -25,7 +26,8 @@
import org.uberfire.ext.editor.commons.service.support.SupportsRead;

@Remote
public interface DDEditorService extends ViewSourceService<DeploymentDescriptorModel>,
public interface DDEditorService extends BuildValidationHelper,
ViewSourceService<DeploymentDescriptorModel>,
ValidationService<DeploymentDescriptorModel>,
SupportsRead<DeploymentDescriptorModel>,
SupportsUpdate<DeploymentDescriptorModel> {
Expand Down
5 changes: 5 additions & 0 deletions jbpm-wb-integration/jbpm-wb-integration-backend/pom.xml
View file
Open in desktop
Expand Up @@ -200,6 +200,11 @@
<artifactId>kie-wb-common-library-api</artifactId>
</dependency>

<dependency>
<groupId>org.mvel</groupId>
<artifactId>mvel2</artifactId>
</dependency>

<!-- Test dependencies -->
<dependency>
<groupId>org.kie</groupId>
Expand Down
101 changes: 99 additions & 2 deletions ...on-backend/src/main/java/org/jbpm/workbench/wi/backend/server/dd/DDEditorServiceImpl.java
View file
Open in desktop
Expand Up @@ -18,10 +18,12 @@

import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.inject.Named;
import javax.lang.model.SourceVersion;

import org.guvnor.common.services.backend.exceptions.ExceptionUtilities;
import org.guvnor.common.services.backend.util.CommentedOptionFactory;
Expand All @@ -34,13 +36,17 @@
import org.jbpm.workbench.wi.dd.model.ItemObjectModel;
import org.jbpm.workbench.wi.dd.model.Parameter;
import org.jbpm.workbench.wi.dd.service.DDEditorService;
import org.jbpm.workbench.wi.dd.type.DDResourceTypeDefinition;
import org.kie.internal.runtime.conf.AuditMode;
import org.kie.internal.runtime.conf.DeploymentDescriptor;
import org.kie.internal.runtime.conf.NamedObjectModel;
import org.kie.internal.runtime.conf.ObjectModel;
import org.kie.internal.runtime.conf.PersistenceMode;
import org.kie.internal.runtime.conf.RuntimeStrategy;
import org.kie.workbench.common.services.backend.service.KieService;
import org.mvel2.CompileException;
import org.mvel2.MVEL;
import org.mvel2.ParserContext;
import org.uberfire.backend.server.util.Paths;
import org.uberfire.backend.vfs.Path;
import org.uberfire.io.IOService;
Expand All @@ -62,6 +68,9 @@ public class DDEditorServiceImpl
@Inject
private CommentedOptionFactory commentedOptionFactory;

@Inject
private DDResourceTypeDefinition resourceTypeDefinition;

@Override
public DeploymentDescriptorModel load(Path path) {
return super.loadContent(path);
Expand Down Expand Up @@ -131,8 +140,20 @@ public List<ValidationMessage> validate(Path path,
DeploymentDescriptorModel content) {
final List<ValidationMessage> validationMessages = new ArrayList<ValidationMessage>();
try {
unmarshal(path,
content).toXml();
DeploymentDescriptor dd = unmarshal(path, content);

// validate the content of the descriptor

validationMessages.addAll(validateObjectModels(path, dd.getConfiguration()));
validationMessages.addAll(validateObjectModels(path, dd.getEnvironmentEntries()));
validationMessages.addAll(validateObjectModels(path, dd.getEventListeners()));
validationMessages.addAll(validateObjectModels(path, dd.getGlobals()));
validationMessages.addAll(validateObjectModels(path, dd.getMarshallingStrategies()));
validationMessages.addAll(validateObjectModels(path, dd.getTaskEventListeners()));
validationMessages.addAll(validateObjectModels(path, dd.getWorkItemHandlers()));

// validate its structure
dd.toXml();
} catch (Exception e) {
final ValidationMessage msg = new ValidationMessage();
msg.setPath(path);
Expand All @@ -157,6 +178,65 @@ public String toSource(Path path,

// helper methods

protected List<ValidationMessage> validateObjectModels(Path path, List<? extends ObjectModel> objectModels) {

final List<ValidationMessage> validationMessages = new ArrayList<ValidationMessage>();

objectModels.forEach(model -> {

String identifier = model.getIdentifier();

if (identifier == null || identifier.isEmpty()) {
validationMessages.add(newMessage(path, "Identifier cannot be empty for " + model.getIdentifier(), Level.ERROR));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any chances to make localization for this and other messages?

}

String resolver = model.getResolver();
if (resolver == null) {
validationMessages.add(newMessage(path, "No resolver selected for " + model.getIdentifier(), Level.ERROR));
}
else if (resolver.equalsIgnoreCase(ItemObjectModel.MVEL_RESOLVER)) {
try {
ParserContext parserContext = new ParserContext();
parserContext.setStrictTypeEnforcement( true );
parserContext.setStrongTyping( true );
MVEL.compileExpression(identifier, parserContext);
} catch (CompileException e) {
StringBuilder text = new StringBuilder();
text.append("Could not compile mvel expression '" + model.getIdentifier() +"'.")
.append(" this can be due to invalid syntax of missing classes")
.append("-")
.append(e.getMessage());
validationMessages.add(newMessage(path, text.toString(), Level.WARNING));
}
} else if (resolver.equalsIgnoreCase(ItemObjectModel.REFLECTION_RESOLVER)) {
if (!SourceVersion.isName(identifier)) {
validationMessages.add(newMessage(path, "Identifier is not valid Java class which is required by reflection resolver " + model.getIdentifier(), Level.ERROR));
}
} else {
validationMessages.add(newMessage(path, "Not valid resolver selected for " + model.getIdentifier(), Level.ERROR));
}


if (model instanceof NamedObjectModel) {
String name = ((NamedObjectModel) model).getName();
if (name == null || name.isEmpty()) {
validationMessages.add(newMessage(path, "Name cannot be empty for " + model.getIdentifier(), Level.ERROR));
}
}
});

return validationMessages;
}

protected ValidationMessage newMessage(Path path, String text, Level level) {
final ValidationMessage msg = new ValidationMessage();
msg.setPath(path);
msg.setLevel(level);
msg.setText(text);

return msg;
}

protected DeploymentDescriptorModel marshal(DeploymentDescriptor originDD) {
DeploymentDescriptorModel ddModel = new DeploymentDescriptorModel();
ddModel.setPersistenceUnitName(originDD.getPersistenceUnit());
Expand Down Expand Up @@ -370,4 +450,21 @@ public void createIfNotExists(Path path) {
xmlDescriptor);
}
}

@Override
public boolean accepts(Path path) {
return this.resourceTypeDefinition.accept(path);
}

@Override
public List<ValidationMessage> validate(Path path) {
try {
InputStream input = ioService.newInputStream(Paths.convert(path));
DeploymentDescriptorModel ddModel = marshal(DeploymentDescriptorIO.fromXml(input));

return validate(path, ddModel);
} catch (Exception e) {
return Arrays.asList(newMessage(path, e.getMessage(), Level.ERROR));
}
}
}
120 changes: 120 additions & 0 deletions ...on-backend/src/test/java/org/jbpm/workbench/wi/backend/server/dd/DDEditorServiceTest.java
View file
Open in desktop
Expand Up @@ -19,10 +19,14 @@
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Random;

import org.guvnor.common.services.shared.message.Level;
import org.guvnor.common.services.shared.validation.model.ValidationMessage;
import org.jbpm.workbench.wi.dd.model.DeploymentDescriptorModel;
import org.jbpm.workbench.wi.dd.model.ItemObjectModel;
import org.jgroups.util.UUID;
import org.junit.Test;
import org.kie.internal.runtime.conf.AuditMode;
Expand All @@ -33,6 +37,8 @@
import org.kie.internal.runtime.conf.RuntimeStrategy;
import org.kie.test.util.compare.ComparePair;

import static org.junit.Assert.*;

public class DDEditorServiceTest extends DDEditorServiceImpl {

private static Random random = new Random();
Expand Down Expand Up @@ -136,4 +142,118 @@ public void marshalUnmarshalTest() throws Exception {
"DeploymentDescriptorModel.overview")
.compare();
}

@Test
public void testValidateEmptyResolver() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(null,
"item-name",
"handler-classname")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(1, validationMessages.size());

ValidationMessage error = validationMessages.get(0);
assertEquals(Level.ERROR, error.getLevel());
assertTrue(error.getText().startsWith("No resolver selected"));

models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel("",
"item-name",
"handler-classname")});

validationMessages = validateObjectModels(null, models);
assertEquals(1, validationMessages.size());

error = validationMessages.get(0);
assertEquals(Level.ERROR, error.getLevel());
assertTrue(error.getText().startsWith("Not valid resolver selected"));
}

@Test
public void testValidateReflectionResolver() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(ItemObjectModel.REFLECTION_RESOLVER,
"item-name",
"java.lang.String")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(0, validationMessages.size());

}

@Test
public void testValidateReflectionResolverInvalid() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(ItemObjectModel.REFLECTION_RESOLVER,
"item-name",
"handler-classname")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(1, validationMessages.size());

ValidationMessage error = validationMessages.get(0);
assertEquals(Level.ERROR, error.getLevel());
assertTrue(error.getText().startsWith("Identifier is not valid Java class which is required by reflection resolver"));
}

@Test
public void testValidateReflectionResolverMissingIdentifier() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(ItemObjectModel.REFLECTION_RESOLVER,
"item-name",
"")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(2, validationMessages.size());

ValidationMessage error = validationMessages.get(0);
assertEquals(Level.ERROR, error.getLevel());
assertTrue(error.getText().startsWith("Identifier cannot be empty"));
error = validationMessages.get(1);
assertEquals(Level.ERROR, error.getLevel());
assertTrue(error.getText().startsWith("Identifier is not valid Java class which is required by reflection resolver"));
}

@Test
public void testValidateReflectionResolverNameEmpty() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(ItemObjectModel.REFLECTION_RESOLVER,
"",
"java.lang.String")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(1, validationMessages.size());

ValidationMessage error = validationMessages.get(0);
assertEquals(Level.ERROR, error.getLevel());
assertTrue(error.getText().startsWith("Name cannot be empty"));
}

@Test
public void testValidateMvelResolver() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(ItemObjectModel.MVEL_RESOLVER,
"item-name",
"new String()")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(0, validationMessages.size());

}

@Test
public void testValidateMvelResolverInvalid() {
List<NamedObjectModel> models = Arrays.asList(new NamedObjectModel[]{
new NamedObjectModel(ItemObjectModel.MVEL_RESOLVER,
"item-name",
"handler-classname")});

List<ValidationMessage> validationMessages = validateObjectModels(null, models);
assertEquals(1, validationMessages.size());

ValidationMessage error = validationMessages.get(0);
assertEquals(Level.WARNING, error.getLevel());
assertTrue(error.getText().startsWith("Could not compile mvel expression"));
}
}