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

Check for message names being null during validation #9164

Merged
merged 3 commits into from
Apr 21, 2022
Merged

Check for message names being null during validation #9164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b9e63f
refactor(engine): fix typo
pihme Apr 19, 2022
603135a
refactor(engine): convert test to JUnit5
pihme Apr 19, 2022
496cc70
fix(engine): check for names that are null
pihme Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions engine/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
Expand Down
4 changes: 4 additions & 0 deletions .../processing/deployment/model/validation/ProcessMessageStartEventMessageNameValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ private void validateMessageName(
return;
}
final String nameExpression = message.getName();
if (nameExpression == null) {
// no need to add an error, this case was already handled by MessageValidator
return;
}
final Expression parseResult = expressionLanguage.parseExpression(nameExpression);

final EvaluationResult evaluationResult =
Expand Down
154 changes: 87 additions & 67 deletions ...cessing/deployment/model/validation/ProcessMessageStartEventMessageNameValidatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
*/
package io.camunda.zeebe.engine.processing.deployment.model.validation;

import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;
Expand All @@ -15,90 +17,108 @@
import io.camunda.zeebe.el.Expression;
import io.camunda.zeebe.el.ExpressionLanguage;
import io.camunda.zeebe.el.ResultType;
import io.camunda.zeebe.el.impl.FeelExpressionLanguage;
import io.camunda.zeebe.model.bpmn.Bpmn;
import io.camunda.zeebe.model.bpmn.BpmnModelInstance;
import io.camunda.zeebe.model.bpmn.instance.StartEvent;
import io.camunda.zeebe.util.sched.clock.ActorClock;
import org.camunda.bpm.model.xml.validation.ValidationResultCollector;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import org.mockito.junit.jupiter.MockitoExtension;

@RunWith(MockitoJUnitRunner.class)
@ExtendWith(MockitoExtension.class)
public class ProcessMessageStartEventMessageNameValidatorTest {

private static final String TEST_EXPRESSION = "expression";

private static final BpmnModelInstance MODEL =
Bpmn.createProcess().startEvent().message(TEST_EXPRESSION).endEvent().done();

private static final StartEvent START_EVENT =
MODEL.getModelElementsByType(StartEvent.class).iterator().next();

@Mock ExpressionLanguage mockExpressionLanguage;

@Mock Expression mockExpression;

@Mock EvaluationResult mockResult;

@Mock ValidationResultCollector mockResultCollector;

ProcessMessageStartEventMessageNameValidator sutValidator;

@Before
public void setUp() {
when(mockExpressionLanguage.parseExpression(TEST_EXPRESSION)).thenReturn(mockExpression);

when(mockExpressionLanguage.evaluateExpression(Mockito.eq(mockExpression), Mockito.any()))
.thenReturn(mockResult);

sutValidator = new ProcessMessageStartEventMessageNameValidator(mockExpressionLanguage);
}

@Test
public void shouldLetValidMessageNameExpressionsPass() {
@Test // regression test for #9083
void shouldNotThrowNPEIfMessageNameIsNull() {
// given
when(mockResult.isFailure()).thenReturn(false);
when(mockResult.getType()).thenReturn(ResultType.STRING);
final var model = Bpmn.createProcess().startEvent().message((String) null).endEvent().done();

// when
sutValidator.validate(START_EVENT, mockResultCollector);
final var startEvent = model.getModelElementsByType(StartEvent.class).iterator().next();

// then
verifyNoInteractions(mockResultCollector);
}

@Test
public void shoulAddErrorIfEvaluationFailed() {
// given
when(mockResult.isFailure()).thenReturn(true);
when(mockResult.getFailureMessage()).thenReturn("Test failure message");
final var sutValidator =
new ProcessMessageStartEventMessageNameValidator(
new FeelExpressionLanguage(ActorClock.current()));

// when
sutValidator.validate(START_EVENT, mockResultCollector);

// then
verify(mockResultCollector)
.addError(
0,
"Expected constant expression but found 'expression', which could not be evaluated without context: Test failure message");
assertThatNoException()
.isThrownBy(() -> sutValidator.validate(startEvent, mockResultCollector));
}

@Test
public void shoulAddErrorIfEvaluationDoesNotReturnString() {
// given
when(mockResult.isFailure()).thenReturn(false);
when(mockResult.getType()).thenReturn(ResultType.NUMBER);

// when
sutValidator.validate(START_EVENT, mockResultCollector);

// then
verify(mockResultCollector)
.addError(
0,
"Expected constant expression of type String for message name 'expression', but was NUMBER");
@Nested
final class WithMockedExpressionLanguage {

private static final String TEST_EXPRESSION = "expression";
private static final BpmnModelInstance MODEL =
Bpmn.createProcess().startEvent().message(TEST_EXPRESSION).endEvent().done();
private static final StartEvent START_EVENT =
MODEL.getModelElementsByType(StartEvent.class).iterator().next();
@Mock ExpressionLanguage mockExpressionLanguage;
@Mock Expression mockExpression;
@Mock EvaluationResult mockResult;

ProcessMessageStartEventMessageNameValidator sutValidator;

@BeforeEach
void setUp() {
when(mockExpressionLanguage.parseExpression(TEST_EXPRESSION)).thenReturn(mockExpression);

when(mockExpressionLanguage.evaluateExpression(eq(mockExpression), Mockito.any()))
.thenReturn(mockResult);

sutValidator = new ProcessMessageStartEventMessageNameValidator(mockExpressionLanguage);
}

@Test
void shouldLetValidMessageNameExpressionsPass() {
// given
when(mockResult.isFailure()).thenReturn(false);
when(mockResult.getType()).thenReturn(ResultType.STRING);

// when
sutValidator.validate(START_EVENT, mockResultCollector);

// then
verifyNoInteractions(mockResultCollector);
}

@Test
void shouldAddErrorIfEvaluationFailed() {
// given
when(mockResult.isFailure()).thenReturn(true);
when(mockResult.getFailureMessage()).thenReturn("Test failure message");

// when
sutValidator.validate(START_EVENT, mockResultCollector);

// then
verify(mockResultCollector)
.addError(
0,
"Expected constant expression but found 'expression', which could not be evaluated without context: Test failure message");
}

@Test
void shouldAddErrorIfEvaluationDoesNotReturnString() {
// given
when(mockResult.isFailure()).thenReturn(false);
when(mockResult.getType()).thenReturn(ResultType.NUMBER);

// when
sutValidator.validate(START_EVENT, mockResultCollector);

// then
verify(mockResultCollector)
.addError(
0,
"Expected constant expression of type String for message name 'expression', but was NUMBER");
}
}
}