-
Notifications
You must be signed in to change notification settings - Fork 950
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): allow flow to define and expose outputs (#2133)
- Loading branch information
1 parent
7584998
commit 2134aca
Showing
4 changed files
with
173 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
core/src/main/java/io/kestra/core/models/flows/Output.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package io.kestra.core.models.flows; | ||
|
|
||
| import io.micronaut.core.annotation.Introspected; | ||
| import lombok.Getter; | ||
| import lombok.NoArgsConstructor; | ||
| import lombok.experimental.SuperBuilder; | ||
|
|
||
| import javax.validation.constraints.NotBlank; | ||
| import javax.validation.constraints.NotNull; | ||
| import javax.validation.constraints.Pattern; | ||
|
|
||
| /** | ||
| * Definition of a flow's output. | ||
| */ | ||
| @SuperBuilder | ||
| @Getter | ||
| @NoArgsConstructor | ||
| @Introspected | ||
| public class Output { | ||
| /** | ||
| * The output's unique id. | ||
| */ | ||
| @NotNull | ||
| @NotBlank | ||
| @Pattern(regexp = "^[a-zA-Z0-9][.a-zA-Z0-9_-]*") | ||
| String id; | ||
| /** | ||
| * Short description of the output. | ||
| */ | ||
| String description; | ||
| /** | ||
| * The output value. Can be a dynamic expression. | ||
| */ | ||
| @NotNull | ||
| Object value; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
core/src/test/java/io/kestra/core/tasks/flows/SubflowTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| package io.kestra.core.tasks.flows; | ||
|
|
||
| import io.kestra.core.exceptions.IllegalVariableEvaluationException; | ||
| import io.kestra.core.models.executions.Execution; | ||
| import io.kestra.core.models.executions.TaskRun; | ||
| import io.kestra.core.models.flows.Flow; | ||
| import io.kestra.core.models.flows.Output; | ||
| import io.kestra.core.models.flows.State; | ||
| import io.kestra.core.runners.RunContext; | ||
| import io.kestra.core.runners.SubflowExecutionResult; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| 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.jupiter.MockitoExtension; | ||
| import org.mockito.junit.jupiter.MockitoSettings; | ||
| import org.mockito.quality.Strictness; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| @MockitoSettings(strictness = Strictness.LENIENT) | ||
| class SubflowTest { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(SubflowTest.class); | ||
|
|
||
| private static final State DEFAULT_SUCCESS_STATE = State.of(State.Type.SUCCESS, Collections.emptyList()); | ||
| public static final String EXECUTION_ID = "executionId"; | ||
|
|
||
| @Mock | ||
| private RunContext runContext; | ||
|
|
||
| @BeforeEach | ||
| void beforeEach() { | ||
| Mockito.when(runContext.logger()).thenReturn(LOG); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldNotReturnResultForExecutionNotTerminated() { | ||
| // Given | ||
| TaskRun taskRun = TaskRun | ||
| .builder() | ||
| .state(State.of(State.Type.CREATED, Collections.emptyList())) | ||
| .build(); | ||
| // When | ||
| Optional<SubflowExecutionResult> result = new Subflow().createSubflowExecutionResult( | ||
| runContext, | ||
| taskRun, | ||
| Flow.builder().build(), | ||
| Execution.builder().build() | ||
| ); | ||
| // Then | ||
| Assertions.assertEquals(Optional.empty(), result); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldOnlyReturnOutputsFromFlowOutputs() throws IllegalVariableEvaluationException { | ||
| // Given | ||
| Output output = Output.builder().id("key").value("value").build(); | ||
| Mockito.when(runContext.render(Mockito.anyMap())).thenReturn(Map.of(output.getId(), output.getValue())); | ||
| Flow flow = Flow.builder() | ||
| .outputs(List.of(output)) | ||
| .build(); | ||
|
|
||
| // When | ||
| Optional<SubflowExecutionResult> result = new Subflow().createSubflowExecutionResult( | ||
| runContext, | ||
| TaskRun.builder().state(DEFAULT_SUCCESS_STATE).build(), | ||
| flow, | ||
| Execution.builder().id(EXECUTION_ID).state(DEFAULT_SUCCESS_STATE).build() | ||
| ); | ||
|
|
||
| // Then | ||
| Assertions.assertTrue(result.isPresent()); | ||
| Map<String, Object> outputs = result.get().getParentTaskRun().getOutputs(); | ||
|
|
||
| Map<String, Object> expected = Subflow.Output.builder() | ||
| .executionId(EXECUTION_ID) | ||
| .state(DEFAULT_SUCCESS_STATE.getCurrent()) | ||
| .outputs(Map.of(output.getId(), output.getValue())) | ||
| .build() | ||
| .toMap(); | ||
| Assertions.assertEquals(expected, outputs); | ||
| } | ||
| } |