apache / apache/beam

[Task]: Examples for the Playground Frontend integration tests

Open
#24,991 0 comments 0 reactions 0 assignees View on GitHub
awaiting triage P3 playground task
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

### What needs to happen?

In the Playground database we need to have examples that integration tests can load. To be reliable, these examples should not be changed or deletable by Apache Beam editors.

Examples should be on both staged/deployed backend and local backend that is started with
`./gradlew :playground:dockerComposeLocalUp`

The source code of these examples should be structured in the directory tree so that new examples can be easily added in the same or other SDKs. Adding examples may require changes in the CI/CD code, but changing an example's should not require changing CI/CD code.

Each of such example's output should be ` output`.
Each of such example's logs should be ` log`.

So far we need only one such example in Go. Its code is here: https://github.com/akvelon/beam/blob/issue24959_test-loading-url/playground/frontend/playground_components_dev/lib/src/examples/content/example.go
It can be placed and/or renamed as is convenient.

Suggested path to fetch it:
`SDK_GO/INTEGRATION_TEST/Example`

### Issue Priority

Priority: 3 (nice-to-have improvement)

### Issue Components

- [ ] Component: Python SDK
- [ ] Component: Java SDK
- [ ] Component: Go SDK
- [ ] Component: Typescript SDK
- [ ] Component: IO connector
- [ ] Component: Beam examples
- [X] Component: Beam playground
- [ ] Component: Beam katas
- [ ] Component: Website
- [ ] Component: Spark Runner
- [ ] Component: Flink Runner
- [ ] Component: Samza Runner
- [ ] Component: Twister2 Runner
- [ ] Component: Hazelcast Jet Runner
- [ ] Component: Google Cloud Dataflow Runner

Contributor guide

Open the contributing guide

Research direction

Start with the Go example at playground/frontend/playground_components_dev/lib/src/examples/content/example.go and inspect the local backend command ./gradlew :playground:dockerComposeLocalUp. Add a structured example available through SDK_GO/INTEGRATION_TEST/Example in both local and staged/deployed backends, protected from editing or deletion, with the specified output and log text.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devops, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.