[YUNIKORN-2726] Add How to check E2E test logs? to developer guide #450
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
craigcondit
requested changes
Jul 11, 2024
docs/developer_guide/e2e_test.md
Outdated
| ## Checking E2E Test Logs | ||
|
|
||
| After implementing [YUNIKORN-2305](https://issues.apache.org/jira/browse/YUNIKORN-2305), the logs of failed E2E tests are stored locally and uploaded to the GitHub Action Artifact. This section explains how to retrieve and understand these logs. |
There was a problem hiding this comment.
We don't need to mention the JIRA that implemented this. It's fine to have it in the docs without that.
chia7712
reviewed
Jul 15, 2024
docs/developer_guide/e2e_test.md
Outdated
| ### Steps to Retrieve Local Logs | ||
|
|
||
| 1. Run the E2E test using `make e2e_test`. |
There was a problem hiding this comment.
Can we recommend to use ./scripts/run-e2e-tests.sh -a "test" -n "yk8s" instead of make e2e_test? run-e2e-tests.sh is easy to use. Also it is the command used by CI.
There was a problem hiding this comment.
Done! Great suggestion. Totally agreed with aligning with CI.
blueBlue0102
approved these changes
Jul 18, 2024
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.
What is this PR for?
After YUNIKORN-2305 , the logs of failed E2E test are dumped to local and upload to Github Action Artifact. We should let new developers know how to retrieve them.
We should add some explaination to developer guide(https://yunikorn.apache.org/docs/next/developer_guide/e2e_test), below should be included:
Where to find the local e2e test logs after
make e2e_testfailed? (In yunikorn-k8shim/build/e2e/{suite}/)What's logs types we have
a. {specName}_k8sClusterInfo.txt
b.{specName}_ykContainerLog.txt
c.{specName}_ykFullStateDump.json
How to download logs in Github Action (Check below screenshot in the failed CI Link)
What type of PR is it?
Todos
What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-2726
How should this be tested?
Screenshots (if appropriate)
Questions: