Skip to content
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

Delete workflow feature and add alternative bash script #1223

Merged
merged 26 commits into from
Apr 17, 2024

Conversation

HansRobo
Copy link
Member

@HansRobo HansRobo commented Apr 4, 2024

Description

Abstract

  • Delete the workflow feature from scenario_test_runner to simplify it
  • Add a bash script to replace workflow feature

Background

The workflow feature was considered necessary at the initial stage of scenario_simulator_v2.
However, over time, we found that the workflow feature did not provide useful functionality to justify the added complexity of the data flow.
And I'm removing this feature in this pull-request as a simple script can replace it.

Details

usage for new script

./workflow.sh <workflow file> <other options for scenario_test_runner>

workflow file example

A file with a scenario path written on each line is valid.
It is passed to the scenario specification part of scenario_test_runner, so special commands such as find-pkg-share can be used.

$(find-pkg-share scenario_test_runner)/scenario/all-in-one.yaml
$(find-pkg-share scenario_test_runner)/scenario/minimal.yaml

script exit status

The script's exit status is 1 if even one scenario fails, and 0 if all are successful.

References

Regression Test Result: OK

Destructive Changes

Workflow functionality has been removed.
Users must create their own replacement functionality.
A simple sample is included in this pull request for your reference.

Known Limitations

N/A

Copy link

github-actions bot commented Apr 4, 2024

Checklist for reviewers ☑️

All references to "You" in the following text refer to the code reviewer.

  • Is this pull request written in a way that is easy to read from a third-party perspective?
  • Is there sufficient information (background, purpose, specification, algorithm description, list of disruptive changes, and migration guide) in the description of this pull request?
  • If this pull request contains a destructive change, does this pull request contain the migration guide?
  • Labels of this pull request are valid?
  • All unit tests/integration tests are included in this pull request? If you think adding test cases is unnecessary, please describe why and cross out this line.
  • The documentation for this pull request is enough? If you think adding documents for this pull request is unnecessary, please describe why and cross out this line.

@HansRobo HansRobo changed the title refactor: delete workflow.Workflow and rename workflow.py to scenario.py Delete workflow feature and add alternative bash script Apr 9, 2024
@HansRobo HansRobo added the bump minor If this pull request merged, bump minor version of the scenario_simulator_v2 label Apr 9, 2024
@HansRobo HansRobo marked this pull request as ready for review April 10, 2024 01:44
@HansRobo HansRobo marked this pull request as draft April 10, 2024 01:44
@HansRobo HansRobo marked this pull request as ready for review April 16, 2024 02:16
@yamacir-kit yamacir-kit self-requested a review April 16, 2024 08:43
.github/workflows/workflow.sh Outdated Show resolved Hide resolved
.github/workflows/workflow.sh Outdated Show resolved Hide resolved
.github/workflows/workflow.sh Outdated Show resolved Hide resolved
.github/workflows/workflow.sh Outdated Show resolved Hide resolved
.github/workflows/workflow.sh Outdated Show resolved Hide resolved
@yamacir-kit yamacir-kit merged commit 2690adb into master Apr 17, 2024
11 checks passed
@yamacir-kit yamacir-kit deleted the refactor/drop_workflow branch April 17, 2024 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump minor If this pull request merged, bump minor version of the scenario_simulator_v2 wait for regression test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants