[BEAM-13135] [Playground] Validate step in Beam CI pipelines for Playground objects

• Type: New Feature
• Status: Resolved
• Priority: P3
• Resolution: Done
• Fix Version/s: Missing
• Component/s: beam-playground
• Labels: beam-playground-beta-launch beam-playground-devops beam-playground-sprint-3 beam-playground-sprint-4 beam-playground-sprint-5
• Assignee: Unassigned
• Reporter: Ilya Kozyrev
• Created: 28/Oct/21 07:30
• Updated: 13/Jan/22 21:49
• Resolved: 10/Jan/22 08:44

Description

As an Apache Beam maintainer who develops examples, katas, or unit tests, I want to have a validation step in the CI pipeline for my Pull Request into the Apache Beam repository. This step should check tagged objects for Playground and give feedback in PR if something went wrong.

Acceptance criteria:

1. Search Tags in the Apache Beam codebase
2. Tag format validations for objects
3. Compilation validation for tagged objects
4. Verification for running ability in the Playground environment
5. Feedback sends in Pull Request

Scenario: CI script found object available for Playground usage

Given: CI is triggered for new PR

When: CI script scan file in apache beam repository 

And: File contained Playground tag

Then: CI Validates this file for usage in Playground

 

Given: CI found tagged object

When: CI runs validation for tag format

And: Validation is complete

Then: CI starts the compilation for this object

 

Given: CI found tagged object

When: CI runs validation for tag format

And: Validation is failed

Then: CI task ends with an error and feedback received to PR

–

Given: Validation is complete

When: CI runs compilation for object

And: Compilation is complete

Then: CI starts the run step for this object

–

Given: Validation is complete

When: CI runs compilation for object

And: Compilation is failed

Then: CI task ends with an error and feedback received to PR

–

Given: Compilation is complete

When: CI runs object's code in Playground 

And: Run step is complete

Then: CI Ends successfully 

 

Given: Compilation is complete

When: CI runs object's code in Playground 

And: Run step

Then: CI task ends with an error and feedback received to PR

Issue Links

• links to: GitHub Pull Request #16072

Sub-Tasks

• [Playground] Initialise structure to find and validate tagged files: Resolved
• [Playground] Add function to find all tagged files: Resolved
• [Playground] Add client to send found tagged file to the backend: Resolved
• [Playground] Implement an example verification method: Resolved
• [Playground] Implement setup of CI test environment: Resolved
• [Playground] Implement get_statuses method: Resolved