-
Notifications
You must be signed in to change notification settings - Fork 223
Initial workflow dashboard config for testcontainers #1601
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
salaboy
wants to merge
22
commits into
dapr:master
Choose a base branch
from
salaboy:workflow-dashboard
base: master
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.
+231
−5
Open
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
1f08776
initial workflow dashboard config
salaboy c654553
adding test for dashboard container
salaboy 1c7e5e7
adding URL to output
salaboy 3b73edf
Adding a Flux based subscribeToEvents method (#1598)
artur-ciocanu 787edfc
fixing configure()
salaboy d8f2810
Remove SDK docs due to migration to main Docs repo (#1593)
marcduiker b4baa1f
fixing headers
salaboy 4399d30
codecov token and new image
salaboy 0b406ae
Update testcontainers-dapr/src/main/java/io/dapr/testcontainers/Workf…
salaboy ce544d3
Update testcontainers-dapr/src/main/java/io/dapr/testcontainers/Workf…
salaboy c26fddf
Bringing Durable Task Java as a Maven module inside the Java SDK (#1575)
salaboy 8f4fa61
Bump codecov/codecov-action from 5.5.1 to 5.5.2 (#1607)
dependabot[bot] 3ab0009
Create Dapr WaitStrategy to improve ITs ergonomics (#1609)
artur-ciocanu 78af4a3
Bump actions/upload-artifact from 4 to 6 (#1606)
dependabot[bot] 0dd4f59
Jobs promotion to DaprClient (#1602)
salaboy 6862ec6
Add Cryptography APIs to the Java SDK (#1599)
siri-varma 80eb395
Adding DaprSpringBootTest and DaprSidecarContainer annotation for eas…
artur-ciocanu 3ae7ab1
adding constant for dashboard
salaboy ea78b8d
extend test for codecov
salaboy c81ac16
adding tests for null state store
salaboy 572fb41
testing string constructor
salaboy 816edbd
Merge branch 'master' into workflow-dashboard
salaboy 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
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
109 changes: 109 additions & 0 deletions
109
testcontainers-dapr/src/main/java/io/dapr/testcontainers/WorkflowDashboardContainer.java
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,109 @@ | ||
| /* | ||
| * Copyright 2025 The Dapr Authors | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package io.dapr.testcontainers; | ||
|
|
||
| import io.dapr.testcontainers.converter.ComponentYamlConverter; | ||
| import io.dapr.testcontainers.converter.YamlConverter; | ||
| import io.dapr.testcontainers.converter.YamlMapperFactory; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.testcontainers.containers.GenericContainer; | ||
| import org.testcontainers.images.builder.Transferable; | ||
| import org.testcontainers.utility.DockerImageName; | ||
| import org.yaml.snakeyaml.Yaml; | ||
|
|
||
| /** | ||
| * Test container for Dapr Workflow Dashboard. | ||
| */ | ||
| public class WorkflowDashboardContainer extends GenericContainer<WorkflowDashboardContainer> { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(WorkflowDashboardContainer.class); | ||
| private static final Yaml YAML_MAPPER = YamlMapperFactory.create(); | ||
| private static final YamlConverter<Component> COMPONENT_CONVERTER = new ComponentYamlConverter(YAML_MAPPER); | ||
| public static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName | ||
| .parse(DaprContainerConstants.DAPR_WORKFLOWS_DASHBOARD); | ||
| private int dashboardPort = 8080; | ||
| private Component stateStoreComponent; | ||
|
|
||
| /** | ||
| * Creates a new workflow dashboard container. | ||
| * @param dockerImageName Docker image name. | ||
| */ | ||
| public WorkflowDashboardContainer(DockerImageName dockerImageName) { | ||
| super(dockerImageName); | ||
| dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME); | ||
| withExposedPorts(dashboardPort); | ||
| } | ||
|
|
||
| public WorkflowDashboardContainer withStateStoreComponent(Component stateStoreComponent) { | ||
| this.stateStoreComponent = stateStoreComponent; | ||
| return this; | ||
| } | ||
|
|
||
| public Component getStateStoreComponent() { | ||
| return stateStoreComponent; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new workflow dashboard container. | ||
| * @param image Docker image name. | ||
| */ | ||
| public WorkflowDashboardContainer(String image) { | ||
| this(DockerImageName.parse(image)); | ||
| } | ||
|
|
||
| @Override | ||
| protected void configure() { | ||
| super.configure(); | ||
| if (stateStoreComponent == null) { | ||
| throw new IllegalStateException("State store component cannot be null"); | ||
| } | ||
|
|
||
| String componentYaml = COMPONENT_CONVERTER.convert(stateStoreComponent); | ||
| withCopyToContainer(Transferable.of(componentYaml), "/app/components/" + stateStoreComponent.getName() + ".yaml"); | ||
| withEnv("COMPONENT_FILE", "/app/components/" + stateStoreComponent.getName() + ".yaml"); | ||
|
|
||
| } | ||
|
|
||
| public static DockerImageName getDefaultImageName() { | ||
| return DEFAULT_IMAGE_NAME; | ||
| } | ||
|
|
||
| public WorkflowDashboardContainer withPort(Integer port) { | ||
| this.dashboardPort = port; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public void start() { | ||
| super.start(); | ||
|
|
||
| LOGGER.info("Dapr Workflow Dashboard container started."); | ||
| LOGGER.info("Access the Dashboard at: http://localhost:{}", this.getMappedPort(dashboardPort)); | ||
| } | ||
|
|
||
| public int getPort() { | ||
| return dashboardPort; | ||
| } | ||
|
|
||
| // Required by spotbugs plugin | ||
| @Override | ||
| public boolean equals(Object o) { | ||
| return super.equals(o); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return super.hashCode(); | ||
| } | ||
| } |
70 changes: 70 additions & 0 deletions
70
testcontainers-dapr/src/test/java/io/dapr/testcontainers/DaprWorkflowDashboardTest.java
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,70 @@ | ||
| /* | ||
| * Copyright 2025 The Dapr Authors | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package io.dapr.testcontainers; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.util.Collections; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| public class DaprWorkflowDashboardTest { | ||
|
|
||
| @Test | ||
| public void dashboardTest() { | ||
| Component stateStoreComponent = new Component("kvstore", | ||
| "state.in-memory", "v1", Collections.singletonMap("actorStateStore", "true")); | ||
| try (WorkflowDashboardContainer dashboard = | ||
| new WorkflowDashboardContainer(WorkflowDashboardContainer.DEFAULT_IMAGE_NAME) | ||
| .withStateStoreComponent(stateStoreComponent).withPort(8080)) { | ||
| dashboard.configure(); | ||
| assertNotNull(dashboard.getEnvMap().get("COMPONENT_FILE")); | ||
| assertFalse(dashboard.getEnvMap().get("COMPONENT_FILE").isEmpty()); | ||
| assertEquals(8080, dashboard.getPort()); | ||
| assertEquals(WorkflowDashboardContainer.DEFAULT_IMAGE_NAME, dashboard.getDefaultImageName()); | ||
| assertEquals(8080, dashboard.getExposedPorts().get(0)); | ||
| assertEquals(stateStoreComponent, dashboard.getStateStoreComponent()); | ||
| assertEquals("/app/components/kvstore.yaml", dashboard.getEnvMap().get("COMPONENT_FILE")); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void dashboardNoStateStoreTest() { | ||
| Exception expectedException = null; | ||
| try{ | ||
| WorkflowDashboardContainer dashboard = | ||
| new WorkflowDashboardContainer(WorkflowDashboardContainer.DEFAULT_IMAGE_NAME); | ||
| dashboard.configure(); | ||
| } catch(IllegalStateException ex){ | ||
| expectedException = ex; | ||
| } | ||
| assertNotNull(expectedException); | ||
| } | ||
|
|
||
| @Test | ||
| public void dashboardWithImageStringTest() { | ||
| Component stateStoreComponent = new Component("kvstore", | ||
| "state.in-memory", "v1", Collections.singletonMap("actorStateStore", "true")); | ||
| WorkflowDashboardContainer dashboard = | ||
| new WorkflowDashboardContainer(DaprContainerConstants.DAPR_WORKFLOWS_DASHBOARD) | ||
| .withStateStoreComponent(stateStoreComponent); | ||
| dashboard.configure(); | ||
|
|
||
| assertEquals(WorkflowDashboardContainer.DEFAULT_IMAGE_NAME, dashboard.getDefaultImageName()); | ||
|
|
||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.