Health report integration tests bootstrapper and initial tests implementation #16467
Conversation
This file contains 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
…cenario implementation.
mashhurs
force-pushed
the
health-report-bootstrap-and-integration-tests
branch
from
5f7dd0d
to
ffaac9a
Compare
|
💚 Build Succeeded
cc @mashhurs |
mashhurs
changed the title
kaisecheng
reviewed
Sep 19, 2024
There was a problem hiding this comment.
I have tried to run a happy case and a sad case that changed expectation.status from yellow to red. However, both give me YAML 'expectation' section matches the stats.
[14:05:35] logstash git:(pr-16467) ✗ python3 .buildkite/scripts/health-report-tests/main.py
Starting Logstash Health Report Integration test.
LS_VERSION is not specified, using main branch.
logstash-integration-failure_injector successfully installed.
Validating /Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/tests/slow-start.yaml scenario file.
YAML file validation successful!
Logstash is running with PID: 55550.
Testing the scenario: [{'status': 'red'}, {'symptom': 'The pipeline is degraded or at risk of becoming unhealthy; 1 area is impacted and 1 diagnosis is available.'}, {'diagnosis': [{'cause': 'pipeline is loading'}]}, {'impacts': [{'description': 'pipeline is loading'}, {'impact_areas': 'pipeline_execution'}]}, {'details': [{'run_state': 'LOADING'}]}]
Logstash health report: {'path': '/_health_report', 'status': 404, 'error': {'message': 'Not Found'}}
YAML 'expectation' section matches the stats.
[14:46:10] logstash git:(pr-16467) ✗ python3 .buildkite/scripts/health-report-tests/main.py
Starting Logstash Health Report Integration test.
LS_VERSION is not specified, using main branch.
logstash-integration-failure_injector successfully installed.
Validating /Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/tests/slow-start.yaml scenario file.
YAML file validation successful!
Logstash is running with PID: 57476.
Testing the scenario: [{'status': 'yellow'}, {'symptom': 'The pipeline is degraded or at risk of becoming unhealthy; 1 area is impacted and 1 diagnosis is available.'}, {'diagnosis': [{'cause': 'pipeline is loading'}]}, {'impacts': [{'description': 'pipeline is loading'}, {'impact_areas': 'pipeline_execution'}]}, {'details': [{'run_state': 'LOADING'}]}]
Logstash health report: {'path': '/_health_report', 'status': 404, 'error': {'message': 'Not Found'}}
YAML 'expectation' section matches the stats.| def __init__(self): | ||
| pass | ||
|
|
||
| def __meets_expectation(self, scenario_content: list) -> None: |
There was a problem hiding this comment.
Suggested change
| def __meets_expectation(self, scenario_content: list) -> None: | |
| def __is_expected(self, scenario_content: list) -> None: |
|
|
||
| def on(self, scenario_name: str, scenario_content: list) -> None: | ||
| print(f"Testing the scenario: {scenario_content}") | ||
| if self.__meets_expectation(scenario_content) is False: |
There was a problem hiding this comment.
Suggested change
| if self.__meets_expectation(scenario_content) is False: | |
| if self.__is_expected(scenario_content) is False: |
Comment on lines
+1
to
+8
| - name: "Slow start pipeline" | ||
| - config: | ||
| - pipeline.id: slow-start-pp | ||
| config.string: | | ||
| input { heartbeat {} } | ||
| filter { failure_injector { degrade_at => [register] } } | ||
| output { stdout {} } | ||
| - expectation: |
There was a problem hiding this comment.
This is an array containing three items, each of which is a map.
I think you need a map rather than an array of map.
name: "Slow start pipeline"
config:
- pipeline.id: slow-start-pp
config.string: |
input { heartbeat {} }
filter { failure_injector { degrade_at => [register] } }
output { stdout {} }
expectation:
- status: yellow
- symptom: "The pipeline is degraded or at risk of becoming unhealthy; 1 area is impacted and 1 diagnosis is available."
- diagnosis:
- cause: "pipeline is loading"
- impacts:
- description: "pipeline is loading"
- impact_areas: "pipeline_execution"
- details:
- run_state: "LOADING"| logstash_version = os.environ.get("LS_VERSION") | ||
| if logstash_version is None: | ||
| # version is not specified, use the main branch, no need to git checkout | ||
| print(f"LS_VERSION is not specified, using main branch.") |
There was a problem hiding this comment.
suggest to rename LS_VERSION to LS_BRANCH. It can't handle version, eg 8.13.4.
$ LS_VERSION="8.13.4" python3 .buildkite/scripts/health-report-tests/main.py
Starting Logstash Health Report Integration test.
Using specified branch: 8.13.4
error: pathspec '8.13.4' did not match any file(s) known to git
Traceback (most recent call last):
File "/Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/main.py", line 74, in <module>
main()
File "/Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/main.py", line 42, in main
with BootstrapContextManager() as bootstrap:
File "/Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/main.py", line 20, in __enter__
self.bootstrap = Bootstrap()
^^^^^^^^^^^
File "/Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/bootstrap.py", line 31, in __init__
util.git_check_out_branch(logstash_version)
File "/Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/util.py", line 17, in git_check_out_branch
run_or_raise_error(["git", "checkout", branch_name],
File "/Users/kcheng/GitHub/kaisecheng/logstash/.buildkite/scripts/health-report-tests/util.py", line 26, in run_or_raise_error
raise Exception(f"{full_error_message}")
Exception: Error occurred while checking out the 8.13.4 branchThere was a problem hiding this comment.
I have tried LS_VERSION=8.15. It doesn't run the test. Maybe that branch has no python script
$ LS_VERSION="8.15" python3 .buildkite/scripts/health-report-tests/main.py
Starting Logstash Health Report Integration test.
Using specified branch: 8.15
Switched to branch '8.15'
logstash-integration-failure_injector successfully installed.|
|
||
| def load(self, file_path: str) -> None: | ||
| """Load the YAML file content into self.yaml_content.""" | ||
| self.yaml_content: Union[List[Dict[str, Any]], None] = None |
There was a problem hiding this comment.
I have another comment related to the structure of yaml file. I think it can be simplified to Union[Dict[str, Any], None]
| print(f"Logstash has successfully built.") | ||
|
|
||
| def apply_config(self, config: dict) -> None: | ||
| with open(os.getcwd() + "/config/pipelines.yml", 'w') as pipelines_file: |
There was a problem hiding this comment.
nitpick: we need to be careful not to commit the test config/pipelines.yml, or use --path.settings to point the config files to other directory
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Release notes
[rn:skip]
What does this PR do?
Why is it important/What is the impact to the user?
N.A
Checklist
Author's Checklist
How to test this PR locally
./gradlew clean bootstrap assemble installDefaultGemslogstash-integration-failure_injectorlogstash-integration-failure_injectorfolder underqa/supportlogstash-integration-failure_injector-0.0.1.gemof Failure injector plugin implementation. #16466 toqa/support/logstash-integration-failure_injectorfolderbin/logstash-plugin install qa/support/logstash-integration-failure_injector/logstash-integration-failure_injector-0.0.1.gemREADME.mdof this PR to run the integration test.Related issues
Use cases
Screenshots
Logs