generated from kestra-io/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 7
fix: use onInvalidSyntax properly when invalid flows #247
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.
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
Open
fdelbrayelle
wants to merge
2
commits into
main
Choose a base branch
from
issues/246
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,127 @@ | ||
| package io.kestra.plugin.git; | ||
|
|
||
| import com.sun.net.httpserver.HttpServer; | ||
| import io.kestra.core.exceptions.KestraRuntimeException; | ||
| import io.kestra.core.junit.annotations.KestraTest; | ||
| import io.kestra.core.runners.RunContextFactory; | ||
| import io.kestra.core.tenant.TenantService; | ||
| import io.kestra.sdk.KestraClient; | ||
| import jakarta.inject.Inject; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.io.ByteArrayOutputStream; | ||
| import java.lang.reflect.InvocationTargetException; | ||
| import java.lang.reflect.Method; | ||
| import java.net.InetSocketAddress; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Map; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
| import java.util.zip.ZipEntry; | ||
| import java.util.zip.ZipOutputStream; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.containsString; | ||
| import static org.hamcrest.Matchers.instanceOf; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
|
|
||
| @KestraTest | ||
| class TenantSyncTest { | ||
| private static final String TENANT_ID = TenantService.MAIN_TENANT; | ||
| private static final String NAMESPACE = "my.namespace"; | ||
|
|
||
| @Inject | ||
| private RunContextFactory runContextFactory; | ||
|
|
||
| @Test | ||
| void shouldFailOnInvalidTaskDefinitionFromKestraExport() throws Exception { | ||
| var yaml = """ | ||
| id: exported-flow | ||
| namespace: my.namespace | ||
|
|
||
| tasks: | ||
| - id: log | ||
| type: io.kestra.core.tasks.log.Log | ||
| message: hello | ||
| """; | ||
| var exportedZip = zippedYaml("my.namespace/exported-flow.yaml", yaml); | ||
| var validateCalls = new AtomicInteger(); | ||
|
|
||
| var server = HttpServer.create(new InetSocketAddress(0), 0); | ||
| server.createContext("/api/v1/" + TENANT_ID + "/flows/export/by-query", exchange -> { | ||
| exchange.getRequestBody().readAllBytes(); | ||
| exchange.getResponseHeaders().add("Content-Type", "application/octet-stream"); | ||
| exchange.sendResponseHeaders(200, exportedZip.length); | ||
| exchange.getResponseBody().write(exportedZip); | ||
| exchange.close(); | ||
| }); | ||
| server.createContext("/api/v1/" + TENANT_ID + "/flows/validate", exchange -> { | ||
| validateCalls.incrementAndGet(); | ||
| exchange.getRequestBody().readAllBytes(); | ||
|
|
||
| var body = """ | ||
| [ | ||
| { | ||
| "index": 0, | ||
| "constraints": "invalid task definition" | ||
| } | ||
| ] | ||
| """; | ||
| var payload = body.getBytes(StandardCharsets.UTF_8); | ||
| exchange.getResponseHeaders().add("Content-Type", "application/json"); | ||
| exchange.sendResponseHeaders(200, payload.length); | ||
| exchange.getResponseBody().write(payload); | ||
| exchange.close(); | ||
| }); | ||
| server.start(); | ||
|
|
||
| try { | ||
| var task = TenantSync.builder().build(); | ||
| var method = fetchFlowsMethod(); | ||
| var runContext = runContextFactory.of(Map.of( | ||
| "flow", Map.of( | ||
| "tenantId", TENANT_ID, | ||
| "namespace", NAMESPACE, | ||
| "id", "tenant-sync-test" | ||
| ) | ||
| )); | ||
| var kestraClient = KestraClient.builder() | ||
| .url("http://localhost:" + server.getAddress().getPort()) | ||
| .basicAuth("user", "pass") | ||
| .build(); | ||
|
|
||
| var exception = assertThrows( | ||
| InvocationTargetException.class, | ||
| () -> method.invoke(task, kestraClient, runContext, NAMESPACE, TenantSync.OnInvalidSyntax.FAIL) | ||
| ); | ||
| assertThat(exception.getCause(), instanceOf(KestraRuntimeException.class)); | ||
| assertThat(exception.getCause().getMessage(), containsString("FLOW from entry my.namespace/exported-flow.yaml")); | ||
| assertThat(exception.getCause().getMessage(), containsString("invalid task definition")); | ||
| assertEquals(1, validateCalls.get()); | ||
| } finally { | ||
| server.stop(0); | ||
| } | ||
| } | ||
|
|
||
| private static byte[] zippedYaml(String entryName, String yaml) throws Exception { | ||
| var output = new ByteArrayOutputStream(); | ||
| try (var zip = new ZipOutputStream(output)) { | ||
| zip.putNextEntry(new ZipEntry(entryName)); | ||
| zip.write(yaml.getBytes(StandardCharsets.UTF_8)); | ||
| zip.closeEntry(); | ||
| } | ||
| return output.toByteArray(); | ||
| } | ||
|
|
||
| private static Method fetchFlowsMethod() throws Exception { | ||
| var method = TenantSync.class.getDeclaredMethod( | ||
| "fetchFlowsFromKestra", | ||
| KestraClient.class, | ||
| io.kestra.core.runners.RunContext.class, | ||
| String.class, | ||
| TenantSync.OnInvalidSyntax.class | ||
| ); | ||
| method.setAccessible(true); | ||
| return method; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will only catch flow schema validations and not invalid task definitions e.g some property no longer avaiable or incorrect property name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix proposal: ef6dbf9
What do you think @Malaydewangan09 ?